SeaDAS User Defined Operations Widget

User Defined Band Operations

Description: This function provides the capability of generating new band data based on any user defined IDL operations on loaded band data and displayed graphics data. For this function to work correctly, the following variable naming restrictions have to be followed and should not be used for other purposes (case insensitive):
     1. B1, B2, B3, ... are reserved for the geophysical data of Band 1, Band 2, Band 3, .....
     2. R1, R2, R3, .... are reserved for the raw data of Band 1, Band 2, Band 3, ....
     3. GR1, GR2, GR3, ... are reserved for the graphics data of the Display Window 1, 2, 3, ...
     4. RESULT is reserved and has to be used for the result of the new band.
For example, the command 'result = b1 + b2' will create a new band at the end of the Band List Widget with the result of the sum of Band 1 and Band 2 geophysical values. Users having IDL experience may use IDL commands to do more sophisticated operations.

[Interactive mode] [Command mode]

Command Mode:

Usage:mband_cmd, cmd_file=cmd_file, cmd_array=cmd_array, bandname=bandname, navband=navband, unit=unit

Arguments/Keywords:

cmd_file The script text file that contains the IDL commands to generate the new band based on the loaded bands and graphics data. This argument cannot be used with the argument cmd_array.

cmd_array The text array that contains the IDL commands to generate the new band based on the loaded bands and graphics data. This argument cannot be used with the argument cmd_file.

bandname The name for the new band to be displayed at the end of the Band List Widget when it is created.

navband The band number in the Band List Widget whose navigation information will be copied to the new band so that it can be navigated.

unit Image data unit for new band output

Examples:

Create a new band by summing Band 1 and Band2 in geophysical units with the band name 'new_band:band1+band2' and with the same navigation as in Band 1.

mband_cmd, cmd_array=['result = b1 + b2'], bandname='new_band:band1+band2', navband=1,units='mg/m^3'

Create a new band from the Band 1 raw data by assigning all pixels that are blotched with graphics palette 1 (red by default) in the Display Window 1 to value 0.0

mband_cmd, cmd_array=['result=R1', 'ix=WHERE(GR1 EQ 1, icnt)', 'if (icnt GT 0) then result(ix) = 0.0']

Create a new band by taking the command from the text script file '$SDSDEMO/mband_chlora.cmd'. This file is available under the $SDSDEMO directory. Assumes that the nLw_490, nLw_555, and l2_flags from an SeaWiFS L2 file are loaded into Band List Widget as Band1, 2, and 3, the commands in the script file will create the chlor_a product same as the one in the L2 file.

mband_cmd, cmd_file='$SDSDEMO/mband_chlora.cmd', navband=1, bandname='chlor_a:user defined'

Interactive Mode:

User Defined Operations Widget: This widget can be accessed within the Seadisp Main Menu by selecting Functions->User Defined Operations.

Input Items:

File to save/load the command The file name that the IDL commands in the command window are to be saved to, or the file containing the IDL commands to be loaded into the command window.

Band command window The text window for the IDL commands to be entered and updated for generating the new band data based on any user defined IDL operations on loaded band data and displayed graphics data. Use the Example button on top of the window to display some examples for guidance.

Name for the new band The name for the new band to be displayed at the end of the Band List Widget when it is created.

Band whose navigation to be used for the new band The band number in the Band List Widget whose navigation information will be copied to the new band so that it can be navigated.

Actions Items:

Save Save the IDL commands in the Band command window to the file specified in the File to save/load the command field.

Load Load the IDL commands from the file specified in the File to save/load command field into the Band command window.

Clear Clear all the IDL commands in the Band command window. To remove only a certain part of the commands in the command window, you can drag the left mouse button to highlight the part to be removed and then press the <space> key.

Example Display examples in the Band command window for helping the users to write commands for operations on loaded band data and displayed graphics data.

Quit Exit the widget.

Help Bring up hypertext help in an HTML viewer.

Go Perform the function specified. Notice that a new resultant output grid will appear in the Band List Selection Widget and is now available for use as any other loaded product.

Curator: OceanColor Webmaster

Authorized by: gene carl feldman

cmd_file	The script text file that contains the IDL commands to generate the new band based on the loaded bands and graphics data. This argument cannot be used with the argument cmd_array.
cmd_array	The text array that contains the IDL commands to generate the new band based on the loaded bands and graphics data. This argument cannot be used with the argument cmd_file.
bandname	The name for the new band to be displayed at the end of the Band List Widget when it is created.
navband	The band number in the Band List Widget whose navigation information will be copied to the new band so that it can be navigated.
unit	Image data unit for new band output

File to save/load the command	The file name that the IDL commands in the command window are to be saved to, or the file containing the IDL commands to be loaded into the command window.
Band command window	The text window for the IDL commands to be entered and updated for generating the new band data based on any user defined IDL operations on loaded band data and displayed graphics data. Use the Example button on top of the window to display some examples for guidance.
Name for the new band	The name for the new band to be displayed at the end of the Band List Widget when it is created.
Band whose navigation to be used for the new band	The band number in the Band List Widget whose navigation information will be copied to the new band so that it can be navigated.

Save	Save the IDL commands in the Band command window to the file specified in the File to save/load the command field.
Load	Load the IDL commands from the file specified in the File to save/load command field into the Band command window.
Clear	Clear all the IDL commands in the Band command window. To remove only a certain part of the commands in the command window, you can drag the left mouse button to highlight the part to be removed and then press the <space> key.
Example	Display examples in the Band command window for helping the users to write commands for operations on loaded band data and displayed graphics data.
Quit	Exit the widget.
Help	Bring up hypertext help in an HTML viewer.
Go	Perform the function specified. Notice that a new resultant output grid will appear in the Band List Selection Widget and is now available for use as any other loaded product.