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

Inheritance diagram for Corner:

[legend]

Collaboration diagram for Corner:

[legend]

Public Member Functions
function	Corner (in df, in varargin)
	Generate an return an object of class pm.vis.Corner. More...

function	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. More...

function	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. More...

function	premake (in self, in varargin)
	Prepare the corner plot specs for subsequent visualization by `make()`. More...

function	Corner (in df, in varargin)
	Generate an return an object of class pm.vis.Corner. More...

function	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. More...

function	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. More...

function	premake (in self, in varargin)
	Prepare the corner plot specs for subsequent visualization by `make()`. More...

Data Fields
Property	cols

Property	diag

Property	lower

Property	upper

Detailed Description

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

Note: See the list of class attributes below, also those of the superclass pm.vis.Tiling.; See also the documentation of the constructor of the class pm.vis.Corner::Corner.

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:20 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.

Note: See the list of class attributes below, also those of the superclass pm.vis.Tiling.; See also the documentation of the constructor of the class pm.vis.Corner::Corner.

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:20 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.

Definition at line 18 of file Corner.m.

Constructor & Destructor Documentation

◆ Corner() [1/2]

function Corner::Corner	(	in	df,
		in	varargin
	)

Generate an return an object of class pm.vis.Corner.

This is the constructor of the class pm.vis.Corner.

Parameters

[in]	dfref	: See the documentation of the corresponding input argument of the class pm.vis.Subplot. (optional. default = `table(zeros(0, 0))`)
[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.Corner.

Possible calling interfaces ⛓

: plot = pm.vis.Corner(subplot);

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

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 22 2024, 9:39 PM, University of Texas at Arlington

◆ Corner() [2/2]

function Corner::Corner	(	in	df,
		in	varargin
	)

Generate an return an object of class pm.vis.Corner.

This is the constructor of the class pm.vis.Corner.

Parameters

[in]	dfref	: See the documentation of the corresponding input argument of the class pm.vis.Subplot. (optional. default = `table(zeros(0, 0))`)
[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.Corner.

Possible calling interfaces ⛓

: plot = pm.vis.Corner(subplot);

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

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 22 2024, 9:39 PM, University of Texas at Arlington

Member Function Documentation

◆ make() [1/2]

function Corner::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.

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

Parameters

[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 ⛓

: f = pm.vis.Corner.make(varargin);

Example usage ⛓

f = pm.vis.Corner();
f.make()

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, 7:56 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, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin

◆ make() [2/2]

function Corner::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.

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

Parameters

[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 ⛓

: f = pm.vis.Corner.make(varargin);

Example usage ⛓

f = pm.vis.Corner();
f.make()

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, 7:56 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, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin

◆ premake() [1/2]

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

Prepare the corner plot specs for subsequent visualization by make().

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

Parameters

[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.

Example usage ⛓

For example, change the left/bottom margin of the main
axis of the figure to provide room for lengthy variable names.
Then call the ``self.update()`` method to reflect the changes.

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, 8:00 AM, University of Texas at Arlington

◆ premake() [2/2]

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

Prepare the corner plot specs for subsequent visualization by make().

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

Parameters

[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.

Example usage ⛓

For example, change the left/bottom margin of the main
axis of the figure to provide room for lengthy variable names.
Then call the ``self.update()`` method to reflect the changes.

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, 8:00 AM, University of Texas at Arlington

◆ reset() [1/2]

function Corner::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] 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 ⛓

: pm.vis.Corner.reset() % reset all object properties to the default settings.

Corner::reset
function reset(in self, in varargin)
Reset the properties of the figure to the original default settings. Use this method when you change ...

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, 7:58 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, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin

◆ reset() [2/2]

function Corner::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] 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 ⛓

: pm.vis.Corner.reset() % reset all object properties to the 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, 7:58 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, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin

Field Documentation

◆ cols

Property Corner::cols

cols (standing for columns)

The vector of MATLAB integers or names of of the input dataframe columns that determines the columns of the specified dataframe to visualize. It can have multiple forms:

a numeric or cell array of column indices in the input dfref.
a string or cell array of column names in dfref.Properties.VariableNames.
a cell array of a mix of the above two.
a numeric range.
Example usage:

self.cols = [7, 8, 9]
self.cols = ["sampleLogFunc", "sampleVariable1"]
self.cols = {"sampleLogFunc", 9, "sampleVariable1"}
self.cols = 7:9 # every column in the data frame starting from column #7 to #9
self.cols = 7:2:20 # every other column in the data frame starting from column #7 to #20 The ith element of the specified cols will be used as value for:

the ith column of data to visualize on the x-axis in subplot subplot{i, i}.

the ith column of data to visualize on the x-axis in subplot subplot{i, :}.

the ith column of data to visualize on the y-axis in subplot subplot{:, i}.
If cols is empty, no visualizations will be made.

Definition at line 81 of file Corner.m.

◆ diag

Property Corner::diag

diag

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 92 of file Corner.m.

◆ lower

Property Corner::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 102 of file Corner.m.

◆ upper

Property Corner::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 112 of file Corner.m.

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

src/matlab/main/+pm/+vis/Corner.m
src/matlab/main/+pm/+vis/TilingSymm.m

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ Corner() [1/2]

◆ Corner() [2/2]

Member Function Documentation

◆ make() [1/2]

◆ make() [2/2]

◆ premake() [1/2]

◆ premake() [2/2]

◆ reset() [1/2]

◆ reset() [2/2]

Field Documentation

◆ cols

◆ diag

◆ lower

◆ upper