Subplot Class Reference

This is the abstract class for generating instances of axes with various types of plots from one or more columns of data.
More...

Inheritance diagram for Subplot:

Collaboration diagram for Subplot:

Public Member Functions
function	Subplot (in ptype, in dfref, in varargin)
	Construct and return an object of class pm.vis.Subplot. More...
function	make (in self, in varargin)
	Generate a plot from the selected columns of the parent object component df. More...
function	premake (in self, in varargin)
	Prepare the subplot for visualization. More...
function	reset (in self, in varargin)
	Reset the properties of the plot to the original default settings. More...

Data Fields
Property	df
Property	fout
Property	rows

Detailed Description

This is the abstract class for generating instances of axes with various types of plots from one or more columns of data.

While it can be directly used for visualization tasks, this class primarily serves as the superclass for the visualization subclasses accessible to the end users.

Note

In case of pm.vis.SubplotContour, pm.vis.SubplotContour3, and pm.vis.SubplotContourf visualization objects, the density of the input data is first computed and smoothed by a Gaussian kernel density estimator and then passed to the MATLAB intrinsic plotting functions contour, contourf, contour3.

Dynamic class attributes

This class contains a set of attributes that are defined dynamically at runtime for the output object depending on its subclass (plot type it represents).
The following is the list of all class attributes that are dynamically added to the instantiated class objects based on the specified input plot type.
See also the explicit class and superclass attributes not listed below.

1. colx (standing for x-columns; available for all axes types)
   

   Optional property that determines the columns of the specified dataframe to serve as the x-values. It can have multiple forms:
   

   1. a numeric or cell array of column indices in the input dfref.
   2. a string or cell array of column names in dfref.Properties.VariableNames.
   3. a cell array of a mix of the above two.
   4. a numeric range.

   If colx is empty,
   

   1. it will be set to the row indices of dfref for line/scatter axes types.
   2. it will be set to all columns of dfref for density axes types.

   Warning

   In all cases, colx must have a length that is either 0 (empty), 1, or equal to the length of coly or colz.
   If the length is 1, then colx will be plotted against data corresponding to each element of coly and colz.
   

   
   Example usage ⛓

   Subplot.colx = [7, 8, 9]
   Subplot.colx = ["sampleLogFunc", "sampleVariable1"]
   Subplot.colx = {"sampleLogFunc", 9, "sampleVariable1"}
   Subplot.colx = 7:9      # every column in the data frame starting from column #7 to #9
   Subplot.colx = 7:2:20   # every other column in the data frame starting from column #7 to #20

   
   

2. coly (standing for y-columns; available for all axes types except pm.vis.SubplotHeatmap, pm.vis.SubplotHistogram, pm.vis.SubplotHistfit)
   

   Optional property that determines the columns of the specified dataframe to serve as the z-values.
   It can have multiple forms:
   

   1. a numeric or cell array of column indices in the input dfref.
   2. a string or cell array of column names in dfref.Properties.VariableNames.
   3. a cell array of a mix of the above two.
   4. a numeric range.

   If coly is empty,
   

   1. it will be set to the row indices of dfref for line/scatter axes types.
   2. it will be set to all columns of dfref for density axes types.

   Warning

   In all cases, coly must have a length that is either 0 (empty), 1, or equal to the length of colx or colz.
   If the length is 1, then coly will be plotted against data corresponding to each element of colx and colz.
   

   
   Example usage ⛓

   Subplot.coly = [7, 8, 9]
   Subplot.coly = ["sampleLogFunc", "sampleVariable1"]
   Subplot.coly = {"sampleLogFunc", 9, "sampleVariable1"}
   Subplot.coly = 7:9      # every column in the data frame starting from column #7 to #9
   Subplot.coly = 7:2:20   # every other column in the data frame starting from column #7 to #20

   
   

3. colz (standing for z-columns; available only for 3D plots, e.g., pm.vis.SubplotLine3, pm.vis.SubplotScatter3, pm.vis.SubplotLineScatter3)
   

   Optional property that determines the columns of the specified dataframe to serve as the z-values.
   It can have multiple forms:
   

   1. a numeric or cell array of column indices in the input dfref.
   2. a string or cell array of column names in dfref.Properties.VariableNames.
   3. a cell array of a mix of the above two.
   4. a numeric range.

   If colz is empty,
   

   1. it will be set to the row indices of dfref for line/scatter axes types.
   2. it will be set to all columns of dfref for density axes types.

   Warning

   In all cases, colz must have a length that is either 0 (empty), 1, or equal to the length of colx or coly.
   If the length is 1, then colz will be plotted against data corresponding to each element of colx and coly.
   

   
   Example usage ⛓

   Subplot.colz = [7, 8, 9]
   Subplot.colz = ["sampleLogFunc", "sampleVariable1"]
   Subplot.colz = {"sampleLogFunc", 9, "sampleVariable1"}
   Subplot.colz = 7:9      % every column in the data frame starting from column #7 to #9
   Subplot.colz = 7:2:20   % every other column in the data frame starting from column #7 to #20

   
   

