Skip to main content
  • Home
  • Documentation
  • FAQ
  • Downloads
  • Support
  • Current Release Notes
  • Ferret Users Guide
    • Users Guide Index
    • Commands Reference
    • 1. Introduction
    • 2. Data Set Basics
    • 3. Variables & Expressions
    • 4. Grids & Regions
    • 5. Animations & Gif Images
    • 6. Customizing Plots
    • 7. Handling String Data Symbols
    • 8. Working with Special Data Sets
    • 9. Computing Environment
    • 10. Converting to NetCDF
    • 11. Writing External Functions
    • Glossary
    • Appendix A: Functions
    • Appendix B: PPLUS Guide
    • Appendix C: Ferret-Specific PPLUS Enhancements
  • Previous Release Notes
  • Tutorials and Demos
    • Ferret Tour
    • DSG files: Discrete Sampling Geometries Demo
    • Ferret sorting demo
    • Fast Fourier Transforms demo
    • Empirical Orthogonal Functions demo
    • Ferret objective analysis demo
    • Ferret Palette Demo
    • Map projections
    • Ferret polygon vector demo
    • Ferret Graticules demo
    • Ferret Polytube Demo
    • Ferret Polymark Demo
    • Ferret Constant-Array demo
    • Ferret land_detail demo
    • COADS Tour
    • Levitus Tour
    • Use OPeNDAP
    • Ferret binary read demo
  • PyFerret
    • PyFerret Downloads and Install
    • What is PyFerret?
    • Why use PyFerret?
    • PyFerret for the Ferret user
    • PyFerret command syntax: quick-start notes
    • PyFerret for the Python user
    • Graphics in PyFerret ?
    • New Ferret functionality
    • PyFerret Python functions and constants
    • PyFerret Python objects and methods
    • Ferret external functions in Python
    • Ferret Fortran external functions
    • PyFerret metadata-and-data dictionaries
  • OPeNDAP
    • OPeNDAP usage in Ferret
    • Use OPeNDAP Demo
    • Test OPeNDAP

Full Index

Full Index

The index for the Users Guide.

Note: it's often helpful to use your browser-search capability (Ctrl-F) here. The search box at the top right returns results only for complete words; a browser search is simpler and more flexible.

* A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Non-alphabetic characters used in command syntax:

* (asterisk) evaluating script arguments

| (vertical bar) list of valid argument values

