radarlib 1.4.6
OdimH5v20::PolarScanData Class Reference

OdimH5 v2.0 SCAN quantity data. More...

#include <radarlib/odimh5v20_classes.hpp>

Inheritance diagram for OdimH5v20::PolarScanData:
OdimH5v20::OdimData OdimH5v20::WHATDatasetMetadata OdimH5v20::WHATRootMetadata

Public Member Functions

virtual std::string getObject ()
 Get the value of 'object' attribute.
 
virtual void setObject (const std::string &val)
 Set the value of 'object' attribute.
 
virtual std::string getVersion ()
 Get the value of 'version' attribute.
 
virtual void setVersion (const std::string &val)
 Set the value of 'version' attribute.
 
virtual time_t getDateTime ()
 Get the joined value of 'date' and 'time' attributes.
 
virtual void setDateTime (const time_t val)
 Set the value of 'date' and 'time' attributes.
 
virtual SourceInfo getSource ()
 Get the value of 'source' attribute.
 
virtual void setSource (const SourceInfo &val)
 Set the value of 'source' attribute.
 
virtual std::string getProduct ()
 Get the value of 'product' attribute.
 
virtual void setProduct (const std::string &val)
 Set the value of 'product' attribute.
 
virtual double getProdPar ()
 Get the value of 'prodpar' attribute as double value.
 
virtual VILHeights getProdParVIL ()
 Get the value of 'prodpar' attribute as VILHeights pair.
 
virtual void setProdPar (double val)
 Set the value of 'prodpar' attribute.
 
virtual void setProdPar (const VILHeights &val)
 Set the value of 'prodpar' attribute using the given VILHeights values.
 
virtual std::string getQuantity ()
 Set the value of 'quantity' attribute.
 
virtual void setQuantity (const std::string &val)
 Get the value of 'quantity' attribute.
 
virtual time_t getStartDateTime ()
 Get the value of 'startdate' and 'starttime' attributes.
 
virtual void setStartDateTime (time_t val)
 Set the value of 'startdate' and 'starttime' attributes.
 
virtual time_t getEndDateTime ()
 Get the value of 'enddate' and 'endtime' attributes.
 
virtual void setEndDateTime (time_t val)
 Set the value of 'enddate' and 'endtime' attributes.
 
virtual double getGain ()
 Get the value of 'gain' attribute.
 
virtual void setGain (double val)
 Set the value of 'gain' attribute.
 
virtual double getOffset ()
 Get the value of 'offset' attribute.
 
virtual void setOffset (double val)
 Set the value of 'offset' attribute.
 
virtual double getNodata ()
 Get the value of 'nodata' attribute.
 
virtual void setNodata (double val)
 Set the value of 'nodata' attribute.
 
virtual double getUndetect ()
 Get the value of 'undetect' attribute.
 
virtual void setUndetect (double val)
 Set the value of 'undetect' attribute.
 
virtual int getNumRays ()
 Get the number of rays in the matrix.
 
virtual int getNumBins ()
 Get the number of bins in each ray of the matrix.
 
H5::AtomType getBinType ()
 Get the type of each element in the matrix.
 
virtual void readTranslatedData (RayMatrix< float > &matrix)
 Read the matrix data translating the values.
 
virtual void readTranslatedData (RayMatrix< double > &matrix)
 Read the matrix data translating the values.
 
virtual void writeAndTranslate (RayMatrix< float > &matrix, float offset, float gain, H5::DataType type)
 Write the given matrix of data into the quantity matrix.
 
virtual void writeAndTranslate (RayMatrix< double > &matrix, double offset, double gain, H5::DataType type)
 Write the given matrix of data into the quantity matrix.
 
virtual H5::Group * getH5Object ()
 Get the HDF5 group associated to this object.
 
virtual bool existWhat ()
 Test is the WHAT attributes group exist.
 
virtual bool existWhere ()
 Test is the WHERE attributes group exist.
 
virtual bool existHow ()
 Test is the HOW attributes group exist.
 
virtual MetadataGroupgetWhat ()
 Get the WHAT attributes group.
 
virtual MetadataGroupgetWhere ()
 Get the WHERE attributes group.
 
virtual MetadataGroupgetHow ()
 Get the HOW attributes group.
 
virtual H5::AtomType getDataType ()
 Get the HDF5 atom type of the elements of the HDF5 dataset contained inside this 'data' group.
 
virtual int getDataWidth ()
 Get the width (cols num) of the matrix associated to this data group.
 
virtual int getDataHeight ()
 Get the height (rows num) of the matrix associated to this data group.
 