4. colc (standing for color-columns; available only for 2D/3D line/scatter axes types, e.g., pm.vis.SubplotLine3, pm.vis.SubplotScatter3, pm.vis.SubplotLineScatter3, pm.vis.SubplotLine, pm.vis.SubplotScatter, pm.vis.SubplotLineScatter)
   

   Optional property that determines the columns of the input dfref to use as the color mapping values for each line/point element in the plot.
   It can have multiple forms:
   

   1. a numeric or cell array of column indices in the input dfref.
   2. a string or cell array of column names in dfref.Properties.VariableNames.
   3. a cell array of a mix of the above two.
   4. a numeric range.

   The default value is the indices of the rows of the input dfref.
   
   Example usage ⛓

   Subplot.colc = [7,8,9]
   Subplot.colc = ["sampleLogFunc", "sampleVariable1"]
   Subplot.colc = {"sampleLogFunc", 9, "sampleVariable1"}
   Subplot.colc = 7:9      # every column in the data frame starting from column #7 to #9
   Subplot.colc = 7:2:20   # every other column in the data frame starting from column #7 to #20

   
   

Note

For example usage, see the documentation of the constructor of the class pm.vis.Subplot::Subplot.

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.

See also

pm.vis
pm.vis.axes.Axes
pm.matlab.Handle
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 187 of file Subplot.m.

Constructor & Destructor Documentation

Subplot()

function Subplot::Subplot	(	in	ptype,
		in	dfref,
		in	varargin
	)

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

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

Parameters

[in]	ptype	: See the documentation of the corresponding input argument of the superclass constructor pm.vis.axes.Axes::Axes.
[in]	dfref	: The input MATLAB matrix or table containing the data to plot or a function handle that returns such a MATLAB matrix or table. Specifying a function handle is superior to specifying the data directly, because the function handle will always use the most updated version of the user table or matrix. (optional. The default is an empty table.)

Returns

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

Possible calling interfaces ⛓

s = pm.vis.Subplot(ptype, dfref);
s = pm.vis.Subplot(ptype, dfref, varargin);

Warning

In all cases, colc must have a length that is either 0, or 1, or equal to the maximum lengths of (colx, coly, colz).
If the length is 1, then all data will be plotted with the same color mapping determined by values specified by the elements of colc.
If it is an empty object having length 0, then the default value will be used.

Note

In case of pm.vis.SubplotContour/pm.vis.SubplotContourf/pm.vis.SubplotContour3 visualization objects, the density of the input data is first computed and smoothed by a Gaussian kernel density estimator and then passed to the MATLAB intrinsic plotting functions , contour, contourf, contour3.

Example usage ⛓

cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.
addpath('../../../'); % Add the ParaMonte library root directory to the search path.
 
theta = linspace(0, 8 * pi, 500);
r = 1.5 * theta;
df = array2table(ctranspose([r .* cos(theta); r .* sin(theta); r(end) - r]));
df.Properties.VariableNames = ["X = r cos(theta)", "Y = r sin(theta)", "Z = r"];
 
