GeoEco.Datasets.Virtual.GridSlice

class GeoEco.Datasets.Virtual.GridSlice(grid, tIndex=None, zIndex=None, tQAName='DateTime', tQADisplayName='Date', tQACoordType='min', zQAName='Depth', zQADisplayName='Depth', zQACoordType='center', displayName=None, additionalQueryableAttributeValues=None)

Bases: Grid

A Grid representing a time or depth slice of a 3D or 4D Grid.

Parameters:

• grid (Grid) – Grid to slice. It must have a t (time) dimension or z (depth) dimension, or both.

• tIndex (int, optional) – t index of the slice to extract. Omit if grid does not have a t dimension, or you don’t want to slice the t dimension.

• zIndex (int, optional) – z index of the slice to extract. Omit if grid does not have a z dimension, or you don’t want to slice the z dimension.

• tQAName (str, optional) – Name of the QueryableAttribute to define for the t coordinate. Must be given if tIndex is given. Ignored otherwise. Minimum length꞉ 1.

• tQADisplayName (str, optional) – Display name of the QueryableAttribute to define for the t coordinate. Must be given if tIndex is given. Ignored otherwise. Minimum length꞉ 1.

• tQACoordType (str, optional) – Type of t coordinate to use for the value of the QueryableAttribute for the t coordinate. For example, if grid has a TIncrementUnit of 'day', and the t coordinates start at midnight and are spaced 1 day apart, then if tQACoordType is 'min', the value of the QueryableAttribute will be midnight on the date of the time slice. If it is 'center' the value will be 12:00:00 on that date, and if it is 'max' it will be midnight of the next day. Allowed values꞉ 'min', 'center', 'max'.

• zQAName (str, optional) – Name of the QueryableAttribute to define for the t (depth) coordinate. Must be given if zIndex is given. Ignored otherwise. Minimum length꞉ 1.

• zQADisplayName (str, optional) – Display name of the QueryableAttribute to define for the z coordinate. Must be given if zIndex is given. Ignored otherwise. Minimum length꞉ 1.

• zQACoordType (str, optional) – Type of z coordinate to use for the value of the QueryableAttribute for the z coordinate. For example, if increasing positive values of the z coordinate of grid indicate deeper depths and zQACoordType is 'min', the value of the QueryableAttribute will be the depth representing the shallow edge of the depth slice. If it is 'center' the value will be the center depth, and if it is 'max' it will the deep edge. Allowed values꞉ 'min', 'center', 'max'.

• displayName (str, optional) – Informal name of this object. If you do not provide a name, a suitable name will be created automatically. Minimum length꞉ 1.

• additionalQueryableAttributeValues (dict mapping str to object, optional) – Values of additional queryable attributes to define, expressed as a dictionary mapping the case-insensitive names of queryable attributes to their values.

Returns:

GridSlice instance.

Return type:

GridSlice

Properties

property CenterCoords

(object) Coordinates of the grid cell centers, indexed using the 1-character dimension of interest and optionally a range to retrieve a numpy.ndarray of coordinates (e.g. CenterCoords['x', 0:4]) or an integer to retrieve a float for a single coordinate (e.g. CenterCoords['x', 10]). Coordinates for the t dimension are returned as datetime instances. Read only.

property CoordDependencies

(tuple of str) Same length as Dimensions. Dimensions that each dimension depends on for determining its coordinates. None for dimensions that have a constant coordinate increment. Read only.

property CoordIncrements

(tuple of float) Same length as Dimensions. Coordinate increment for each dimension. None for dimensions that do not have a constant coordinate increment. Read only.

property Data

(object) This grid’s data, indexable using slices (e.g. grid.Data[:, 5:10, -10:]) or integers (e.g. grid.Data[0,1,-2]) or both in combination. Strides and negative indexes are supported in the traditional manner. If the grid is writable, Data can be assigned to write values to the grid, e.g. grid.Data[0,1] = 5 or grid.Data[:,:] = numpy.zeros(grid.Shape). Returns and accepts numpy.ndarray, float, and int. Read only.

property DataIsScaled

(bool) If True, the underlying raw data are stored as the UnscaledDataType to save storage space and then transformed by a scaling equation on the fly when they are returned by Data. The raw data can be accessed with UnscaledData. If False, the raw data are returned as is, with no transformation needed, and UnscaledDataType and DataType are the same, and UnscaledData returns the same values as Data. Read only.

property DataType

(str) Numeric data type of the grid, after the scaling function (if any) has been applied to the raw data. numpy.ndarrays returned by Data have this type. Read only. Allowed values꞉ 'int8', 'uint8', 'int16', 'uint16', 'int32', 'uint32', 'float32', 'float64'. Case sensitive.