` (backquote or grave accent) immediate evaluation

" (double quotes)
arguments to scripts
defining title or units
embedded in strings
for missing arguments
SET DATA/VARIABLES="var,..."
string arguments

' (single quotes) reserved variable names

{ } (curly brackets) for constant-arrays

[ ] (square brackets)
for variable context
in expressions
in function arguments

/ (slash) denotes a command qualifier

\ (backslash)
continuation line
escape a reserved character

! (exclamation point) comments

; (semicolon) separates commands

$ (dollar sign)
symbol evaluation
$ppl auto-generated symbols

+ – * / ^ (numeric operators) in expressions

@ (@ notation)
@ as region specifier
@ for regridding
@ for transformations

@ASN regridding transformation

@AVE
regridding transformation
transformation @AVE

@BIN regridding transformation

@CDA transformation nearest neighbor above

@CDB transformation nearest neighbor below

@CIA transformation nearest index above

@CIB transformation nearest index below

@DDB transformation backward derivative

@DDC transformation centered derivative

@DDF transformation forward derivative

@DIN transformation definite integral

@EVNT transformation locates events

@FAV transformation averaging filler

@FLN transformation linear interpolation filler

@FNR transformation nearest neighbor filler

@IIN transformation
regridding
indefinite integral transformation

@ITP interpolation

@LIN regridding transformation

@LOC transformation location of

@MAX
regridding
max value transformation

@MED transformation median

@MIN transformation minimum value

@MOD transformation modulo regridding transformation

Modulo regridding
Discussion
@MODNBD regridding statistics
@MODMAX regridding statistics
@MODMIN regridding statistics
@MODNGD regridding statistics
@MODVAR regridding statistics

@NBD transformation number bad data

@NBIN regridding transformation

@NGD
regridding transformation
transformation

@RSUM transformation running unweighted sum

@SBN transformation binomial smoother

@SBX transformation boxcar smoother

@SHF transformation shift data

@SHN transformation Hanning smoother

@SMN transformation minimum smoother

@SMX transformation maximum smoother

@SPZ transformation Parzen smoother

@STD transformation Standard Deviation

@SUM regridding transformation

@SUM transformation unweighted sum

@SWL transformation Welch smoother

@VAR transformation weighted variance

@WEQ weighted equal

@WGT weights from average or integral

360_DAY calendar

Return to top

A

abbreviating commands

ABS function

abstract expression

abstract variable

ACOS function

add_offset in NetCDF files

attribute for packing data
in NetCDF files
setting scale/offset for var in a netCDF file
RETURN=NC_OFFSET

Aggregation: define an Ensemble, Forecast collection, Time series or Union dataset on the fly

DEFINE DATA/AGGREGATE/E
DEFINE DATA/AGGREGATE/F
DEFINE DATA/AGGREGATE/T
DEFINE DATA/AGGREGATE/U

ALIAS

definition
SHOW ALIAS

aliases for Ferret commands
  
   ALIAS for DEFINE ALIAS
   CLEARMASK for CANCEL DATA/FMASK
   COLUMNS for SET DATA/FORM=DELIMITED
   ENSEMBLE for DEFINE DATA/AGGREGATE/E
   FILE for SET DATA/EZ
   FILL for CONTOUR/FILL
   FLOWLINE for VECTOR/FLOWLINE
   FMASK for SET DATA/FMASK
   FMRC for DEFINE DATA/AGGREGATE/F
   KEYMARK for enabling annotating the ends of colorbars
   LABELfor PPL%LABEL, put a label on a plot
   LET for DEFINE VARIABLE
   PALETTE for PPL SHASET SPECTRUM= Set the palette for subsequent plots
   PATTERN for PPL PATSET PATTERN= Set a pattern for subsequent plots
   PAUSE for MESSAGEQUIT for EXIT
   REGION for SET REGION
   RIBBON for PLOT/RIBBON
   SAVE for LIST/FORMAT=CDF
   SAY for MESSAGE/CONTINUE
   TSERIES for DEFINE DATA/AGGREGATE/T
   UNALIAS for CANCEL ALIAS
   UNION for DEFINE DATA/AGGREGATE/U
   USE for SET DATA/FORMAT=CDF
   VTREE for SHOW VAR/TREE
   WHERE for PPL %WHERE  

ALINE pplus command

ambiguous coordinate message

analysis techniques

curvilinear coordinate data
polygonal coordinates
sigma coordinate data

animations

FRAME
general discussion
on the fly
viewing
outside tools for

ANNOTATE Add labels to plots

ANNOTATE command
/ANGLE
/HALIGN/VALIGN
/NORM/NOUSER/USER
/SIZE
/XPOS/YPOS

anomaly example

append

slab to NetCDF, example
time to NetCDF, example
time steps to NetCDF file, notes about
creating a time axis for variable having no time axis

arguments

quoted
GO script

arrow

text labels
VECTOR command
vectors drawn as arrows

ASCII (text) data

accessing
Fortran formats
integers
output
reading "delimited"
reading, examples
sets of profiles: EXPNDI_BY_Z function
sets of time series: EXPNDI_BY_T function
SET DATA/EZ
writing strings to ascii files

ASIN function: Arcsine

@ASN regridding transformation

aspect ratio:SET WINDOW/ASPECT

ATAN function

ATAN2 function

Attributes of variables, datasets

Attributes discussion
adding new
CANCEL ATTRIBUTE
coordinate variables
DEFINE ATTRIBUTE
define variable from
editing
Ferret access to
global
in output files
inherit from a variable
keywords/syntax
NetCDF attributes, discussion
NetCDF global attributes, discussion
of non-netCDF variables
scale & offset, packing data
SET ATTRIBUTE
SET ATTRIBUTE/LIKE=
SHOW ATTRIBUTE
SHOW DATA/ATT

Autocorrelation

TAUTO_COR function
XAUTO_COR function

Auxiliary Regridding Transformations

AVE

regridding transformation
transformation @AVE

average

@AVE regridding
monthly climatology
over complex regions in space
transformation @AVE

averaging filler: @FAV transformation

axis

axis, definition of
/NOAXIS on plot commands
box size, grid
CANCEL
CANCEL depth setting
CANCEL modulo setting
customizing plot axes
custom time axis, defining
DEFINE AXIS
DEFINE GRID
dynamic
dynamic, definition
formatting plot axes
inheriting
irregular, defining
irregular, in SHOW AXIS
/KEEP_AXISNAMES on SAVE
label, plot axes
limits, plot axes
modulo
monthly climatology, define
monthly, defining
monthly, non-standard calendars
multiple axis plots
NetCDF axis definitions
permuting
plot formats
PLOT/AXES
PPLUS commands
redefining
regular, defining
regular, in SHOW AXIS
removing from plot
RETURN=XAXIS etc.
reversed, in netCDF files
reversing Z axis
seasonal axis
SET AXIS/modulo
transformation
units
values, using

Return to top

B

background color

indices for
options in PPLUS
PyFerret window color

backquote

embedded expressions
order of precedence

backslash syntax: escaping special characters

backward derivative: @DDB transformation

bar charts: script

batch mode

gif output
metafile output
movie making
postscript output
-script
-server
-nodisplay for PyFerret
SET GIFFILE

big-endian

binary data

byte-swapped
output
reading
record structure
SET DATA/EZ

binning

frequency_histogram script
functions scat2grid_bin
, put scattered data into a grid by binning
ts_frequency script

binomial smoother: @SBN transformation

bold

GO bold script
PyFerret SET TEXT/BOLD

borders, land and political boundaries

land.jnl
land_detailed.jnl
fland.jnl
adding custom borders
vland.jnl
vfland.jnl

bounds, axis

NetCDF attribute
NetCDF irregular axes
on SAVE command

box, grid cells

pseudo variables for axes
relation to grid, region

boxcar smoother: @SBX transformation

bullseye: find local min or max

BYTE order

BYTEORDER symbol
byte-swapped files

Return to top

C

calendar

360 day
axis, discussion converting time for NetCDF
default
360 day
axis, discussion
converting time for NetCDF
default
DEFINE AXIS/CALENDAR
grids with calendar axis
GREGORIAN
Proleptic-Gregorian
Modulo regridding, and
MODE CALENDAR
NetCDF attribute
NetCDF conventions
NOLEAP
regridding between
SET AXIS/CALENDAR
specifying time origin
specifying time values
standard calendar
time axes

CANCEL command

CANCEL

CANCEL ALIAS

CANCEL ATTRIBUTE

CANCEL AXIS
/ALL
/DEPTH
/STRIDE

CANCEL DATA
/ALL
/NOERROR

CANCEL EXPRESSION

CANCEL LIST
/ALL
/APPEND
/FILE
/FORMAT
/HEAD
/OUTTYPE
/PRECISION

CANCEL MEMORY
/ALL
/PERMANENT
/TEMPORARY

CANCEL MODE

CANCEL MOVIE

CANCEL NCCACHE

CANCEL PYVAR
/ALL /DATASET

CANCEL REDIRECT

CANCEL REGION
/ALL

CANCEL SYMBOL
/ALL

CANCEL TEXT (PyFerret)
/ALL
/FONT
/COLOR
/ITALIC
/BOLD
/ISIZ

CANCEL VARIABLE
/ALL
/DATASET
/NOERROR

CANCEL V or CAN V abbreviation for CANCEL VIEWPORT

CANCEL VIEWPORT

CANCEL WINDOW
/ALL

case sensitivity

NetCDF variables
user-defined variables
writing to NetCDF

CDA transformation: nearest neighbor above

CDB transformation: nearest neighbor below

CDL file

advanced usage
definition of
for Ferret conversion
sample
using

CF conventions: NetCDF standard

child axis: NetCDF

@CIA transformation

@CIB transformation

climatology

climatological axes
creating
defining custom climatological axis

CLSPLT: pplus command

CMYK: color postscript

COARDS standard

definition
NetCDF standard
non-COARDS files

coastlines

land.jnl
land_detailed.jnl
adding custom borders

collections, data

time series
vertical profiles

color

background, plot
contouring
custom control, lines
custom control, color filled plots
GO tools for
hard copy
in animations
line plots, PLOT/LINE
lines, Ribbon plot to color-by-variable
MODE LINECOLORS
of text, examples
palette
patterns
PPLUS COLOR command
PPLUS line color
PPLUS PEN
PPLUS shading
PPLUS SHASET
PPLUS SHASET PROTECT
PPLUS SHASET RESET

colorbar or colorkey settings

CONTOUR/KEY
FILL/KEY
PLOT/VS/RIBBON/KEY
POLYGON/KEY
SHADE/KEY
WHERE to position
customizing color key with SHAKEY
centered labels on color key
continuous color key
horizontal color key
PyFerret: customizing text on colorbar labels
for contour lines
for lines
customizing key or legend for multi-line plots

columns

LIST/WIDTH=columns
SET DATA/COLUMNS examples
SET DATA/EZ/COLUMNS=
SET DATA/STREAM/COLUMNS=

COLUMNS

alias for SET DATA/FORM=DELIMITED

commands

abbreviated syntax
Commands Reference
continuation
executing a Unix command
SHOW COMMAND
syntax of

command line, Unix

starting Ferret
starting PyFerret
Unix commands

COMMON_YEAR: calendar

compressing data

COMPRESS functions
COMPRESS*_BY functions

concatenation

TCAT
XCAT
YCAT
ZCAT
ECAT
FCAT
addition of strings

confidence interval, plotting: error_bar_demo script

conformability: combining variables on like or different grids

CONPRE, CONPST, CONSET contouring controls

alternative syntax
CONPRE
CONPST
CONSET

constant arrays: list of constants

context

definition
setting the

CONTOUR command

/AXES
/COLOR
/COLOR in PyFerret
/D
/DEGMINSEC
/FILL
/FRAME
/GRATICULE
/HALFSPACE
/HGRATICULE,/VGRATICULE
/HLIMITS
/I /J /K /L/M/N
/KEY
/LEVELS
/LEVELS options
/LINE
/MODULO
/NOAXIS
/NOKEY
/NOLABELS
/OPACITY
/OVERLAY
/PALETTE
/PATTERN
/PEN
/SIGDIG
/SIZE
/SPACING
/TRANSPOSE
/VLIMITS
/X/Y/Z/T/E/F

Contouring

color of contours
controlling labels
curvilinear version
customizing CONTOUR plots
dash controls
demo script
examples
extrema, annotating
label controls
options
pplus controls
settings
spline_tension

converting units: auto-conversion of units

convolution: convolution functions

coordinates

curvilinear coordinate data
in NetCDF file
interpolation
precision
pseudo-variables
RETURN= start,end coord
RETURN=xcoord, ycoord, zcoord, tcoord coordinate variable in DSG dataset
SHOW GRID /X/Y/Z/T/E/F
SHOW GRID of DSG dataset
spacing, NetCDF
underlying grid

correlation

autocorrelation functions TAUTO_COR and XAUTO_COR
FAQ
in correlation_with_students_t_test script
in variance script

cosine

COS function
COSINE(latitude) correction

cross section

along an x-y track
using SAMPLEXY_CLOSEST
using SAMPLEXY_CURV

cross-hatching

PATTERN

curl

centered derivative

curly brackets

curvilinear regridding

CURV_TO_RECT function
CURV-TO-RECT-MAP function

curvilinear coordinates

curvilinear coordinate data
gridded data
plot commands
plot with /MODULO
regridding to curvilinear
regridding to rectilinear
scripts for

CSV files, reading

See reading ASCII "delimited" files
See reading ASCII files, examples

Return to top

D

D= dataset specifier in a context

contour lines
graticule lines
line plots

data

ASCII
CANCEL DATA_SET
checking existence
data set
DEFINE DATA, virtual data sets
editing
examples
EZ
general discussion
label
locating
MC: multi CDF
multi CDF, creating
NetCDF, using
NetCDF, writing
save and restore
SET DATA
SHOW DATA
STATISTICS
TMAP-formatted

DATE1900 function

dates

axis labels
datestring script
DAYS1900 function
DAYS1900TOYMDHMS function
for modulo time axis
format for
i n ASCII files
in external functions
in NetCDF file
in REPEAT loops
ISO 8601 date strings
LON_LAT_TIME_STRING function
MODE CALENDAR
SAMPLET_DATE function
SESSION_DATE
SESSION_TIME

dates: functions to convert dates

TAX_DATESTRING function
TAX_DAY function
TAX_DAYFRAC function
TAX_JDAY function
TAX_MONTH function
TAX_UNITS function
TAX_YEAR function
TAX_YEARFRAC function

DAYS1900 function Days since the start of 1900

DAYS1900TOYMDHMS function Days since the start of 1900 converted to year,minute,day,hour,minute,second

DDB transformation: backward derivative

DDC transformation: centered derivative

DDF transformation:forward derivative

debugging

complex expressions
go tools
SET MODE DIAGNOSTIC
SET MODE IGNORE_ERROR

DEFINE command

DEFINE ALIAS

DEFINE ATTRIBUTE

/DATASET
/OUTPUT
/QUIET
/TYPE
examples and discussion

DEFINE AXIS

/BOUNDS
/CALENDAR
/DEPTH
/EDGES
/FILE
/FROM_DATA
/LIKE
/MODULO
/NAME
/NPOINTS
/T0
/UNITS
/X/Y/Z/T/E/F
Defining monthly or seasonal axis
redefining an axis

DEFINE DATA

/AGGREGATE
/E (ensemble)
ensemble examples
/F (forecast)
/T (timeseries)
/U (union)
/QUIET
/HIDE
defining, member variables as user-defined variables

DEFINE GRID

/FILE
/LIKE
/X/Y/Z/T/E/F

DEFINE PYFUNC

DEFINE REGION

/DEFAULT
/DI/DJ/DK/DL/DM/DN
/DX/DY/DZ/DT/DE/DF
/I/J/K/L/M/N
/X/Y/Z/T/E/F

DEFINE SYMBOL

DEFINE VARIABLE

/BAD=
/DATASET
/LIKE=
/UNITS
User-defined variables

DEFINE VIEWPORT

/AXES
/TEXT
/XLIMITS
/YLIMITS
special symbols for viewports

definite integral: @DIN transformation

degrees

axis style (degrees lon and lat, see modes LONG_LABEL, LATIT_LABEL)
label deg-min (ppl XFOR and ppl YFOR)

delimited data files, CSV files

reading
SET DATA/FORM=DELIMITED

delta function

delta notation; LO:HI:DELTA

demo scripts

density

RHO_UN function
ZAXREPLACE function

depth

DEFINE AXIS/DEPTH
go scripts
SET AXIS/DEPTH
SET MODE DEPTH_LABEL
specifying ranges

derivative

backward @DDB
centered @DDC
forward @DDF
transformations

descriptor file

definition
example
formatting notes
locating
naming
syntax
TMAP-formatted data
tools for creating
see also: TSERIES, define a time series aggregation on the fly

DIAGNOSTIC mode

digitize

digits

dimensions

multi-dimensional expression
NetCDF

direct access: Fortran files

Discrete Sampling Geometries (DSG) datasets

Discussion and examples
DSG-to-grid regridding FAQ
listings: ascii listings
listings: SAVE data
Native plot styles
Non-Native plot styles e.g. to plot a map showig profile or timeseries stations
MODE DSG
output of SHOW DATA
output of SHOW GRID
regridding to DSG
SET DATA/FEATURE=
SET DATA/FMASK= or FMASK
CANCEL DATA/FMASK= or CLEARMASK
Tutorial Script
transformations

divergence

DNCASE function

OPeNDAP (formerly DODS)

.dodsrc file
accessing remote data
caching
for reading HDF
initialization file
locating data
password access
proxy servers
security
sharing data
TEST_OPENDAP function, Test a URL

DSG datasets:
See Discrete Sampling Geometries

drifter data

dynamic axis

dynamic grid

definition
SHOW GRID/DYNAMIC

dynamic height

Return to top

E

ECAT function

ECHO

ELEMENT_INDEX

ELEMENT_INDEX_STR

ELSE

conditional execution
masking
ELIF
ENDIF

embed point data in axis

embedded expressions

immediate mode
with symbols

empirical orthogonal functions

eigenfunctions
EOF_SPACE
EOF_STAT
EOF_TFUNC
EOFSVD_SPACE
EOFSVD_STAT
EOFSVD_TFUNC

endian

Ensemble: define an ensemble on the fly

DEFINE DATA/AGGREGATE/E
ENSEMBLE (alias)
ensemble examples

environment, computing

environment variables

list of Ferret related
listing with Fenv

EOF functions

eigenfunctions
EOF_SPACE
EOF_STAT
EOF_TFUNC
EOFSVD_SPACE
EOFSVD_STAT
EOFSVD_TFUNC
time amplitude fcns

error bars, plotting: error_bar_demo script

errors

generating messages
FER_LAST_ERROR symbol
Host is down
insufficient memory
MODE IGNORE_ERROR
request exceeds memory setting
syntax for generating

escape: special characters in commands

ESEQUENCE function

event mask: EVNT transformation

exclamation mark syntax

existence checking: dataset or URL exists

EXIT Command

/COMMAND_FILE
/CYCLE
/LOOP
/PROGRAM
/PROMPT
/SCRIPT
/TOPYTHON
QUIT

EXP function

EXPNDI_BY function

EXPNDI_BY_M_COUNTS function

EXPNDI_BY_T function

EXPNDI_BY_Z function

EXPNDI_BY_Z_COUNTS function

EXPND_BY_LEN function

EXPND_BY_LEN_STR function

EXPNDI_ID_BY_Z_COUNTS function

export graphics

gif files
gif, batch mode
postscript files
postscript, batch mode
SET GIFFILE

expressions

algebraic
CANCEL EXPRESSION
definition
discussion
SET default context
SHOW EXPRESSION

External Functions

axis inheritance
compute subroutine
custom axes
EF_Util.cmn
example functions
getting EF example code
getting started, writing
inheriting axes
init subroutine
list of included functions
loop indices
reduced axes
result_limits
string arguments
structure of EF
utility functions
working storage
writing your own

extrema

FINDHI function
FINDLO function
transformations @MAX, @MIN

EZ data (ASCII data)

definition
FILE command
missing data markers
reading ASCII (text) files
SET DATA/EZ

Return to top

F

Faddpath

FAV transformation: averaging filler

FCAT function

FC_ISUBSET function

Fdata

Fdescr

Feature Collections: See Discrete Sampling Geometries

Fenv

Ferret environment variables

FER_DATA
FER_DESCR
FER_DIR
FER_DSETS
FER_GO
FER_GRIDS
FER_PALETTE

ferret_paths

Ferret state information

FER_LAST_ERROR
CLOCK_SECS
CURRENT_DATE
CURRENT_TIME
DELTA_CPU
FERRET_MEMORY
FERRET_PLATFORM
FERRET_VERSION
FER_LAST_ERROR
FERRET_MEMORY
FERRET_VERSION
NETCDF_VERSION
PROGRAM_NAME
SESSION_DATE
SESSION_TIME

FFT functions

FFTA (Amplitude)
FFTP (Phase)
FFT_IM (Imaginary)
FFT_RE (Real)
FFT_INVERSE

Fgo

Fgrids

FILE

alias for SET DATA/EZ
See SET DATA/EZ

files

ASCII
ASCII "delimited"
binary
byte-swapped
delimited (spreadsheet)
OPeNDAP (formerly DODS)
L IST
mixed types
NetCDF formatted
reading, demo
real*8
SET DATA
stream
TMAP-formatted

FILL command

CONTOUR/FILL
curvilinear version

FILL_XY function

fill value (_FillValue attribute in netCDF files)

file creation on output to NetCDF
and missing values

filling transformations (fill missing values)

@FAV averaging filler
@FLN linear interpolation
@FNR nearest neighbor filler

FILLPOL polygon command

FILL_XY function

filtering

Lanczos bandpass
lowpass
transformations
with CONVOLVE functions

FINDHI function

FINDLO function

flag (missing value)

FLN transformation linear interpolation filler

FLOATSTR function

flow control (scripts)

ELIF
F
IF-THEN-ELSE
SET MODE IGNORE_ERROR

flowline: VECTOR/FLOW

FMASK alias  for SET DATA/FMASK.
   Define a Feature mask on a DSG dataset

FMRC Forecast Model Run Collection

Define as Ferret aggregation
Working with FMRC grids

FNR transformation: nearest neighbor filler

fonts

Ferret controls
fonts in PyFerret
special symbols (Greek, Math) in labels, PyFerret
show PyFerret font settings
PPLUS commands
PPLUS fonts
pplus symbol fonts

foreach: see REPEAT

forecast dataset (see FMRC above)

data sets
Fortran formats for reading ASCII data
HDF movies
HDF and NetCDF-4 data format
LIST/FORMAT=
MODE ASCII_FONT
MODE LATIT_LABEL
MODE LONG_LABEL
NetCDF data format
NetCDF-4 data format
SET DATA/FORMAT
SET LIST/FORMAT
standardized data

formatting

LIST/FORMAT
LIST/HEADING
numerical output
plot axes
plots

forward derivative: @DDF transformation

Fourier transforms

FFT_INVERSE function
FFTA function
FFTP function

Fpalette

Fprint: Unix command

Fpurge: Clean up files that Ferret creates

FRAME

/FILE=filename
/FORMAT=GIF
/FORMAT=PNG,SVG,PDF,PS
/FORMAT=HDF
/ANNOTATE
/XPIXELS/YPIXELS
/XINCHS/YINCHES
/TRANSPARENT
PyFerret options
movies in GIF format
PLOT/FRAME
SET GIFFILE

FSEQUENCE function

FshowGO

Make listing of GO-script calls
Use with SET REDIRECT

Fsort: Sort unix files Ferret creates

Function

grid-changing
list of functions
SHOW function
string functions
See also: Transformations

Return to top

G

G=, also GX=, GY=, GXY= ...

Regridding syntax

geographic scripts

getting point data into Ferret

GIF image and PNG image

creating gif images
FRAME/FORMAT=GIF
-gif command line switch
PyFerret .png files
SET GIFFILE

GKS

color map
graphic metafile
line bundles
MODE METAFILE
MODE SEGMENTS

gksm2ps

GLOSSARY

GO

/HELP
arguments
demonstration files
file, definition
files
files, running
LAST_GO_FILE
quoted arguments
scripts, included with Ferret
Unix file naming
writing GO scripts

graphics

/SET_UP
hard copy
memory
MODE METAFILE
output controls
viewport

graticule

CONTOUR /GRAT
overlay on plot
PLOT/GRAT
POLYGON/GRAT
SET MODE GRATICULE
SHADE/GRAT

grave accent

embedded expressions
order of precedence

Greek letters in labels

special symbols (Greek, Math) in PyFerret
pplus symbol fonts

GREGORIAN calendar

grid

box size
conformable
default
DEFINE AXIS
DEFINE GRID
Defining
definition
dynamic
dynamic, definition
grid box
of expressions
of pseudo-variables
regridding
RESHAPE function
RETURN=GRID name
SET GRID
staggered
grid-changing functions
gridded data sampled at points

gridding scattered data

defining grid from data
objective analysis
SCAT2GRID_BIN_XY
SCAT2GRID_BIN_XYT
SCAT2GRID_BIN_XYZ
SCAT2GRID_BIN_XYZT
SCAT2GRID_NBIN_XY
SCAT2GRID_NBIN_XYT
SCAT2GRID_NOBS_XY
SCAT2GRIDGAUSS_XY function
SCAT2GRIDGAUSS_XZ function
SCAT2GRIDGAUSS_XT function
SCAT2GRIDGAUSS_YZ function
SCAT2GRIDGAUSS_YT function
SCAT2GRIDGAUSS_ZT function
SCAT2GRIDLAPLACE_XY function
SCAT2GRIDLAPLACE_XZ function
SCAT2GRIDLAPLACE_XT function
SCAT2GRIDLAPLACE_YZ function
SCAT2GRIDLAPLACE_YT function
SCAT2GRIDLAPLACE_ZT function

Return to top

H

Hanning smoother: @SHN transformation

hard copy

creating gif images
Fprint, postscript files
PyFerret FRAME image options
MODE metafile

HDF

creating, single image
HDF-5 and NetCDF-4 data format
movie making
reading, via OPeNDAP
SET MOVIE

help

HELP
Web-based
within Ferret

histograms

frequency_histogram script
histogram-based color levels

HLIMITS

plot qualifier
and modulo operations

hyperslabs; NetCDF

Return to top

I

IF

conditional execution
masking
see also IFV masking
with strings
Define a mask on a Disrete sampling geometries (DSG) dataset

IFV masking: ifValid

IGNORE0 function

images

gif files
gif, batch mode
PyFerret options: PNG, PDF, SVG, PS
postscript files
postscript, batch mode

immediate mode

BAD=
embedded expressions
formatting output of
mathematical expressions
PRECISION=
RETURN=

indefinite integral

indefinite integral
indefinite integral regridding transformation

indices

Pseudo-variables
RETURN= start,end index

inheritance

of attributes
of axes

initialization file

insitu temperature: THETA_FO function

insufficient memory messages

INT function

integral

definite
indefinite
transformations

integration

@DIN definite integral
@IIN indefinite integral
@IIN indefinite integral regridding transformation
over irregular regions

interpolation

@ITP transformation
MODE INTERPOLATE
see also "regridding"

IS_ELEMENT_OF function

IS_ELEMENT_OF_STR function

IS_ELEMENT_OF_STR_N function

ISO 8601 date strings

isopycnal: ZAXREPLACE function

isosurface

@LOC transformation
example

ITP: interpolation transformation

Return to top

J

journal file

GO files
log of Ferret commands
MODE JOURNAL
naming
-nojnl startup
writing

JULIAN calendar

Return to top

K

key

annotating with data min,max
contour and fill plots
FILL/KEY
customizing key or legend for multi-line plots
PLOT/KEY and /NOKEY
PLOT/RIBBON/KEY
POLYGON/KEY
positioning with PPL SHAKEY command
SHADE/KEY
use WHERE to position
on VECTOR plots

KEYMARK alias

keywords, reserved

keywords FAQ

Return to top

L

LABEL command

ANNOTATE command
General discussion "labels" /NOUSER
positioning with mouse

labels

adding
ANNOTATE command
axis
color controls
color controls in Pyferret
contour line
customizing the text
Ferret controls
finding width of
finding label numbers
fonts
fonts in PyFerret
special symbols (Greek, Math) in PyFerret
label with pointing arrow
LABNUM symbols
LABWID function
long labels
MODE ASCII_FONT
MODE CALENDAR
MODE DEPTH_LABEL
MODE LABELS
MODE LATIT_LABEL
MODE LOGO
MODE LONG LABEL
movable labels
multi-line label demo
plot labels
positioning with mouse
PPLUS commands
PyFerret style controls
removing
superscripts, subscripts and backspacing (PPLUS)
Pyferret superscripts and subscripts

LABWID: function, width of label

Lanczos filter

land mass

filled land fland.jnl
filled land on vertical plot vfland.jnl
outline land.jnl
outline land on vertical plot vland.jnl

latitude

axis formatting
COSINE(latitude) correction
region, specifying

layer: Z axis in layers

layout

axes
controlling white space
customizing labels
go tools for
metafile translation
plot layout controls
viewports for multi-panel

least squares

least-squares regression script examples
regression scripts

legend: customizing key or legend for multi-line plots

LET

levels, contour and color levels

general discussion
histogram-based
open-ended
saving the settings
variance-based

limits: Ferret program limits

line

adding contour lines
connecting plotted points
CONTOUR/LINE
hard copy
LINECOLORS mode
line styles
line styles, GO tools
overlaying contours
PLOT/LINE
PLOT/COLOR/THICK
PLOT/COLOR/THICK in PyFerret
POLYGON/LINE
ribbon plots
thickness

LINE: pplus command

linear interpolation filler: @FLN transformation

LIST

/APPEND
/ASGLOBAL
/BOUNDS
/CLOBBER
/D
/DEFLATE
/EDGES
/ENDIAN
/FILE
/FORMAT
/HEAD
/HEADING=ENHANCED
/I /J /K /L/M/N
/ILIMITS /JLIMITS /KLIMITS /LLIMITS/MLIMITS/NLIMITS
/KEEP_AXISNAMES
/NCFORMAT
/NOHEAD
/NOROWLAB
/ORDER
/OUTTYPE
/PRECISION
/QUIET
/RIGID
/SHUFFLE
/SINGLY
/TITLE="title string"
/WIDTH=
/X/Y/Z/T/E/F
/XCHUNK /YCHUNK /ZCHUNK /TCHUNK/ECHUNK/FCHUNK
/XLIMITS /YLIMITS /ZLIMITS /TLIMITS/ELIMITS/FLIMITS
LIST ALINE
LIST SHAKEY
LIST SHASET

lists of constants

little-endian

LN function

LOAD

/D
/I/J/K/L/M/N
/NAME
/PERMANENT
/TEMPORARY
/X/Y/Z/T/E/F

LOC transformation: location of

local extrema

FINDHI function
FINDLO function

location transformation: @LOC

log plot

2-D plots
demo script
PLOT/VLOG/HLOG

logarithmic functions: LN and LOG

Logical operators

AND, OR, ...
with strings

logo

long_name: NetCDF attribute for variables

longitude

region, specifying

LON_LAT_TIME_STRING function

loop

low pass filter

LSL_LOWPASS function

Return to top

M

make_des

map projections

curvilinear coordinate plots
demo script
overlays on
scripts
using scripts

maps

basemap script
ETOPO data sets
land script
overlays using GO tools

masking

IF-THEN-ELSE logic
IFV-THEN-ELSE logic Define a mask on a Disrete sampling geometries (DSG) dataset

mathematical expressions, immediate mode

BAD=
PRECISION=
RETURN=

Mathematical symbols in labels

special symbols (Greek, Math) in PyFerret
pplus symbol fonts

matrix notation

maximum

@MAX transformation
FINDHI function
local mamima
MAX function
MINMAX function

MC data sets, aka descriptor files

creating
definition
tools for creating
see also: TSERIES, define a time series aggregation on the fly

memory

cache, default size
CANCEL MEMORY
insufficient memory
large calculations
loading expressions into
management
-memsize switch
NetCDF
request exceeds memory setting
SET MEMORY
SET MODE SEGMENTS
SHOW MEMORY

Merging netCDF datasets in X, Y, and/or Z

MESSAGE

/CONTINUE
/ERROR
/JOURNAL
/QUIET
alias PAUSE

metafile (Ferret)

hard copy
MODE METAFILE
naming, automatic
specifying a name
translation

minimum

@MIN regridding
@MIN transformation
bullseye.jnl script
FINDLO function
local minima
MIN function
MINMAX function

MINMAX function

MINUTES24 function

MISSING function

missing value flag

get flag
in netCDF files
setting message
setting values

MOD function

MODE

mode: Ferret state
MODE 6D_LAB
MODE ASCII_FONT
MODE CALENDAR
MODE DATE_FORMAT
MODE DEPTH_LABEL
MODE DESPERATE
MODE DIAGNOSTIC
MODE FRUGAL
MODE IGNORE_ERROR
MODE INTERPOLATE
MODE JOURNAL
MODE LABELS
MODE LATIT_LABEL
MODE LINECOLORS
MODE LONG_LABEL
MODE METAFILE
MODE NLEVELS
MODE NODATA_LAB
MODE PPLLIST
MODE REFRESH
MODE SEGMENTS
MODE STUPID
MODE UPCASE_OUTPUT
MODE VERIFY
MODE WAIT
SET MODE
SHOW MODE

MODMAX modulo regridding statistics

MODMIN modulo regridding statistics

MODNGD modulo regridding statistics

MODSUM modulo regridding statistics

modulo

@mod transformation
attribute, NetCDF
axis
axis, DEFINE
axis, definition
length, finding
MOD function
regridding
regridding, definition
subspan length
subspan modulo axis
modulo regridding statistics
MODMIN
MODSUM
MODVAR

month

monthly axis

climatological
creating
creating, non-standard calendar

mouse: WHERE command to get position

movies

animations
creating from gifs

creating
definition

multiple axis plots

Return to top

N

naming

Coordinate Axes, /KEEP_AXISNAMES on SAVE
file version numbers
of external functions
Unix file names
variables, DEFINE VARIABLE
variables, in NetCDF files
variables, renaming

NaN: in NetCDF files

national boundaries

land.jnl
land_detailed.jnl
adding custom borders

NBD transformation: number of bad points

nc2mc Creating descriptor multi-file dataset

ncdump

creating cdl file
examples

ncgen

example
utility

NCO function

NCO_ATTR function

nearest neighbor filler: @FNR transformation

NetCDF

accessing data with USE
append slab to
append time steps
axis attributes
axis definition
bounds attribute
case sensitive names
CDL data initialization
CDL files
child_axis
converting to
coordinates
data set title
data type, when writing
definition
dimensions
disordered coordinates
editing files
editing attributes
global attributes
grid_definition
hyperslabs
KEEP_AXISNAMES on SAVE
LIST/FORMAT=CDF
locating
long_name
missing values
missing values, output
modulo axes
multi-file data sets
multi-file, tools
NaN in
ncatted
NCO operators
NetCDF 4
parent grid
permuted axes, /ORDER qualifier
permuted axis ordering
RETURN=dsettitle
reverse-ordered coordinates
SAVE
slab_max_index
slab_min_index
special axis interpretations
staggered grids
strides
string data
USE
utilities (e.g. ncgen)
variable attributes
variables
variable type, when writing
variables, invalid names
writing to

NGD

regridding transformation
transformation

NLEVELS

NOLEAP calendar

non-gridded data

collections
curvilinear
point data
polygonal
time series
vertical profiles

normal axis

notation: @ notation

NRST: regridding transformation

number of bad points

@NBD transformation

number of good points

@NGD regridding transformation
@NGD transformation

Return to top

O

objective analysis

demo script
See also entries under gridding scattered data and scat2grid* functions

offset

NetCDF attribute
RETURN=NC_OFF
RETURN=USER_OFF
SET VARIABLE/OFFSET=

OPenDAP

.dodsrc file
accessing remote data
caching
for reading HDF
initialization file
locating data
password access
proxy servers
security
sharing data
TEST_OPENDAP function, Test a URL

operator

definition
list of

order of operations instring substitution

ORDER qualifier

for LIST
for SET DATA/FORMAT=CDF (i.e. USE)

output

gif files
gif, batch mode
/FILE= qualifier on LIST command and SET LIST command
/OUTFILE= qualifier on SHOW AXIS, SHOW DATA, SHOW VAR, SHOW GRID and MESSAGE commands
postscript files
postscript, batch mode

overlay

CONTOUR/OVERLAY
overlay tools (scripts)
PLOT/OVERLAY
POLYGON/OVERLAY
SHADE/OVERLAY
VECTOR/OVERLAY
WIRE/OVERLAY

Return to top

P

P= or PREC= abbreviation for PRECISION=

packed netCDF data

setting scale/offset for var in a netCDF file
NetCDF output
RETURN=NC_SCALE
RETURN=NC_OFFSET

palette

by_level
by_percent
by_value
CONTOUR/PALETTE
creating
directory
files in $FER_PALETTE
locating files: Fpalette
PALETTE command
POLYGON/PALETTE
restoring default
scripts
SHADE/PALETTE
testing

panel: See viewport

parent grid: NetCDF

Parzen smoother: @SPZ transformation

password access to URLs

pattern

CONTOUR/PATTERN=
demo script
PATTERN command
POLYGON/PATTERN=
SHADE/PATTERN=

pause: MESSAGE command

PEN : PPLUS commands

performance (See also entries under memory) initializing NetCDF file

permutation: of axes on input

PLOT Drawing line plots

/ALONG
/AXES
/COLOR
color-by-variable, see /RIBBON
/D
/DEGMINSEC
/DASH
/FAST
/FRAME
/GRATICULE
/HALFSPACE
/HGRATICULE,/HGRATICULE
/HLIMITS
/HLOG
/I/J/K/L/M/N
/KEY=TITLE for the legend on multi-line plots
/KEY for the colorbar on ribbon plots
/LEVELS
/LINE
/NOKEY
/NOLABELS
/NOYADJUST
/OVERLAY
/PALETTE
/RIBBON
/SET_UP
/SIZE
/SKIPSYM
/STEP
/SYMBOL
/THICKNESS
/TITLE
/TRANSPOSE
/VLIMITS
/VLOG
/VS
/X/Y/Z/T/E/F
lines, controlling color and thickness
lines, customizing key or legend
log plots
symbols, controlling size and color

plot file name

batch, metafile output
batch, postscript output
PLTNME pplus command
SET MODE METAFILE:name

plot output files<

gif files
gif, batch mode
postscript files
postscript, batch mode
PyFerret options

PLOTUV

PLTNME PPLUS command

Point-data Collections: See Discrete Sampling Geometries

point data structure

political boundaries

land.jnl
land_detailed.jnl
adding custom borders

POLYGON

/AXES
/COLOR
/COLOR/THICKNESS in PyFerret
/COORD_AX
/D
/FILL
/FRAME
/HGRATICULE,/VGRATICULE
/HLIMITS
/HLOG
/I/J/K/L/M/N
/KEY
/LEVELS
/LINE
/MODULO
/NOKEY
/NOLABELS
/OVERLAY
/SET_UP
/THICKNESS
/TITLE
/TRANSPOSE
/VLIMITS
/VLOG
/X/Y/Z/T/E/F
log axes
POLYMARK script
POLYMARK script demo
POLYSHAPE script
scripts

polygon vector: poly_vec_demo.jnl

polymark script

portrait orientation

Fprint option
GO scripts
metafile translation

postscript

ferret -batch option
Fprint command
gksm2ps command
MODE METAFILE
postscript from PyFerret

potential temperature: THETA_FO function

PPLUS

/RESET
axis commands
command format
Ferret Enhancements Guide
for plot customization
labels
MODE ASCII_FONT
special symbols
string editing tools
syntax
time axes
Users Guide

precision

coordinates
in embedded expressions
LIST/PREC=
of floating-point variables

printing: hard copy

Profile Collections

See Discrete Sampling Geometries
profile collection structure; getting profile data into Ferret

PROGRAM_NAME symbol

Proleptic-Gregorian calendar

projection

curvilinear coordinates
map projections
map projections & curvilinear coordinates
mp_mask
overlays
polar stereographic
sigma coordinates
x_page, y_page

pseudo-variable

definition
in NetCDF files
list of

PT_IN_POLY function: flag points within a polygon

Punctuation

* (asterisk)
evaluating script arguments

| (vertical bar)
list of valid argument values

` (backquote or grave accent)
immediate evaluation

