This is the base class for generating instances of figures containing a tile of subplots.
More...

Inheritance diagram for Tiling:

Collaboration diagram for Tiling:

Public Member Functions
function	Tiling (in subplot, in varargin)
	Construct and return an object of class pm.vis.Tiling. More...

function	make (in self, in varargin)
	Configure the figure settings and specifications, make the figure and the subplots, and return nothing. 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...

Data Fields
Property	tiledlayout

Property	subplot

Detailed Description

This is the base class for generating instances of figures containing a tile of subplots.

Note: See the list of class attributes below, also those of the superclass pm.vis.figure.Figure.; See also the documentation of the constructor of the class pm.vis.Tiling::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 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 Tiling.m.

Constructor & Destructor Documentation

◆ Tiling()

function Tiling::Tiling	(	in	subplot,
		in	varargin
	)

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

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

Parameters

[in]	subplot	: The input cell matrix of MATLAB objects of superclass pm.vis.Subplot.
[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.Tiling.

Possible calling interfaces ⛓

: t = pm.vis.Tiling(subplot);

t = pm.vis.Tiling(subplot, varargin);

Tiling::subplot
Property subplot
Definition: Tiling.m:40

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

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

Member Function Documentation

◆ make()

function Tiling::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 ⛓

: t = pm.vis.Tiling(subplot, varargin);

t.make(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.

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

◆ premake()

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

Preset the tiling settings before making it.

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.

Possible calling interfaces ⛓

: t = pm.vis.Tiling(subplot, varargin);

t.premake(varargin);

Example usage ⛓

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 Tiling::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 ⛓

: t = pm.vis.Tiling(subplot, varargin) % reset all object properties to the default settings.

t.reset(varargin);

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

Field Documentation

◆ subplot

Property Tiling::subplot

subplot

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

Definition at line 40 of file Tiling.m.

◆ tiledlayout

Property Tiling::tiledlayout

tiledlayout

A MATLAB struct whose fields and values are passed as keyword arguments to the MATLAB intrinsic tiledlayout().

Definition at line 32 of file Tiling.m.

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

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

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ Tiling()

Member Function Documentation

◆ make()

◆ premake()

◆ reset()

Field Documentation

◆ subplot

◆ tiledlayout