Categories | Alphabetical | Classes | All Contents | [ < ] | [ > ]

WV_PLOT3D_WPS


Syntax | Return Value | Arguments | Keywords | Version History | See Also

The WV_PLOT3D_WPS function runs the graphical user interface for three-dimensional visualization of the wavelet power spectrum. WV_PLOT3D_WPS is accessible from the Visualize Menu of WV_APPLET.

Note
The IDL Wavelet Toolkit must be licensed on your system to be able to use this function.

Syntax

Result = WV_PLOT3D_WPS( Array [, X] [, Y] [, GROUP_LEADER=widget_id] [, SURFACE_STYLE=value] [, TITLE=string] [, UNITS=string] [, XTITLE=string] [, XUNITS=string] [, YTITLE=string] [, YUNITS=string] )

Return Value

The returned variable is the Widget ID of the newly-created widget.

Arguments

Input

Input must be either a string giving the name of a file to open, or a one- or two-dimensional array of data. If set to a string, the file must contain a valid WV_PLOT3D_WPS "saved state."

X

An optional vector of uniformly-spaced values giving the location of points along the first dimension of Input. The default is 0, 1, 2,..., NX-1, where NX is the size of the first dimension. This argument is ignored if Input is a filename.

Y

An optional vector of uniformly-spaced values giving the location of points along the second dimension of Input. The default is 0, 1, 2,..., NY-1, where NY is the size of the second dimension. This argument is ignored if Input is a filename.

Keywords

GROUP_LEADER

The widget ID of an existing widget that serves as "group leader" for the newly-created widget. When a group leader is killed, for any reason, all widgets in the group are also destroyed.

A given widget can be in more than one group. The WIDGET_CONTROL procedure can be used to add additional group associations to a widget. See WIDGET_CONTROL for more information. It is not possible to remove a widget from an existing group.

Note
The following keywords are ignored if Input is a filename. This includes the SURFACE_STYLE, TITLE, UNITS, XTITLE, XUNITS, YTITLE, and YUNITS keywords.

SURFACE_STYLE

Set this keyword to an integer specifying the initial style to use for the three-dimensional surface. Valid values are:

TITLE

A scalar string giving the label to be used for the widget. The default is `WPS:'.

UNITS

A scalar string giving the units of Array.

XTITLE

A scalar string giving the label to be used for the first dimension.

XUNITS

A scalar string giving the units of X.

YTITLE

A scalar string giving the label to be used for the y-axis (for a 1D vector) or for the second dimension (for a 2D array).

YUNITS

A scalar string giving the units of Array (for a 1D vector) or the units of Y (for a 2D array).

Widget Keywords Accepted

The WV_PLOT3D_WPS function also accepts the following WIDGET_BASE keywords: DISPLAY_NAME, EVENT_FUNC, FRAME, KBRD_FOCUS_EVENTS, KILL_NOTIFY, MODAL, NOTIFY_REALIZE, RESOURCE_NAME, SCR_XSIZE, SCR_YSIZE, SPACE, TLB_FRAME_ATTR, TRACKING_EVENTS, UNITS, XOFFSET, XSIZE, YOFFSET, YSIZE. See WIDGET_BASE for more information.

Version History

Introduced: 5.3

See Also

WV_APPLET


Categories | Alphabetical | Classes | All Contents | [ < ] | [ > ]