Axes Class Reference

This is the class for generating instances of objects that contain the specifications of various types of plots.
More...

Inheritance diagram for Axes:

Collaboration diagram for Axes:

Public Member Functions
function	Axes (in ptype, in varargin)
	Construct and return an object of class pm.vis.axes.Axes. More...
function	reset (in self, in varargin)
	Reset the properties of the plot to the original default settings and return nothing. More...
function	premake (in self, in varargin)
	Configure the plot settings and specifications and return nothing. More...
function	comp2hash (in self, in comp)
	Convert the components of the input component comp of the parent object into a cell array of key-val pairs. More...

Data Fields
Property	silent
Property	type
Property	cenabled

Detailed Description

This is the class for generating instances of objects that contain the specifications of various types of plots.

This class primarily serves as the superclass for the visualization-ready subclass pm.vis.Subplot and its subclasses, all accessible to the end users.

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. axes (available for all subplots except pm.vis.SubplotHeatmap)
   

   A MATLAB struct whose fields and values are passed as keyword arguments to the MATLAB intrinsic set() for the current active axes object in the plot gca().
   

2. colorbar (available for all axes types that allow color-mapping)
   

   A MATLAB struct whose fields and their values will be passed as keyword arguments to the MATLAB intrinsic colorbar.
   The following are the default components of colorbar:
   

   1. enabled

      A logical value. If true, the color bar will be applied to the axes.
      

   2. others

      See the acceptable keyword arguments of the MATLAB intrinsic colorbar().
      

   Warning

   Keep in mind that MATLAB keyword arguments are case-INsensitive.
   Hence, ensure you do not add the same keyword as multiple different fields.
   For example, colorbar.color and colorbar.Color are the same, and only one of the two will be processed.
   

   
   Example usage ⛓

   self.colorbar.enabled = true;
   self.colorbar.location = "west";

   
   

3. colormap (available for all axes types that allow color-mapping)

   A MATLAB struct whose fields and their values will be passed as keyword arguments to the MATLAB intrinsic colormap.
   The following are the default components of colormap:
   

   1. enabled

      A logical value. If true, the colormap will be applied to the axes.
      

   2. map

      A string or a vector of color triplets or any other value that the intrinsic MATLAB colormap accepts as input.
      

      This option is relevant only to visualizations that allow color-mapping.
      

   Warning

   Keep in mind that MATLAB keyword arguments are case-INsensitive.
   Hence, ensure you do not add the same keyword as multiple different fields.
   For example, colormap.map and colormap.Map are the same, and only one of the two will be processed.
   

   
   Example usage ⛓

   self.colormap.enabled = true;
   self.colormap.map = "winter";
   self.colormap.map = "winter";
   self.colormap.map = 'default';
   self.colormap.map = pm.vis.cmap.redblue();

   
   

4. contour (available only for pm.vis.SubplotContour axes types)

   A MATLAB struct whose fields and their values will be passed as keyword arguments to the MATLAB intrinsic contour.
   The following are the default components of contour:
   

   1. enabled

      A logical value. If true, the contour will be added to the axes.

   2. levels

      See the corresponding positional argument of the MATLAB intrinsic contourf().
      

   3. lineSpec

      See the corresponding positional argument of the MATLAB intrinsic contourf().
      

   4. others

      See the acceptable keyword arguments of the MATLAB intrinsic contour().
      

   Warning

   Keep in mind that MATLAB keyword arguments are case-INsensitive.
   Hence, ensure you do not add the same keyword as multiple different fields.
   

   
   Example usage ⛓

   self.contour.enabled = true;
   self.contour.lineWidth = "none";

   
   

5. contour3 (available only for pm.vis.SubplotContour3 axes types)

   A MATLAB struct whose fields and their values will be passed as keyword arguments to the MATLAB intrinsic contour3.
   The following are the default components of contour3:
   

   1. enabled

      A logical value. If true, the contour3 will be added to the axes.
      

   2. levels

      See the corresponding positional argument of the MATLAB intrinsic contourf().
      

   3. lineSpec

      See the corresponding positional argument of the MATLAB intrinsic contourf().
      

   4. others

      See the acceptable keyword arguments of the MATLAB intrinsic contour3().
      

   Warning

   Keep in mind that MATLAB keyword arguments are case-INsensitive.
   Hence, ensure you do not add the same keyword as multiple different fields.
   

   
   Example usage ⛓

   self.contour3.enabled = true;
   self.contour3.lineWidth = "none";

   
   

