This is the base class for generating instances of figures containing a square symmetric tiling of subplots.
More...

Inheritance diagram for Triplex:

Collaboration diagram for Triplex:

Public Member Functions
function	Triplex (in lower, in diago, in upper, in varargin)
	Construct and return an object of class pm.vis.Triplex. More...

function	reset (in self, in varargin)
	Reset the properties of the figure to the original default settings. More...

function	premake (in self, in varargin)
	Preset the tiling settings before making it. More...

function	make (in self, in varargin)
	Configure the figure settings and specifications, make the figure and the subplots, and return nothing. More...

function	rotateAxesLabels (in self, in degx, in degy)
	Rotate the axes labels of the subplots of the Triplex, and return nothing. More...

function	setAxesLimits (in self, in limits)
	Set the axes x-y limits of the subplots that are currently present in the GridPlot to the input user-provided values. More...

function	hideShowAxesLabels (in self)
	Hide or show axis labels and ticks depending on the presence of the neighbor subplots. More...

function	setDiagoTicksY (in self)
	Hide or show axis labels and ticks depending on the presence of the neighbor subplots. More...

Data Fields
Property	layout

Property	diago

Property	lower

Property	upper

Property	tile

Property	diagYTick

Detailed Description

This is the base class for generating instances of figures containing a square symmetric tiling of subplots.

This class generates figures containing three types of plots in the upper-triangle, lower-triangle, and diagonal subplots of the figure.
For more information, see the documentation of the class constructor pm.vis.Triplex.Triplex.

Note: This class is not meant to be used directly by the end users.
Instead, use the subclasses of this parent class.; See the list of class attributes below, also those of the superclass pm.vis.figure.Figure.

Todo:: High Priority: The hideShow() method of this class still has unresolved bugs that lead to missing X and Y axes labels and tick marks.
Consequently, the show() and hide() class methods are also unavailable until the issues are resolved.
For now, all of these functionalities are commented out.
A simple bypass is to generate tilings with prior contemplation about its design so that post-visualization modifications are unnecessary.

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, August 31 2024, 6:40 AM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.

Definition at line 30 of file Triplex.m.

Constructor & Destructor Documentation

◆ Triplex()

function Triplex::Triplex	(	in	lower,
		in	diago,
		in	upper,
		in	varargin
	)

Construct and return an object of class pm.vis.Triplex.

This is the constructor of the class pm.vis.Triplex.
The input dataset to each plot section is assumed to be common among all plots (though not necessarily).
As such, all axes labels and tick marks of all subplots are dropped by default, except for subplots in the left and bottom boundaries of the figure.

If any of the three input subplot types has colorbar, it is disabled for individual subplots.
Instead, universal colorbar(s) will be added to the right and top sides of the Triplex plot.

Parameters

[in]	lower	: The input scalar MATLAB object of superclass pm.vis.Subplot containing information for the kind the subplot that must be added to the lower-triangular elements of the Triplex matrix of subplots. (optional, default = `[]`. If empty, no lower-triangular subplots will be visualized.)
[in]	diago	: The input scalar MATLAB object of superclass pm.vis.Subplot containing information for the kind the subplot that must be added to the diagonal elements of the Triplex matrix of subplots. (optional, default = `[]`. If empty, no diagonal subplots will be visualized.)
[in]	upper	: The input scalar MATLAB object of superclass pm.vis.Subplot containing information for the kind the subplot that must be added to the upper-triangular elements of the Triplex matrix of subplots. (optional, default = `[]`. If empty, no upper-triangular subplots will be visualized.)
[in]	varargin	: Any `property, value` pair of the parent object. If the property is a `struct()`, then its value must be given as a cell array, with consecutive elements representing the struct `property-name, property-value` pairs. Note that all of these property-value pairs can be also directly set via the parent object attributes, before calling the `make()` method.

Returns: self : The output scalar object of class pm.vis.Triplex.

