cf.BoundsFromNodesArray¶
- class cf.BoundsFromNodesArray(*args, **kwargs)[source]¶
Initialisation
- Parameters:
- node_connectivity: array_like
A 2-d integer array that contains indices which map each cell boundary vertex to its corresponding position in the 1-d node_coordinates array, as found in a UGRID “edge_node_connectivity” or “face_node_connectivity” variable.
- shape:
tuple
The shape of the bounds array.
- start_index:
int
The base of the indices provided by the integer index array. Must be
0
or1
for zero- or one-based indices respectively.- cell_dimension:
int
The position of the data dimension that indexes the cells, either
0
or1
.- node_coordinates: array_like
A 1-d array that contains a coordinate location for each mesh node, as found in a UGRID “node_coordinates” variable.
- source: optional
Convert source, which can be any type of object, to a
BoundsFromNodesArray
instance.All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the
BoundsFromNodesArray
API. Any parameters that can not be retrieved from source in this way are assumed to have their default value.Note that if
x
is also aBoundsFromNodesArray
instance thencf.BoundsFromNodesArray(source=x)
is equivalent tox.copy()
.- copy:
bool
, optional If True (the default) then deep copy the input parameters prior to initialisation. By default the parameters are not deep copied.
Methods
Initialisation |
|
Mapping of compressed to uncompressed dimensions. |
|
The conformed node connectivity and node coordinate data. |
|
Return a deep copy of the array. |
|
The attributes of the array. |
|
Return the Subarray class. |
|
The calendar of the array. |
|
Return the position of the cell dimension. |
|
Return axes that are compressed in the underlying array. |
|
Returns the compressed dimension's position in the array. |
|
Returns the array's compression type. |
|
Return the name of the file containing the compressed data. |
|
The coordinates representing the node locations. |
|
Return the start index. |
|
The units of the array. |
|
Return the underlying array object. |
|
Non-data parameters required by the |
|
Create the subarray shapes along each uncompressed dimension. |
|
Return descriptors for every subarray. |
|
Convert the data to a |
|
Bring data on disk into memory. |
Attributes
|
The |
|
Returns a numpy array containing the uncompressed data. |
|
Cast the data to a specified type. |
|
Returns an independent numpy array with the compressed data. |
|
The data-type of the uncompressed data. |
|
Number of array dimensions. |
|
Shape of the uncompressed data. |
|
Number of elements in the array. |