<<prev file | next file >>    view single page | view frames    summary: fields | routine    details: routine

ReadWrite/

ncdf_getaxis.pro

get the x/y dimension Id and x/y axes from a netcdf file

topncdf_getaxis Read NetCDF file

ncdf_getaxis, fileid, dimidx, dimidy, xaxis, yaxis, XAXISNAME=scalar string, YAXISNAME=scalar string, XDIMNAME=scalar string, YDIMNAME=scalar string, XYINDEX=scalar: 0 or 1, START1=scalar: 0 or 1, XMINMESH=scalar, XMAXMESH=scalar, YMINMESH=scalar, YMAXMESH=scalar, ROMSGRID=variable, _EXTRA=_EXTRA

Parameters

fileid        in required type: scalar

the id of the netcdf file

dimidx        out type: scalar (long)

id of the x dimension

dimidy        out type: scalar (long)

id of the y dimension

xaxis        out type: 1D or 2D array

the x axis

yaxis        out type: 1D or 2D array

the y axis

Keywords

XAXISNAME        type: scalar string default: 'x', 'longitude', 'nav_lon', 'lon', 'lon_rho' or 'NbLongitudes'

A string giving the name of the variable in the file that contains the x axis or/and a named variable in which this variable name is returned.

YAXISNAME        type: scalar string default: 'y', 'latitude', 'nav_lat','lat', 'lat_rho' or 'NbLatitudes'

A string giving the name of the variable in the file that contains the y axis or/and a named variable in which this variable name is returned.

XDIMNAME        type: scalar string default: 'longitude', 'lon', 'x', 'longitude*', 'lon*', 'x*', '*longitude*', '*lon*' or '*x*'

A string giving the name of the x dimension or/and a named variable in which x dimension name is returned.

YDIMNAME        type: scalar string default: 'latitude', 'lat', 'y', 'latitude*', 'lat*', 'y*', 'eta_*', '*latitude*', '*lat*', '*y*'

A string giving the name of the y dimension or/and a named variable in which y dimension name is returned.

XYINDEX        type: scalar: 0 or 1 default: 0

To define the x/y axis with index instead of using the values contained in X/YAXISNAME. x/yaxis = keyword_set(start1) + findgen(jpi/jpj)

START1        type: scalar: 0 or 1 default: 0

Index the axis from 1 instead of 0 when using /xyindex

XMINMESH        type: scalar default: 0L

Define common (cm_4mesh) variables ixminmesh used to define the localization of the first point of the grid along the x direction in a zoom of the original grid

XMAXMESH        type: scalar default: jpiglo-1

Define common (cm_4mesh) variables ixmaxmesh used to define the localization of the last point of the grid along the x direction in a zoom of the original grid Note that if XMAXMESH < 0 then ixmaxmesh is defined as ixmaxmesh = jpiglo -1 + xmaxmesh

YMINMESH        type: scalar default: 0L

Define common (cm_4mesh) variables iyminmesh used to define the localization of the first point of the grid along the y direction in a zoom of the original grid

YMAXMESH        type: scalar default: jpjglo-1

Define common (cm_4mesh) variables iymaxmesh used to define the localization of the last point of the grid along the y direction in a zoom of the original grid Note that if YMAXMESH < 0 then iymaxmesh is defined as iymaxmesh = jpjglo -1 + ymaxmesh

ROMSGRID        out type: scalar: 0 or 1

gives back if we are using a ROMS grid (1) or not (0)

_EXTRA       

Used to be able to call ncdf_getaxis with _extra

Version history

Version

$Id: ncdf_getaxis.pro 399 2009-07-02 08:38:54Z smasson $

History

March 2007: Sebastien Masson (smasson@locean-ipsl.upmc.fr)

Statistics

McCabe cyclic 55
McCabe essential 1
McCabe modular design 1
Produced by IDLdoc 2.0.