Routines (alphabetical) > Routines: W > WV_CW_WAVELET

# WV_CW_WAVELET

The WV_CW_WAVELET function is a compound widget that lets the user select and display wavelet functions. WV_CW_WAVELET is accessible from the Visualize Menu of WV_APPLET.

## Syntax

Result = WV_CW_WAVELET( [Parent] [, /DISCRETE] [, /NO_COLOR] [, /NO_DRAW_WINDOW] [, TITLE=string] [, UNAME=string] [, UVALUE=value] [, VALUE=structure] [, WAVELETS=string array] )

## Return Value

The returned value of this function is the widget ID of the newly-created widget.

## Arguments

### Parent

The widget ID of the parent widget. Omit this argument to created a top-level widget.

## Keywords

### DISCRETE

Set this keyword to include only discrete wavelets in the list of wavelet functions. Set this keyword to zero to include only continuous wavelets. The default is to include all available wavelets.

### NO_COLOR

If this keyword is set, the wavelet functions will be drawn in black and white.

### NO_DRAW_WINDOW

If this keyword is set, the draw window will not be included within the widget.

### TITLE

Set this keyword equal to a scalar string containing the title of the top level base. TITLE is not used if the wavelet widget has a parent widget. If it is not specified, the default title is “Wavelets.”

### UNAME

Set this keyword to a string that can be used to identify the widget in your code. You can associate a name with each widget in a specific hierarchy, and then use that name to query the widget hierarchy and get the correct widget ID.

To query the widget hierarchy, use the WIDGET_INFO function with the FIND_BY_UNAME keyword. See WIDGET_INFO for more information. The UNAME should be unique to the widget hierarchy because the FIND_BY_UNAME keyword returns the ID of the first widget with the specified name.

### UVALUE

Set this keyword equal to the user value associated with the widget.

### VALUE

Set this keyword to an anonymous structure of the form `{FAMILY:'', ORDER:0d}` representing the initial value for the widget.

### WAVELETS

A scalar string or vector of strings giving the names of user-defined wavelet functions to be included in WV_CW_WAVELET. The actual function names are constructed by removing all white space from each name and attaching a prefix of WV_FN_.

### Widget Keywords Accepted

The WV_CW_WAVELET function also accepts the following WIDGET_BASE keywords: ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_TOP, DISPLAY_NAME, FRAME, GROUP_LEADER, KBRD_FOCUS_EVENTS, MAP, NOTIFY_REALIZE, RESOURCE_NAME, SCR_XSIZE, SCR_YSIZE, SPACE, TLB_FRAME_ATTR, TRACKING_EVENTS, UNITS, XOFFSET, XSIZE, YOFFSET, YSIZE. See WIDGET_BASEfor more information.

### Keywords to WIDGET_CONTROL and WIDGET_INFO

The widget ID returned by most compound widgets is actually the ID of the compound widget’s base widget. This means that many keywords to the WIDGET_CONTROL and WIDGET_INFO routines that affect or return information on base widgets can be used with compound widgets.

In addition, you can use the GET_VALUE and SET_VALUE keywords to WIDGET_CONTROL to obtain or set the value of the wavelet. Use the command:

WIDGET_CONTROL, id, GET_VALUE=value

to read the current wavelet. To change the current wavelet, use the command:

WIDGET_CONTROL, id, SET_VALUE=value

In both cases value is an anonymous structure, `{``FAMILY: '',` `ORDER: 0}`, where FAMILY is a string containing the name (for example ‘Daubechies’), and ORDER is a variable giving the order number. Depending on the family, ORDER can be of type Integer or Double.

See WIDGET_CONTROL and WIDGET_INFO.

## Widget Events Returned by the WV_CW_WAVELET Widget

This widget generates event structures each time the family or order is changed. The event structure has the following definition:

Event = { ID:0L, TOP:0L, HANDLER:0L, FAMILY:'', ORDER:0}

The ID field is the widget ID of the WV_CW_WAVELET widget. The TOP field is the widget ID of the top-level widget. HANDLER is the widget ID of the widget handler. The FAMILY field contains the family name. The ORDER field contains the order number, and can be an Integer or a Double depending on the family.

## Version History

5.3 | Introduced

## See Also

WV_FN_COIFLET, WV_FN_DAUBECHIES, WV_FN_GAUSSIAN, WV_FN_HAAR, WV_FN_MORLET, WV_FN_PAUL, WV_FN_SYMLET