Trees | Indices | Help |
---|
|
object --+ | Dataset
A netCDF Dataset is a collection of dimensions, variables and attributes. Together they describe the meaning of data and relations among data fields stored in a netCDF file.
Constructor: Dataset(filename, mode="r", clobber=True,
format='NETCDF4_CLASSIC')
Parameters:
filename
- Name of netCDF file to hold
dataset.
Keywords:
mode
- access mode. r
means
read-only; no data can be modified. w
means write; a new
file is created, an existing file with the same name is deleted.
a
and r+
mean append (in analogy with serial
files); an existing file is opened for reading and writing.
clobber
- if True
(default), opening
a file with mode='w'
will clobber an existing file with the
same name. if False
, an exception will be raised if a file
with the same name already exists.
format
- underlying file format (one of
'NETCDF4_CLASSIC', 'NETCDF3_CLASSIC'
or
'NETCDF3_64BIT'
. Only relevant if mode = 'w'
(if mode = 'r','a'
or 'r+'
the file format is
automatically detected). Default 'NETCDF4_CLASSIC'
, which
means the data is stored in an HDF5 file, but using only netCDF 3
compatibile API features. netCDF 3 clients must be recompiled and linked
against the netCDF 4 library to read files in
NETCDF4_CLASSIC
format. The advantage is that the files are
also readable by HDF5 clients, and you get to use on-the-fly zlib
compression (which makes for much smaller files).
'NETCDF3_CLASSIC'
is the classic netCDF 3 file format that
does not handle 2+ Gb files very well. 'NETCDF3_64BIT'
is
the 64-bit offset version of the netCDF 3 file format, which fully
supports 2+ GB files, but is only compatible with clients linked against
netCDF version 3.6.0 or later.
Returns:
a Dataset instance. All further operations on the netCDF Dataset are accomplised via Dataset instance methods.
A list of attribute names corresponding to global netCDF attributes
defined for the Dataset can be obtained with the ncattrs() method. These attributes can be created by
assigning to an attribute of the Dataset
instance. A dictionary containing all the netCDF attribute name/value
pairs is provided by the __dict__
attribute of a Dataset
instance.
dimensions, variables
amd
file_format
are read-only (and should not be modified by the
user).
|
|||
|
__delattr__(...) x.__delattr__('name') <==> del x.name |
||
|
__getattribute__(...) x.__getattribute__('name') <==> x.name |
||
|
__init__(...) x.__init__(...) initializes x; see x.__class__.__doc__ for signature |
||
| __new__(T, S, ...) | ||
|
__setattr__(...) x.__setattr__('name', value) <==> x.name = value |
||
| _enddef(...) | ||
| _redef(...) | ||
|
close(...) Close the Dataset. |
||
|
createDimension(...) Creates a new dimension with the given dimname and
size .
|
||
|
createVariable(...) Creates a new variable with the given varname ,
datatype , and dimensions .
|
||
|
ncattrs(...) return names of netCDF attribute for this Dataset in a list |
||
|
renameDimension(...) rename a Dimension named oldname to
newname .
|
||
|
renameVariable(...) rename a Variable named oldname to
newname
|
||
|
set_fill_off(...) Sets the fill mode for a Dataset open for writing to off .
|
||
|
set_fill_on(...) Sets the fill mode for a Dataset open for writing to on .
|
||
|
sync(...) Writes all buffered data in the Dataset to the disk file. |
||
Inherited from |
|
|||
|
_dsetid = <member '_dsetid' of 'netCDF4_classic.Dataset' objects>
|
|
|||
|
dimensions = <member 'dimensions' of 'netCDF4_classic.Dataset' ob... The dimensions dictionary maps the names of
dimensions defined for this Dataset to
instances of the Dimension class.
|
||
|
file_format = <member 'file_format' of 'netCDF4_classic.Dataset' o... The file_format attribute describes the netCDF file
format version, one of NETCDF3_CLASSIC ,
NETCDF4_CLASSIC or NETCDF3_64BIT .
|
||
|
variables = <member 'variables' of 'netCDF4_classic.Dataset' obj... The variables dictionary maps the names of variables
defined for this Dataset to instances of the Variable
class.
|
|
|||
Inherited from |
|
|
|
|
|
|
|
|
Close the Dataset. close()
|
Creates a new dimension with the given
size must be a positive integer or None ,
which stands for "unlimited" (default is None ).
The return value is the Dimension class instance describing the new dimension.
To determine the current maximum size of the dimension, use the
len function on the Dimension
instance. To determine if a dimension is 'unlimited', use the
isunlimited() method of the Dimension
instance.
|
Creates a new variable with the given
The Data from netCDF variables are presented to python as numpy arrays with the corresponding data type.
If the optional keyword The optional keyword If the optional keyword If the optional keyword If the optional keyword The optional keyword If the optional keyword parameter The return value is the Variable class instance describing the new variable. A list of names corresponding to netCDF variable attributes can be
obtained with the Variable method dimensions, dtype,
shape and least_significant_digit Application
programs should never modify these attributes. The
dimensions attribute is a tuple containing the names of the
dimensions associated with this variable. The dtype
attribute is a string describing the variable's data type (i4, f8,
S1, etc). The shape attribute is a tuple describing
the current sizes of all the variable's dimensions. The
least_significant_digit attributes describes the power of
ten of the smallest decimal place in the data the contains a reliable
value. Data is truncated to this decimal place when it is assigned to
the Variable instance. If None , the data is not
truncated.
|
return names of netCDF attribute for this Dataset in a list ncattrs()
|
rename a Dimension named renameDimension(oldname, newname)
|
rename a Variable named renameVariable(oldname, newname)
|
Sets the fill mode for a Dataset open for writing to
|
Sets the fill mode for a Dataset open for writing to
_Fill_Value attribute,
but is usually sufficient to the use the netCDF default
_Fill_Value (defined separately for each variable type). The
default behavior of the netCDF library correspongs to
set_fill_on . Data which are equal to the
_Fill_Value indicate that the variable was created, but
never written to.
|
Writes all buffered data in the Dataset to the disk file. sync()
|
|
_dsetidNone
|
|
dimensionsThedimensions dictionary maps the names of dimensions
defined for this Dataset to instances of the Dimension
class.
|
file_formatThefile_format attribute describes the netCDF file
format version, one of NETCDF3_CLASSIC ,
NETCDF4_CLASSIC or NETCDF3_64BIT . To read or
write files in NETCDFr format, use the netCDF4 module.
|
variablesThevariables dictionary maps the names of variables
defined for this Dataset to instances of the Variable
class.
|
Trees | Indices | Help |
---|
Generated by Epydoc 3.0alpha3 on Tue Feb 13 19:56:15 2007 | http://epydoc.sourceforge.net |