" (double quotes)
arguments to scripts
defining title or units
embedded in strings
for missing arguments
SET DATA/VARIABLES="var,..."
string arguments

' (single quotes)
reserved variable names

{ } (curly brackets)
for constant-arrays

[ ] (square brackets)
for variable context
in expressions
in function arguments

/ (slash)
denotes a command qualifier

\ (backslash)
continuation line
escape a reserved character

! (exclamation point)
comments

; (semicolon)
separates commands

$ (dollar sign)
symbol evaluation
$ppl auto-generated symbols

+ – * / ^ (numeric operators)
in expressions
PyFerret

PyFerret SET WINDOW options

/ANTIALIAS
/NOANTIALIAS
/COLOR
/OPACITY
/THICKEN
/OUTLINE
PyFerret background window color
/SCALE
/TEXTPROM
/XINCH/YINCH
/XPIXEL/YPIXEL
/QUALITY
/ENGINE
/WMARK
/WMSCALE
/WMOPAC
/WMXLOC
/WMYLOC

PyFerret SET TEXT font and text style controls

/BOLD
/COLOR
/FONT
/ISIZ
/ITALIC
customizing sub-groups of text in PyFerret
PyFerret fonts
special symbols (Greek, Math) in PyFerret
show PyFerret font settings

PyFerret SHOW TEXT for font and text settings