Possible calling interfaces ⛓

: g = pm.vis.Triplex(diago, [], [], varargin);

g = pm.vis.Triplex([], [], upper, varargin);

g = pm.vis.Triplex([], lower, [], varargin);

g = pm.vis.Triplex(diago, lower, [], varargin);

g = pm.vis.Triplex(diago, [], upper, varargin);

g = pm.vis.Triplex([], lower, upper, varargin);

g = pm.vis.Triplex(lower, diago, upper, varargin);

Triplex::lower
Property lower
Definition: Triplex.m:68

Triplex::diago
Property diago
Definition: Triplex.m:58

Triplex::upper
Property upper
Definition: Triplex.m:78

Warning: The data columns to be plotted in each Triplex section must be consistent with other sections.
Failure to ensure this will lead to undefined behavior and possibly a runtime error.

Note: See the list of class attributes below, also those of the superclass pm.vis.figure.Figure.

Example usage ⛓

: 1close all

2clear all

3cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.

4addpath('../../../'); % Add the ParaMonte library root directory to the search path.

5

6sampler = pm.sampling.Paradram();

7sampler.spec.outputRestartFileFormat = "ascii";

8sampler.spec.outputChainSize = 10000;

9sampler.spec.outputFileName = "./test";

10sampler.spec.outputStatus = "retry";

11sampler.run(@(x) -sum(x.^2), 4);

12restart = sampler.readRestart();

13sample = sampler.readSample();

14

15%%%%

16

17cols = sample{1}.slfc + [1 : sample{1}.ndim];

18kws = {"colorbar", {"enabled", false}};

19tx = pm.vis.Triplex ( pm.vis.SubplotScatter(sample{1}.df, "colx", cols, "coly", cols, kws{:}) ...

20 , pm.vis.SubplotHistogram(sample{1}.df, "colx", cols) ...

21 , pm.vis.SubplotContour(sample{1}.df, "colx", cols, "coly", cols, kws{:}) ...

22 );

23%tx.layout.reset();

24%tx.layout.cbarh.enabled = true;

25%tx.layout.cbarv.enabled = true;

26%tx.layout.cbarh.position = [];

27%tx.layout.cbarv.position = [];

28%tx.layout.tiling.tile.width = [];

29tx.make();

30pm.vis.figure.savefig("Triplex.1.png", "-m3");

31

32%%%%

33%%%%

34

35url = "https://raw.githubusercontent.com/cdslaborg/paramontex/fbeca6745684c798ff28c1bf57cfae0c190db478/MATLAB/mlx/sampling_multivariate_normal_distribution_via_paradram/out/mvn_serial_process_1_chain.txt";

36chain = sampler.readChain(url);

37cols = chain{1}.slfc + [1 : chain{1}.ndim];

38

39%%%%

40

41tx = pm.vis.Triplex ( pm.vis.SubplotLineScatter(chain{1}.df, "colx", cols, "coly", cols, "colc", chain{1}.slfc, "colorbar", {"enabled", false}, "colormap", {"map", "autumn"}) ...

42 , pm.vis.SubplotHistogram(chain{1}.df, "colx", cols, "histogram", {"faceColor", "red"}) ...

43 , pm.vis.SubplotContour3(chain{1}.df, "colx", cols, "coly", cols, "colorbar", {"enabled", false}) ...

44 );

45tx.make();

46pm.vis.figure.savefig("Triplex.2.png", "-m3");

47

48tx.fout.cbarv.Label.Interpreter = "tex";

49tx.fout.cbarv.Label.FontSize = 13;

50tx.fout.cbarv.Label.String = "Log_e ( Probbability Density Function of the MVN distribution )";

51pm.vis.figure.savefig("Triplex.3.png", "-m3");

52

53%%%%

54

