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

ToBeReviewed/HOPE/

read_hope.pro

Routine summary

read_hope_event, event

NAME: read_hope PURPOSE: read the Hope grid file converted in NetCdf by xconv CATEGORY: reading CALLING SEQUENCE: a=read_hope([typein, varnamein]) INPUTS: typein: a string specifing from which type of section the 4D array based: 'xy, 'xz', 'yz' varnamein: a string the name of the cariable to be read (in lower or upper case) KEYWORD PARAMETERS: FILENAME = the name of the file to be read XLIMITS = a two elements vertor [lonmin, lonmax]] the bondary of the longitudes (from 0 to 360) YLIMITS = a two elements vertor [latmin, latmax]] the bondary of the latitudes (from -90 to 90) ZLIMITS = a two elements vertor [depthmin, depthmax]] the bondary of the depth TLIMITS = a two elements vertor [date1, date2]] the bondary of the calendar with date1 and date2 folowing the syntaxe yyyymmdd /ODDPT: activate to read only the sections located on ODD points /EVENPT: activate to read only the sections located on even points /ODDEVENPT: activate to read only the sections located on both even and odd points (horizontal sections) OUTPUTS: -1 if typein and varnamein are undefine (this is the widget version) a structure which but be read by litchamp.

result = read_hope(typein, varnamein, FILENAME=FILENAME, XLIMITS=XLIMITS, YLIMITS=YLIMITS, ZLIMITS=ZLIMITS, TLIMITS=TLIMITS, ODDPT=ODDPT, ODDEVENPT=ODDEVENPT, EVENPT=EVENPT, _extra=_extra)

topread_hope_event

read_hope_event, event

NAME: read_hope PURPOSE: read the Hope grid file converted in NetCdf by xconv CATEGORY: reading CALLING SEQUENCE: a=read_hope([typein, varnamein]) INPUTS: typein: a string specifing from which type of section the 4D array based: 'xy, 'xz', 'yz' varnamein: a string the name of the cariable to be read (in lower or upper case) KEYWORD PARAMETERS: FILENAME = the name of the file to be read XLIMITS = a two elements vertor [lonmin, lonmax]] the bondary of the longitudes (from 0 to 360) YLIMITS = a two elements vertor [latmin, latmax]] the bondary of the latitudes (from -90 to 90) ZLIMITS = a two elements vertor [depthmin, depthmax]] the bondary of the depth TLIMITS = a two elements vertor [date1, date2]] the bondary of the calendar with date1 and date2 folowing the syntaxe yyyymmdd /ODDPT: activate to read only the sections located on ODD points /EVENPT: activate to read only the sections located on even points /ODDEVENPT: activate to read only the sections located on both even and odd points (horizontal sections) OUTPUTS: -1 if typein and varnamein are undefine (this is the widget version) a structure which but be read by litchamp.pro and is necessary to complute the grid associated to the data (see the example). COMMON BLOCKS: common.pro (usefull only for the definition of iodir) SIDE EFFECTS: 'x', 'y', 'z', 't', 'xt', 'yt' and 'zt' section not coded, xconv must be able to works with this kind of fonction. The grib file has no zoom possibilities on horizontal dimensions. RESTRICTIONS: When typein and varnamein are defined, the methode to find the godd variable is: 1) find the variables which are available on this type of sections woth this name 2) if ODDPT, EVENPT or ODDEVENPT are specified, consider only these types of sections 3) for an XY section the chosen variable is the one which has the most level in the vertical domain specified by ZLIMITS. for an XZ section the chosen variable is the one which has the most points in the latitude domain specified by YLIMITS. for an YZ section the chosen variable is the one which has the most points in the longitude domain specified by XLIMITS. EXAMPLE: IDL> a=read_hope('xy','ocpt',filename='CLIM_CNT_1993-1998.nc') IDL> help, a,/struct ** Structure <82ec344>, 6 tags, length=1860176, refs=1: ARRAY FLOAT Array[128, 242, 15] UNIT STRING 'deg C' NAME STRING 'Ocean potential temperature' DATE FLOAT Array[1] GRID STRING 'T' HOPEGRID STRUCT -> Array[1] IDL> help, a.hopegrid,/struct ** Structure <82eb9cc>, 8 tags, length=1588, refs=2: XAXIS FLOAT Array[128] YAXIS FLOAT Array[242] ZAXIS FLOAT Array[15] FIRSTS LONG Array[3] LASTS LONG Array[3] TYPE STRING 'xy' LINETYPE STRING 'odd-even' PTTYPE STRING 'T' IDL> help, litchamp(a) FLOAT = Array[128, 242, 15]

Parameters

event       

topread_hope

result = read_hope(typein, varnamein, FILENAME=FILENAME, XLIMITS=XLIMITS, YLIMITS=YLIMITS, ZLIMITS=ZLIMITS, TLIMITS=TLIMITS, ODDPT=ODDPT, ODDEVENPT=ODDEVENPT, EVENPT=EVENPT, _extra=_extra)

Parameters

typein       

varnamein       

Keywords

FILENAME       

XLIMITS       

YLIMITS       

ZLIMITS       

TLIMITS       

ODDPT       

ODDEVENPT       

EVENPT       

_extra       

Produced by IDLdoc 2.0.