virtual void getDataDimension (int *height, int *width)
 Get height and width (rows and cols num) of the matrix associated to this data group.
 
virtual void writeData (const void *buff, int width, int height, const H5::DataType &elemtype)
 Write data to the matrix associated to this 'data' group.
 
virtual void writeData (const char *buff, int width, int height)
 Write data to the matrix associated to this 'data' group.
 
virtual void writeData (const unsigned char *buff, int width, int height)
 Write data to the matrix associated to this 'data' group.
 
virtual void writeData (const unsigned short *buff, int width, int height)
 Write data to the matrix associated to this 'data' group.
 
virtual void writeData (const float *buff, int width, int height)
 Write data to the matrix associated to this 'data' group.
 
virtual void writeData (const DataMatrix< char > &matrix)
 Write data to the matrix associated to this 'data' group.
 
virtual void writeData (const DataMatrix< unsigned char > &matrix)
 Write data to the matrix associated to this 'data' group.
 
virtual void writeData (const DataMatrix< unsigned short > &matrix)
 Write data to the matrix associated to this 'data' group.
 
virtual void writeData (const DataMatrix< float > &matrix)
 Write data to the matrix associated to this 'data' group.
 
virtual void readData (void *buffer)
 Read data from the dataset of this 'data' group.
 
virtual int getQualityCount ()
 Get the number of 'quality' groups inside this data group.
 
virtual OdimQualitycreateQuality ()
 Create a new group 'Quality' inside this data.
 
virtual OdimQualitygetQuality (int index)
 Get an existing Quality group using the given index.
 
virtual void removeQuality (int index)
 Remove a 'quality' group from this dataset.
 

Detailed Description

OdimH5 v2.0 SCAN quantity data.

This class represents OdimH5 data group associated with a OdimH5 quantity Generic data manipulations can be done using methods provided by the OdimObject interface

See also
PolarScanData
Examples
create_polar_volume.cpp, read_polar_volume.cpp, and read_polar_volume2.cpp.

Member Function Documentation

◆ getObject()

std::string OdimH5v20::PolarScanData::getObject ( )
virtual

Get the value of 'object' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

◆ setObject()

void OdimH5v20::PolarScanData::setObject ( const std::string & val)
virtual

Set the value of 'object' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

◆ getVersion()

std::string OdimH5v20::PolarScanData::getVersion ( )
virtual

Get the value of 'version' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

◆ setVersion()

void OdimH5v20::PolarScanData::setVersion ( const std::string & val)
virtual

Set the value of 'version' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

◆ getDateTime()

time_t OdimH5v20::PolarScanData::getDateTime ( )
virtual

Get the joined value of 'date' and 'time' attributes.

Get the joined value of 'date' and 'time' attributes in a single time_t value

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

◆ setDateTime()

void OdimH5v20::PolarScanData::setDateTime ( const time_t val)
virtual

Set the value of 'date' and 'time' attributes.

Set the value of 'date' and 'time' attributes using the given time_t value

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

◆ getSource()

SourceInfo OdimH5v20::PolarScanData::getSource ( )
virtual

Get the value of 'source' attribute.

Returns
A SourceInfo object ottained parsing the 'source' attribute
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

◆ setSource()

void OdimH5v20::PolarScanData::setSource ( const SourceInfo & val)
virtual

Set the value of 'source' attribute.

Set the value of 'source' attribute according to OdimH5 format, using the values stored in a SourceInfo object

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

◆ getProduct()

std::string OdimH5v20::PolarScanData::getProduct ( )
virtual

Get the value of 'product' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ setProduct()

void OdimH5v20::PolarScanData::setProduct ( const std::string & val)
virtual

Set the value of 'product' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ getProdPar()

double OdimH5v20::PolarScanData::getProdPar ( )
virtual

Get the value of 'prodpar' attribute as double value.

This method is used only for some kind of products

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ getProdParVIL()

VILHeights OdimH5v20::PolarScanData::getProdParVIL ( )
virtual

Get the value of 'prodpar' attribute as VILHeights pair.

This method is used only for some kind of products

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ setProdPar() [1/2]

void OdimH5v20::PolarScanData::setProdPar ( double val)
virtual

Set the value of 'prodpar' attribute.

This method is used only for some kind of products

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ setProdPar() [2/2]

void OdimH5v20::PolarScanData::setProdPar ( const VILHeights & val)
virtual

Set the value of 'prodpar' attribute using the given VILHeights values.

Set the value of 'prodpar' attribute using the given VILHeights values This method is used only for some kind of products

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ getQuantity()