PyFerret CANCEL TEXT for font and text settings

/ALL
/FONT
/COLOR
/ITALIC
/BOLD
/ISIZ

PyFerret image output formats: PyFerret FRAME options

PyFerret Color and thickness settings

CONTOUR/COLOR/THICK
PLOT/COLOR/THICK
POLYGON/COLOR/THICKNESS
VECTOR/COLOR/THICKNESS

PyFerret functions: DEFINE PYFUNC

PyFerret variables: CANCEL PYVAR

PyFerret to Python: EXIT /TOPYTHON

PyFerret PROGRAM_NAME symbol

Return to top

Q

qualifiers

definition
string substitution

QUERY: in GO tools

QUIET

QUIT : alias for EXIT

quotes: back quotes

immediate evaluation

quotes: double quotes

arguments to scripts
defining title or units
embedded in strings
for missing arguments
SET DATA/VARIABLES="var"
string arguments

quotes: single quotes

reserved variable names

Return to top

R

R= or RET= abbreviation for RETURN=

random number generator

RANDN function
RANDU function

reading data files

ASCII delimited files
ASCII files
direct access
FORTRAN-structured
NetCDF
unformatted data

reading scattered data

record axis

record structure : FILE command

RECT_TO_CURV function

rectangle: draw rectangle on a plot

