ParaMonte MATLAB 3.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
Public Member Functions | Data Fields
Figure Class Reference

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

Inheritance diagram for Figure:
Inheritance graph
[legend]
Collaboration diagram for Figure:
Collaboration graph
[legend]

Public Member Functions

function Figure (in varargin)
 Construct and return an object of class pm.vis.figure.Figure.
More...
 
function make (in self, in varargin)
 Configure the figure settings and specifications, make the figure, 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)
 Configure the figure 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...
 
function savefig (in self, in file, in varargin)
 Export the current figure to the specified external file.
More...
 

Data Fields

Property figure
 
Property fout
 
Property silent
 

Detailed Description

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

This is a generic class for generating figures containing arbitrary number of subplots (to be added by the subclasses).

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.Triplex
pm.vis.Figure
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 26 of file Figure.m.

Constructor & Destructor Documentation

◆ Figure()

function Figure::Figure ( in  varargin)

Construct and return an object of class pm.vis.figure.Figure.

This is the custom constructor of the class pm.vis.figure.Figure.

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.
Returns
self : The output scalar object of class pm.vis.figure.Figure.


Possible calling interfaces ⛓

f = pm.vis.figure.Figure();
f = pm.vis.figure.Figure(varargin);


Example usage ⛓

1cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.
2addpath('../../../../'); % Add the ParaMonte library root directory to the search path.
3
4range = -6 : 0.01 : 6;
5[x, y] = meshgrid(range, range);
6z = exp(pm.stats.dist.himmelblau.getLogUDF(x, y, 1));
7f = pm.vis.figure.Figure("figure", {"color", "white"});
8f.make();
9surf(x, y, z, log(z), "EdgeColor", "none");
10set(gca, "zscale", "log");
11zlabel("Z");
12f.savefig("Figure.himmelblau.3d.png", "-m3");
root
function root()
Return a scalar MATLAB string containing the root directory of the ParaMonte library package.

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, 12:06 AM, University of Texas at Arlington
Amir Shahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin

Member Function Documentation

◆ comp2hash()

function Figure::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.figure.Figure.
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.figure.Figure 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.figure.Figure(varargin);
hash = a.comp2hash(comp);
Warning
This method has side-effects by manipulating the existing attributes of the parent object.


Example usage ⛓

a = pm.vis.figure.Figure("figure", {"color", "white"});
hash = a.comp2hash("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.

  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

◆ make()

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

Configure the figure settings and specifications, make the figure, 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.figure.Figure 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 ⛓

f = pm.vis.figure.Figure.make(varargin);
f.make()


Example usage ⛓

1cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.
2addpath('../../../../'); % Add the ParaMonte library root directory to the search path.
3
4range = -6 : 0.01 : 6;
5[x, y] = meshgrid(range, range);
6z = exp(pm.stats.dist.himmelblau.getLogUDF(x, y, 1));
7f = pm.vis.figure.Figure("figure", {"color", "white"});
8f.make();
9surf(x, y, z, log(z), "EdgeColor", "none");
10set(gca, "zscale", "log");
11zlabel("Z");
12f.savefig("Figure.himmelblau.3d.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, 8:09 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 Figure::premake ( in  self,
in  varargin 
)

Configure the figure 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.figure.Figure 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 ⛓

f = pm.vis.figure.Figure(varargin);
f.premake(varargin);


Example usage ⛓

f = pm.vis.figure.Figure();
f.premake("figure", {"color", "none"})


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, 8:13 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 Figure::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,out]self: The input/output parent object of class pm.vis.figure.Figure 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.figure.Figure.reset() % reset the plot to the default settings.
Figure::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.

  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, 8:11 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

◆ savefig()

function Figure::savefig ( in  self,
in  file,
in  varargin 
)

Export the current figure to the specified external file.

This method internally uses the venerable export_fig MATLAB package.
As such, it accepts all arguments that the export_fig() function accepts.
If no optional argument is present, then a default set of options determined by the export_fig library will be used.