std::string OdimH5v20::PolarScanData::getQuantity ( )
virtual

Set the value of 'quantity' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ setQuantity()

void OdimH5v20::PolarScanData::setQuantity ( const std::string & val)
virtual

Get the value of 'quantity' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ getStartDateTime()

time_t OdimH5v20::PolarScanData::getStartDateTime ( )
virtual

Get the value of 'startdate' and 'starttime' attributes.

Get the value of 'startdate' and 'starttime' attributes joined into a time_t value

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ setStartDateTime()

void OdimH5v20::PolarScanData::setStartDateTime ( time_t val)
virtual

Set the value of 'startdate' and 'starttime' attributes.

Set the value of 'startdate' and 'starttime' attributes using the given absolute time_t value

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ getEndDateTime()

time_t OdimH5v20::PolarScanData::getEndDateTime ( )
virtual

Get the value of 'enddate' and 'endtime' attributes.

Get the value of 'enddate' and 'endtime' attributes joined into a time_t value

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ setEndDateTime()

void OdimH5v20::PolarScanData::setEndDateTime ( time_t val)
virtual

Set the value of 'enddate' and 'endtime' attributes.

Set the value of 'enddate' and 'endtime' attributes using the given absolute time_t value

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ getGain()

double OdimH5v20::PolarScanData::getGain ( )
virtual

Get the value of 'gain' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ setGain()

void OdimH5v20::PolarScanData::setGain ( double val)
virtual

Set the value of 'gain' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

Examples
create_polar_volume.cpp.

◆ getOffset()

double OdimH5v20::PolarScanData::getOffset ( )
virtual

Get the value of 'offset' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ setOffset()

void OdimH5v20::PolarScanData::setOffset ( double val)
virtual

Set the value of 'offset' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

Examples
create_polar_volume.cpp.

◆ getNodata()

double OdimH5v20::PolarScanData::getNodata ( )
virtual

Get the value of 'nodata' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ setNodata()

void OdimH5v20::PolarScanData::setNodata ( double val)
virtual

Set the value of 'nodata' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

Examples
create_polar_volume.cpp.

◆ getUndetect()

double OdimH5v20::PolarScanData::getUndetect ( )
virtual

Get the value of 'undetect' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ setUndetect()

void OdimH5v20::PolarScanData::setUndetect ( double val)
virtual

Set the value of 'undetect' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

Examples
create_polar_volume.cpp.

◆ getNumRays()

int OdimH5v20::PolarScanData::getNumRays ( )
virtual

Get the number of rays in the matrix.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Examples
read_polar_volume.cpp, and read_polar_volume2.cpp.

◆ getNumBins()

int OdimH5v20::PolarScanData::getNumBins ( )
virtual

Get the number of bins in each ray of the matrix.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Examples
read_polar_volume.cpp, and read_polar_volume2.cpp.

◆ getBinType()

H5::AtomType OdimH5v20::PolarScanData::getBinType ( )

Get the type of each element in the matrix.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Examples
read_polar_volume.cpp.

◆ readTranslatedData() [1/2]

void OdimH5v20::PolarScanData::readTranslatedData ( RayMatrix< float > & matrix)
virtual

Read the matrix data translating the values.

Read the matrix data translating the values using 'gain' and 'offset' attributes.
The result is store int the given 32 floating point values matrix.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Examples
read_polar_volume.cpp, and read_polar_volume2.cpp.

◆ readTranslatedData() [2/2]

void OdimH5v20::PolarScanData::readTranslatedData ( RayMatrix< double > & matrix)
virtual

Read the matrix data translating the values.

Read the matrix data translating the values using 'gain' and 'offset' attributes The result is store int the given 32 floating point values matrix

Exceptions
OdimH5ExceptionThrowed if an error occurs

◆ writeAndTranslate() [1/2]

void OdimH5v20::PolarScanData::writeAndTranslate ( RayMatrix< float > & matrix,
float offset,
float gain,
H5::DataType type )
virtual

Write the given matrix of data into the quantity matrix.

Write the given matrix of data into the HDF5 dataset associated to this quantity.
Value will be written according to the given HDF5 type and translated useing the given gain and offset.

Parameters
matrixthe values to rite
gainthe gain value used to translate values
offsetthe offset value used to translate values
typethe type to use fo the HDF5 dataset elements
Exceptions
OdimH5ExceptionThrowed if an error occurs
Examples
create_polar_volume.cpp.

◆ writeAndTranslate() [2/2]

