Univeristy of Alabama in Huntsville

UAH LTG IDL Library

IDL Routines from Phillip Bitzer and UAH Lightning Group

summary     class     fields     routine details     file attributes

misc/plotting/

pmb_plot_param__define.pro

Plotting


This is an object that load/save plot parameters. Helpful when dealing with direct graphics plots, especially when you have multiple plots.

Basically, this is an object implementation of pmb_swap_plot_parameters

Author information

Author

Phillip M. Bitzer, University of Alabama in Huntsville, pm.bitzer "AT" uah.edu

History

Modification History:

First written: Feb 24, 2017

Class description for pmb_plot_param

Inheritance

Properties

Properties in pmb_plot_param

map get set
p get set
x get set
y get set
z get set

Routines

Routines from pmb_plot_param__define.pro

result = pmb_plot_param::IsValid()

Check the property x (an axis structure) and its tag x to see if a valid transformation is here.

pmb_plot_param::GetProperty [, p=structure] [, x=structure] [, y=structure] [, z=structure] [, map=structure]

Overload the IDL_OBJECT GetProperty method for this object.

pmb_plot_param::SetProperty [, p=structure] [, x=structure] [, y=structure] [, z=structure] [, map=structure]

Overload the IDL_OBJECT SetProperty method for this object.

pmb_plot_param::load

Load the plot parameters stored in the object to the current workspace

pmb_plot_param::save

Save the current plot parameters into the object

pmb_plot_param::cleanup

Cleanup the object.

result = pmb_plot_param::init()

Initialization method.

pmb_plot_param__define

Define the object.

Routine details

top pmb_plot_param::IsValid

result = pmb_plot_param::IsValid()

Check the property x (an axis structure) and its tag x to see if a valid transformation is here. Assume that if x.s is all zeros, it's not a valud coordinate system

Return value

1 if the coordinate system is valid, 0 else. On error, NaN is returned

top pmb_plot_param::GetProperty

pmb_plot_param::GetProperty [, p=structure] [, x=structure] [, y=structure] [, z=structure] [, map=structure]

Overload the IDL_OBJECT GetProperty method for this object.

Keywords

p in optional type=structure

Get the !PLT plot structure

x in optional type=structure

Get the !X plot structure

y in optional type=structure

Get the !Y plot structure

z in optional type=structure

Get the !Z plot structure

map in optional type=structure

Get the !MAP plot structure

top pmb_plot_param::SetProperty

pmb_plot_param::SetProperty [, p=structure] [, x=structure] [, y=structure] [, z=structure] [, map=structure]

Overload the IDL_OBJECT SetProperty method for this object.

Keywords

p in optional type=structure

Set the !PLT plot structure

x in optional type=structure

Set the !X plot structure

y in optional type=structure

Set the !Y plot structure

z in optional type=structure

Set the !Z plot structure

map in optional type=structure

Set the !MAP plot structure

top pmb_plot_param::load

pmb_plot_param::load

Load the plot parameters stored in the object to the current workspace

top pmb_plot_param::save

pmb_plot_param::save

Save the current plot parameters into the object

top pmb_plot_param::cleanup

pmb_plot_param::cleanup

Cleanup the object. Not necessary here, but no big perfomance penalty for keeping it. Keep it around in case we need it at some point.

top pmb_plot_param::init

result = pmb_plot_param::init()

Initialization method. Currently, does nothing.

top pmb_plot_param__define

pmb_plot_param__define

Define the object. It has five properties for the various plot parameters.

File attributes

Modification date: Tue Oct 17 17:26:48 2017
Lines: 96
Docformat: rst rst