6. contourf (available only for pm.vis.SubplotContourf axes types)

   A MATLAB struct whose fields and their values will be passed as keyword arguments to the MATLAB intrinsic contourf.
   The following are the default components of contourf:
   

   1. enabled

      A logical value. If true, the contourf will be added to the axes.
      

   2. levels

      See the corresponding positional argument of the MATLAB intrinsic contourf().
      

   3. lineSpec

      See the corresponding positional argument of the MATLAB intrinsic contourf().
      

   4. others

      See the acceptable keyword arguments of the MATLAB intrinsic contourf().
      

   Warning

   Keep in mind that MATLAB keyword arguments are case-INsensitive.
   Hence, ensure you do not add the same keyword as multiple different fields.
   

   
   Example usage ⛓

   self.contourf.enabled = true;
   self.contourf.lineWidth = "none";

   
   

7. histfit (available only for pm.vis.SubplotHistfit axes types)

   A MATLAB struct whose fields and their values will be passed as keyword arguments to the MATLAB intrinsic histfit.
   The following are the default components of histfit:
   

   1. enabled

      A logical value. If true, the histfit will be added to the axes.
      

   2. nbins

      See the corresponding positional argument of the MATLAB intrinsic histfit().
      

   3. dist

      See the corresponding positional argument of the MATLAB intrinsic histfit().
      

   Warning

   Keep in mind that MATLAB keyword arguments are case-INsensitive.
   Hence, ensure you do not add the same keyword as multiple different fields.
   

   
   Example usage ⛓

   self.histfit.enabled = true;
   self.histfit.nbins = 20;

   
   

8. histogram (available only for pm.vis.SubplotHistogram axes types)

   A MATLAB struct whose fields and their values will be passed as keyword arguments to the MATLAB intrinsic histogram.
   The following are the default components of histogram:
   

   1. enabled

      A logical value. If true, the histogram will be added to the axes.
      

   2. nbins

      See the corresponding positional argument of the MATLAB intrinsic histogram().
      

   3. edges

      See the corresponding positional argument of the MATLAB intrinsic histogram().
      

   4. others

      See the corresponding acceptable keyword arguments of the MATLAB intrinsic histogram().
      

   Warning

   Keep in mind that MATLAB keyword arguments are case-INsensitive.
   Hence, ensure you do not add the same keyword as multiple different fields.
   

   
   Example usage ⛓

   self.histogram.enabled = true;
   self.histogram.edgeColor = "none";
   self.histogram.nbins = 20;

   
   

9. histogram2 (available only for pm.vis.SubplotHistogram2 axes types)

   A MATLAB struct whose fields and their values will be passed as keyword arguments to the MATLAB intrinsic histogram2.
   The following are the default components of histogram2:
   

   1. enabled

      A logical value. If true, the histogram2 will be added to the axes.
      

   2. nbins

      See the corresponding positional argument of the MATLAB intrinsic histogram2().
      

   3. xedges

      See the corresponding positional argument of the MATLAB intrinsic histogram2().
      

   4. yedges

      See the corresponding positional argument of the MATLAB intrinsic histogram2().
      

   5. others

      See the corresponding acceptable keyword arguments of the MATLAB intrinsic histogram2().
      

   Warning

   Keep in mind that MATLAB keyword arguments are case-INsensitive.
   Hence, ensure you do not add the same keyword as multiple different fields.
   

   
   Example usage ⛓

   self.histogram2.enabled = true;
   self.histogram2.edgeColor = "none";
   self.histogram2.nbins = 20;

   
   

10. legend (available for all axes types except pm.vis.SubplotHeatmap)

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

11. maxnoise (available only for pm.vis.SubplotContour/pm.vis.SubplotContourf/pm.vis.SubplotContour3 axes types)

    A float indicating the threshold below which the kernel density estimate is considered to be noise and is rounded to zero.
    The higher this value is, the less noise will be visible in the resulting contour plots.
    If empty, the default value is 0.001.
    