55tx = pm.vis.Triplex ( pm.vis.SubplotLineScatter(chain{1}.df, "colx", cols, "coly", cols, "colc", chain{1}.slfc, "colorbar", {"enabled", false}) ...

56 , pm.vis.SubplotHistfit(chain{1}.df, "colx", cols) ...

57 , [] ...pm.vis.SubplotContour3(chain{1}.df, "colx", cols, "coly", cols, "colorbar", {"enabled", false}) ...

58 );

59tx.layout.tiling.position = [.1, nan, nan, nan]; % allow more room for axes labels.

60tx.make();

61pm.vis.figure.savefig("Triplex.4.png", "-m3");

62

63%%%%

64

65tx = pm.vis.Triplex ( pm.vis.SubplotLineScatter(chain{1}.df, "colx", cols, "coly", cols, "colormap", {"enabled", false}) ...

66 , pm.vis.SubplotHistfit(chain{1}.df, "colx", cols) ...

67 , pm.vis.SubplotContour3(chain{1}.df, "colx", cols, "coly", cols, "colormap", {"enabled", false}) ...

68 );

69tx.layout.tiling.position = [.1, nan, nan, nan]; % allow more room for axes labels.

70tx.make();

71pm.vis.figure.savefig("Triplex.5.png", "-m3");

72

73%%%%

74

75tx = pm.vis.Triplex ( [] ...

76 , pm.vis.SubplotHistfit(chain{1}.df, "colx", cols) ...

77 , pm.vis.SubplotScatter(chain{1}.df, "colx", cols, "coly", cols, "colorbar", {"enabled", false}) ...

78 );

79tx.make();

80pm.vis.figure.savefig("Triplex.6.png", "-m3");

81

82%%%%

83

84tx = pm.vis.Triplex ( pm.vis.SubplotLineScatter(chain{1}.df, "colx", cols, "coly", cols, "colormap", {"enabled", false}) ...

85 , [] ...

86 , pm.vis.SubplotContourf(chain{1}.df, "colx", cols, "coly", cols, "colorbar", {"enabled", false}, "colormap", {"enabled", true}) ...

87 );

88tx.make();

89pm.vis.figure.savefig("Triplex.7.png", "-m3");

root
function root()
Return a scalar MATLAB string containing the root directory of the ParaMonte library package.

Visualization of the example output ⛓

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, August 31 2024, 6:40 AM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.

Member Function Documentation

◆ hideShowAxesLabels()

function Triplex::hideShowAxesLabels ( in self )

Hide or show axis labels and ticks depending on the presence of the neighbor subplots.

This is an internal (hidden) method of the class and inaccessible to end users.

Parameters

[in] self : The implicitly-passed input argument representing the parent object of the method.

Possible calling interfaces ⛓

: g = pm.vis.Triplex(lower, diago, upper, varargin);

g.hideShowAxesLabels();

Warning: This method causes side-effects by manipulating the existing attributes of the object.

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Joshua Alexander Osborne, May 21 2024, 9:28 AM, University of Texas at Arlington
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.
Amir Shahmoradi, July 7 2024, 12:53 AM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.

◆ make()

function Triplex::make	(	in	self,
		in	varargin
	)

Configure the figure settings and specifications, make the figure and the subplots, and return nothing.

The subplots are made by calling their make() methods.

Parameters

[in]	self	: The implicitly-passed input argument representing the parent object of the method.
[in]	varargin	: Any `property, value` pair of the parent object. If the property is a `struct()`, then its value must be given as a cell array, with consecutive elements representing the struct `property-name, property-value` pairs. Note that all of these property-value pairs can be also directly set via the parent object attributes, before calling the `make()` method.

Possible calling interfaces ⛓

: g = pm.vis.Triplex(lower, diago, upper, varargin);

g.make(varargin);

Warning: This method has side-effects by manipulating the existing attributes of the parent object.

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, July 7 2024, 12:53 AM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.

◆ premake()

function Triplex::premake	(	in	self,
		in	varargin
	)

Preset the tiling settings before making it.

Parameters

