Document Actions
CANCEL
Cancels a program state or definition—generally paired with a SET or DEFINE command. See commands SET and DEFINE for further information.
Arguments:
The arguments, which are names of variables, data sets, or other definitions can be specified using wildcards. The * wildcard matches any number of characters in the name; the ? wildcard matches exactly one character.
CANCEL ALIAS
Cancels a user-defined command alias.
yes? CANCEL ALIAS ALIAS_NAME
The command UNALIAS is an alias for CANCEL ALIAS.
CANCEL ATTRIBUTE
/OUTPUT /DATASET
Removes an attribute from a variable, or if /OUTPUT is specified, sets the output flag so that the attribute is not written to netCDF files when the variable is written. (See the section on commands for working with dataset and variable attributes)
yes? CANCEL ATTRIBUTE[/qualifiers] varname.attname
Examples:
This command removes the long_name attribute entirely from the variable sst.
yes? CANCEL ATTRIBUTE sst.long_name
These commands set a flag so that the AXIS attribute is not written for the coordinate variables COADSX, COADSY, and TIME are written to an netCDF file. This applies to the default dataset
yes? CANCEL ATTRIBUTE/OUTPUT (COADSX).AXIS
yes? CANCEL ATTRIBUTE/OUTPUT (COADSY).AXIS
yes? CANCEL ATTRIBUTE/OUTPUT (TIME).AXIS
CANCEL AXIS
/MODULO /DEPTH /ALL /STRIDE
CANCEL AXIS forms the complement to DEFINE AXIS, or SET AXIS It is also applicable to "persistent" axes which are defined by netCDF files such as climatological_axes.cdf -- axes which are not associated with any variables in the netCDF file, itself, and are not automatically deleted when the data set is canceled.
yes? CANCEL AXIS AXIS_NAME
Attempts to CANCEL AXIS on a axis which is used by a variable in a currently open data set will be rejected with a message indicating the reason.
Command qualifiers for CANCEL AXIS:
Cancels the modulo nature of a user-defined axis.
yes? CANCEL AXIS/MODULO my_x_axis
or
yes? CANCEL AXIS/MODULO my_t*
Cancels the depth setting of a Z axis, which may have been set with a positive="down" attribute in a netCDF file, or for a user-defined axis with a DEFINE AXIS/DEPTH or SET AXIS/DEPTH command. If applied to an X, Y, or T axis, this qualifier is ignored.
yes? CANCEL AXIS/DEPTH my_z_axis
Cancels all axes that have been defined by the user, and restores any coordinate storage that was used to define irregular axes. It does not cancel axes defined when a data set is opened.
Cancels the strided behavior of an axis that was set to native striding by a SET AXIS/STRIDE command. See the discussion of netCDF strides.
/ALL /NOERROR
Removes the specified data set from the list of available sets.
yes? CANCEL DATA_SET dset1, dset2, ..., dsetn
where each dset may be the name or number of a data set; or
yes? CANCEL DATA/ALL
See also SET DATA_SET, and SHOW DATA SET
Command qualifiers for CANCEL DATA_SET:
Eliminates all data sets from the list of accessible data sets.
CANCEL DATA/NOERROR
Suppresses the error message otherwise generated when a data set that was never set is canceled. Useful in GO scripts for closing data sets that may have been opened in previous usage of the script.
Note that if a grid or axis from a netCDF file is used in the definition of a LET-defined variable (e.g. LET my_X = X[g=sst[D=coads_climatology]]) that variable definition will be invalidated when the data set is canceled (CANCEL DATA coads_climtology, in the preceding example). There is a single exception to this behavior: netCDF files such as climtological_axes.cdf, which define grids or axes that are not actually used by any variables. These grids and axes will remain defined even after the data set, itself, has been canceled. They may be deleted with explicit use of CANCEL GRID or CANCEL AXIS.
Un-specifies the current context expression. Ferret's "action" commands can be issued without an argument (e.g., yes? PLOT), in which case Ferret uses the current context expression. This expression is either the argument of the most recent action command, or an expression set explicitly with SET EXPRESSION.
yes? CANCEL EXPRESSION
The qualifier /ALL can be used with this command, but it exists for compatibility purposes only and has no effect.
CANCEL GRID
CANCEL GRID forms the complement to DEFINE GRID It is also applicable to "persistent" grids which are defined by netCDF files such as climatological_axes.cdf -- grids which are not associated with any variables in the netCDF file, itself, and are not automatically deleted when the data set is canceled.
Attempts to CANCEL GRID on a grid or axis which is used by a variable in a currently open data set will be rejected with a message indicating the reason.
/ALL /APPEND /FILE /FORMAT /HEADING /PRECISION
Toggles the effects of the SET LIST command. See command SET LIST.
yes? CANCEL LIST[/qualifiers]
Command qualifiers for: CANCEL LIST
Restores all aspects of the LIST command to their default behavior.
Resets the listed output to NOT append to existing file.
Resets the listed output to automatic file naming.
Resets the listed output to its default formatting.
Instructs listed output to omit the descriptive data header.
Resets the precision of listed data to 4 significant digits.
/ALL /PERMANENT /TEMPORARY
Clears data currently cached in memory.
yes? CANCEL MEMORY[/qualifier]
Use this command to save memory space—by clearing data as soon as it is no longer needed virtual memory requirements can be reduced. This is especially useful for efficient batch processing. Default is CANCEL MEMORY/TEMPORARY.
Example:
To produce an animation using minimal virtual memory try:
yes? REPEAT/T=lo:hi:delta GO min_mem_movie
Where the file min_mem_movie.jnl contains
CONTOUR/FRAME temp[Z=0] ! contour plot
CANCEL MEMORY/ALL ! clear memory for next time step
Command qualifiers for CANCEL MEMORY:
Clears all variables stored in memory.
Clears all "permanent" variables stored in memory (i.e., variables loaded into memory with LOAD/PERMANENT).
CANCEL MEMORY/TEMPORARY (default)
Clears all non-permanent variables stored in memory.
Sets the state of a mode to "canceled".
yes? CANCEL MODE mode_name
(See command SET MODE for descriptions of modes.)
This command is unnecessary in Ferret version 3.1 and later; it is provided for compatibility with older versions of Ferret. It restores the default movie file name (ferret.mgm) but is not needed to conclude capturing graphics to a movie file.
yes? CANCEL MOVIE
The qualifier /ALL can be used with this command, but it exists for compatibility purposes only and has no effect.
CANCEL SYMBOL
/ALL
Deletes a user-defined symbol (string variable) definition.
yes? CANCEL STRING[/qualifier] [symbol_name]
Command qualifiers for CANCEL SYMBOL:
Deletes all user-defined symbol definitions.
Examples:
yes? CANCEL SYMBOL my_x_label !eliminate my_x_label from the definitions
yes? CANCEL SYMBOL *x_label !remove all strings ending in x_label
yes? CANCEL SYMBOL/ALL !remove all user-defined symbols.
CANCEL REGION
/I/J/K/L /X/Y/Z/T /ALL
Cancels part or all of the current or named region.
yes? CANCEL REGION[/qualifier] [region_name]
Examples:
yes? CANCEL REGION !clear the current region
yes? CANCEL REGION/T !eliminate T from the current context
yes? CANCEL REGION reg1 !clear the region named "reg1"
Command qualifiers for CANCEL REGION:
CANCEL REGION/I /J /K /L /X /Y /Z /T
Eliminates I, J, K, L, X, Y, Z, or T axis information from current context or named region.
Eliminates ALL stored region information (rarely used).
/ALL /DATASET
Deletes a user-defined variable definition.
yes? CANCEL VARIABLE[/qualifier] [var_name]
Command qualifiers for CANCEL VARIABLE:
Deletes all user-defined variable definitions.
Examples:
yes? CANCEL VARIABLE my_sst !eliminate my_sst from the definitions
yes? CANCEL VARIABLE *wind !delete all variables ending in wind
yes? CANCEL VARIABLE tau? !delete variables named tau plus one character
yes? CANCEL VARIABLE/ALL !delete all user-defined defined variables
Deletes user define variables associated with the named dataset, which were defined by a DEFINE VARIABLE/DATASET command.
CANCEL VIEWPORT
Cancels a defined viewport or cancels use of viewports.
yes? CANCEL VIEWPORT view_name !un-define view_name
yes? CANCEL VIEWPORT !return to full window output
/ALL
Removes graphics window(s) from the screen.
yes? CANCEL WINDOW n !or
yes? CANCEL WINDOW/ALL
Command qualifiers for CANCEL WINDOW:
Removes all graphics windows.