ParaMonte MATLAB 3.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation. |
This is the base class for generating instances of figures containing a square symmetric tiling of subplots.
More...
Public Member Functions | |
function | Triplex (in subplot, 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 | hide (in self, in varargin) |
Hide the requested section(s) of the Triplex, and return nothing. More... | |
function | show (in self, in varargin) |
Show the requested section(s) of the Triplex, 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 | hideShow (in self, in varargin) |
function | hideShowAxesLabels (in self) |
Hide or show axis labels and ticks depending on the presence of the neighbor subplots. More... | |
function | adjustAxesTicks (in self) |
function | getAxesPositionColorbar (in self) |
function | getAxesPositionSubplot (in self, in irow, in icol) |
function | getAxesPositionMain (in self) |
function | setLayout (in self) |
Update the layout of the Triplex plot with the new changes. More... | |
Data Fields | |
Property | layout |
Property | subplot |
Property | colorbared |
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.
The dataset 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 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, a universal colorbar will be visualized on the right side of the Triplex plot.
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.
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.
function Triplex::Triplex | ( | in | subplot, |
in | varargin | ||
) |
Construct and return an object of class pm.vis.Triplex.
This is the constructor of the class pm.vis.Triplex.
[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. |
self
: The output scalar object of class pm.vis.Triplex.
Possible calling interfaces ⛓
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.
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.
function Triplex::adjustAxesTicks | ( | in | self | ) |
function Triplex::getAxesPositionColorbar | ( | in | self | ) |
function Triplex::getAxesPositionMain | ( | in | self | ) |
function Triplex::getAxesPositionSubplot | ( | in | self, |
in | irow, | ||
in | icol | ||
) |
function Triplex::hide | ( | in | self, |
in | varargin | ||
) |
Hide the requested section(s) of the Triplex, and return nothing.
[in] | varargin | : A comma-separated sequence of strings to char-vectors each of which can be one of the following:
|
Possible calling interfaces ⛓
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.
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.
function Triplex::hideShow | ( | in | self, |
in | varargin | ||
) |
function Triplex::hideShowAxesLabels | ( | in | self | ) |
Hide or show axis labels and ticks depending on the presence of the neighbor subplots.
Possible calling interfaces ⛓
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.
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.
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.
[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 ⛓
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.
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.
function Triplex::premake | ( | in | self, |
in | varargin | ||
) |
Preset the tiling settings before making it.
[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 ⛓
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.
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.
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.
[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 ⛓
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.
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.
function Triplex::rotateAxesLabels | ( | in | self, |
in | degx, | ||
in | degy | ||
) |
Rotate the axes labels of the subplots of the Triplex, and return nothing.
[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 ⛓
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.
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.
function Triplex::setLayout | ( | in | self | ) |
Update the layout of the Triplex plot with the new changes.
For example, change the left/bottom margin of the main axis of the figure to provide room for lengthy variable names.
Then call the setLayout() method of layout to reflect the changes.
Possible calling interfaces ⛓
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.
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.
function Triplex::show | ( | in | self, |
in | varargin | ||
) |
Show the requested section(s) of the Triplex, and return nothing.
[in] | varargin | : A comma-separated sequence of strings to char-vectors each of which can be one of the following:
|
Possible calling interfaces ⛓
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.
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.
Property Triplex::colorbared |
Property Triplex::layout |
layout
The MATLAB struct
containing the default layout of the Triplex plot.
Such information includes the margin of the subplots from the figure border and the interspaces between the subplots.
This information is applied only to figure components whose positions are unset.
Property Triplex::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.