12. plot (available only for pm.vis.SubplotLine, pm.vis.SubplotLineScatter axes types)

    A MATLAB struct whose fields and their values will be passed as keyword arguments to the MATLAB intrinsic plot.
    The following are the default components of plot:
    

    1. enabled

       A logical value. If true, the plot will be added to the axes.
       

    2. lineSpec

       See the corresponding positional argument of the MATLAB intrinsic plot().
       

    3. others

       See the corresponding acceptable keyword arguments of the MATLAB intrinsic plot().
       

    Warning

    Keep in mind that MATLAB keyword arguments are case-INsensitive.
    Hence, ensure you do not add the same keyword as multiple different fields.
    

    
    Example usage ⛓

    self.plot.enabled = true;
    self.plot.lineWidth = 1;

    
    

13. plot3 (available only for pm.vis.SubplotLine3/pm.vis.SubplotLineScatter3 axes types)

    A MATLAB struct whose fields and their values will be passed as keyword arguments to the MATLAB intrinsic plot3.
    The following are the default components of plot3:
    

    1. enabled

       A logical value. If true, the plot3 will be added to the axes.
       

    2. lineSpec

       See the corresponding positional argument of the MATLAB intrinsic plot3().
       

    3. others

       See the corresponding acceptable keyword arguments of the MATLAB intrinsic plot3().
       

    Warning

    Keep in mind that MATLAB keyword arguments are case-INsensitive.
    Hence, ensure you do not add the same keyword as multiple different fields.
    

    
    Example usage ⛓

    self.plot3.enabled = true;
    self.plot3.lineWidth = 1;

    
    

14. precision (available only for pm.vis.SubplotHeatmap axes types)

    A scalar integer representing the number of digits after the decimal point for the values that appear in each cell of the heatmap. The default value is set by MATLAB.
    

15. resolution (available only for pm.vis.SubplotContour, pm.vis.SubplotContourf, pm.vis.SubplotContour3 axes types)

    A scalar integer indicating the grid resolution for discretization of the data during the kernel density estimation. It must be a power of two, otherwise it will be changed to the next power of two at the time of using it. If empty, the default value is 2^9.
    

16. scatter (available only for pm.vis.SubplotScatter, pm.vis.SubplotLineScatter axes types)

    A MATLAB struct whose fields and their values will be passed as keyword arguments to the MATLAB intrinsic scatter.
    The following are the default components of scatter:
    

    1. enabled

       A logical value. If true, the scatter will be added to the axes.
       

    2. size

       See the corresponding sz positional argument of the MATLAB intrinsic plot3().
       

    3. color

       See the corresponding C positional argument of the MATLAB intrinsic plot3().
       

    4. filled

       See the corresponding filled positional argument of the MATLAB intrinsic plot3().
       

    5. marker

       See the corresponding mkr positional argument of the MATLAB intrinsic plot3().
       

    6. others

       See the corresponding acceptable keyword arguments of the MATLAB intrinsic scatter().
       

    Warning

    Keep in mind that MATLAB keyword arguments are case-INsensitive.
    Hence, ensure you do not add the same keyword as multiple different fields.
    

    
    Example usage ⛓

    self.scatter.enabled = true; % add scatter()
    self.scatter.color = "red"; % set the points color
    self.scatter.marker = "."; % set the marker type
    self.scatter.size = 10; % set the point size
    self.scatter.lineWidth = 0;

    
    

17. scatter3 (available only for pm.vis.SubplotScatter3, pm.vis.SubplotLineScatter3 axes types)

    A MATLAB struct whose fields and their values will be passed as keyword arguments to the MATLAB intrinsic scatter3.
    The following are the default components of scatter3:
    

    1. enabled

       A logical value. If true, the scatter3 will be added to the axes.
       

    2. size

       See the corresponding sz positional argument of the MATLAB intrinsic plot3().
       

    3. color

       See the corresponding C positional argument of the MATLAB intrinsic plot3().
       

    4. filled

       See the corresponding filled positional argument of the MATLAB intrinsic plot3().
       

    5. marker

       See the corresponding mkr positional argument of the MATLAB intrinsic plot3().
       

    6. others

       See the corresponding acceptable keyword arguments of the MATLAB intrinsic scatter3().
       

    Warning

    Keep in mind that MATLAB keyword arguments are case-INsensitive.
    Hence, ensure you do not add the same keyword as multiple different fields.
    

    
    Example usage ⛓

    self.scatter3.enabled = true; % add scatter3()
    self.scatter3.color = "red"; % set the points color
    self.scatter3.marker = "."; % set the marker type
    self.scatter3.size = 10; % set the point size
    self.scatter3.lineWidth = 0;

    
    

