NumRu::GrADS_Gridded -- a class for GrADS gridded datasets

by T Horinouchi and R Mizuta

Overview

a GrADS_Gridded object corresponds to a GrADS control file, through which the users can also access its binary data file(s).

Current Limitations

Class Methods

GrADS_Gridded.new(ctlfilename, mode="r")

same as GrADS_Gridded.open

GrADS_Gridded.open(ctlfilename, mode="r")

make a new GrADS_Gridded object.

ARGUMENTS

REMARK

GrADS_Gridded.create(ctlfilename, noclobber=false, share=false)

make a new GrADS_Gridded object with creating a new control file

REMARK

Methods

ndims

returns the number of dimensions in the file (always 4).

nvars

returns the number of variables in the file.

natts

returns the number of attributes of the variable.

path

returns the path of the control file.

put_att( attname, value )

set global attribute

ARGUMENTS

def_var(name="noname",nlev=0,option="99",description="")

define a variable

ARGUMENTS

var( varname=nil )

opens an existing variable in the file.

ARGUMENTS

RETURN VALUE

vars( names=nil )

opens existing variables in the file.

ARGUMENTS

RETURN VALUE

get_att( key=nil )

returns tha value of the global attribute

dim_names

returns the names of all dimensions in the control file.

var_names

returns the names of all variables in the control file.

att_names

returns the names of all the global attributes.

to_ctl

returns the contents of the corresponding control file as a String.

REMARK

get(name, z, t)

reads the binary data and returns as a NArray.

ARGUMENTS

put(ary)

writes the NArray on the binary data file.

ARGUMENTS

varnames

Returns names of the variable in the GrADS file as an Array in the order placed.

dimensions

Returns info on the four dimensions.

RETURN VALUE

WARNING

get_dim(dim)

returns positions of a dimension as an NArray.

ARGUMENTS

RETURN VALUE

title

title=

get/set the title

undef

undef=

get/set the undef value

dset

dset=

get/set the dset string

GrADSVar -- a class for a variable of GrADS gridded datasets

by R Mizuta

Overview

a GrADSVar object corresponds to one variable in a GrADS control file. It is intended to behave as a correspondent of a NetCDFVar object.

Current Limitations

Class Methods

GrADSVar.new(file, varname)

make a new GrADSVar object.

ARGUMENTS

Methods

shape_ul0

returns the shape of the variable, but the length of the unlimited dimension is set to zero.

RETURN VALUE

shape_current

returns the current shape of the variable.

RETURN VALUE

dim_names

returns the names of all dimensions of the variable.

att_names

returns the names of all attributes of the variable.

name

returns the name of the variable.

ndims

returns the number of dimensions in the file (always 4).

rank

alias of ndims

vartype

returns "sfloat" in order to behave as NetCDFVar#vartype.

natts

returns the number of attributes of the variable.

file

returns the file name that controls the variable.

get_att( name=nil )

returns tha value of the attribute of the variable.

put_att( name, value )

set an attribute of the variable.

ARGUMENTS

get(hash=nil)

returns values of the variable.

ARGUMENTS

RETURN VALUE

REMARK "stride","index" is not supported yet.

[]

Same as GrADSVar#get but a subset is specified as in the method [] of NArray.