redirection

pipe a script into Ferret
CANCEL REDIRECT
SET REDIRECT

Reduced axes

region Specifying a region in time or space

CANCEL
DEFINE
definition
named
pre-defined
save and restore
SET
SHOW
specifying with @
region (irregular)

regression scripts
least-squares regression script example

regridding

   definition
   demo script
  
Regridding transformations @ASN, @AVE, @LIN, @MAX, @MIN, @NGD, @NRST, @SUM, @VAR, @XACT
   Modulo regridding
   Modulo regridding statistics: @MODMAX, @MODMIN, @MODNGD, @MODSUM, @MODVAR
   DSG-to-grid regridding FAQ
   regridding gridded data to DSG
   curvilinear data

request exceeds memory setting

relative version

GO
numbers
Unix file naming

Renaming variables

REPEAT

/ANIMATE
/I/J/K/L/M/N
/LOOP=
/NAME
/RANGE
/X/Y/Z/T/E/F
exiting from loops
in making animations

reserved keywords

reserved keywords FAQ

RESHAPE function

RETURN=

BAD flag
CALENDAR
coordinates of result
Coordinate variables for DSG data
data set information
DEFINED
DSET
DSETNUM
DTYPE
embedded expressions
GRID name
IAXIS (also JKLMN)
IEND (also JKLMN)
ISIZE (also JKLMN)
isReady
ISTART (also JKLMN)
IUNITS (also JKLMN)
NC_OFFSET
NC_SCALE
SHAPE
SIZE
STATUS
T0 (time origin)
TITLE of variable
TMOD
UNITS of variable
USER_OFFSET
USER_SCALE
XEND (also YZTEF)
XMOD
XCOORD (also Y,Z,T) Coordinate variables from DSG dataset
XSTART (also YZTEF)