Parameters
[in,out]self: The input/output parent object of class pm.vis.figure.Figure which is implicitly passed to this dynamic method (not by the user).
[in]file: The input scalar MATLAB string or char vector containing the path to the external file that will contain the visualization.
The specified file extension determines its type (e.g., .pdf, .png).
If no file extension is specified, then the default .png file extension is used.
(optional. If file is missing or empty, first, the fileName component of the figure property of the parent object will be used as the filename if not empty.
Otherwise, the figure will be exported to a file in the current working directory of MATLAB with name figure suffixed by a unique number and .png extension.)
[in]varargin: The following optional flags are also acceptable as input string arguments.
This method internally uses the venerable export_fig MATLAB package.
As such, it accepts all arguments that the export_fig() function accepts.
If no optional argument is present, then a default set of options determined by the export_fig library will be used.
The recommended set of optional flags for PNG file formats is "-m4 -transparent".

  1. "-<format>"

    The input scalar (or variadic array of) MATLAB string(s) containing the output file extension(s). Options include:

    1. '-pdf'
    2. '-eps'
    3. '-emf'
    4. '-svg'
    5. '-png'
    6. '-tif'
    7. '-jpg'
    8. '-gif'
    9. '-bmp'

    Multiple formats can be specified, without restriction.
    For example:

    savefig('-jpg', '-pdf', '-png')
    Figure::savefig
    function savefig(in self, in file, in varargin)
    Export the current figure to the specified external file.

    Note that '-tif' and '-tiff' are equivalent.

  2. "-transparent"

    The input option indicating that the figure background is to be made transparent (PNG, PDF, TIF, EPS, EMF formats only).
    Specifying this option also activates "-noinvert".

  3. "-nocrop"

    The input option indicating that empty margins should not be cropped.

  4. "-c[<val>,<val>,<val>,<val>]"

    The input option indicating the crop amounts. It must be a 4-element vector of numeric values: [top, right, bottom, left] where NaN/Inf indicates auto-cropping, 0 means no cropping, any other value means cropping in pixel amounts. e.g. '-c7,15,0,NaN' Note that this option is not supported by SVG and EMF formats.

  5. "-p<val>"

    The input option to pad a border of width val to exported files, where val is either a relative size with respect to cropped image size (i.e. p = 0.01 adds a 1% border). For EPS & PDF formats, val can also be integer in units of 1/72 points (abs(val) > 1).
    val can be positive (padding) or negative (extra cropping).
    If used, the -nocrop flag will be ignored, i.e. the image will always be cropped and then padded. Default: 0 (i.e. no padding).
    Note: this option is not supported by SVG and EMF formats.

  6. "-m<val>"

    The input option val indicates the factor to magnify the figure dimensions when generating bitmap outputs (does not affect vector formats).
    Default: '-m1' (i.e. val=1). Note: val~=1 slows down savefig.

  7. "-r<val>"

    The input option val indicates the resolution (in pixels per inch) to export bitmap and vector outputs, without changing dimensions of the on-screen figure. Default: '-r864' (for vector output only).
    Note: -m option overides -r option for bitmap exports only.

  8. "-native"

    The input option indicating that the output resolution (when outputting a bitmap format) should be such that the vertical resolution of the first suitable image found in the figure is at the native resolution of that image. To specify a particular image to use, give it the tag 'export_fig_native'.
    Notes: This overrides any value set with the -m and -r options.
    It also assumes that the image is displayed front-to-parallel with the screen. The output resolution is approximate and should not be relied upon. Anti-aliasing can have adverse effects on image quality (disable with the -a1 option).

  9. "-a1, -a2, -a3, -a4"

    The input option indicating the amount of anti-aliasing (AA) to use for bitmap outputs, when GraphicsSmoothing is not available.
    '-a1'=no AA; '-a4'=max. Default: 3 for HG1, 1 for HG2.

  10. "-<renderer>"

    The input option to force a particular renderer (painters, opengl or [in R2014a or older] zbuffer). Default value: opengl for bitmap formats or figures with patches and/or transparent annotations; painters for vector formats without patches/transparencies.

  11. "-<colorspace>"

    The input option indicating which colorspace color figures should be saved in: RGB (default), CMYK or gray. Usage example: '-gray'.
    Note: CMYK is only supported in PDF, EPS and TIF formats.

  12. "-q<val>"

    The input option to vary bitmap image quality (PDF, EPS, JPG formats only).
    A larger val, in the range 0-100, produces higher quality and lower compression. val > 100 results in lossless compression.
    Default: '-q95' for JPG, ghostscript prepress default for PDF,EPS.
    Note: lossless compression can sometimes give a smaller file size than the default lossy compression, depending on the image type.

  13. "-n<val>"

    The input option to set minimum output image size (bitmap formats only).
    The output size can be specified as a single value (for both rows & cols, e.g. -n200) or comma-separated values (e.g. -n300,400).
    Use an Inf value to keep a dimension unchanged (e.g. -n50,inf).
    Use a NaN value to keep aspect ratio unchanged (e.g. -n50,nan).

  14. "-x<val>"

    The input option to set maximum output image size (bitmap formats only).
    The output size can be specified as a single value (for both rows & cols, e.g. -x200) or comma-separated values (e.g. -x300,400).
    Use an Inf value to keep a dimension unchanged (e.g. -x50,inf).
    Use a NaN value to keep aspect ratio unchanged (e.g. -x50,nan).

  15. "-s<val>"

    The input option to scale output image to specific size (bitmap formats only).
    The fixed size can be specified as a single value (for rows=cols) or comma-separated values (e.g. -s300,400). Each value can be a scalar integer (signifying pixels) or percentage (e.g. -s125%). The scaling is done last, after any other cropping/rescaling due to other params.

  16. "-append"

    The input option indicating that if the file already exists the figure is to be appended as a new page, instead of being overwritten (default).
    PDF, TIF & GIF output formats only (multi-image GIF = animated).

  17. "-bookmark"

    The input option to indicate that a bookmark with the name of the figure is to be created in the output file (PDF format only).

  18. "-clipboard"

    The input option to save output as an image on the system clipboard.

  19. "-clipboard<:format>"

    The input copies to clipboard in the specified format: image (default), bitmap, emf, or pdf.
    Notes that only -clipboard (or -clipboard:image, which is the same) applies export_fig parameters such as cropping, padding etc.

    1. -clipboard:image create a bitmap image using export_fig processing
    2. -clipboard:bitmap create a bitmap image as-is (no auto-cropping etc.)
    3. -clipboard:emf is vector format without auto-cropping; Windows-only.
    4. -clipboard:pdf is vector format without cropping; not universally supported

  20. "-d<gs_option>"

    The input option to indicate a ghostscript setting. For example, -dMaxBitmap=0 or -dNoOutputFonts (Ghostscript 9.15+).

  21. "-depsc"

    The input option to use EPS level-3 rather than the default level-2 print device. This solves some bugs with MATLAB's default -depsc2 device such as discolored subplot lines on images (vector formats only).

  22. "-metadata <metaDataInfo>"

    The input adds the specified meta-data information to the exported file (PDF format only). metaDataInfo must be either a struct or a cell array with pairs of values: {'fieldName', fieldValue, ...}.
    Common metadata fields are Title, Author, Creator, Producer, Subject, Keywords.

  23. "-nofontswap"

    The input option to avoid font swapping. Font swapping is automatically done in vector formats (only): 11 standard MATLAB fonts are replaced by the original figure fonts. This option prevents this.

  24. "-font_space <char>"

    The input option to set a spacer character for font-names that contain spaces, used by EPS/PDF. Default: ''

  25. "-linecaps"

    The input option to create rounded line-caps (vector formats only).

  26. "-noinvert"

    The input option to avoid setting figure's InvertHardcopy property to 'off' during output (this solves some problems of empty outputs).

  27. "-preserve_size"

    The input option to preserve the figure's PaperSize property in output file (PDF/EPS formats only; default is to not preserve it).

  28. "-options <optionsStruct>"

    The input format-specific parameters as defined in MATLAB's documentation of the imwrite function, contained in a struct under the format name. For example to specify the JPG Comment parameter, pass a struct such as this: options.JPG.Comment='abc'.
    Similarly, options.PNG.BitDepth = 4.
    Only used by PNG, TIF, JPG, GIF output formats.
    Options can also be specified as a cell array of name-value pairs, e.g. {'BitDepth', 4, 'Author', 'Yair'}. These options will be used by all supported output formats of the pm.vis.figure.savefig function.

  29. "-silent"

    The input option to avoid various warning and informational messages, such as version update checks, transparency or renderer issues, etc.

  30. "-notify"

    The input option to notify the user when export is done, in both a console message and a popup dialog (allow opening the exported file/folder).

  31. "-regexprep <old> <new>"

    The input replaces all occurrences of <old> (a regular expression string or array of strings; case-sensitive), with the corresponding new string(s), in EPS/PDF files (only). See regexp function's doc.
    Warning: invalid replacement can make your EPS/PDF file unreadable!

  32. "-toolbar"

    The input adds an interactive export button to the figure's toolbar

  33. "-menubar"

    The input adds an interactive export menu to the figure's menubar

  34. "-contextmenu"

    The input adds interactive export menu to figure context-menu (right-click)

  35. "handle"

    The input handle of the figure, axes or uipanels (can be an array of handles but all the objects must be in the same figure) to be exported.
    The default is gcf (handle of current figure).

  36. "figName"

    The input name (title) of the figure to export (e.g. 'Figure 1' or 'My fig').
    Overridden by handle (if specified)
    The default is the current figure.

