Document Actions
SHOW
Ref Sec33.
/ALL
Displays program states and stored values.
Command qualifiers for SHOW:
SHOW/ALL
Executes all SHOW options. This command gives a complete description of the current state, including information about region, grids, axes, variables, and the state of various modes (default or set with SET MODE).
yes? SHOW/ALL
Arguments:
The names of variables, data sets, or other definitions can be specified using wildcards. The * wildcard matches any number of characters in the name; the question wildcard matches exactly one character.
Ref Sec33.1.
Lists all command aliases and the full command names for which they stand, or, with an argument, shows a specified command alias.
yes? SHOW ALIAS [alias_name]
Ref Sec33.2.
SHOW ATTRIBUTE
/ALL /DATASET /OUTPUT
yes? SHOW ATTRIBUTE varname.attname
yes? SHOW ATTRIBUTE/ALL varname
yes? SHOW ATTRIBUTE/D=1/ALL varname
Shows the attribute(s) for a variable. This command is included for convenience; it does not add any capabilities beyond the LIST command, but is useful especially with the /ALL qualifier for a quick look at what attributes a variable has. See the section on access to dataset and variable attributes.
Ref Sec33.3.
SHOW AXIS
Shows a basic description of the named axis.
SHOW AXIS[/qualifiers] axis_name
A typical output appears below. The columns are:
|
name |
name of axis (used also in DEFINE AXIS and DEFINE GRID) |
|
number of points on axis; "r" or "i" for regular or irregular spacing, "m" if the axis is "modulo" (repeating) |
|
|
axis |
the orientation of the axis; "(-)" after the "r" or "i" on a depth axis indicates increasing downward |
|
start |
position of first point on the axis |
|
end |
position of last point on the axis |
The axis span (length of the axis), and for modulo axes, the modulo length are also given.
yes? SHOW AXIS PSXT
name axis # pts start end
PSXT LONGITUDE 160 r 130.5E 70.5W
Axis span (to cell edges) = 360 (modulo length = axis span)
yes? SHOW AXIS/I=1:2 COADSX
name axis # pts start end
COADSX LONGITUDE 180mr 21E 19E(379)
Axis span (to cell edges) = 360 (modulo length = axis span)
I X XBOX XBOXLO
1> 21E 2 20E
2> 23E 2 22E
Command qualifiers for SHOW AXIS:
SHOW AXIS/I=/J=/K=/L=/X=/Y=/Z=/T=/XML
Displays the coordinates and grid box sizes for the specified axis. Optionally, low and high limits and a delta value may be specified to restrict the range of values displayed.
yes? SHOW AXIS/X[=lo:hi:delta] axis-name
Example:
yes? SHOW AXIS/L=1:12:3 my_custom_time_axis
SHOW AXIS/ALL
Show a brief summary of all axes defined.
yes? SHOW AXIS/ALL
SHOW AXIS/XML
List the axis information in XML-style
yes? SH AXIS/XML fnocx
<axis name="FNOCX">
<units>degrees_east</units>
<length>144</length>
<start>20E</start>
<end>17.5E(377.5)</end>
<point_spacing>even</point_spacing>
<modulo>yes</modulo
</axis>
Ref Sec33.4.
SHOW COMMANDS
/ALL
Displays commands, subcommands, and qualifiers recognized by program Ferret. This command does not display aliases; use SHOW ALIAS.
SHOW COMMAND [command_name or partial_command]
Note: This is the most reliable way to view command qualifiers. The output of this command will be current even when this manual is out of date.
Examples:
yes? SHOW COMMAND S ! show all commands beginning with "S"
yes? SHOW COMMAND ! show all commands
yes? SHOW COMMAND PLOT ! shows command PLOT and all its qualifiers
Ref Sec33.5.
SHOW DATA_SET
/ALL /BRIEF /FILES /FULL /VARIABLE /XML /ATTRIBUTES
Shows information about the data sets which have been SET and indicates the current default data set. By default the variables and their subscript ranges are also listed.
yes? SHOW DATA[/qualifiers] [set_name_or_number1,set2,...]
If no data set name or number is specified then all SET data sets are shown.
Command qualifiers for SHOW DATA_SET:
SHOW DATA/ALL
This qualifier has no effect on this command; it exists for compatibility reasons.
SHOW DATA/ATTRIBUTES
Makes an expanded listing which includes the global and variable attributes, the attribute types, sizes, and the output flag for each (See the section on access to dataset and variable attributes.
SHOW DATA/BRIEF
Shows only the names of the data sets; does not describe the data contained in them.
SHOW DATA/FILES
Displays the names of the data files for this data set and the ranges of time steps contained in each. Output is formatted as date strings or as time step values depending on the state of MODE CALENDAR.
SHOW DATA/FULL
Equivalent to /VARIABLES and /FILES used together.
SHOW DATA/VARIABLES
In addition to the information given by the SHOW DATA command with no qualifiers, this query also provides the grid name and world coordinate limits for each variable in the data set.
SHOW DATA/XML
For netCDF files, including those accessed via DODS, SHOW DATA/XML and SHOW DATA/VAR/XML list information about the file and variables as xml-style output.
Example: SHOW DATA
SHOW DATA produces a listing similar to the one below. The output begins with the descriptor file name (for TMAP-formatted data) and data set title. The columns I, J, K, and L give the subscript limits for each variable with respect to its defining grid (use SHOW DATA/FULL and SHOW GRID variable_name for more information).
yes? SET DATA levitus_climatology
yes? SHOW DATA
currently SET data sets:
1> /home/e1/tmap/fer_dsets/descr/levitus_climatology.des (default)
name title I J K L
TEMP TEMPERATURE 1:360 1:180 1:20 1:1
SALT SALINITY 1:360 1:180 1:20 1:1
Example: SHOW DATA/XML, SHOW DATA/VARIABLES/XML
Example:
yes? USE monthly_navy_winds
yes? SHOW DATA/XML
<dataset>
<title> </title>
<vname>UWND</vname>
<vname>VWND</vname>
</dataset>
yes? SHOW DATA/VAR/XML
<var name="UWND">
<units>M/S</units>
<long_name>ZONAL WIND</long_name>
<_FillValue>-99.9</_FillValue>
<missing_value>-99.9</missing_value>
<grid name="GDN1">
<xaxis>FNOCX</xaxis>
<yaxis>FNOCY</yaxis>
<taxis>TIME</taxis>
</grid>
</var>
<var name="VWND">
<units>M/S</units>
<long_name>MERIDIONAL WIND</long_name>
<_FillValue>-99.9</_FillValue>
<missing_value>-99.9</missing_value>
<grid name="GDN1">
<xaxis>FNOCX</xaxis>
<yaxis>FNOCY</yaxis>
<taxis>TIME</taxis>
</grid>
</var>
Ref Sec33.6.
SHOW EXPRESSION
Shows the current expression(s) implied or set with SET EXPRESSION. If not explicitly set with this command, the default current context expression is the argument of the most recent "action" command (PLOT, SHADE, CONTOUR, VECTOR, WIRE, etc.) See the chapter "Variables and Expressions", section "Expressions" for an explanation and list of action commands.
yes? SHOW EXPRESSION
Ref Sec33.7.
SHOW FUNCTION
/ALL /BRIEF /EXTERNAL /INTERNAL /DETAILS
Shows a complete list of the functions defined in Ferret including descriptions of the function arguments.
yes? SHOW FUNCTION[/qualifiers] [function_name]
If no qualifier or function name is given then all functions are listed. SHOW FUNCTION will accept name templates such as
yes? SHOW FUNCTION *days*
DAYS1900(year,month,day)
days elapsed since 1-Jan-1900
DAYS1900TOYMDHMS(day1900)
Convert Julian day to values y,m,d,h,m,s on k=1,...,6
day1900: Julian day counted from 1-jan-1900
Parameters
The parameter(s) may be the name of a function, with * replacing part of the string as above.
Command qualifiers for SHOW FUNCTION:
SHOW FUNCTION/ALL
List all functions defined
SHOW FUNCTION/BRIEF
List the functions and their arguments in brief form; no function or argument descriptions.
SHOW FUNCTION/EXTERNAL
List only the available Ferret External Functions. However, this also lists functions that were developed as external functions but are now linked internally as part of the Ferret executable.
SHOW FUNCTION/INTERNAL
List only the internally defined Ferret functions.
SHOW FUNCTION/DETAILS
Lists the axis inheritance for grid-changing functions
Example:.SHOW FUNCTION/DETAILS
yes? SHOW FUNCTION/DETAILS SAMPLEXY
SAMPLEXY(DAT_TO_SAMPLE,XPTS,YPTS)
Returns data sampled at a set of (X,Y) points, using linear interpolation
Grid of result:
X: ABSTRACT (result will occupy indices 1...N)
Y: NORMAL (no axis)
Z: inherited from argument(s)
T: inherited from argument(s)
DAT_TO_SAMPLE: variable (x,y,z,t) to sample
Influence on output grid:
X: no influence (indicate argument limits with "[]")
Y: no influence (indicate argument limits with "[]")
Z: passed to result grid
T: passed to result grid
XPTS: X indices of sample points
Influence on output grid:
X: no influence (indicate argument limits with "[]")
Y: no influence (indicate argument limits with "[]")
Z: no influence (indicate argument limits with "[]")
T: no influence (indicate argument limits with "[]")
YPTS: Y indices of sample points
Influence on output grid:
X: no influence (indicate argument limits with "[]")
Y: no influence (indicate argument limits with "[]")
Z: no influence (indicate argument limits with "[]")
T: no influence (indicate argument limits with "[]")
/I/J/K/L /X/Y/Z/T /ALL /DYNAMIC
Shows the name and axis limits of a grid.
yes? SHOW GRID[/qualifiers] [var_or_grid1 var_or_grid2 ...]
Example:
(See the command SHOW AXIS, for an explanation of the columns.)
yes? SET DATA levitus_climatology
yes? SHOW GRID salt
GRID GLEVITR1
name axis # pts start end
XAXLEVITR LONGITUDE 360mr 20.5E 19.5E(379.5)
YAXLEVITR LATITUDE 180 r 89.5S 89.5N
ZAXLEVITR DEPTH(-) 20 i 0m 5000m
Parameters
The parameter(s) may be the name of one or more grid(s) or variable(s). If no parameter is given SHOW GRID displays the grid of the last variable accessed. This is the only mechanism to display the grid of an algebraic expression.
Note: To apply SHOW GRID to an algebraic expression it is necessary for Ferret to have evaluated the expression in a previous command. The command LOAD is useful for this purpose in some circumstances.
Command qualifiers for SHOW GRID:
SHOW GRID/I=/J=/K=/L=/X=/Y=/Z=/T=
Displays the coordinates and grid box sizes for the specified axis. Optionally, low and high limits and a delta value may be specified to restrict the range of values displayed. The argument may be an expression.
yes? SHOW GRID/X[=lo:hi:delta] [variable_or_grid]
Example:
yes? SHOW GRID/L=1:12:3 sst[coads_climatology]
SHOW GRID/ALL
Shows the names only of all grids defined.
yes? SHOW GRID/ALL
SHOW GRID/DYNAMIC
Shows the names of dynamic grids that are defined.
yes? SHOW GRID/DYNAMIC
SHOW GRID/XML gridname
Shows the grid information in XML-style format.
yes? USE monthly_navy_winds
yes? SHOW GRID/XML gdn1
<grid name="GDN1">
<xaxis>FNOCX</xaxis>
<yaxis>FNOCY</yaxis>
<taxis>TIME</taxis>
</grid>
Ref Sec33.9.
SHOW LIST
Shows the current states of the LIST command.
yes? SHOW LIST
The qualifier /ALL may be used with this command but exists merely for compatibility reasons and has no effect.
Ref Sec33.10.
SHOW MEMORY
/ALL/FREE/PERMANENT/TEMPORARY
Shows the state of the memory cache.
yes? SHOW MEMORY
Shows the current size of the cache.
Note that the symbol FERRET_MEMORY also contains the current memory size setting:
yes? IF `($ferret_memory) LT 20` THEN SET MEM/SIZ=20
Command qualifiers for SHOW MEMORY:
SHOW MEMORY/ALL
Shows all variables currently cached in memory—permanent and temporary.
SHOW MEMORY/FREE
Shows cache memory and memory table space that remains unused.
Cache memory is organized into "blocks." One block is the smallest unit that any variable stored in memory may allocate. The total number of variables that may be stored in memory cannot exceed the size of the memory table. The "largest free region" gives an indication of memory fragmentation. A typical SHOW MEMORY/FREE output looks as below:
total memory table slots: 150
total memory blocks: 500
memory block size:1600
number of free memory blocks: 439
largest free region: 439
number of free regions: 1
free memory table slots: 149
SHOW MEMORY/PERMANENT
Lists the variables cached in memory and cataloged as permanent. These variables will not be deleted even when memory space is needed. They become cataloged in memory as permanent when the LOAD/PERMANENT command is used.
SHOW MEMORY/TEMPORARY
Lists the variables cached in memory and cataloged as temporary (they may be deleted when memory capacity is needed).
Ref Sec33.11.
Shows the names, states and arguments of the Ferret SET MODE command.
SHOW MODE [partial_mode_name1,name2,...]
Example:
yes? SHOW MODE VERIFY,META
The qualifier /ALL may be used with this command but exists merely for compatibility reasons and has no effect.
Ref Sec33.12.
Shows the current state of SET MOVIE. This state affects FRAME and graphics commands specified with the /FRAME qualifier.
yes? SHOW MOVIE
The qualifier /ALL can be used with this command, but it exists for compatibility purposes only and has no effect.
Ref Sec33.13.
SHOW QUERIES
Queries are a vehicle for communication between Ferret and a stand-alone interface program. They are not supported for general use.
Ref Sec33.14.
Shows the current default region or the named region.
yes? SHOW REGION[/ALL] [region_name]
The region displayed is formatted appropriately for the axes of the last data accessed. For example, suppose the region along the Y axis was specified as Y=5S:5N. Then if the Y axis of the last data accessed is in units of degrees-latitude the Y location is shown as Y=5S:5N but if the Y axis of the last data accessed is "ABSTRACT" then the Y location is shown as Y=-5:5.
Ref Sec33.15.
/ALL
Shows the value of one or more symbols (string variables).
yes? SHOW SYMBOL[/qualifier] [symbol_name]
If no qualifier or symbol name is given then all defined symbols are listed. SHOW SYMBOL will accept partial names such as
yes? SHOW SYMBOL *lab*
MY_X_LABEL = "Sample Number"
LABEL_2 = "Station at 23N"
Parameters
The parameter may be the name of a symbol, with * replacing part of the string as above.
Command qualifiers for SHOW SYMBOL:
SHOW SYMBOL/ALL
Lists all symbols that are defined.
Ref Sec33.16.
SHOW TRANSFORM
Shows the available transformations, including regridding transformations.
yes? SHOW TRANSFORM
Note: This is the most reliable way to view transformations. The output of this command will be current even when this manual is out of date.
The qualifier /ALL may be used with this command but exists merely for compatibility reasons and has no effect.
Ref Sec33.17.
/ALL /DATASET /DIAGNOSTIC /USER
Lists diagnostic or user-defined variables.
SHOW VARIABLES[/qualifier] [partial_name]
Examples:
yes? SHOW VARIABLES !all user-defined variables
yes? SHOW VAR/DIAG Q !all diagnostic vars beginning with Q
Command qualifiers for SHOW VARIABLES:
SHOW VARIABLES/ALL
Lists both diagnostic variables (available for the COX/PHILANDER model) and user-defined variables.
SHOW VARIABLES/DATA_SET
Lists variables associated with the named dataset by DEFINE VARIABLE/DATA_SET=
SHOW VARIABLES/DIAGNOSTIC
This is an unsupported (obsolete) qualifier. It lists "diagnostic" variables available for the COX/PHILANDER model.
SHOW VARIABLES/USER
Lists expressions that have been defined by the user as new variables. This is the default behavior of SHOW VARIABLES with no qualifier.
Ref Sec33.18.
Shows one or more of the currently defined viewports. Omitting an argument gives information on all viewports.
yes? SHOW VIEWPORT [view_name1,view_name2,...]
Example:
yes? DEFINE VIEWPORT/AXES/XLIM=0:0.5/YLIM=0.3:0.8 leftmid
yes? SHOW VIEWPORT left*
name text xlimits ylimits mode
LEFT 1.00 0.00,0.50 0.00,1.00 edges
LEFTMID 0.50 0.00,0.50 0.30,0.80 axes
current viewport is NONE
This command shows the pre-defined viewport LEFT, and our user-defined viewport named LEFTMID. Under Column 1, text, is the setting for scaling the size of text. The xlimits and ylimits columns list the edges of the viewport. Mode takes the value edges for the default setting where the viewport limits include space for margins around the plot axes, or axes if the viewport was defined with the /axes qualifier, indicating that the limits define the location of the plot axes.
The qualifier /ALL may be used with this command but exists merely for compatibility reasons and has no effect.
Ref Sec33.19.
Lists open window numbers and indicates which is the active one.
yes? SHOW WINDOWS
The qualifier /ALL may be used with this command but exists merely for compatibility reasons and has no effect.