Reversed axis

reverse on input
reverse-ordered coordinates in NetCDF files
SET AXIS/DEPTH

RGB: color postscript

RGB mapping

by level
by value
percent

RHO_UN function

RIBBON PLOTS 1-D plot colored by variable

/FAST
/KEY
/LEVELS
/PALETTE

rivers: land_detailed.jnl

RSUM transformation

running unweighted sum
@RSUM transformation

Return to top

S

SAMPLEI function

SAMPLEI_MULTI function and J, K, K

SAMPLEIJ function

SAMPLEJ function

SAMPLEK function

SAMPLEL function

SAMPLET_DATE function

defined
examples

SAMPLEXY function

function definition
further examples

SAMPLEXY_CURV_AVG

SAMPLEXY_CURV_NRST

SAMPLEXYT function

SAMPLEXYT_NRST function

SAMPLEXY_CURV_NRST

SAMPLEXYZ function

SAMPLEXYZT function

SAMPLEXZ function

SAMPLEYZ function

sampling (See also above entries)

of string arrays
scattered sampling

scripts demonstrating sampling

SAVE (alias for LIST/FORMAT=cdf)

attribute control
data types (see also TYPE)
history attribute
/KEEP_AXISNAMES on SAVE
NetCDF-4 formatted files
notes
packed data
see LIST
upcase_output

SAY

alias for MESSAGE/CONTINUE
examples

SBN transformation: binomial

SBX transformation: boxcar smoother

scale

attribute for packing data
NetCDF attribute
RETURN=NC_SCALE
scale_factor in NetCDF files
setting scale/offset for var in a netCDF file

Scattered data, gridding

defining grid from data
objective analysis
SCAT2GRID_BIN_XYT
SCAT2GRID_NBIN_XYT
SCAT2GRID_NOBS_XY
SCAT2GRIDGAUSS_XY function
SCAT2GRIDGAUSS_XZ function
SCAT2GRIDGAUSS_XT function
SCAT2GRIDGAUSS_YZ function
SCAT2GRIDGAUSS_YT function
SCAT2GRIDGAUSS_ZT function
SCAT2GRIDLAPLACE_XY function
SCAT2GRIDLAPLACE_XZ function
SCAT2GRIDLAPLACE_XT function
SCAT2GRIDLAPLACE_YZ function
SCAT2GRIDLAPLACE_YT function
SCAT2GRIDLAPLACE_ZT function

scatterplot

scattered sampling

script

-script startup mode

scripts

GO files
writing

seasonal axis

section, cross

along an x-y track
using SAMPLEXY_CLOSEST
using SAMPLEXY_CURV
see also SAMPLEXY_CURV_AVG
see also SAMPLEXY_CURV_NRST

segments: MODE SEGMENTS

SEPARATE function

server startup mode

SET

SET ATTRIBUTE
/LIKE
/OUTPUT
/TYPE
examples and discussion

SET AXIS

/CALENDAR=
/MODULO
/OFFSET
/REGULAR
/STRIDE
/T0=
/UNITS=

SET DATA

/DELIMITER
/EZ/COLUMNS
/FORMAT
/FORMAT=CDF
/FORMAT=DELIMITED
/FORMAT=DESCRIPTOR
/FORMAT=FORTRAN format
/FORMAT=FREE
/FORMAT=STREAM
/GRID
/ORDER
/REGULART
/RESTORE
/SAVE
/SKIP
/SWAP
/TITLE
/TYPE
/TYPE for ASCII file
/VARIABLES
ASCII data examples
data set basics
Fortran binary data
NetCDF files
stream files

SET EXPRESSION

SET GIFFILE

SET GRID

/RESTORE
/SAVE
and curvilinear data

SET LIST

/APPEND
/DEFLATE
/ENDIAN
/FILE
/FORMAT
/HEAD
/NCFORMAT
/OUTTYPE
/PRECISION
/SHUFFLE
/XCHUNK/YCHUNK/ZCHUNK/TCHUNK/ECHUNK/FCHUNK

SET MEMORY

SET MODE

/LAST
ASCII_FONT
CALENDAR
DEPTH_LABEL
DESPERATE
DIAGNOSTIC
FRUGAL
GRATICULE
IGNORE_ERROR
INTERPOLATE
JOURNAL
LABELS
LATIT_LABEL
LOGO
LONG_LABEL
METAFILE
NLEVELS
REFRESH
SEGMENTS
STUPID
VERIFY
WAIT

SET MOVIE

SET NCCACHE

SET REDIRECT

/APPEND
/CLOBBERa>
/FILE
/JOURNAL
/TEE

SET REGION

/DI/DJ/DK/DL/DM/DN
/DX/DY/DZ/DT/DE/DF
/I/J/K/L/M/N
/X/Y/Z/T/E/F

SET TEXT Font and text style controls for PyFerret

/BOLD
/COLOR
/FONT
/ISIZ
/ITALIC
settings for text groupings
show PyFerret font settings
special symbols (Greek, Math) in PyFerret

SET VARIABLE

/BAD
/GRID
/NAME
/OFFSET
/OUTTYPE
/TITLE
/SCALE=
/UNITS

SET V abbreviation for SET VIEWPORT

SET VIEWPORT

SET WINDOW

/ASPECT
/CLEAR
/LOCATION
/NEW
/SIZE
/TITLE

SET WINDOW options for PyFerret

/ANTIALIAS
/NOANTIALIAS
/COLOR
/OPACITY
/THICKEN
/OUTLINE
/SCALE
/TEXTPROM
/XINCH/YINCH
/XPIXEL/YPIXEL
/QUALITY
/ENGINE

settings on startup

/XINCH/YINCH
PPLUS and Ferret settings

setup: /SET_UP qualifier for plot calls

setting up to run Ferret

SHADE

/AXES
/D
/DEGMINSEC
/FRAME
/GRATICULE
/HALFSPACE
/HGRATICULE,/VGRATICULE
/HLIMITS
/I/J/K/L/M/N
/KEY
/LEVELS
/LEVELS options
/MODULO
/NOAXIS
/NOKEY
/NOLABELS
/OPACITY
/OVERLAY
/PALETTE
/SET
/TITLE
/TRANSPOSE
/VLIMITS
/X/Y/Z/T/E/F
curvilinear version

SHAKEY

CONTOUR/KEY
example
POLYGON/KEY
pplus command syntax
SHADE/KEY

shape (of variable)

Shapefiles

PyFerret Shapefile Functions
FAQ, Using Shapefiles in PyFerret

SHASET

pplus command
pplus SHASET PROTECT
pplus SHASET RESET

SHF transformation

shift data
for string arrays

shift transformation

@SHF
for string arrays

SHN transformation: Hanning smoother

SHOW

/ALL

SHOW ALIAS

SHOW ATTRIBUTE

SHOW AXIS
/ALL
/I/J/K/L/M/N/X/Y/Z/T/E/F
/XML/OUTFILE/APPEND/CLOBBER

SHOW COMMANDS

SHOW DATA
/ATTRIBUTES
/BRIEF
/MEMBERS /FULL
/HIDDEN
/VARIABLES
/XML
/OUTFILE/APPEND/CLOBBER

SHOW EXPRESSION

SHOW FUNCTION

SHOW GRID
/ALL
/DYNAMIC
/I/J/K/L/M/N
/X/Y/Z/T/E/F
/XML
/OUTFILE/APPEND/CLOBBER

SHOW GRID of DSG dataset

SHOW LIST
/ALL

SHOW MEMORY
/ALL
/DIAGNOSTIC
/FREE
/PERMANENT
/TEMPORARY

SHOW MODE
/ALL

SHOW MOVIE

SHOW NCCACHE

SHOW QUERIES

SHOW REGION

SHOW SYMBOL

SHOW TEXT
PyFerret text and font settings

SHOW TRANSFORM
/ALL

SHOW VARIABLES
/ALL
/DATA
/DIAGNOSTIC
/USER
/TREE
/XML/OUTFILE/APPEND/CLOBBER

SHOW VIEWPORT
/ALL

SHOW WINDOWS
/ALL