[in]	self	: The implicitly-passed input argument representing the parent object of the method.
[in]	varargin	: Any `property, value` pair of the parent object. If the property is a `struct()`, then its value must be given as a cell array, with consecutive elements representing the struct `property-name, property-value` pairs. Note that all of these property-value pairs can be also directly set via the parent object attributes, before calling the `make()` method.

Possible calling interfaces ⛓

: g = pm.vis.Triplex(lower, diago, upper, varargin);

g.premake(varargin);

Warning: This method causes side-effects by manipulating the existing attributes of the object.

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Joshua Alexander Osborne, May 21 2024, 9:28 AM, University of Texas at Arlington
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.
Amir Shahmoradi, July 7 2024, 12:53 AM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.

◆ reset()

function Triplex::reset	(	in	self,
		in	varargin
	)

Reset the properties of the figure to the original default settings.

Use this method when you change many attributes of the plot and you want to clean up and go back to the default settings.

Parameters

[in]	self	: The implicitly-passed input argument representing the parent object of the method.
[in]	varargin	: Any `property, value` pair of the parent object. If the property is a `struct()`, then its value must be given as a cell array, with consecutive elements representing the struct `property-name, property-value` pairs. Note that all of these property-value pairs can be also directly set via the parent object attributes, before calling the `make()` method.

Possible calling interfaces ⛓

: g = pm.vis.Triplex(lower, diago, upper, varargin);

g.reset(varargin); % reset all object properties to the default settings.

Triplex::reset
function reset(in self, in varargin)
Reset the properties of the figure to the original default settings.

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Joshua Alexander Osborne, May 21 2024, 9:25 AM, University of Texas at Arlington
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.
Amir Shahmoradi, July 7 2024, 12:53 AM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.

◆ rotateAxesLabels()

function Triplex::rotateAxesLabels	(	in	self,
		in	degx,
		in	degy
	)

Rotate the axes labels of the subplots of the Triplex, and return nothing.

All axes labels in the tiling will be impacted by this routine, even though only a selected subset might be visible.

Parameters

[in]	self	: The implicitly-passed input argument representing the parent object of the method.
[in]	degx	: The input scalar MATLAB positive whole-number, representing the amount of rotation to be applied to the x-axis labels with respect to the horizontal line. If it is set to empty `[]`, the axis label orientation will remain intact. (optional, default = `45`. It must be present if and only if `degy` is also present.)
[in]	degy	: The input scalar MATLAB positive whole-number, representing the amount of rotation to be applied to the y-axis labels with respect to the horizontal line. If it is set to empty `[]`, the axis label orientation will remain intact. (optional, default = `45`. It must be present if and only if `degx` is also present.)

Possible calling interfaces ⛓

: g = pm.vis.Triplex(lower, diago, upper, varargin);

g.make(varargin);

g.rotateAxesLabels(); % rotate all axes labels by 45 degrees.

g.rotateAxesLabels(degx, []); % rotate x-axis labels by ``degx`` degrees.

g.rotateAxesLabels([], degy); % rotate y-axis labels by ``degy`` degrees.

g.rotateAxesLabels(degx, degy); % rotate x-axis and y-axis labels by ``degx`` and ``degy`` degrees.

Warning: This method has side-effects by manipulating the existing attributes of the parent object.

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, July 7 2024, 12:53 AM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.

◆ setAxesLimits()

function Triplex::setAxesLimits	(	in	self,
		in	limits
	)

Set the axes x-y limits of the subplots that are currently present in the GridPlot to the input user-provided values.

Parameters

[in]	self	: The implicitly-passed input argument representing the parent object of the method.
[in]	limits	: A MATLAB `cell` vector of maximum length `max(size(self.tile))`, each element of which corresponds to one row of the Triplex plot, from the top-left corner. Each element of the cell array must be a real vector of length `2` whose values determine the lower and upper limits of the vertical axis of the corresponding subplot in the visualization. The the axes limits of all subplots whose corresponding elements in the input cell array `limits` are set to empty `[]`, will be set to the appropriate default value taken from the maximum range possible in the relevant plots. (optional, default = `cell(max(size(self.tile)), 1)`)