property Dimensions

(str) Dimensions of this grid. Read only. Allowed values꞉ 'yx', 'zyx', 'tyx', 'tzyx'. Case sensitive.

property DisplayName

(str) Informal name of this object, suitable to be displayed to the user. Read only. Minimum length꞉ 1.

property MaxCoords

(object) Maximum coordinate value for each cell (i.e., the coordinates of the cells’ right edges), indexed using the 1-character dimension of interest and optionally a range to retrieve a numpy.ndarray of coordinates (e.g. MaxCoords['x', 0:4]) or an integer to retrieve a float for a single coordinate (e.g. MaxCoords['x', 10]). Coordinates for the t dimension are returned as datetime instances. Read only.

property MinCoords

(object) Minimum coordinate value for each cell (i.e., the coordinates of the cells’ left edges), indexed using the 1-character dimension of interest and optionally a range to retrieve a numpy.ndarray of coordinates (e.g. MinCoords['x', 0:4]) or an integer to retrieve a float for a single coordinate (e.g. MinCoords['x', 10]). Coordinates for the t dimension are returned as datetime instances. Read only.

property NoDataValue

(object or None) int or float value that indicates that cells of Data should be interpreted as having no data (these are also known as missing, NA, or NULL cells), or None if all cells must have data. Read only.

property ParentCollection

(DatasetCollection or None) Parent DatasetCollection that this object is part of (if any). Read only.

property Shape

(tuple of int) Same length as Dimensions. Length (number of grid cells) of each dimension. Read only.

property TCountPerSemiRegularPeriod

(int or None) Number of time slices per semi-regular period (i.e. per year). None if the grid’s dimensions do not contain a t coordinate or the t coordinate is not semi-regular. Read only.

property TIncrementUnit

(str or None) Unit of the t coordinate. None if the grid’s dimensions do not contain a t coordinate. Read only. Allowed values꞉ 'year', 'month', 'day', 'hour', 'minute', 'second'. Case sensitive.

property TSemiRegularity

(str or None) Type of semi-regularity used for the t coordinate. None if the grid’s dimensions do not contain a t coordinate or the t coordinate is not semi-regular. Read only. Allowed values꞉ 'annual'. Case sensitive.

property UnscaledData

(object) This grid’s data underlying raw data, before it has been transformed by a scaling equation. UnscaledData is indexable using slices (e.g. grid.UnscaledData[:, 5:10, -10:]) or integers (e.g. grid.UnscaledData[0,1,-2]) or both in combination. Strides and negative indexes are supported in the traditional manner. If the grid is writable, UnscaledData can be assigned to write values to the grid, e.g. grid.UnscaledData[0,1] = 5 or grid.UnscaledData[:,:] = numpy.zeros(grid.Shape). Returns and accepts numpy.ndarray, float, and int. Read only.

property UnscaledDataType

(str) Numeric data type of the grid’s raw data, before it has been transformed by a scaling equation. numpy.ndarrays returned by UnscaledData have this type. If no transformation is needed (DataIsScaled is False), then UnscaledDataType and ScaledDataType are the same, and UnscaledData returns the same values as Data. Read only. Allowed values꞉ 'int8', 'uint8', 'int16', 'uint16', 'int32', 'uint32', 'float32', 'float64'. Case sensitive.

property UnscaledNoDataValue

(object or None) int or float value that indicates that cells of UnscaledData should be interpreted as having no data (these are also known as missing, NA, or NULL cells), or None if all cells must have data. Read only.

Methods

Close	Closes any open files or connections associated with this object and releases any other resources allocated to access it.
ConvertSpatialReference	Converts a spatial reference from one format to another, such as an OGC WKT string to a Proj4 string.
DeleteLazyPropertyValue	Deletes the lazy property with the specified name.
GetAllQueryableAttributes	Returns a list of all queryable attributes.
GetIndicesForCoords	Given a tuple or list of coordinates, returns a list of int indices into Data for the cell that contains the coordinates.
GetLazyPropertyValue	Returns the value of the lazy property with the specified name.
GetQueryableAttribute	Returns the queryable attribute with the specified name.
GetQueryableAttributeValue	Returns the value of the queryable attribute with the specified name.
GetQueryableAttributesWithDataType	Returns a list queryable attributes having the specified data type.
GetSpatialReference	Returns the spatial reference of this dataset.
HasLazyPropertyValue	Returns True if the specified lazy property has a value.
SetLazyPropertyValue	Sets the lazy property with the specified name to the specified value.
SetSpatialReference	Sets the spatial reference of this dataset.
TestCapability	Tests whether a capability is supported by this class or an instance of it.
numpy_equal_nan