ITOOLWAPROFILE__DEFINE
Class Name
itoolwaprofile
Purpose (one Line)
To plot profiles of an extracted array of data.
Category
Widgets
Superclasses
Subclasses
Creation
See itoolwaprofile::init
Methods
itoolwaprofile::cleanup
itoolwaprofile::process
itoolwaprofile::refresh
itoolwaprofile::getproperty
itoolwaprofile::realize
itoolwaprofile::init
Modification History
2004/04, Written by Doug Loucks, Consultant for Lowell Observatory.
(See cw_pfile.pro)
Removed all remnants of compound-widget code; replaced with
stand-alone code that is compatible with the new object-oriented version
of itool.
Modified the usage of the state-structure variable. A pointer to
the state structure is stored in the object instance of this tool and
this tool's object reference is stored in its top-level base.
Modified the incoming argument. Now, it is the object reference of the
host instance of itool, which is stored in this tool's object instance.
-----------------------------------------------------------------------------
METHOD NAME:
itoolwaprofile::cleanup
Purpose
Self-explanatory
Calling Sequence
obj_destroy, oref
Inputs
oref : An itoolwaprofile object reference.
Optional Inputs
Keyword Parameters
Outputs
Optional Outputs
Common Blocks
Side Effects
Restrictions
Procedure
Example
Modification History
-----------------------------------------------------------------------------
METHOD NAME:
itoolwaprofile::process
Purpose
To perform all processing for the draw widget and the
hardcopy (Post Script) device.
Calling Sequence
oref->process
Inputs
Optional Inputs
Keyword Parameters
HARDCOPY : Set this keyword to print a copy of the graphics display to the
default printer device.
Outputs
Optional Outputs
Common Blocks
Side Effects
Restrictions
Procedure
Example
Modification History
-----------------------------------------------------------------------------
METHOD NAME:
itoolwaprofile::refresh
Purpose
To refresh this widget.
Calling Sequence
oref->refresh, value
Inputs
value : A structure defined as {image:array, xset:xs, yset:ys}
where "array" is an array of data, "xs" and "ys" are the
coordinates of the lower-left corner of "array" in a larger
array from which "array" was extracted.
Optional Inputs
Keyword Parameters
TITLE : Set this keyword to a string containing the title to be displayed
on the title bar of the main widget.
Outputs
Optional Outputs
Common Blocks
Side Effects
Restrictions
Procedure
Example
Modification History
-----------------------------------------------------------------------------
METHOD NAME:
itoolwaprofile::getproperty
Purpose
To retrieves "properties" defined for the itoolwaprofile object
class. Properties are specified as keyword arguments.
Calling Sequence
oref->getproperty
Inputs
Optional Inputs
Keyword Parameters
PSTATE : Set this keyword to a named variable into which will be
placed a pointer to the state structure.
Outputs
Optional Outputs
Common Blocks
Side Effects
Restrictions
Procedure
Example
Modification History
-----------------------------------------------------------------------------
METHOD NAME:
itoolwaprofile::realize
Purpose
To realize a new, managed instance of the itoolwaprofile object class.
Calling Sequence
oref->realize
Inputs
Optional Inputs
Keyword Parameters
NO_BLOCK : Set this keyword to cause the widget application to run
in non-blocked mode.
Outputs
Optional Outputs
Common Blocks
Side Effects
Restrictions
Procedure
Example
Modification History
-----------------------------------------------------------------------------
METHOD NAME:
itoolwaprofile::init
Purpose
To initialize a new instance of the itoolwaprofile object class.
Calling Sequence
oref = obj_new('itoolwaprofile', oitool)
Inputs
oitool : An object reference of a host instance of the object class
"itool."
Optional Inputs
Keyword Parameters
GROUP_LEADER = The group leader for this tool.
HCTITLE = Title of Hard Copy.
PLATESCALE = Plate Scale in arcseconds per pixel (used at display time).
If supplied and non-zero, display the bottom axis in
arcseconds and the top axis in pixels, else display the
bottom axis in pixels.
TITLE = The string to be displayed on the title bar. This keyword
may be specified on the call to the "refresh" method, as
well, to update the title dynamically.
Outputs
oref = The object reference of the new instance of the itoolwaprofile
object class.
Optional Outputs
Common Blocks
Side Effects
Restrictions
Procedure
After creating a new instance of this object-oriented widget application,
it must be realized and then be given a "value" to display.
Example
oref = obj_new('itoolwaprofile', oitool, GROUP_LEADER=group_leader)
oref->realize
oref->refresh, {image:array, xset:xs, yset:ys}, TITLE=title
Modification History
-----------------------------------------------------------------------------