sigma coordinate data

definition
ZAXREPLACE function

SIN function

size: RETURN= # points, variable

slab_max_index: NetCDF

smoothing

contour lines
transformations, general
transformations, smoothing
with CONVOLVE functions

sorting

SORTI function
SORTJ function
SORTK function
SORTL function
SORTM function
SORTN function
SAMPLEI function
SAMPLEIJ function
SAMPLEJ function
SAMPLEK function
SAMPLEL function
SAMPLEM function
SAMPLEN function

SPAWN

execute unix commands
return a string variable
SPAWN function

special characters

escaping, in commands
special data

spreadsheet data: reading Delimited files

SPZ transformation: Parzen

square brackets

for variable context
in expressions
in function arguments

square root

staggered grids

NetCDF

STANDARD calendar

standard deviation

starting Ferret

starting PyFerret

startup file state (Ferret state)

in go tools
SET GRID
SET MODE

statistical analysis: demo script

statistics

pyFerret statistics functions from SciPy:

STATS_CHISQUARE (PyFerret function)
the chi-square test statistic

STATS_FIT (PyFerret function)
parameters for a probability distribution that best fit

STATS_KSTEST1 , STATS_KSTEST2 (PyFerret functions)
Two-sided Kolmogorov-Smirnov tests

STATS_LINREGRESS (PyFerret function)
the slope, intercept, and correlation coefficient (r) for a linear regression.

STATS_PEARSONR (PyFerret function)
Pearson correlation coefficient between two samples of data.

STATS_PERCENTILESOFSCORES (PyFerret function)
interpolated percentiles (0-100) through a sample for given scores

STATS_PROBPLOTVALS (PyFerret function)
the order statistic medians, ordered response data for indicated distribution

STATS_STATS (PyFerret function)
the unweighted mean, variance, skew, and excess kurtosis

STATS_SCORESATPERCENTILES (PyFerret function)
interpolated scores (values) that are given percentiles

STATS_SPEARMANR (PyFerret function)
Spearman's rank correlation coefficient between two samples of data

STATS_TTEST1, STATS_TTEST2IND, STATS_TTEST2REL (PyFerret functions)
the two-sided T-test statistic functions

STATS_ZSCORE (PyFerret function)
the standard scores for data values relative to a normal distribution with same mean and variance as the data.

STATS_HISTOGRAM (PyFerret function)
the unweighted histogram bin counts for all defined data values.

Generic statistical functions applying to probability distributions:

STATS_HELPER(PDNAME) (PyFerret function)
Help on probability distribution names or parameters

STATS_CDF (PyFerret function)
cumulative distribution function

STATS_ISF (PyFerret function)
inverse survival function

STATS_PDF (PyFerret function)
probability density function values for a continuous probability distribution

STATS_PMF (PyFerret function)
probability mass function values for a discrete probability distribution

STATS_PPF (PyFerret function)
percent point function values for a probability distribution

STATS_SF (PyFerret function)
survival function values for a probability distribution

STATS_RVS (PyFerret function)
random variates for a probability distribution

Beta distribution functions: (PyFerret functions)
STATS_BETA_CDF, STATS_BETA_ISF, STATS_BETA_PDF, STATS_BETA_PPF, STATS_BETA_SF, STATS_BETA_RVS

Binomial distribution functions (PyFerret functions)
STATS_BINOM_CDF, STATS_BINOM_ISF, STATS_BINOM_PMF, STATS_BINOM_PPF, STATS_BINOM_SF, STATS_BINOM_RVS

Cauchy distribution functions (PyFerret functions)
STATS_CAUCHY_CDF, STATS_CAUCHY_ISF, STATS_CAUCHY_PDF, STATS_CAUCHY_PPF, STATS_CAUCHY_SF, STATS_CAUCHY_RVS

Chi distribution functions (PyFerret functions)
STATS_CHI_CDF, STATS_CHI_ISF, STATS_CHI_PDF, STATS_CHI_PPF, STATS_CHI_SF, STATS_CHI_RVS

Chi-square distribution functions (PyFerret functions)
STATS_CHI2_CDF, STATS_CHI2_ISF, STATS_CHI2_PDF, STATS_CHI2_PPF, STATS_CHI2_SF, STATS_CHI2_RVS

Exponential distribution functions (PyFerret functions)
STATS_EXPON_CDF, STATS_EXPON_ISF, STATS_EXPON_PDF, STATS_EXPON_PPF, STATS_EXPON_SF, STATS_EXPON_RVS

Exponentiated-Weibull distribution functions (PyFerret functions)
STATS_EXPONWEIB_CDF, STATS_EXPONWEIB_ISF, STATS_EXPONWEIB_PDF, STATS_EXPONWEIB_PPF, STATS_EXPONWEIB_SF, STATS_EXPONWEIB_RVS

Fisher (F) distribution functions (PyFerret functions)
STATS_F_CDF, STATS_F_ISF, STATS_F_PDF, STATS_F_PPF, STATS_F_SF, STATS_F_RVS

Gamma distribution functions (PyFerret functions)
STATS_GAMMA_CDF, STATS_GAMMA_ISF, STATS_GAMMA_PDF, STATS_GAMMA_PPF, STATS_GAMMA_SF, STATS_GAMMA_RVS

(Shifted-)geometric distribution functions (PyFerret functions)
STATS_GEOM_CDF, STATS_GEOM_ISF, STATS_GEOM_PM, STATS_GEOM_PPF, STATS_GEOM_SF, STATS_GEOM_RVS

Hypergeometric distribution functions (PyFerret functions)
STATS_HYPERGEOM_CDF, STATS_HYPERGEOM_ISF, STATS_HYPERGEOM_PMF, STATS_HYPERGEOM_PPF, STATS_HYPERGEOM_SF, STATS_HYPERGEOM_RVS

Inverse-gamma distribution functions (PyFerret functions)
STATS_INVGAMMA_CDF, STATS_INVGAMMA_ISF, STATS_INVGAMMA_PDF, STATS_INVGAMMA_PPF, STATS_INVGAMMA_SF, STATS_INVGAMMA_RVS

Laplace distribution functions (PyFerret functions)
STATS_LAPLACE_CDF, STATS_LAPLACE_ISF, STATS_LAPLACE_PDF, STATS_LAPLACE_PPF, STATS_LAPLACE_SF, STATS_LAPLACE_RVS

Log-normal distribution functions (PyFerret functions)
STATS_LOGNORM_CDF, STATS_LOGNORM_ISF, STATS_LOGNORM_PDF, STATS_LOGNORM_PPF, STATS_LOGNORM_SF, STATS_LOGNORM_RVS

Negative-binomial distribution functions (PyFerret functions)
STATS_NBINOM_CDF, STATS_NBINOM_ISF, STATS_NBINOM_PMF, STATS_NBINOM_PPF, STATS_NBINOM_SF, STATS_NBINOM_RVS

Normal distribution functions (PyFerret functions)
STATS_NORM_CDF, STATS_NORM_ISF, STATS_NORM_PDF, STATS_NORM_PPF, STATS_NORM_SF, STATS_NORM_RVS

Pareto distribution functions (PyFerret functions)
STATS_PARETO_CDF, STATS_PARETO_ISF, STATS_PARETO_PDF, STATS_PARETO_PPF, STATS_PARETO_SF, STATS_PARETO_RVS

Poisson distribution functions (PyFerret functions)
STATS_POISSON_CDF, STATS_POISSON_ISF, STATS_POISSON_PMF, STATS_POISSON_PPF, STATS_POISSON_SF, STATS_POISSON_RVS

Students-T distribution functions (PyFerret functions)
STATS_T_CDF, STATS_T_ISF, STATS_T_PDF, STATS_T_PPF, STATS_T_SF, STATS_T_RVS

Discrete-uniform (random integer) distribution functions (PyFerret functions)
STATS_RANDINT_CDF, STATS_RANDINT_ISF, STATS_RANDINT_PMF, STATS_RANDINT_PPF, STATS_RANDINT_SF, STATS_RANDINT_RVS

Uniform distribution functions (PyFerret functions)
STATS_UNIFORM_CDF, STATS_UNIFORM_ISF, STATS_UNIFORM_PDF, STATS_UNIFORM_PPF, STATS_UNIFORM_SF, STATS_UNIFORM_RVS

Weibull distribution functions (PyFerret functions)
STATS_WEIBULL_CDF, STATS_WEIBULL_ISF, STATS_WEIBULL_PDF, STATS_WEIBULL_PPF, STATS_WEIBULL_SF, STATS_WEIBULL_RVS

regridding statistics

STATISTICS command
/D
/I/J/K/L/M/N
/X/Y/Z/T/E/F
/BRIEF

stick plot

PLOTUV command
stick_vectors script

STRCMP function

stream files

stream format data

streamline: relation to FLOWLINE

strides

"native"
applied to all axes
netCDF discussion
offset

string variables

arrays of
changing case
comparing strings
concatenating
converting to float
FLOATSTR function
from Unix commands
functions for strings
LABWID function
length, getting
logical operators
NetCDF I/O
order of precedence
reading from ascii files
regridding arrays
writing strings
sampling functions
sampling functions
STRCAT function
STRFLOAT function
STRINDEX function
STRLEN function
STRRINDEX function
SUBSTRING function

strings