Possible calling interfaces ⛓

: g = pm.vis.Triplex(lower, diago, upper, varargin);

g.make(varargin);

g.setAxesLimits(); % reset all axes limits to the maximum ranges among all relevant plots.

g.setAxesLimits({}); % reset all axes limits to the maximum ranges among all relevant plots.

g.setAxesLimits(limits); % reset all axes limits to the custom ranges among all relevant plots.

Example usage ⛓

: g = pm.vis.Triplex(lower, diago, upper, varargin);

g.make(varargin);

g.setAxesLimits({[-10,10], [-20, 0]})

g.setAxesLimits({[-10,10], [], [-20, 0]}) % the limits for the second variable will remain unchanged.

Warning: This method has side-effects by manipulating the existing attributes of the parent object.

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, July 7 2024, 12:53 AM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.

◆ setDiagoTicksY()

function Triplex::setDiagoTicksY ( in self )

Hide or show axis labels and ticks depending on the presence of the neighbor subplots.

This is an internal (hidden) method of the class and inaccessible to end users.

Parameters

[in] self : The implicitly-passed input argument representing the parent object of the method.

Possible calling interfaces ⛓

: g = pm.vis.Triplex(lower, diago, upper, varargin);

g.hideShowAxesLabels();

Warning: This method causes side-effects by manipulating the existing attributes of the object.

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Joshua Alexander Osborne, May 21 2024, 9:28 AM, University of Texas at Arlington
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.
Amir Shahmoradi, July 7 2024, 12:53 AM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.

Field Documentation

◆ diago

Property Triplex::diago

diago

The scalar object of superclass pm.vis.Subplot representing the template of the diagonal subplots to display.
Note that only the visualization properties of the template are used.
The data properties of the template are set by the make() method.
(optional. The default value is pm.vis.SubplotHistogram.)

Definition at line 58 of file Triplex.m.

◆ diagYTick

Property Triplex::diagYTick

diagYTick

The MATLAB cell vector of length nrow`, containing the diagonal y-tick labels.

Warning: This is an internal Hidden class attribute that is inaccessible to the end users.

Definition at line 102 of file Triplex.m.

◆ layout

Property Triplex::layout

layout

The scalar object of class pm.vis.TilingLayout containing the default layout of the Triplex plot.
The information includes the subplots and colorbar positions.
This information is applied only to figure components whose positions are unset.

Definition at line 47 of file Triplex.m.

◆ lower

Property Triplex::lower

lower

The scalar object of superclass pm.vis.Subplot representing the template of the lower-triangle subplots to display.
The data properties of the template are set by the make() method.
(optional. The default value is pm.vis.SubplotContour.)

Definition at line 68 of file Triplex.m.

◆ tile

Property Triplex::tile

tile

The MATLAB cell matrix containing objects of superclass pm.vis.Subplot each of which represents one tile (subplot) axes to display in the figure.

Definition at line 86 of file Triplex.m.

◆ upper

Property Triplex::upper

upper

The scalar object of superclass pm.vis.Subplot representing the template of the upper-triangle subplots to display.
The data properties of the template are set by the make() method.
(optional. The default value is pm.vis.SubplotLineScatter.)

Definition at line 78 of file Triplex.m.

The documentation for this class was generated from the following file:

src/matlab/main/+pm/+vis/Triplex.m

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ Triplex()

Member Function Documentation

◆ hideShowAxesLabels()

◆ make()

◆ premake()

◆ reset()

◆ rotateAxesLabels()

◆ setAxesLimits()

◆ setDiagoTicksY()

Field Documentation

◆ diago

◆ diagYTick

◆ layout

◆ lower

◆ tile

◆ upper