18. surface (available only for pm.vis.SubplotLine, pm.vis.SubplotLineScatter, pm.vis.SubplotLine3/pm.vis.SubplotLineScatter3 axes types)

    A MATLAB struct whose fields and their values will be passed as keyword arguments to the MATLAB intrinsic surface.
    The following are the default components of surface:
    

    1. enabled

       A logical value. If true, the surface will be added to the axes.
       

    2. others

       See the corresponding acceptable keyword arguments of the MATLAB intrinsic surface().
       

    Warning

    Keep in mind that MATLAB keyword arguments are case-INsensitive.
    Hence, ensure you do not add the same keyword as multiple different fields.
    

    
    Example usage ⛓

    self.surface.enabled = true;
    self.surface.edgeColor = 1;

    
    

19. title (available for all axes types)

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

20. xlabel (available for all axes types)

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

21. ylabel (available for all axes types)

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

22. zlabel (available only for all tri-axes axes types)

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

23. xlim (available for all axes types, except pm.vis.SubplotHeatmap)

    A MATLAB vector of length 2 whose fields and values are passed as keyword arguments to the MATLAB intrinsic xlim().
    

24. ylim (available for all axes types, except pm.vis.SubplotHeatmap)

    A MATLAB vector of length 2 whose fields and values are passed as keyword arguments to the MATLAB intrinsic ylim().
    

25. zlim (available only for all tri-axes axes types)

    A MATLAB vector of length 2 whose fields and values are passed as keyword arguments to the MATLAB intrinsic zlim().
    

26. xscale (available for all axes types, except pm.vis.SubplotHeatmap)

    A MATLAB string whose value is passed directly to the MATLAB intrinsic xscale() to set the axis scale to either logarithmic or linear.
    Possible values are: "log", "linear".
    The default behavior is set by MATLAB.
    

27. yscale (available for all axes types, except pm.vis.SubplotHeatmap)

    A MATLAB string whose value is passed directly to the MATLAB intrinsic yscale() to set the axis scale to either logarithmic or linear.
    Possible values are: "log", "linear".
    The default behavior is set by MATLAB.
    

28. zscale (available only for all tri-axes axes types)

    A MATLAB string whose value is passed directly to the MATLAB intrinsic zscale() to set the axis scale to either logarithmic or linear.
    Possible values are: "log", "linear".
    The default behavior is set by MATLAB.
    

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.matlab.Handle

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 621 of file Axes.m.

Constructor & Destructor Documentation

Axes()

function Axes::Axes	(	in	ptype,
		in	varargin
	)

Construct and return an object of class pm.vis.axes.Axes.

This function is the constructor of the class pm.vis.axes.Axes.
For more information, see the documentation of the class pm.vis.axes.Axes.

Parameters

[in]	ptype	: The input scalar MATLAB string containing the name of the subclass that whose parent is Axes (e.g., "heatmap"). Supported plot names are: "line" "line3" "scatter" "scatter3" "lineScatter" "lineScatter3" "histogram2" "histogram" "contour3" "contourf" "contour" "histfit" "heatmap"
[in]	varargin	: Any property, value pair of the 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.

Returns

self : The output scalar object of class pm.vis.axes.Axes.

Possible calling interfaces ⛓

axes = pm.vis.axes.Axes(ptype);

Example usage ⛓

cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.
addpath('../../../../'); % Add the ParaMonte library root directory to the search path.
 
pm.matlab.show()
pm.matlab.show('a = pm.vis.axes.Axes("line")')
                a = pm.vis.axes.Axes("line")
pm.matlab.show()
 
pm.matlab.show()
pm.matlab.show('a = pm.vis.axes.Axes("line", "plot", {"linewidth", 2})')
                a = pm.vis.axes.Axes("line", "plot", {"linewidth", 2})
pm.matlab.show('hash = a.comp2hash("plot")')
                hash = a.comp2hash("plot")
pm.matlab.show()
pm.matlab.show('a.plot')
                a.plot
