vapor.dataset module#
- class vapor.dataset.Dataset(dataMgr: DataMgr, id: str, ses)#
Bases:
SmartWrapperWraps VAPoR::DataMgr A cache based data reader.
DataMgr class is an abstract class that defines public methods for accessing (reading) 1D, 2D and 3D field variables. The class implements a memory cache to speed data access once a variable is read it is stored in cache for subsequent access. The DataMgr class is abstract: it declares a number of public and protected pure virtual methods that must be implemented by specializations of this class to allow access to particular file formats.
This class inherits from Wasp::MyBase . Unless otherwise documented any method that returns an integer value is returning status. A negative value indicates failure. Error messages are logged via Wasp::MyBase::SetErrMsg() . Methods that return a boolean do not, unless otherwise documented, log an error message upon failure (return of false).
- GetCoordVarNames#
- std::vector<string> VAPoR::DataMgr::GetCoordVarNames()
Return a list of names for all of the defined coordinate variables. This method returns a list of all coordinate variables defined in the data set.
- Returns
list A vector containing a list of all the coordinate variable names
- See Also
GetDataVarNames()
- GetDataRange(varname: str, atTimestep: int = 0)#
- GetDataVarNames#
- std::vector<string> VAPoR::DataMgr::GetDataVarNames()
Return a list of names for all of the defined data variables. This method returns a list of all data variables defined in the data set.
Test New in 3.0
- Returns
list A vector containing a list of all the data variable names
- See Also
GetCoordVarNames()
std::vector<string> VAPoR::DataMgr::GetDataVarNames(int ndim, VarType type=VarType::Any)
- static GetDatasetTypes()#
- GetDimLens#
- int VAPoR::DataMgr::GetDimLens(string varname, std::vector< size_t > &dims, long ts)
Return a variable’s array dimension lengths This method is equivalent to calling GetDimLensAtLevel() with level equal to -1
std::vector<size_t> VAPoR::DataMgr::GetDimLens(string varname)
- GetDimensionLength#
- long VAPoR::DataMgr::GetDimensionLength(string name, long ts)
Returns the length of a dimension at a given timestep
- Returns
length A negative int is returned on failure
- GetDimensionNames#
std::vector<string> VAPoR::DataMgr::GetDimensionNames() Return names of all defined dimensions This method returns the list of names of all of the dimensions defined in the DC .
- GetMesh#
- bool VAPoR::DataMgr::GetMesh(string meshname, DC::Mesh &mesh)
Return a Mesh’s definition This method returns the definition of the mesh named by mesh_name as a reference to a DC::Mesh object.
- Parameters
mesh_name A string specifying the name of the Mesh. mesh The returned Mesh object reference
- Returns
bool If the named mesh can not be found false is returned.
DC::Mesh VAPoR::DataMgr::GetMesh(string meshname)
- GetMeshNames#
std::vector<string> VAPoR::DataMgr::GetMeshNames() Return names of all defined meshes This method returns the list of names of all of the meshes defined in the DC .
- GetName()#
- GetNumTimeSteps#
- int VAPoR::DataMgr::GetNumTimeSteps(string varname)
Return the time dimension length for a variable Returns the number of time steps (length of the time dimension) for which a variable is defined. If varname does not have a time coordinate 1 is returned. If varname is not defined as a variable a negative int is returned.
- Parameters
varname A string specifying the name of the variable.
- Returns
count The length of the time dimension, or a negative int if varname is undefined.
- See Also
IsTimeVarying()
- int VAPoR::DataMgr::GetNumTimeSteps()
Return the maximum time dimension length for this data set Returns the number of time steps (length of the time dimension) for any variable is defined.
- GetTimeCoordVarName#
string VAPoR::DataMgr::GetTimeCoordVarName() Get time coordinate var name Return the name of the time coordinate variable. If no time coordinate variable is defined the empty string is returned.
- GetTransform()#
- GetVarCoordVars#
- bool VAPoR::DataMgr::GetVarCoordVars(string varname, bool spatial, std::vector< string > &coord_vars)
Return an ordered list of a data variable’s coordinate names Returns a list of a coordinate variable names for the variable varname , ordered from fastest to slowest. If spatial is true and the variable is time varying the time coordinate variable name will be included. The time coordinate variable is always the slowest varying coordinate axis
- Parameters
varname A valid variable name spatial If true only return spatial dimensions coordvars Ordered list of coordinate variable names.
- Returns
Returns true upon success, false if the variable is not defined.
vector<string> VAPoR::DataMgr::GetVarCoordVars(string varname, bool spatial)
- GetVarGeometryDim#
size_t VAPoR::DataMgr::GetVarGeometryDim(string varname)
- GetVarTopologyDim#
size_t VAPoR::DataMgr::GetVarTopologyDim(string varname)
- IsTimeVarying#
- bool VAPoR::DataMgr::IsTimeVarying(string varname)
Return a boolean indicating whether a variable is time varying This method returns true if the variable named by varname is defined and it has a time axis dimension. If either of these conditions is not true the method returns false.
- Parameters
varname A string specifying the name of the variable.
- Returns
bool Returns true if variable varname exists and is time varying.
- class vapor.dataset.PythonDataset(dataMgr: DataMgr, id: str, ses)#
Bases:
DatasetWraps VAPoR::PythonDataMgr DataMgr for data loaded from python scripts.
- AddNumpyData(name: str, arr: ndarray)#
Vapor expects data to be in order=’C’ with X as the fastest varying dimension. You can swap your axes with np.swapaxes(data, 0, -1).
- AddXArrayData(varName: str, arr: DataArray)#
Vapor supports grids commonly used in earth science data. It is recommended to import more complex datasets directly using Session.OpenDataset() as this will ensure coordinates and time varying data are handled automatically. Since xarray does not distinguish temporal dimensions your data will be interpeded as len(n.dims) space-dimensional, therefore arr must only contain spacial dimensions. Vapor expects data to be in order=’C’ with X as the fastest varying dimension.