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

ToBeReviewed/INIT/

initncdf.pro

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

NAME:initncdf PURPOSE:initfile for Netcdf file. define all the grid parameters CATEGORY: CALLING SEQUENCE:initncdf, ncfilename INPUTS:ncfilename: a string giving the name of the NetCdf file KEYWORD PARAMETERS: GLAMBOUNDARY:a 2 elements vector, {lon1,lon2], the longitute boundaries that should be used to visualize the data. lon2 > lon1 lon2 - lon1 le 360 key_shift will be defined according to GLAMBOUNDARY. /INVMASK: to inverse the mask: mask = 1-mask IODIRECTORY;a string giving the name of iodirectory (see isafile.pro for all possibilities). default value is common variable iodir MASKNAME: a string giving the name of the variable in the file that contains the land/sea mask 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 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 [XYZ]AXISNAME= 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'. for Y axis, default name must be 'y', 'latitude', 'nav_lat' or 'lat'. for Z axis, default name must be 'z', 'level', 'lev', 'depth...' [XYZ]MINMESH: to define the common variables i[xyz]minmesh used to define the grid only in a zoomed part of the original grid. Defaut values are 0L [XYZ]MAXMESH: to define the common variables i[xyz]maxmesh used to define the grid only in a zoomed part of the original grid. Defaut values are jp[ijk]glo-1 /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) OUTPUTS:none, except the grid parameters of the common.pro COMMON BLOCKS:common.pro SIDE EFFECTS:change the grid parameters of the common.pro RESTRICTIONS: the file must contain an x and an y axis. (1 ou 2 dimentional array) EXAMPLE: IDL> initncdf,'toto.nc',glam=[-180,180]

Parameters

ncfilein       

Keywords

XAXISNAME       

YAXISNAME       

ZAXISNAME       

MASKNAME       

INVMASK       

USEASMASK       

MISSING_VALUE       

START1       

XYINDEX       

ZINDEX       

_EXTRA       

Produced by IDLdoc 2.0.