Cascade Class Reference

This is the abstract class for generating instances of objects that contain the specifications of a cascade of figures (plots).
More...

Inheritance diagram for Cascade:

Collaboration diagram for Cascade:

Public Member Functions
function	Cascade (in template, in varargin)
	Construct and return an object of class pm.vis.Cascade. More...
function	reset (in self, in varargin)
	Reset the properties of the cascade of plots to the original default settings. More...
function	make (in self, in varargin)
	Configure the cascade settings and specifications, make the cascade of plots, and return nothing. More...
function	savefigs (in self, in files, in varargin)
	Export the current cascade of figures to the specified external files. More...
function	premake (in self, in varargin)
	Configure the cascade of plots settings and specifications and return nothing. More...

Data Fields
Property	window
Property	template

Detailed Description

This is the abstract class for generating instances of objects that contain the specifications of a cascade of figures (plots).

This is a generic class for generating multiple separate cascading figures each containing a single plot (axes).

Developer Remark:

While dynamic addition of class attributes is not ideal, the current design was deemed unavoidable and best, given the constraints of the MATLAB language and visualization tools.

Note

See the list of class attributes below, also those of the superclass pm.matlab.Handle.

See also

pm.vis.Cascade
pm.vis.Subplot
pm.vis.Figure
pm.vis.Corner
pm.vis.Plot
pm.vis.Tile

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.

1. 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.
   
2. 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:

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

Definition at line 31 of file Cascade.m.

Constructor & Destructor Documentation

Cascade()

function Cascade::Cascade	(	in	template,
		in	varargin
	)

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

This is the custom constructor of the class pm.vis.Cascade.

Parameters

[in]	template	: The input scalar object of superclass pm.vis.Plot. It serves as the template based upon which the cascade of plots are constructed.
[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 pm.vis.Cascade.make() method.

Returns

self : The scalar output object of class pm.vis.Cascade.

Possible calling interfaces ⛓

plot = pm.vis.Cascade(template);
plot = pm.vis.Cascade(template, varargin);

Note

The input varargin can also contain the components of the plot component of the parent object.

Example usage ⛓

cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.
addpath('../../../'); % Add the ParaMonte library root directory to the search path.
 
cholow = chol(pm.stats.dist.cov.getRand(10), 'lower');
df = transpose(pm.stats.dist.mvu.getRand(zeros(length(cholow), 1), cholow, 5000));
cv = pm.vis.Cascade(pm.vis.PlotScatter(df, "colx", 1:2:5, "coly", 2:2:6));
cv.make();
cv.savefigs(["Cascade.window.1.png", "Cascade.window.2.png", "Cascade.window.3.png"], "-m3");

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.

1. 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.
   
2. 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, 6:20 AM, University of Texas at Arlington
Amir Shahmoradi, July 5 2024, 1:07 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.

Member Function Documentation

make()

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

Configure the cascade settings and specifications, make the cascade of plots, and return nothing.

In making the figure, this method calls the make() methods of each of the plot objects stored in the window component.

Warning

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

Parameters

[in,out]	self	: The input/output parent object of class pm.vis.Cascade which is implicitly passed to this dynamic method (not by the user).
[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 pm.vis.Cascade.make() method.

Possible calling interfaces ⛓

p = pm.vis.Cascade.make(varargin);

Note

The input varargin can also contain the components of the template component of the parent object.

Example usage ⛓

cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.
addpath('../../../'); % Add the ParaMonte library root directory to the search path.
 
cholow = chol(pm.stats.dist.cov.getRand(10), 'lower');
df = transpose(pm.stats.dist.mvu.getRand(zeros(length(cholow), 1), cholow, 5000));
cv = pm.vis.Cascade(pm.vis.PlotScatter(df, "colx", 1:2:5, "coly", 2:2:6));
cv.make();
cv.savefigs(["Cascade.window.1.png", "Cascade.window.2.png", "Cascade.window.3.png"], "-m3");

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.

1. 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.
   
2. 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, 6:27 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()

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

Configure the cascade of plots settings and specifications and return nothing.

Warning

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

Parameters

[in,out]	self	: The input/output parent object of class pm.vis.Cascade which is implicitly passed to this dynamic method (not by the user).
[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 premake() method.

Possible calling interfaces ⛓

c = pm.vis.Cascade.premake(varargin);

Example usage ⛓

cv = pm.vis.Cascade(pm.vis.PlotLine(rand(100, 10)));
c.premake("figure", {"color", "white"})
cv.make("coly", 1:3)

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.

1. 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.
   
2. 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, 6:31 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()

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

Reset the properties of the cascade of plots 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,out]	self	: The input/output parent object of class pm.vis.Cascade which is implicitly passed to this dynamic method (not by the user).
[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 pm.vis.Cascade.make() method.

Note

The input varargin can also contain the components of the template component of the parent object.

Possible calling interfaces ⛓

pm.vis.Cascade.reset() % reset the plot to the default settings.
pm.vis.Cascade.reset(varargin) % reset the plot to the default settings and to those specified via ``varargin``.

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.

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

savefigs()

function Cascade::savefigs	(	in	self,
		in	files,
		in	varargin
	)

Export the current cascade of figures to the specified external files.

This method is merely a wrapper around all savefig methods of the figure objects in the window component of the parent cascade object.

Parameters

[in,out]	self	: The input/output parent object of class pm.vis.Cascade which is implicitly passed to this dynamic method (not by the user).
[in]	files	: The input vector of MATLAB strings or cell array of char vectors that must be of the same length as the length of the window component of the parent object. containing the paths to the external files to contain the visualizations. For more information, see the corresponding argument of the savefig method of class pm.vis.figure.Figure. (optional. If files or any elements of it are is missing or empty, the default will be set by the savefig method of the corresponding cascade figure in the window component.)
[in]	varargin	: Any optional key-val pair that is accepted by the savefig method of class pm.vis.figure.Figure. For more information, see the savefig method of class pm.vis.figure.Figure.

Possible calling interfaces ⛓

c.savefigs();
c.savefigs(files);
c.savefigs(files, varargin);

Example usage ⛓

cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.
addpath('../../../'); % Add the ParaMonte library root directory to the search path.
 
cholow = chol(pm.stats.dist.cov.getRand(10), 'lower');
df = transpose(pm.stats.dist.mvu.getRand(zeros(length(cholow), 1), cholow, 5000));
cv = pm.vis.Cascade(pm.vis.PlotScatter(df, "colx", 1:2:5, "coly", 2:2:6));
cv.make();
cv.savefigs(["Cascade.window.1.png", "Cascade.window.2.png", "Cascade.window.3.png"], "-m3");

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.

1. 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.
   
2. 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, 6:29 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

template

Property Cascade::template

template

The scalar object of superclass pm.vis.Plot representing the template of the cascade of plots to display.

Definition at line 53 of file Cascade.m.

window

Property Cascade::window

window

The cell array of scalar objects of superclass pm.vis.Plot representing the cascade of plots to display.

Definition at line 45 of file Cascade.m.

---

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

• src/matlab/main/+pm/+vis/Cascade.m