This is the PlotContour class for generating instances of 2-dimensional Contour Plot visualizations based on the relevant MATLAB intrinsic functions.
More...

Inheritance diagram for PlotContour:

[legend]

Collaboration diagram for PlotContour:

[legend]

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

Detailed Description

This is the PlotContour class for generating instances of 2-dimensional Contour Plot visualizations based on the relevant MATLAB intrinsic functions.

Note: See the documentation of the constructor of the class pm.vis.PlotContour for example usage.; See the documentation of the attributes of the superclass pm.vis.Plot.

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.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Joshua Alexander Osborne, May 21 2024, 6:05 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, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin

Definition at line 29 of file PlotContour.m.

Constructor & Destructor Documentation

◆ PlotContour()

function PlotContour::PlotContour	(	in	dfref,
		in	varargin
	)

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

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

Parameters

[in]	dfref	: See the documentation of the corresponding input argument of the class pm.vis.Subplot.
[in]	varargin	: Any `property, value` pair of the parent object. If the property is a `struct()`, then its value must be given as a cell array, with consecutive elements representing the struct `property-name, property-value` pairs. Note that all of these property-value pairs can be also directly set via the parent object attributes, before calling the `make()` method.

Returns: self : The output object of class pm.vis.PlotContour.

Possible calling interfaces ⛓

: p = pm.vis.PlotContour(dfref);

p = pm.vis.PlotContour(dfref, varargin);

Note: The input varargin can also contain the components of the subplot component of the parent object.; See the documentation of the attributes of the superclass pm.vis.Plot.

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

4theta = linspace(0, 8 * pi, 500);

5r = 1.5 * theta;

6df = array2table(ctranspose([r .* cos(theta); r .* sin(theta); r(end) - r]));

7df.Properties.VariableNames = ["X = r cos(theta)", "Y = r sin(theta)", "Z = r"];

8

9pv = pm.vis.PlotContour(df);

10pv.subplot.title.titletext = "Contour Plot";

11pv.make("colx", 1, "coly", 2, "xlim", [-20, 20], "ylim", [-20, 20]);

12pv.savefig("PlotContour.1.png", "-m3");

13

14close all;

root
function root()
Return a scalar MATLAB string containing the root directory of the ParaMonte library package.

Visualization of the example output ⛓