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

ToBeReviewed/INIT/

initncdf.pro

Initfile for Netcdf file. define all the grid parameters

topinitncdf

initncdf, ncfilein, XAXISNAME=XAXISNAME, YAXISNAME=YAXISNAME, ZAXISNAME=ZAXISNAME, MASKNAME=MASKNAME, INVMASK=INVMASK, USEASMASK=USEASMASK, MISSING_VALUE=MISSING_VALUE, START1=START1, XYINDEX=XYINDEX, ZINDEX=ZINDEX, _EXTRA=_EXTRA

Parameters

ncfilein        in required

A string giving the name of the NetCdf file

Keywords

XAXISNAME       

A string giving the name of the variable in the file that contains the [xyz]axis. for X axis, default name must be 'x', 'longitude', 'nav_lon' or 'lon'.

YAXISNAME       

A string giving the name of the variable in the file that contains the [xyz]axis. for Y axis, default name must be 'y', 'latitude', 'nav_lat' or 'lat'.

ZAXISNAME       

A string giving the name of the variable in the file that contains the [xyz]axis. for Z axis, default name must be 'z', 'level', 'lev', 'depth...'

MASKNAME       

A string giving the name of the variable in the file that contains the land/sea mask

INVMASK       

To inverse the mask: mask = 1-mask

USEASMASK       

A string giving the name of the variable in the file that will be used to build the land/sea mask. In this case the mask is based on the first record (if record dimension exists). The mask is build according to : 1 the keyword missing_value if existing 2 the attribute 'missing_value' if existing 3 NaN values if existing

MISSING_VALUE       

To define (or redifine if the attribute is already existing) the missing values used with USEASMASK keyword

START1       

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

XYINDEX       

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) this forces key_onearth = 0

ZINDEX       

To define the z axis with index instead of using the values contained in ZAXISNAME. zaxis = keyword_set(start1) + findgen(jpk)

_EXTRA       

Used to pass your keywords/

Examples

IDL> initncdf,'toto.nc',glam=[-180,180]

Version history

Version

$Id$

History

Known issues

Restrictions

Change the grid parameters of the common.pro the file must contain an x and an y axis. (1 ou 2 dimentional array)

Other attributes

Uses routines

common.pro
Produced by IDLdoc 2.0.