arguments to go tools
arguments, containing quotes
editing, PPLUS functions
function arguments
IF-THEN-ELSE

structured files: FORTRAN structured

subroutines (scripts)

subsampling to points

subsampling to profiles

subscript (array indexing)

Students-T distribution functions (PyFerret-only functions)
STATS_T_CDF, STATS_T_ISF, STATS_T_PDF, STATS_T_PPF, STATS_T_SF, STATS_T_RVS
STUDENT_T_CUTOFF function

subplot: See viewport

subscripts and superscripts, in labels

PPLUS/ Classic Ferret
Pyferret

subspan modulo

axes
comparing datasets
modulo length

SUBSTRING function

STRINDEX function
STRRINDEX function

SUM

regridding transformation
unweighted sum

SWL transformation: Welch smoother

symbol: Ferret string-variable symbols

CANCEL SYMBOL
commands for
DEFINE SYMBOL
editing
SHOW SYMBOLS

symbols, special Automatically defined

CLOCK_SECS
CURRENT_DATE
CURRENT_TIME
DELTA_CPU
FER_LAST_ERROR
FERRET_MEMORY
FERRET_VERSION
FER_LAST_ERROR
LAST_GO_FILE
NETCDF_VERSION
PPLUS symbols
PROGRAM_NAME
SESSION_DATE
SESSION_TIME
SPAWN_OK
SPAWN_STATUS
XPIXEL, YPIXEL

symbol: Plot-marks

PLOT/SYMBOL=
pplus symbol fonts
PyFerret named symbols
PyFerret named symbols, defining custom
special symbols (Greek, Math) in PyFerret
script to show all plot symbols

syntax

commands
examples
qualifiers
region
regridding
transformation
variables

Return to top

T

TAN function

TAUTO_COR function

TAX_DATESTRING function

TAX_DAY function

TAX_DAYFRAC function

TAX_JDAY function

TAX_MONTH function

TAX_UNITS function

TAX_YEAR function

TAX_YEARFRAC function

Taylor diagrams: script

TBOX

TBOXHI

TBOXLO

TCAT function

Text data, reading:

See entries under ASCII data

text on plots

color controls
color controls in Pyferret
fonts
fonts in Pyferret
special symbols (Greek, Math) in PyFerret
show PyFerret font settings
reading from ascii file
SET MODE ASCII_FONT
style of plot labels
text style in Pyferret
symbol editing

THETA_FO function

three-dimensional plot: WIRE

tic marks

customizing
default
on time axis: See TXLINT, TXNMTC
pplus controls, for time axis
pplus controls, for X, Y axes

time

axis: discussion
axis: MODE CALENDAR
axis: NetCDF REGULART
convert date to days, hrs, min,
convert time string to minutes
convert tstep to day of month
convert tstep to day frac
convert tstep to day-of-year
convert tstep to month
convert tstep to string
convert tstep to year
convert tstep to year frac
converting times for NetCDF files
converting times to numbers
create time axis when var has none (timestamp)
ISO 8601 date strings
non-Gregorian calendar
output formatting
overlaying symbols on time plot
return time units
RETURN= T0
RETURN=TUNIT
SESSION_TIME
specifying time at T0
specifying time region

timestamp: defining time axis for variable with no time axis

Timeseries Collections: See Discrete Sampling Geometries

time series

locating files
scripts for

See timeseries data types Discrete Sampling Geometries discussion

time series analysis

FFT_IM function
FFT_RE function
TAUTO_COR function

title

CONTOUR/TITLE
data set, RETURN
data set, setting
defining variable title
NetCDF "title" attribute
plot title
PLOT/TITLE
SET DATA/TITLE
SET VAR/TITLE
SHADE/TITLE
VECTOR/TITLE
WIRE/TITLE

Trajectory Collections: See Discrete Sampling Geometries
 

transect

scripts
using SAMPLEXY
using SAMPLEXY_CLOSEST
using SAMPLEXY_CURV

transformation

axis
definition
examples
general information
regridding
SHOW

transformations, list of

@AVE average
@CDA closest distance above
@CDB closest distance below
@CIA closest index above
@CIB closest index below
@DDB backward derivative
@DDC centered derivative
@DDF forward derivative
@DIN definite integral
@EVNT event mask
@FAV averaging filler
@FLN linear interpolation filler
@FNR nearest neighbor filler
@IIN indefinite integral
@LOC location of
@MAX maximum value
@MIN minimum value
@NBD number of bad points
@NGD number of good points
@RSUM running unweighted sum
@SBN binomial smoother
@SBX boxcar smoother
@SHF shift data
@SHN Hanning smoother
@SPZ Parzen smoother
@SUM unweighted sum
@SWL Welch smoother
@VAR weighted variance
@WEQ weighted equal

transparency

FRAME/TRANSPARENT
SET WINDOW/OPACITY
FILL/OPACITY
SHADE/OPACITY
(see also the /OPACITY qualifier on the plot commands CONTOUR, PLOT, POLYGON, VECTOR, WIRE)

TRANSPOSE function

trend

least-squares regression script
regression scripts

trigonometric functions

SIN, COS, TAN, ASIN, ACOS, ATAN, ATAN2

TSEQUENCE function

TSERIES: define a timeseries on the fly

DEFINE DATA/AGGREGATE/T

TSERIES (alias)

TYPE

data type when reading ASCII files
data type when writing NetCDF Files
SET LIST/OUTTYPE= for netCDF output
SET VAR/OUTTYPE= for netCDF output

Return to top

U

Udunits package

UNALIAS

unformatted files

Union aggregations, virtual datasets on the fly: DEFINE DATA/U

units

axis
in transformations
RETURN=UNIT (string)
SET VARIABLE/UNITS

Unix

command line switches
PyFerret command line switches
environment variables
executing a Unix command
setting up to run Ferret
Unix tools

unmapped windows

unweighted sum

@SUM transformation
transformation @RSUM
transformation @SUM

upper/lower case

UPCASE function
UPCASE_OUTPUT mode

USE

SET DATA/FORMAT=CDF

USER

utilities

NetCDF utilities
Unix tools

Return to top

V

Variable

abstract expressions
abstract variable, using
CANCEL
conformable
default
DEFINE
defining new variables
file variables
global
local
missing value flag
missing values in user-defined
names, DEFINE VARIABLE
names, in NetCDF file
NetCDF
pseudo-
SET
SET DATA_SET/VARIABLE
SHOW
syntax
user-defined

variance

go tool for
transformation @VAR
variance-based color levels

VECTOR

/ASPECT
/AXES
/COLOR
/COLOR/THICKNESS in PyFerret
/D
/DENSITY
/FLOWLINE
/FRAME
/GRATICULE
/HGRATICULE,/VGRATICULE
/HLIMITS
/I/J/K/L/M/N
/KEY
/LENGTH
/MODULO
/NOAXIS
/NOKEY
/NOLABELS
/OVERLAY
/PEN
/SET_UP
/TITLE
/TRANSPOSE
/VLIMITS
/X/Y/Z/T/E/F
/XSKIP
/YSKIP
as filled polygons
curvilinear version
key, positioning
PPL$VECLEN symbol
PPL$XSKIP symbol
PPL$YSKIP symbol

vector plots

as filled polygons
demo script
plot_vectors.jnl
poly_vec_demo.jnl
scattered
scripts
stick vectors

versions

FERRET_VERSION symbol
Ferret/ PyFerret version number from Unix
purging output files e.g. ferret.jnl
relative version numbers of output files
Unix file naming

vertical profile: example of reading file

vertical sections

along an x-y track
defining from profiles
script
using SAMPLEXY_CURV

viewport

advanced usage
CANCEL
DEFINE
demo script
pre-defined
SET
SHOW
special symbols for

DEFINE DATA: virtual data sets

visualizing curvilinear coordinate data

visualizing Lagrangian data

visualizing point data

visualizing polygonal coordinate data

visualizing profile data

visualizing sigma coordinate data

VLIMITS

VTREE

Return to top

W

WAIT: MESSAGE command

weighted equal

@WEQ transformation: Weighted variance

@SWL transformation: Welch Smoother

WHERE

While loop: see REPEAT

white pen

for labels
for plot lines

window

CANCEL
SET
SHOW
size and shape
test for open window

windowing: transformations @MIN and @MAX

WIRE

/D
/FRAME
/I/J/K/L/M/N
/NOLABEL
/OVERLAY
/SET_UP
/TITLE
/TRANSPOSE
/VIEWPOINT
/X/Y/Z/T/E/F
/ZLIMITS
/ZSCALE
example

wire frame plots

world coordinate

WRITEV5D function

Writing data

See LIST
Write data to NetCDF, see SAVE

Return to top

X

X windows

setting up to run Ferret
size and shape of windows
unmapped

XACT regridding

XAUTO_COR function

XBOX

XBOXHI

XBOXLO

XCAT function

XML

SHOW AXIS/XML
SHOW DATA/XML
SHOW GRID/XML
SHOW GRID/XML/OUTFILE/APPEND/CLOBBER

XPIXEL

XSEQUENCE function

X-Y plot

PLOT
PLOT/VS

Return to top

Y

YBOXHI

YBOXLO

YCAT function

YPIXEL

YSEQUENCE function

Return to top

Z

ZAXREPLACE function

ZAXREPLACE_AVG function

ZAXREPLACE_BIN function

ZCAT function

ZSEQUENCE function

Return to top