Workspace 6.21.5
|
An interface to an ArrayNd object which contains data of a specific type.
#include <DataAnalysis/DataStructures/arraynd.h>
Public Member Functions | |
bool | arrayAccessHint (const NamedDimensionRangeList &range) override=0 |
ArrayNdTyped * | clone () const override=0 |
virtual bool | getData (const NamedDimensionRangeList &range, T *data) const =0 |
double | getFillValue () const override=0 |
QVariant | getFillValueAsVariant () const override=0 |
QVariant | getValue (const DimensionIndexList &dimIndices) const override |
QVariant | getValue (size_type dim0, size_type dim1=0, size_type dim2=0, size_type dim3=0, size_type dim4=0) const override |
bool | hasFillValue () const override=0 |
double | operator() (const DimensionIndexList &dimIndices) const override |
double | operator() (size_type dim0, size_type dim1=0, size_type dim2=0, size_type dim3=0, size_type dim4=0) const override |
ArrayNdTyped & | operator= (const ArrayNdTyped &other)=default |
virtual bool | setFillValue (const T &value)=0 |
void | setHasFillValue (bool b) override=0 |
virtual T | valueAt (const DimensionIndexList &indices) const =0 |
virtual T | valueAt (size_type dim0, size_type dim1=0, size_type dim2=0, size_type dim3=0, size_type dim4=0) const =0 |
virtual bool | writeData (const NamedDimensionRangeList &range, const T *const data)=0 |
Public Member Functions inherited from ArrayNd | |
ArrayNd () | |
~ArrayNd () override | |
virtual bool | arrayAccessHint (const NamedDimensionRangeList &range)=0 |
const_iterator | begin () const |
ArrayNd * | clone () const override=0 |
const_iterator | end () const |
NamedDimensionRangeList | getAllDimensions () const |
virtual const DataCollection & | getAttributes () const =0 |
template<typename T > | |
bool | getData (const NamedDimensionRangeList &range, T *data) const |
virtual const DataExecution::DataFactory * | getDataFactory () const =0 |
NamedDimensionRange | getDimension (const QString &name) const |
virtual int | getDimensionIndex (const QString &name) const =0 |
virtual ArrayNdDimensionLabels | getDimensionLabels (const QString &dimensionName) const =0 |
virtual QString | getDimensionName (int index) const =0 |
virtual size_type | getDimensionSize (const QString &name) const =0 |
virtual size_type | getDimensionSize (int index) const =0 |
virtual double | getFillValue () const =0 |
virtual QVariant | getFillValueAsVariant () const =0 |
template<typename T > | |
ArrayNdTyped< T > * | getTypedInterface () |
template<typename T > | |
const ArrayNdTyped< T > * | getTypedInterface () const |
virtual QVariant | getValue (const DimensionIndexList &dimIndices) const =0 |
virtual QVariant | getValue (size_type dim0, size_type dim1=0, size_type dim2=0, size_type dim3=0, size_type dim4=0) const =0 |
virtual bool | hasFillValue () const =0 |
virtual bool | isDimensionUnlimited (int index) const =0 |
virtual int | numDimensions () const =0 |
virtual double | operator() (const DimensionIndexList &dimIndices) const =0 |
virtual double | operator() (size_type dim0, size_type dim1=0, size_type dim2=0, size_type dim3=0, size_type dim4=0) const =0 |
const_iterator_range | range (const NamedDimensionRangeList &range) const |
virtual bool | setDimensions (const NamedDimensionRangeList &dimensions)=0 |
template<typename T > | |
bool | setFillValue (const T &value) |
virtual void | setHasFillValue (bool b)=0 |
template<typename T > | |
bool | writeData (const NamedDimensionRangeList &range, const T *data) |
Public Member Functions inherited from Clonable | |
virtual | ~Clonable ()=default |
virtual Clonable * | clone () const =0 |
Additional Inherited Members | |
Public Types inherited from ArrayNd | |
typedef NamedDimensionRange::size_type | size_type |
Protected Member Functions inherited from ArrayNd | |
ArrayNd (ArrayNd &&other) | |
ArrayNd (const ArrayNd &other) | |
ArrayNd & | operator= (const ArrayNd &other)=default |
|
overridepure virtual |
range | The range we are expecting to read from when using the getValue or operator() functions. |
The range we are hinting that we're about to access repeatedly through individual indexed reads (i.e. using the operator() function).
Implements ArrayNd.
Implemented in ArrayNdData< T >, ArrayNdData< double >, ArrayNdDimensionFilterTyped< T >, ArrayNdInterface< T >, ArrayNdPermutationTyped< T >, and ArrayNdSliceTyped< T >.
|
overridepure virtual |
Implements ArrayNd.
Implemented in ArrayNdData< T >, ArrayNdData< double >, ArrayNdDimensionFilterTyped< T >, ArrayNdInterface< T >, ArrayNdPermutationTyped< T >, and ArrayNdSliceTyped< T >.
|
pure virtual |
range | The bounded range from which we are reading data. |
data | The data store into which we will write the data that we are reading from the dataset. |
Gets data from the underlying data structure, copying it into the provided data parameter. The exact dimensions of the read are specified by the range parameter.
Implemented in ArrayNdData< double >, ArrayNdData< T >, ArrayNdDimensionFilterTyped< T >, ArrayNdInterface< T >, ArrayNdPermutationTyped< T >, and ArrayNdSliceTyped< T >.
|
overridepure virtual |
The Fill Value of the dataset is used to indicate an 'empty' cell. Cells that do not contain any valid data, or data outside the known / valid range, will contain the fill value.
Implements ArrayNd.
Implemented in ArrayNdData< T >, ArrayNdData< double >, ArrayNdDimensionFilterTyped< T >, ArrayNdInterface< T >, ArrayNdPermutationTyped< T >, and ArrayNdSliceTyped< T >.
|
overridepure virtual |
The Fill Value of the dataset is used to indicate an 'empty' cell. Cells that do not contain any valid data, or data outside the known / valid range, will contain the fill value.
Implements ArrayNd.
Implemented in ArrayNdData< T >, ArrayNdData< double >, ArrayNdDimensionFilterTyped< T >, ArrayNdInterface< T >, ArrayNdPermutationTyped< T >, and ArrayNdSliceTyped< T >.
|
inlineoverridevirtual |
dimIndices | The set of coordinates at which we wish to inspect the value. The coordinate indices are assumed to be in the same order as they are stored in the dataset. |
Retrieve a single value from the underlying dataset using array subscript notation. The number of parameters supplied must match the underlying dataset. It is up to the developer to ensure that this always occurs.
The dimensions must be provided in the same order as they are stored in the dataset. This can be queried using getDimensionIndex() This version of the function returns a QVariant which contains the specific underlying type that matches the dataset.
Implements ArrayNd.
|
inlineoverridevirtual |
dim0 | The index in the first dimension |
dim1 | The index in the second dimension |
dim2 | The index in the third dimension |
dim3 | The index in the fourth dimension |
dim4 | The index in the fifth dimension |
Retrieve a single value from the underlying dataset using array subscript notation. The number of parameters supplied MUST match the underlying dataset. It is up to the developer to ensure that this always occurs.
The dimensions must be provided in the same order as they are stored in the dataset. This can be queried using getDimensionIndex().
Implements ArrayNd.
|
overridepure virtual |
The Fill Value of the dataset is used to indicate an 'empty' cell. Cells that do not contain any valid data, or data outside the known / valid range, will contain the fill value. This function returns a value indicating whether or not a fill value is being used.
Implements ArrayNd.
Implemented in ArrayNdData< T >, ArrayNdData< double >, ArrayNdDimensionFilterTyped< T >, ArrayNdInterface< T >, ArrayNdPermutationTyped< T >, and ArrayNdSliceTyped< T >.
|
inlineoverridevirtual |
dimIndices | The set of coordinates at which we wish to inspect the value. The coordinate indices are assumed to be in the same order as they are stored in the dataset. |
Retrieve a single value from the underlying dataset using array subscript notation. The number of parameters supplied must match the underlying dataset. It is up to the developer to ensure that this always occurs.
The dimensions must be provided in the same order as they are stored in the dataset. This can be queried using getDimensionIndex()
Implements ArrayNd.
|
inlineoverridevirtual |
dim0 | The index in the first dimension |
dim1 | The index in the second dimension |
dim2 | The index in the third dimension |
dim3 | The index in the fourth dimension |
dim4 | The index in the fifth dimension |
Retrieve a single value from the underlying dataset using array subscript notation. The number of parameters supplied MUST match the underlying dataset. It is up to the developer to ensure that this always occurs.
The dimensions must be provided in the same order as they are stored in the dataset. This can be queried using getDimensionIndex().
Implements ArrayNd.
|
default |
|
pure virtual |
value | The fill value that we are setting. |
When the dimensions of a dataset are set (setDimensions), a fill-value is specified which will be used to populate the newly created cells. This function allows the fill-value to be overridden.
Implemented in ArrayNdData< double >, ArrayNdData< T >, ArrayNdDimensionFilterTyped< T >, ArrayNdInterface< T >, ArrayNdPermutationTyped< T >, and ArrayNdSliceTyped< T >.
|
overridepure virtual |
b | Whether or not to use a fill value for this dataset. By default, the fill value will be the default constructed type of the underlying stored data. |
The Fill Value of the dataset is used to indicate an 'empty' cell. Cells that do not contain any valid data, or data outside the known / valid range, will contain the fill value. This function allows the caller to indicate that a fill value is in use in the dataset.
Implements ArrayNd.
Implemented in ArrayNdData< T >, ArrayNdData< double >, ArrayNdDimensionFilterTyped< T >, ArrayNdInterface< T >, ArrayNdPermutationTyped< T >, and ArrayNdSliceTyped< T >.
|
pure virtual |
indices | The specific indices of the dimensions we wish to access. By default, the indices in the list are assumed to be in the same order that they are in the dataset (e.g. indices[0] will index into getDimension(0)). |
Retrieve a single value from the datset using syntax similar to array subscript notation. This particular overload allows the caller to retrieve a value from a dataset with any number of dimensions.
Implemented in ArrayNdData< T >, ArrayNdData< double >, ArrayNdDimensionFilterTyped< T >, ArrayNdInterface< T >, ArrayNdPermutationTyped< T >, and ArrayNdSliceTyped< T >.
|
pure virtual |
dim0 | The index of the first dimension in the dataset. |
dim1 | The index of the second dimension in the dataset. |
dim2 | The index of the third dimension in the dataset. |
dim3 | The index of the fourth dimension in the dataset. |
dim4 | The index of the fifth dimension in the dataset. |
Retrieve a single value from the datset using syntax similar to array subscript notation. This particular overload allows the caller to retrieve a value from a dataset with 5 dimensions. Dimensions at indexes 5 and above (assuming they exist) will be be retrieved using index 0 for these dimensions.
Implemented in ArrayNdData< T >, ArrayNdData< double >, ArrayNdDimensionFilterTyped< T >, ArrayNdInterface< T >, ArrayNdPermutationTyped< T >, and ArrayNdSliceTyped< T >.
|
pure virtual |
range | The bounded range to which we are writing the data. These dimensions must be specified in terms of the sliced dimensions, not the dimensions of the underlying base dataset. |
data | The data which we are going to write into the dataset. |
Writes data to the underlying data structure, copying it from the provided data parameter. The exact dimensions of the write are specified by the range parameter.
Implemented in ArrayNdData< double >, ArrayNdData< T >, ArrayNdDimensionFilterTyped< T >, ArrayNdInterface< T >, ArrayNdPermutationTyped< T >, and ArrayNdSliceTyped< T >.