figure("color", "white");
sv = pm.vis.Subplot("Line", df);
sv.title.titletext = "Line Subplot";
sv.surface.lineWidth = 2;
sv.make("colx", 1, "coly", 2);
pm.vis.figure.savefig("SubplotLine.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Line3", df);
sv.title.titletext = "Line3 Subplot";
sv.surface.lineWidth = 2;
sv.make("colx", 1, "coly", 2, "colz", 3);
pm.vis.figure.savefig("SubplotLine3.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Scatter", df);
sv.title.titletext = "Scatter Subplot";
sv.make("colx", 1, "coly", 2);
pm.vis.figure.savefig("SubplotScatter.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Scatter3", df);
sv.title.titletext = "Scatter3 Subplot";
sv.make("colx", 1, "coly", 2, "colz", 3);
pm.vis.figure.savefig("SubplotScatter3.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("LineScatter", df);
sv.title.titletext = "LineScatter Subplot";
sv.make("colx", 1, "coly", 2);
pm.vis.figure.savefig("SubplotLineScatter.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("LineScatter3", df);
sv.title.titletext = "LineScatter3 Subplot";
sv.make("colx", 1, "coly", 2, "colz", 3);
pm.vis.figure.savefig("SubplotLineScatter3.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Histogram", df);
sv.title.titletext = "Histogram Subplot";
sv.make("colx", 1);
pm.vis.figure.savefig("SubplotHistogram.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Histogram2", df);
sv.title.titletext = "Histogram2 Subplot";
sv.make("colx", 1, "coly", 2);
pm.vis.figure.savefig("SubplotHistogram2.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Histfit", df);
sv.title.titletext = "Histfit Subplot";
sv.make("colx", 1);
pm.vis.figure.savefig("SubplotHistfit.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Contour", df);
sv.title.titletext = "Contour Subplot";
sv.make("colx", 1, "coly", 2, "xlim", [-20, 20], "ylim", [-20, 20]);
pm.vis.figure.savefig("SubplotContour.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Contour3", df);
sv.title.titletext = "Contour3 Subplot";
sv.make("colx", 1, "coly", 2, "xlim", [-20, 20], "ylim", [-20, 20]);
pm.vis.figure.savefig("SubplotContour3.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Contourf", df);
sv.title.titletext = "Contourf Subplot";
sv.make("colx", 1, "coly", 2, "xlim", [-20, 20], "ylim", [-20, 20]);
pm.vis.figure.savefig("SubplotContourf.1.png", "-m3");
 
figure("color", "white");
dfcor = pm.stats.Cor(df(:, 1 : 2));
sv = pm.vis.Subplot("Heatmap", dfcor.val);
sv.make();
title("Heatmap Subplot");
pm.vis.figure.savefig("SubplotHeatmap.1.png", "-m3");
 
%%%% Make Ellipse plots.
 
sampler = pm.sampling.Paradram();
sampler.spec.outputStatus = "retry";
sampler.spec.outputFileName = "mvn";
sampler.spec.randomSeed = 28457353; % make sampling reproducible.
sampler.spec.outputChainSize = 30000; % Use a small chain size for illustration.
sampler.spec.outputRestartFileFormat = "ascii";
sampler.silent = true;
sampler.run(@(x) -sum((x - [-5; 5; 10; -10]) .^ 2), 4);
restart = sampler.readRestart();
restart = restart{1};
 
figure("color", "white");
sv = pm.vis.SubplotEllipse(restart.proposalCov, restart.proposalMean);
pv.subplot.title.titletext = "Ellipse Subplot";
sv.make("axes", {"zscale", "log"}, "dimx", [1, 3], "dimy", [1, 3] + 1);
pm.vis.figure.savefig("SubplotEllipse.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.SubplotEllipse3(restart.proposalCov, restart.proposalMean, transpose(restart.uniqueStateVisitCount));
pv.subplot.title.titletext = "Ellipse3 Subplot";
sv.make("axes", {"zscale", "log"}, "dimx", [1, 3], "dimy", [1, 3] + 1);
pm.vis.figure.savefig("SubplotEllipse3.1.png", "-m3");
 
close all;

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 22 2024, 6:45 PM, 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 Subplot::make	(	in	self,
		in	varargin
	)

Generate a plot from the selected columns of the parent object component df.

Parameters

[in,out]	self	: The input/output parent object of class pm.vis.Subplot 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 make() method.

Possible calling interfaces ⛓

s = pm.vis.Subplot(ptype, dfref)
 
s.make(varargin);
s.make();

Warning

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

Example usage ⛓

dfref = rand(1000, 3);
s = pm.vis.Subplot("scatter", dfref);
s.make("colx", 1, "coly", 2, "colc", 3)

Example usage ⛓

cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.
addpath('../../../'); % Add the ParaMonte library root directory to the search path.
 
theta = linspace(0, 8 * pi, 500);
r = 1.5 * theta;
df = array2table(ctranspose([r .* cos(theta); r .* sin(theta); r(end) - r]));
df.Properties.VariableNames = ["X = r cos(theta)", "Y = r sin(theta)", "Z = r"];
 
figure("color", "white");
sv = pm.vis.Subplot("Line", df);
sv.title.titletext = "Line Subplot";
sv.surface.lineWidth = 2;
sv.make("colx", 1, "coly", 2);
pm.vis.figure.savefig("SubplotLine.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Line3", df);
sv.title.titletext = "Line3 Subplot";
sv.surface.lineWidth = 2;
sv.make("colx", 1, "coly", 2, "colz", 3);
pm.vis.figure.savefig("SubplotLine3.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Scatter", df);
sv.title.titletext = "Scatter Subplot";
sv.make("colx", 1, "coly", 2);
pm.vis.figure.savefig("SubplotScatter.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Scatter3", df);
sv.title.titletext = "Scatter3 Subplot";
sv.make("colx", 1, "coly", 2, "colz", 3);
pm.vis.figure.savefig("SubplotScatter3.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("LineScatter", df);
sv.title.titletext = "LineScatter Subplot";
sv.make("colx", 1, "coly", 2);
pm.vis.figure.savefig("SubplotLineScatter.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("LineScatter3", df);
sv.title.titletext = "LineScatter3 Subplot";
sv.make("colx", 1, "coly", 2, "colz", 3);
pm.vis.figure.savefig("SubplotLineScatter3.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Histogram", df);
sv.title.titletext = "Histogram Subplot";
sv.make("colx", 1);
pm.vis.figure.savefig("SubplotHistogram.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Histogram2", df);
sv.title.titletext = "Histogram2 Subplot";
sv.make("colx", 1, "coly", 2);
pm.vis.figure.savefig("SubplotHistogram2.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Histfit", df);
sv.title.titletext = "Histfit Subplot";
sv.make("colx", 1);
pm.vis.figure.savefig("SubplotHistfit.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Contour", df);
sv.title.titletext = "Contour Subplot";
sv.make("colx", 1, "coly", 2, "xlim", [-20, 20], "ylim", [-20, 20]);
pm.vis.figure.savefig("SubplotContour.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Contour3", df);
sv.title.titletext = "Contour3 Subplot";
sv.make("colx", 1, "coly", 2, "xlim", [-20, 20], "ylim", [-20, 20]);
pm.vis.figure.savefig("SubplotContour3.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.Subplot("Contourf", df);
sv.title.titletext = "Contourf Subplot";
sv.make("colx", 1, "coly", 2, "xlim", [-20, 20], "ylim", [-20, 20]);
pm.vis.figure.savefig("SubplotContourf.1.png", "-m3");
 
figure("color", "white");
dfcor = pm.stats.Cor(df(:, 1 : 2));
sv = pm.vis.Subplot("Heatmap", dfcor.val);
sv.make();
title("Heatmap Subplot");
pm.vis.figure.savefig("SubplotHeatmap.1.png", "-m3");
 
%%%% Make Ellipse plots.
 
sampler = pm.sampling.Paradram();
sampler.spec.outputStatus = "retry";
sampler.spec.outputFileName = "mvn";
sampler.spec.randomSeed = 28457353; % make sampling reproducible.
sampler.spec.outputChainSize = 30000; % Use a small chain size for illustration.
sampler.spec.outputRestartFileFormat = "ascii";
sampler.silent = true;
sampler.run(@(x) -sum((x - [-5; 5; 10; -10]) .^ 2), 4);
restart = sampler.readRestart();
restart = restart{1};
 
figure("color", "white");
sv = pm.vis.SubplotEllipse(restart.proposalCov, restart.proposalMean);
pv.subplot.title.titletext = "Ellipse Subplot";
sv.make("axes", {"zscale", "log"}, "dimx", [1, 3], "dimy", [1, 3] + 1);
pm.vis.figure.savefig("SubplotEllipse.1.png", "-m3");
 
figure("color", "white");
sv = pm.vis.SubplotEllipse3(restart.proposalCov, restart.proposalMean, transpose(restart.uniqueStateVisitCount));
pv.subplot.title.titletext = "Ellipse3 Subplot";
sv.make("axes", {"zscale", "log"}, "dimx", [1, 3], "dimy", [1, 3] + 1);
pm.vis.figure.savefig("SubplotEllipse3.1.png", "-m3");
 
close all;

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 22 2024, 6:36 PM, 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 5 2024, 1:07 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.

premake()

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

Prepare the subplot for visualization.

Parameters

[in,out]	self	: The input/output parent object of class pm.vis.Subplot 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 ⛓

s = pm.vis.Subplot(ptype, dfref);
 
s.premake(varargin);
s.premake();

Warning

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

Example usage ⛓

dfref = rand(1000, 3);
s = pm.vis.Subplot("scatter", dfref);
s.premake("colx", 1, "coly", 2, "colc", 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 22 2024, 6:41 PM, 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 5 2024, 1:07 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.

reset()

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

Reset the properties of the plot 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.Subplot 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 make() method.

Possible calling interfaces ⛓

pm.vis.Subplot.reset() % reset the plot 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.

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 22 2024, 6:43 PM, 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 5 2024, 1:07 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.

Field Documentation

df

Property Subplot::df

df

A scalar object of class pm.data.DataFrame containing the user-specified data to visualize.

Definition at line 201 of file Subplot.m.

fout

Property Subplot::fout

fout

A MATLAB struct whose fields are the outputs of various plotting tools used to make the current axis.

Definition at line 209 of file Subplot.m.

rows

Property Subplot::rows

rows

A numeric vector that serves as a storage for an arbitrary subset of indices of the rows of the input dataframe reference dfref to the class constructor .
It can be either:

1. a numeric range, or,
2. a list of row indices of the dfref.

Example usage ⛓

s = pm.vis.Subplot();
 
s.rows = 15 : -2 : 8;
s.rows = [12, 46, 7, 8, 9, 4, 7, 163];

Warning

If rows is empty, the default will be all rows of the dfref.

Note

The pm.data.DataFrame.rowslog() method of this class can be used to generate logarithmically-spaced row indices of the target dataframe.

Definition at line 240 of file Subplot.m.

---

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

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