Returns
imageData : The output image cube of type uint8 of shape [M, N, C] containing the exported figure data.
alpha : The output image matrix of shape [M, N] of alpha-matte values in the range [0, 1] for the case of transparent background.


Possible calling interfaces ⛓

f = pm.vis.figure.Figure();
[imageData, alpha] = f.savefig();
[imageData, alpha] = f.savefig(file);
[imageData, alpha] = f.savefig(file, varargin{:});


Example usage ⛓

f = pm.vis.figure.Figure();
f.savefig(); % export the current figure with the default name.
f.savefig("gridplot.pdf") % export figure to the specified PDF file.
f.savefig("gridplot.png", "-m4 -transparent") % export a large png plot of magnitude 4 with transparency.
name
function name(in vendor)
Return the MPI library name as used in naming the ParaMonte MATLAB shared library directories.
Figure::figure
Property figure
Definition: Figure.m:74


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, 8:19 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

◆ figure

Property Figure::figure

figure

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

  1. name : Name of the figure, specified as a character vector or a string scalar.
  2. color : Background color, specified as an RGB triplet, a hexadecimal color code, a color name, or a short name.
    If you specify 'none', the background color appears black on screen, but if you print the figure, the background prints as though the figure window is transparent.
  3. fileName : Character vector or string scalar containing the file name for saving the figure specified as a character vector or a string scalar.
  4. position : Location and size of the drawable area, specified as a vector of the form [left bottom width height].
    This area excludes the figure borders, title bar, menu bar, and tool bars.
  5. units : Units of measurement, specified as one of the following values:
    'pixels' | 'normalized' | 'inches' | 'centimeters' | 'points' | 'characters'.
    The MATLAB documentation of the intrinsic figure for the meaning of the options.
  6. others : See the acceptable keyword arguments of the MATLAB intrinsic figure().
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, figure.color and figure.Color are the same, and only one of the two will be processed.


Example usage ⛓

self.figure.units = pixels;
self.figure.color = "none";

Definition at line 74 of file Figure.m.

◆ fout

Property Figure::fout

fout

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

Definition at line 82 of file Figure.m.

◆ silent

Property Figure::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 90 of file Figure.m.

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