void OdimH5v20::PolarScanData::writeAndTranslate ( RayMatrix< double > & matrix,
double offset,
double gain,
H5::DataType type )
virtual

Write the given matrix of data into the quantity matrix.

Write the given matrix of data into the HDF5 dataset associated to this quantity.
Values will be written according to the given HDF5 type and translated useing the given gain and offset.

Parameters
matrixthe values to rite
gainthe gain value used to translate values
offsetthe offset value used to translate values
typethe type to use fo the HDF5 dataset elements
Exceptions
OdimH5ExceptionThrowed if an error occurs

◆ getH5Object()

H5::Group * OdimH5v20::OdimData::getH5Object ( )
virtualinherited

Get the HDF5 group associated to this object.

Get the HDF5 group associated to this object

Remarks
user must not delete this object
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ existWhat()

bool OdimH5v20::OdimData::existWhat ( )
virtualinherited

Test is the WHAT attributes group exist.

Check if the WHAT attributes group of this object exist.

Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples
image-visitor.cpp.

◆ existWhere()

bool OdimH5v20::OdimData::existWhere ( )
virtualinherited

Test is the WHERE attributes group exist.

Check if the WHERE attributes group of this object exist.

Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples
image-visitor.cpp.

◆ existHow()

bool OdimH5v20::OdimData::existHow ( )
virtualinherited

Test is the HOW attributes group exist.

Check if the HOW attributes group of this object exist.

Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples
image-visitor.cpp.

◆ getWhat()

MetadataGroup * OdimH5v20::OdimData::getWhat ( )
virtualinherited

Get the WHAT attributes group.

Get the WHAT attributes group of this object. If it does not exist it will be created

Remarks
user must not delete this object
Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples
create_delete.cpp, create_odim_object.cpp, create_polar_volume.cpp, and image-visitor.cpp.

◆ getWhere()

MetadataGroup * OdimH5v20::OdimData::getWhere ( )
virtualinherited

Get the WHERE attributes group.

Get the WHERE attributes group of this object. If it does not exist it will be created

Remarks
user must not delete this object
Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples
image-visitor.cpp.

◆ getHow()

MetadataGroup * OdimH5v20::OdimData::getHow ( )
virtualinherited

Get the HOW attributes group.

Get the HOW attributes group of this object. If it does not exist it will be created

Remarks
user must not delete this object
Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples
image-visitor.cpp.

◆ getDataType()

H5::AtomType OdimH5v20::OdimData::getDataType ( )
virtualinherited

Get the HDF5 atom type of the elements of the HDF5 dataset contained inside this 'data' group.

Get the HDF5 atom type of the elements of the HDF5 dataset contained inside this 'data' group.
If the HDF5 dataset is not present then NATIVE_OPAQUE will be returned. OdimH5 allow only atomic types: char, schar, uchar, short, ushort, int, uint, long, ulong, llong, ullong, float, double.

Exceptions
OdimH5Exceptionif an unexpected error occurs
OdimH5UnsupportedExceptionif the dataset type cannot be converted to an atomic type
Examples
image-visitor.cpp.

◆ getDataWidth()

int OdimH5v20::OdimData::getDataWidth ( )
virtualinherited

Get the width (cols num) of the matrix associated to this data group.

Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples
image-visitor.cpp.

◆ getDataHeight()

int OdimH5v20::OdimData::getDataHeight ( )
virtualinherited

Get the height (rows num) of the matrix associated to this data group.

Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples
image-visitor.cpp.

◆ getDataDimension()

void OdimH5v20::OdimData::getDataDimension ( int * height,
int * width )
virtualinherited

Get height and width (rows and cols num) of the matrix associated to this data group.

Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ writeData() [1/9]

void OdimH5v20::OdimData::writeData ( const void * buff,
int width,
int height,
const H5::DataType & elemtype )
virtualinherited

Write data to the matrix associated to this 'data' group.

Write data to the matrix associated to this 'data' group from the given buffer where each element has the given type.
The buffer must be a continuous memory array logically organized as a matrix divided in rows and cols.

The size of the buffer must be at least equal to (height * width * elemtype.getSize()). Otherwise a buffer overflow will occur.

Parameters
buffthe buffer containing the data to write
widththe number of cols in the matrix
heightthe number of rows in the matrix
elemtypethe HDF5 datatype of the buffer's elements
Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples
create_odim_object.cpp, create_polar_volume.cpp, and image-visitor.cpp.

◆ writeData() [2/9]

void OdimH5v20::OdimData::writeData ( const char * buff,
int width,
int height )
virtualinherited

Write data to the matrix associated to this 'data' group.