pm.matlab.show()
pm.matlab.show('a.reset("plot", {"markerSize", 5});')
                a.reset("plot", {"markerSize", 5});
pm.matlab.show()
pm.matlab.show('a.plot')
                a.plot

Example output ⛓

 
a = pm.vis.axes.Axes("line")
a = 
  Axes with properties:
 
      silent: 0
      legend: [1x1 struct]
      xlabel: [1x1 struct]
        colc: {}
        axes: [1x1 struct]
      ylabel: [1x1 struct]
        plot: [1x1 struct]
     surface: [1x1 struct]
    colormap: [1x1 struct]
        ylim: []
      yscale: []
    colorbar: [1x1 struct]
        xlim: []
       title: [1x1 struct]
      xscale: []
 
 
a = pm.vis.axes.Axes("line", "plot", {"linewidth", 2})
a = 
  Axes with properties:
 
      silent: 0
      legend: [1x1 struct]
      xlabel: [1x1 struct]
        colc: {}
        axes: [1x1 struct]
      ylabel: [1x1 struct]
        plot: [1x1 struct]
     surface: [1x1 struct]
    colormap: [1x1 struct]
        ylim: []
      yscale: []
    colorbar: [1x1 struct]
        xlim: []
       title: [1x1 struct]
      xscale: []
hash = a.comp2hash("plot")
hash =
  2x1 cell array
    {["lineWidth"]}
    {[          2]}
 
a.plot
ans = 
  struct with fields:
 
              color: []
          lineWidth: 2
          lineStyle: []
    markeredgeColor: []
    markerFaceColor: []
      markerIndices: []
         markerSize: []
            enabled: []
 
a.reset("plot", {"markerSize", 5});
 
a.plot
ans = 
  struct with fields:
 
              color: []
          lineWidth: []
          lineStyle: []
    markeredgeColor: []
    markerFaceColor: []
      markerIndices: []
         markerSize: 5
            enabled: []

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, 5:59 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

Member Function Documentation

comp2hash()

function Axes::comp2hash	(	in	self,
		in	comp
	)

Convert the components of the input component comp of the parent object into a cell array of key-val pairs.

This is a dynamic method of the class pm.vis.axes.Axes.
This method is used internally by the subclasses to convert the parent object attributes to input arguments of MATLAB intrinsic visualization functions.

Parameters

[in,out]	self	: The input/output parent object of class pm.vis.axes.Axes which is implicitly passed to this dynamic method (not by the user).
[in]	comp	: The input scalar MATLAB string representing the name of a struct component of the parent object, whose fields names and values are to be returned as subsequent pairs in the output hash cell array.

Returns

hash : The output cell array containing the pairs of field-name, field-value of the input MATLAB struct comp.

Possible calling interfaces ⛓

a = pm.vis.axes.Axes(ptype);
 
hash = a.comp2hash(comp);

Warning

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

Example usage ⛓

a = pm.vis.axes.Axes("line", "plot", {"linewidth", 2})
hash = a.comp2hash("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.

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

premake()

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

Configure the plot settings and specifications and return nothing.

Parameters

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

a = pm.vis.axes.Axes(ptype);
 
a.premake(varargin);
a.premake();

Warning

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

Example usage ⛓

a = pm.vis.axes.Axes("line");
a.premake("xlim", [0, 1])

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

reset()

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

Reset the properties of the plot to the original default settings and return nothing.

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.axes.Axes 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.

Possible calling interfaces ⛓

a = pm.vis.axes.Axes(ptype)
 
a.reset(varargin) % reset the plot to settings in ``varargin`` and the rest to default.
a.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:

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

cenabled

Property Axes::cenabled

cenabled

An auxiliary scalar MATLAB logical that is true if plot is color-mapped.

Warning

This is an internal Hidden class attribute that is inaccessible to the end users.

Definition at line 663 of file Axes.m.

silent

Property Axes::silent

silent

The scalar MATLAB logical (Boolean) indicator which is false by default.
If it is set to true, it will silence all output postprocessing messages (except warnings and errors).

Definition at line 636 of file Axes.m.

type

Property Axes::type

type

An auxiliary MATLAB struct containing plot type information.

Warning

This is an internal Hidden class attribute that is inaccessible to the end users.

Definition at line 652 of file Axes.m.

---

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

• src/matlab/main/+pm/+vis/+axes/Axes.m