ioda::Variable Class Reference
Variables store data! More...
#include <Variable.h>
Inheritance diagram for ioda::Variable:
Collaboration diagram for ioda::Variable:
Public Member Functions | |
General Functions | |
| Variable () | |
| Variable (std::shared_ptr< detail::Variable_Backend > b) | |
| Variable (const Variable &) | |
| Variable & | operator= (const Variable &) |
| virtual | ~Variable () |
 Public Member Functions inherited from ioda::detail::Variable_Base< Variable > | |
| virtual Type | getType () const |
| Get type. More... | |
| Type | type () const |
| Get type. More... | |
| virtual detail::Type_Provider * | getTypeProvider () const |
| Query the backend and get the type provider. More... | |
| bool | isA () const |
| Convenience function to check a Variable's storage type. More... | |
| virtual bool | isA (Type lhs) const |
| Hand-off to the backend to check equivalence. More... | |
| bool | isA (BasicTypes dataType) const |
| Python compatability function. More... | |
| bool | _py_isA2 (BasicTypes dataType) |
| BasicTypes | getBasicType () const |
| Convenience function to query type. More... | |
| virtual Dimensions | getDimensions () const |
| virtual Variable | resize (const std::vector< Dimensions_t > &newDims) |
| Resize the variable. More... | |
| virtual Variable | attachDimensionScale (unsigned int DimensionNumber, const Variable &scale) |
| Attach a dimension scale to this Variable. More... | |
| virtual Variable | detachDimensionScale (unsigned int DimensionNumber, const Variable &scale) |
| Detach a dimension scale. More... | |
| Variable | setDimScale (const std::vector< Variable > &dims) |
| Set dimensions (convenience function to several invocations of attachDimensionScale). More... | |
| Variable | setDimScale (const std::vector< Named_Variable > &dims) |
| Set dimensions (convenience function to several invocations of attachDimensionScale). More... | |
| Variable | setDimScale (const Variable &dims) |
| Set dimensions (convenience function to several invocations of attachDimensionScale). More... | |
| Variable | setDimScale (const Variable &dim1, const Variable &dim2) |
| Set dimensions (convenience function to several invocations of attachDimensionScale). More... | |
| Variable | setDimScale (const Variable &dim1, const Variable &dim2, const Variable &dim3) |
| Set dimensions (convenience function to several invocations of attachDimensionScale). More... | |
| virtual bool | isDimensionScale () const |
| Is this Variable used as a dimension scale? More... | |
| virtual Variable | setIsDimensionScale (const std::string &dimensionScaleName) |
| Designate this table as a dimension scale. More... | |
| std::string | getDimensionScaleName () const |
| Get the name of this Variable's defined dimension scale. More... | |
| virtual Variable | getDimensionScaleName (std::string &res) const |
| virtual bool | isDimensionScaleAttached (unsigned int DimensionNumber, const Variable &scale) const |
| Is a dimension scale attached to this Variable in a certain position? More... | |
| virtual std::vector< std::vector< Named_Variable > > | getDimensionScaleMappings (const std::list< Named_Variable > &scalesToQueryAgainst, bool firstOnly=true) const |
| Which dimensions are attached at which positions? This function may offer improved performance on some backends compared to serial isDimensionScaleAttached calls. More... | |
| virtual Variable | write (gsl::span< char > data, const Type &in_memory_dataType, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) |
| The fundamental write function. Backends overload this function to implement all write operations. More... | |
| Variable | write (const gsl::span< DataType > data, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) |
| Write the Variable. More... | |
| Variable | write (const gsl::span< const DataType > data, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) |
| Write the Variable. More... | |
| Variable | write (const std::vector< DataType > &data, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) |
| Write the variable. More... | |
| Variable | writeWithEigenRegular (const EigenClass &d, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) |
| Write an Eigen object (a Matrix, an Array, a Block, a Map). More... | |
| Variable | writeWithEigenTensor (const EigenClass &d, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) |
| Write an Eigen Tensor-like object. More... | |
| virtual Variable | read (gsl::span< char > data, const Type &in_memory_dataType, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) const |
| Read the Variable - as char array. Ordering is row-major. More... | |
| Variable | read (gsl::span< DataType > data, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) const |
| Read the variable into a span (range) or memory. Ordering is row-major. More... | |
| Variable | read (std::vector< DataType > &data, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) const |
| Read the variable into a vector. Resize if needed. For a non-resizing version, use a gsl::span. More... | |
| Variable | read (std::valarray< DataType > &data, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) const |
| Valarray read convenience function. Resize if needed. For a non-resizing version, use a gsl::span. More... | |
| std::vector< DataType > | readAsVector (const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) const |
| Read the variable into a new vector. Python convenience function. More... | |
| Variable | readWithEigenRegular (EigenClass &res, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) const |
| Read data into an Eigen::Array, Eigen::Matrix, Eigen::Map, etc. More... | |
| Variable | readWithEigenTensor (EigenClass &res, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) const |
| Read data into an Eigen::Array, Eigen::Matrix, Eigen::Map, etc. More... | |
| EigenClass | _readWithEigenRegular_python (const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) const |
| virtual Selections::SelectionBackend_t | instantiateSelection (const Selection &sel) const |
| Convert a selection into its backend representation. More... | |
| virtual VariableCreationParameters | getCreationParameters (bool doAtts=true, bool doDims=true) const |
| Convenience function to get fill value, attributes, chunk sizes, and compression in a collective call. More... | |
| virtual bool | hasFillValue () const |
| Check if a variable has a fill value set. More... | |
| virtual FillValueData_t | getFillValue () const |
| Retrieve the fill value. More... | |
| virtual std::vector< Dimensions_t > | getChunkSizes () const |
| Retrieve the chunking options for the Variable. More... | |
| virtual std::pair< bool, int > | getGZIPCompression () const |
| Retrieve the GZIP compression options for the Variable. More... | |
| virtual std::tuple< bool, unsigned, unsigned > | getSZIPCompression () const |
| Retrieve the SZIP compression options for the Variable. More... | |
| virtual | ~Variable_Base () |
| std::shared_ptr< Variable_Backend > | get () const |
| Gets a handle to the underlying object that implements the backend functionality. More... | |
Public Attributes | |
Python compatability objects | |
| detail::python_bindings::VariableIsA< Variable > | _py_isA |
| detail::python_bindings::VariableReadVector< Variable > | _py_readVector |
| detail::python_bindings::VariableReadNPArray< Variable > | _py_readNPArray |
| detail::python_bindings::VariableWriteVector< Variable > | _py_writeVector |
| detail::python_bindings::VariableWriteNPArray< Variable > | _py_writeNPArray |
| detail::python_bindings::VariableScales< Variable > | _py_scales |
| Public Attributes inherited from ioda::detail::Variable_Base< Variable > | |
| Has_Attributes | atts |
| Attributes. More... | |
Additional Inherited Members | |
| Public Types inherited from ioda::detail::Variable_Base< Variable > | |
| typedef detail::FillValueData_t | FillValueData_t |
| Remap fill value storage type into this class. More... | |
| Protected Member Functions inherited from ioda::detail::Variable_Base< Variable > | |
| Variable_Base (std::shared_ptr< Variable_Backend >) | |
| Protected Attributes inherited from ioda::detail::Variable_Base< Variable > | |
| std::shared_ptr< Variable_Backend > | backend_ |
| Using an opaque object to implement the backend. More... | |
Detailed Description
Variables store data!
A variable represents a single field of data. It can be multi-dimensional and usually has one or more attached dimension scales.
Variables have Metadata, which describe the variable (i.e. valid_range, long_name, units). Variables can have different data types (i.e. int16_t, float, double, string, datetime). Variables can be resized. Depending on the backend, the data in a variable can be stored using chunks, and may also be compressed.
The backend manages how variables are stored in memory or on disk. The functions in the Variable class provide methods to query and set data. The goal is to have data transfers involve as few copies as possible.
Variable objects themselves are lightweight handles that may be passed across different parts of a program. Variables are always stored somewhere in a Group (or ObsSpace), so you can always re-open a handle.
- Note
- Thread and MPI safety depend on the specific backends used to implement a variable.
- A variable may be linked to multiple groups and listed under multiple names, so long as the storage backends are all the same.
Definition at line 680 of file Variable.h.
Constructor & Destructor Documentation
◆ Variable() [1/3]
| ioda::Variable::Variable | ( | ) |
Definition at line 418 of file Variable.cpp.
◆ Variable() [2/3]
| ioda::Variable::Variable | ( | std::shared_ptr< detail::Variable_Backend > | b | ) |
Definition at line 427 of file Variable.cpp.
◆ Variable() [3/3]
| ioda::Variable::Variable | ( | const Variable & | r | ) |
Definition at line 436 of file Variable.cpp.
◆ ~Variable()
|
virtualdefault |
Member Function Documentation
◆ operator=()
Definition at line 445 of file Variable.cpp.
Member Data Documentation
◆ _py_isA
| detail::python_bindings::VariableIsA<Variable> ioda::Variable::_py_isA |
Definition at line 695 of file Variable.h.
◆ _py_readNPArray
| detail::python_bindings::VariableReadNPArray<Variable> ioda::Variable::_py_readNPArray |
Definition at line 698 of file Variable.h.
◆ _py_readVector
| detail::python_bindings::VariableReadVector<Variable> ioda::Variable::_py_readVector |
Definition at line 697 of file Variable.h.
◆ _py_scales
| detail::python_bindings::VariableScales<Variable> ioda::Variable::_py_scales |
Definition at line 703 of file Variable.h.
◆ _py_writeNPArray
| detail::python_bindings::VariableWriteNPArray<Variable> ioda::Variable::_py_writeNPArray |
Definition at line 701 of file Variable.h.
◆ _py_writeVector
| detail::python_bindings::VariableWriteVector<Variable> ioda::Variable::_py_writeVector |
Definition at line 700 of file Variable.h.
The documentation for this class was generated from the following files:
