Module netCDF4 :: Class Dimension

Class Dimension

object --+
         |
        Dimension

Dimension(self, group, name, size=None)

A netCDF Dimension is used to describe the coordinates of a Variable.

Dimension instances should be created using the createDimension method of a Group or Dataset instance, not using this class directly.

Parameters:

group - Group instance to associate with dimension.

name - Name of the dimension.

Keywords:

size - Size of the dimension. None or 0 means unlimited. (Default None).

Returns:

a Dimension instance. All further operations on the netCDF Dimension are accomplised via Dimension instance methods.

The current maximum size of a Dimension instance can be obtained by calling the python len function on the Dimension instance. The isunlimited() method of a Dimension instance can be used to determine if the dimension is unlimited

Instance Methods
 
__init__(self, group, name, size=None)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
 
__len__(x)
len(x)
a new object with type S, a subtype of T
__new__(T, S, ...)
 
__str__(x)
str(x)
 
isunlimited(self)
returns True if the Dimension instance is unlimited, False otherwise.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Properties

Inherited from object: __class__

Method Details

__init__(self, group, name, size=None)
(Constructor)

 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__

__new__(T, S, ...)

 
Returns: a new object with type S, a subtype of T
Overrides: object.__new__

__str__(x)
(Informal representation operator)

 

str(x)

Overrides: object.__str__