Write data to the matrix associated to this 'data' group from the given 8 bit signed buffer

Parameters
buffthe buffer containing the data to write
widththe number of cols in the matrix
heightthe number of rows in the matrix
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ writeData() [3/9]

void OdimH5v20::OdimData::writeData ( const unsigned char * buff,
int width,
int height )
virtualinherited

Write data to the matrix associated to this 'data' group.

Write data to the matrix associated to this 'data' group from the given 8 bit unsigned buffer

Parameters
buffthe buffer containing the data to write
widththe number of cols in the matrix
heightthe number of rows in the matrix
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ writeData() [4/9]

void OdimH5v20::OdimData::writeData ( const unsigned short * buff,
int width,
int height )
virtualinherited

Write data to the matrix associated to this 'data' group.

Write data to the matrix associated to this 'data' group from the given 16 bit unsigned char buffer

Parameters
buffthe buffer containing the data to write
widththe number of cols in the matrix
heightthe number of rows in the matrix
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ writeData() [5/9]

void OdimH5v20::OdimData::writeData ( const float * buff,
int width,
int height )
virtualinherited

Write data to the matrix associated to this 'data' group.

Write data to the matrix associated to this 'data' group from the given 32 bit floating point buffer

Parameters
buffthe buffer containing the data to write
widththe number of cols in the matrix
heightthe number of rows in the matrix
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ writeData() [6/9]

void OdimH5v20::OdimData::writeData ( const DataMatrix< char > & matrix)
virtualinherited

Write data to the matrix associated to this 'data' group.

Write data to the matrix associated to this 'data' group from the DataMatrix object.
The HDF5 dataset will be created using the size and type of the given matrix object.

Parameters
matrixthe matrix object containing the data
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ writeData() [7/9]

void OdimH5v20::OdimData::writeData ( const DataMatrix< unsigned char > & matrix)
virtualinherited

Write data to the matrix associated to this 'data' group.

Write data to the matrix associated to this 'data' group from the DataMatrix object.
The HDF5 dataset will be created using the size and type of the given matrix object.

Parameters
matrixthe matrix object containing the data
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ writeData() [8/9]

void OdimH5v20::OdimData::writeData ( const DataMatrix< unsigned short > & matrix)
virtualinherited

Write data to the matrix associated to this 'data' group.

Write data to the matrix associated to this 'data' group from the DataMatrix object.
The HDF5 dataset will be created using the size and type of the given matrix object.

Parameters
matrixthe matrix object containing the data
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ writeData() [9/9]

void OdimH5v20::OdimData::writeData ( const DataMatrix< float > & matrix)
virtualinherited

Write data to the matrix associated to this 'data' group.

Write data to the matrix associated to this 'data' group from the DataMatrix object The HDF5 dataset will be created using the size and type of the given matrix object

Parameters
matrixthe matrix object containing the data
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ readData()

void OdimH5v20::OdimData::readData ( void * buffer)
virtualinherited

Read data from the dataset of this 'data' group.

Read data from the dataset of this 'data' group into the given buffer.
The buffer must be large enough to store all elements in the HDF5 dataset.
The minimum size in byte is (getDataWidth() x getDataHeight() x getDataType().getSize()).

Parameters
bufferthe buffer to store the loaded data
Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples
image-visitor.cpp.

◆ getQualityCount()

int OdimH5v20::OdimData::getQualityCount ( )
virtualinherited

Get the number of 'quality' groups inside this data group.

Returns
the number of 'quality' groups
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ createQuality()

OdimQuality * OdimH5v20::OdimData::createQuality ( )
virtualinherited

Create a new group 'Quality' inside this data.

Returns
the object associated to the new 'quality' group
Exceptions
OdimH5Exceptionif an unexpected error occurs
Remarks
User is responsible for deleting the returned object

◆ getQuality()

OdimQuality * OdimH5v20::OdimData::getQuality ( int index)
virtualinherited

Get an existing Quality group using the given index.

Get an existing dataset using the given index

Parameters
indexthe quality index from 0 to n-1
Returns
the OdimQuality object associated to the HDF5 group or NULL if the group does not exist
Exceptions
OdimH5Exceptionif an unexpected error occurs
Remarks
User is responsible for deleting the returned object

◆ removeQuality()

void OdimH5v20::OdimData::removeQuality ( int index)
virtualinherited

Remove a 'quality' group from this dataset.

Remove a 'quality' group from this dataset

Parameters
indexthe dataset index from 0 to n-1
Exceptions
OdimH5Exceptionif an unexpected error occurs

The documentation for this class was generated from the following files: