radarlib 1.4.6
OdimH5v20::Product_XSEC Class Reference

OdimH5 v2.0 XSEC Product Dataset. More...

#include <radarlib/odimh5v20_classes.hpp>

Inheritance diagram for OdimH5v20::Product_XSEC:
OdimH5v20::Vertical_Product_2D OdimH5v20::Product_2D OdimH5v20::WHEREXSECMetadata OdimH5v20::OdimDataset OdimH5v20::WHATDatasetMetadata OdimH5v20::HOWPolarMetadata OdimH5v20::WHATRootMetadata OdimH5v20::HOWDatasetMetadata OdimH5v20::HOWRootMetadata

Public Member Functions

virtual int getXSize ()
 Get the 'X size' attribute value.
 
virtual void setXSize (int val)
 set the 'X size' attribute value
 
virtual int getYSize ()
 Get the 'Y size' attribute value.
 
virtual void setYSize (int val)
 set the 'Y size' attribute value
 
virtual double getXScale ()
 get the 'X scale' attribute value
 
virtual void setXScale (double val)
 set the 'X scale' attribute value
 
virtual double getYScale ()
 Get the 'Y scale' attribute value.
 
virtual void setYScale (double val)
 set the 'Y scale' attribute value
 
virtual double getMinHeight ()
 Get the 'Min Height' attribute value.
 
virtual void setMinHeight (double val)
 set the 'Min Height' attribute value
 
virtual double getMaxHeight ()
 Get the 'Max Height' attribute value.
 
virtual void setMaxHeight (double val)
 set the 'Max Height' attribute value
 
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 std::string getAzimuthMethod ()
 Get the 'azmethod' attribute value.
 
virtual void setAzimuthMethod (const std::string &val)
 Set the 'azmethod' attribute value.
 
virtual std::string getBinMethod ()
 Get the 'binmethod' attribute value.
 
virtual void setBinMethod (const std::string &val)
 Set the 'binmethod' attribute value.
 
virtual std::vector< AZAnglesgetAzimuthAngles ()
 Get the 'azangles' attribute values.
 
virtual void setAzimuthAngles (const std::vector< AZAngles > &val, int precision=10)
 Set the 'azangles' attribute values.
 
virtual std::vector< double > getElevationAngles ()
 Get the 'elangles' attribute values.
 
virtual void setElevationAngles (const std::vector< double > &val, int precision=10)
 Set the 'elangles' attribute values.
 
virtual std::vector< AZTimesgetAzimuthTimes ()
 Get the 'aztimes' attribute values.
 
virtual void setAzimuthTimes (const std::vector< AZTimes > &val)
 Set the 'aztimes' attribute values.
 
virtual double getPointAccEl ()
 Get the 'pointaccEL' attribute values.
 
virtual void setPointAccEl (double val)
 Set the 'pointaccEL' attribute values.
 
virtual double getPointAccAZ ()
 Get the 'pointaccAZ' attribute values.
 
virtual void setPointAccAZ (double val)
 Set the 'pointaccAZ' attribute values.
 
virtual bool getMalfunc ()
 Get the 'malfunc' attribute value.
 
virtual void setMalfunc (bool val)
 Set the 'malfunc' attribute value.
 
virtual std::string getRadarMsg ()
 Get the 'radarmsg' attribute value.
 
virtual void setRadarMsg (const std::string &val)
 Set the 'radarmsg' attribute value.
 
virtual double getRadarHorizon ()
 Get the 'radhoriz' attribute value.
 
virtual void setRadarHorizon (double val)
 Set the 'radhoriz' attribute value.
 
virtual double getMDS ()
 Get the 'MDS' attribute value.
 
virtual void setMDS (double val)
 Set the 'MDS' attribute value.
 
virtual double getOUR ()
 Get the 'OUR' attribute value.
 
virtual void setOUR (double val)
 Set the 'OUR' attribute value.
 
virtual std::vector< std::string > getDClutter ()
 Get the 'Dclutter' attribute value.
 
virtual void setDClutter (const std::vector< std::string > &value)
 Set the 'Dclutter' attribute value.
 
virtual std::string getComment ()
 Get the 'comment' attribute value.
 
virtual void setComment (const std::string &val)
 Set the 'comment' attribute value.
 
virtual double getSQI ()
 Get the 'SQI' attribute value.
 
virtual void setSQI (double val)
 Set the 'SQI' attribute value.
 
virtual double getCSR ()
 Get the 'CSR' attribute value.
 
virtual void setCSR (double val)
 Set the 'CSR' attribute value.
 
virtual double getLOG ()
 Get the 'LOG' attribute value.
 
virtual void setLOG (double val)
 Set the 'LOG' attribute value.
 
virtual bool getVPRCorr ()
 Get the 'VPRCoor' attribute value.
 
virtual void setVPRCorr (bool val)
 Set the 'VPRCoor' attribute value.
 
virtual double getFreeze ()
 Get the 'freeze' attribute value.
 
virtual void setFreeze (double val)
 Set the 'freeze' attribute value.
 
virtual double getMin ()
 Get the 'min' attribute value.
 
virtual void setMin (double val)
 Set the 'min' attribute value.
 
virtual double getMax ()
 Get the 'max' attribute value.
 
virtual void setMax (double val)
 Set the 'max' attribute value.
 
virtual double getStep ()
 Get the 'step' attribute value.
 
virtual void setStep (double val)
 Set the 'step' attribute value.
 
virtual int getLevels ()
 Get the 'levels' attribute value.
 
virtual void setLevels (int val)
 Set the 'levels' attribute value.
 
virtual double getPeakPwr ()
 Get the 'peakpwr' attribute value.
 
virtual void setPeakPwr (double val)
 Set the 'peakpwr' attribute value.
 
virtual double getAvgPwr ()
 Get the 'avgpwr' attribute value.
 
virtual void setAvgPwr (double val)
 Set the 'awgpwr' attribute value.
 
virtual double getDynRange ()
 Get the 'dynrange' attribute value.
 
virtual void setDynRange (double val)
 Set the 'dynrange' attribute value.
 
virtual double getRAC ()
 Get the 'RAC' attribute value.
 
virtual void setRAC (double val)
 Set the 'RAC' attribute value.
 
virtual bool getBBC ()
 Get the 'BBC' attribute value.
 
virtual void setBBC (bool val)
 Set the 'BBC' attribute value.
 
virtual double getPAC ()
 Get the 'PAC' attribute value.
 
virtual void setPAC (double val)
 Set the 'PAC' attribute value.
 
virtual double getS2N ()
 Get the 'S2N' attribute value.
 
virtual void setS2N (double val)
 Set the 'S2N' attribute value.
 
virtual std::string getPolarization ()
 Get the 'polarization' attribute value.
 
virtual void setPolarization (const std::string &val)
 Set the 'polarization' attribute value.
 
virtual std::string getTaskOrProdGen ()
 Get the 'task' attribute value.
 
virtual void setTaskOrProdGen (const std::string &val)
 Set the 'task' attribute value.
 
virtual time_t getStartEpochs ()
 Get the 'startepochs' attribute value.
 
virtual void setStartEpochs (time_t val)
 Set the 'startepochs' attribute value.
 
virtual time_t getEndEpochs ()
 Get the 'endepochs' attribute value.
 
virtual void setEndEpochs (time_t val)
 Set the 'endepochs' attribute value.
 
virtual std::string getSystem ()
 Get the 'system' attribute value.
 
virtual void setSystem (const std::string &val)
 Set the 'system' attribute value.
 
virtual std::string getSoftware ()
 Get the 'software' attribute value.
 
virtual void setSoftware (const std::string &val)
 Set the 'software' attribute value.
 
virtual std::string getSoftwareVer ()
 Get the 'sw_version' attribute value.
 
virtual void setSoftwareVer (const std::string &val)
 Set the 'sw_version' attribute value.
 
virtual double getZR_A ()
 Get the 'zr_a' attribute value.
 
virtual void setZR_A (double val)
 Set the 'zr_a' attribute value.
 
virtual double getZR_B ()
 Get the 'zr_b' attribute value.
 
virtual void setZR_B (double val)
 Set the 'zr_b' attribute value.
 
virtual double getKR_A ()
 Get the 'kr_a' attribute value.
 
virtual void setKR_A (double val)
 Set the 'kr_a' attribute value.
 
virtual double getKR_B ()
 Get the 'kr_b' attribute value.
 
virtual void setKR_B (double val)
 Set the 'kr_b' attribute value.
 
virtual bool getSimulated ()
 Get the 'simulated' attribute value.
 
virtual void setSimulated (bool val)
 Set the 'simulated' attribute value.
 
virtual double getBeamWidth ()
 Get the 'beamwidth' attribute value.
 
virtual double getBeamWidth (double defaultValue)
 Get the 'beamwidth' attribute value.
 
virtual void setBeamWidth (double val)
 Set the 'beamwidth' attribute value.
 
virtual double getWaveLength ()
 Get the 'wavelength' attribute value.
 
virtual double getWaveLength (double defaultValue)
 Get the 'wavelength' attribute value.
 
virtual void setWaveLength (double val)
 Get the 'wavelength' attribute value.
 
virtual double getRPM ()
 Get the 'prm' attribute value.
 
virtual double getRPM (double defaultValue)
 Get the 'rpm' attribute value.
 
virtual void setRPM (double val)
 Get the 'rpm' attribute value.
 
virtual double getPulseWidth ()
 Get the 'pulsewidth' attribute value.
 
virtual double getPulseWidth (double defaultValue)
 Get the 'pulsewidth' attribute value.
 
virtual void setPulseWidth (double val)
 Get the 'pulsewidth' attribute value.
 
virtual int getLowPRF ()
 Get the 'lowprf' attribute value.
 
virtual int getLowPRF (int defaultValue)
 Get the 'lowprf' attribute value.
 
virtual void setLowPRF (int val)
 Get the 'lowprf' attribute value.
 
virtual int getHighPRF ()
 Get the 'highprf' attribute value.
 
virtual int getHighPRF (int defaultValue)
 Get the 'highprf' attribute value.
 
virtual void setHighPRF (int val)
 Get the 'highprf' attribute value.
 
virtual Product_2D_DatacreateQuantityData (const char *name)
 Create a new group for a quantity in the product.
 
virtual int getQuantityDataCount ()
 Get number of quantities stored in the scan.
 
virtual bool hasQuantityData (const char *name)
 Check if the scan contains the data associated to a quantity.
 
virtual int getQuantityDataIndex (const char *name)
 Return the index of the 'data' group containing the given quantity.
 
virtual Product_2D_DatagetQuantityData (int index)
 Get the data associated to a quantity.
 
virtual Product_2D_DatagetQuantityData (const char *name)
 Get the data associated to a quantity.
 
std::set< std::string > getStoredQuantities ()
 Get the name of all quantities present in this scan.
 
virtual void removeQuantityData (const char *name)
 Delete the data associated to a quantity.
 
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 int getDataCount ()
 Get the number of 'data' groups inside this dataset group.
 
virtual OdimDatacreateData ()
 Create a new group 'data' inside this dataset.
 
virtual OdimDatagetData (int index)
 Get an existing dataset using the given index.
 
virtual void removeData (int index)
 Remove a 'data' group from this dataset.
 

Detailed Description

OdimH5 v2.0 XSEC Product Dataset.

This class represents a specilised 2D-Vertical Product for XSEC.
Product generic attributes can be manipulated using these methods.
Generic data manipulations can be done using methods provided by the OdimDataset interface.

See also
Product_2D_Data

Member Function Documentation

◆ getXSize()

int OdimH5v20::Vertical_Product_2D::getXSize ( )
virtualinherited

Get the 'X size' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHEREXSECMetadata.

◆ setXSize()

void OdimH5v20::Vertical_Product_2D::setXSize ( int val)
virtualinherited

set the 'X size' attribute value

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHEREXSECMetadata.

◆ getYSize()

int OdimH5v20::Vertical_Product_2D::getYSize ( )
virtualinherited

Get the 'Y size' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHEREXSECMetadata.

◆ setYSize()

void OdimH5v20::Vertical_Product_2D::setYSize ( int val)
virtualinherited

set the 'Y size' attribute value

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHEREXSECMetadata.

◆ getXScale()

double OdimH5v20::Vertical_Product_2D::getXScale ( )
virtualinherited

get the 'X scale' attribute value

\

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHEREXSECMetadata.

◆ setXScale()

void OdimH5v20::Vertical_Product_2D::setXScale ( double val)
virtualinherited

set the 'X scale' attribute value

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHEREXSECMetadata.

◆ getYScale()

double OdimH5v20::Vertical_Product_2D::getYScale ( )
virtualinherited

Get the 'Y scale' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHEREXSECMetadata.

◆ setYScale()

void OdimH5v20::Vertical_Product_2D::setYScale ( double val)
virtualinherited

set the 'Y scale' attribute value

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHEREXSECMetadata.

◆ getMinHeight()

double OdimH5v20::Vertical_Product_2D::getMinHeight ( )
virtualinherited

Get the 'Min Height' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHEREXSECMetadata.

◆ setMinHeight()

void OdimH5v20::Vertical_Product_2D::setMinHeight ( double val)
virtualinherited

set the 'Min Height' attribute value

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHEREXSECMetadata.

◆ getMaxHeight()

double OdimH5v20::Vertical_Product_2D::getMaxHeight ( )
virtualinherited

Get the 'Max Height' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHEREXSECMetadata.

◆ setMaxHeight()

void OdimH5v20::Vertical_Product_2D::setMaxHeight ( double val)
virtualinherited

set the 'Max Height' attribute value

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHEREXSECMetadata.

◆ getObject()

std::string OdimH5v20::Product_2D::getObject ( )
virtualinherited

Get the value of 'object' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

Examples
image-visitor.cpp.

◆ setObject()

void OdimH5v20::Product_2D::setObject ( const std::string & val)
virtualinherited

Set the value of 'object' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

◆ getVersion()

std::string OdimH5v20::Product_2D::getVersion ( )
virtualinherited

Get the value of 'version' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

◆ setVersion()

void OdimH5v20::Product_2D::setVersion ( const std::string & val)
virtualinherited

Set the value of 'version' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

◆ getDateTime()

time_t OdimH5v20::Product_2D::getDateTime ( )
virtualinherited

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::Product_2D::setDateTime ( const time_t val)
virtualinherited

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::Product_2D::getSource ( )
virtualinherited

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::Product_2D::setSource ( const SourceInfo & val)
virtualinherited

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::Product_2D::getProduct ( )
virtualinherited

Get the value of 'product' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

Examples
image-visitor.cpp.

◆ setProduct()

void OdimH5v20::Product_2D::setProduct ( const std::string & val)
virtualinherited

Set the value of 'product' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ getProdPar()

double OdimH5v20::Product_2D::getProdPar ( )
virtualinherited

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.

Examples
image-visitor.cpp.

◆ getProdParVIL()

VILHeights OdimH5v20::Product_2D::getProdParVIL ( )
virtualinherited

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.

Examples
image-visitor.cpp.

◆ setProdPar() [1/2]

void OdimH5v20::Product_2D::setProdPar ( double val)
virtualinherited

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::Product_2D::setProdPar ( const VILHeights & val)
virtualinherited

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::Product_2D::getQuantity ( )
virtualinherited

Set the value of 'quantity' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ setQuantity()

void OdimH5v20::Product_2D::setQuantity ( const std::string & val)
virtualinherited

Get the value of 'quantity' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ getStartDateTime()

time_t OdimH5v20::Product_2D::getStartDateTime ( )
virtualinherited

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::Product_2D::setStartDateTime ( time_t val)
virtualinherited

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::Product_2D::getEndDateTime ( )
virtualinherited

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::Product_2D::setEndDateTime ( time_t val)
virtualinherited

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::Product_2D::getGain ( )
virtualinherited

Get the value of 'gain' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ setGain()

void OdimH5v20::Product_2D::setGain ( double val)
virtualinherited

Set the value of 'gain' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ getOffset()

double OdimH5v20::Product_2D::getOffset ( )
virtualinherited

Get the value of 'offset' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ setOffset()

void OdimH5v20::Product_2D::setOffset ( double val)
virtualinherited

Set the value of 'offset' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ getNodata()

double OdimH5v20::Product_2D::getNodata ( )
virtualinherited

Get the value of 'nodata' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ setNodata()

void OdimH5v20::Product_2D::setNodata ( double val)
virtualinherited

Set the value of 'nodata' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ getUndetect()

double OdimH5v20::Product_2D::getUndetect ( )
virtualinherited

Get the value of 'undetect' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ setUndetect()

void OdimH5v20::Product_2D::setUndetect ( double val)
virtualinherited

Set the value of 'undetect' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATDatasetMetadata.

◆ getAzimuthMethod()

std::string OdimH5v20::Product_2D::getAzimuthMethod ( )
virtualinherited

Get the 'azmethod' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setAzimuthMethod()

void OdimH5v20::Product_2D::setAzimuthMethod ( const std::string & val)
virtualinherited

Set the 'azmethod' attribute value.

Parameters
valthe value tro write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getBinMethod()

std::string OdimH5v20::Product_2D::getBinMethod ( )
virtualinherited

Get the 'binmethod' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setBinMethod()

void OdimH5v20::Product_2D::setBinMethod ( const std::string & val)
virtualinherited

Set the 'binmethod' attribute value.

Parameters
valthe value tro write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getAzimuthAngles()

std::vector< AZAngles > OdimH5v20::Product_2D::getAzimuthAngles ( )
virtualinherited

Get the 'azangles' attribute values.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setAzimuthAngles()

void OdimH5v20::Product_2D::setAzimuthAngles ( const std::vector< AZAngles > & val,
int precision = 10 )
virtualinherited

Set the 'azangles' attribute values.

Parameters
valthe values to write
precisionprecision to use when converting angle pairs to string pairs
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getElevationAngles()

std::vector< double > OdimH5v20::Product_2D::getElevationAngles ( )
virtualinherited

Get the 'elangles' attribute values.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setElevationAngles()

void OdimH5v20::Product_2D::setElevationAngles ( const std::vector< double > & val,
int precision = 10 )
virtualinherited

Set the 'elangles' attribute values.

Parameters
valthe values to write
precisionprecision to use when converting angle pairs to string pairs
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getAzimuthTimes()

std::vector< AZTimes > OdimH5v20::Product_2D::getAzimuthTimes ( )
virtualinherited

Get the 'aztimes' attribute values.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setAzimuthTimes()

void OdimH5v20::Product_2D::setAzimuthTimes ( const std::vector< AZTimes > & val)
virtualinherited

Set the 'aztimes' attribute values.

Parameters
valthe values to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getPointAccEl()

double OdimH5v20::Product_2D::getPointAccEl ( )
virtualinherited

Get the 'pointaccEL' attribute values.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setPointAccEl()

void OdimH5v20::Product_2D::setPointAccEl ( double val)
virtualinherited

Set the 'pointaccEL' attribute values.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getPointAccAZ()

double OdimH5v20::Product_2D::getPointAccAZ ( )
virtualinherited

Get the 'pointaccAZ' attribute values.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setPointAccAZ()

void OdimH5v20::Product_2D::setPointAccAZ ( double val)
virtualinherited

Set the 'pointaccAZ' attribute values.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getMalfunc()

bool OdimH5v20::Product_2D::getMalfunc ( )
virtualinherited

Get the 'malfunc' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setMalfunc()

void OdimH5v20::Product_2D::setMalfunc ( bool val)
virtualinherited

Set the 'malfunc' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getRadarMsg()

std::string OdimH5v20::Product_2D::getRadarMsg ( )
virtualinherited

Get the 'radarmsg' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setRadarMsg()

void OdimH5v20::Product_2D::setRadarMsg ( const std::string & val)
virtualinherited

Set the 'radarmsg' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getRadarHorizon()

double OdimH5v20::Product_2D::getRadarHorizon ( )
virtualinherited

Get the 'radhoriz' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setRadarHorizon()

void OdimH5v20::Product_2D::setRadarHorizon ( double val)
virtualinherited

Set the 'radhoriz' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getMDS()

double OdimH5v20::Product_2D::getMDS ( )
virtualinherited

Get the 'MDS' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setMDS()

void OdimH5v20::Product_2D::setMDS ( double val)
virtualinherited

Set the 'MDS' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getOUR()

double OdimH5v20::Product_2D::getOUR ( )
virtualinherited

Get the 'OUR' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setOUR()

void OdimH5v20::Product_2D::setOUR ( double val)
virtualinherited

Set the 'OUR' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getDClutter()

std::vector< std::string > OdimH5v20::Product_2D::getDClutter ( )
virtualinherited

Get the 'Dclutter' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setDClutter()

void OdimH5v20::Product_2D::setDClutter ( const std::vector< std::string > & val)
virtualinherited

Set the 'Dclutter' attribute value.

Parameters
valthe values to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getComment()

std::string OdimH5v20::Product_2D::getComment ( )
virtualinherited

Get the 'comment' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setComment()

void OdimH5v20::Product_2D::setComment ( const std::string & val)
virtualinherited

Set the 'comment' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getSQI()

double OdimH5v20::Product_2D::getSQI ( )
virtualinherited

Get the 'SQI' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setSQI()

void OdimH5v20::Product_2D::setSQI ( double val)
virtualinherited

Set the 'SQI' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getCSR()

double OdimH5v20::Product_2D::getCSR ( )
virtualinherited

Get the 'CSR' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setCSR()

void OdimH5v20::Product_2D::setCSR ( double val)
virtualinherited

Set the 'CSR' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getLOG()

double OdimH5v20::Product_2D::getLOG ( )
virtualinherited

Get the 'LOG' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setLOG()

void OdimH5v20::Product_2D::setLOG ( double val)
virtualinherited

Set the 'LOG' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getVPRCorr()

bool OdimH5v20::Product_2D::getVPRCorr ( )
virtualinherited

Get the 'VPRCoor' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setVPRCorr()

void OdimH5v20::Product_2D::setVPRCorr ( bool val)
virtualinherited

Set the 'VPRCoor' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getFreeze()

double OdimH5v20::Product_2D::getFreeze ( )
virtualinherited

Get the 'freeze' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setFreeze()

void OdimH5v20::Product_2D::setFreeze ( double val)
virtualinherited

Set the 'freeze' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getMin()

double OdimH5v20::Product_2D::getMin ( )
virtualinherited

Get the 'min' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setMin()

void OdimH5v20::Product_2D::setMin ( double val)
virtualinherited

Set the 'min' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getMax()

double OdimH5v20::Product_2D::getMax ( )
virtualinherited

Get the 'max' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setMax()

void OdimH5v20::Product_2D::setMax ( double val)
virtualinherited

Set the 'max' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getStep()

double OdimH5v20::Product_2D::getStep ( )
virtualinherited

Get the 'step' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setStep()

void OdimH5v20::Product_2D::setStep ( double val)
virtualinherited

Set the 'step' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getLevels()

int OdimH5v20::Product_2D::getLevels ( )
virtualinherited

Get the 'levels' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setLevels()

void OdimH5v20::Product_2D::setLevels ( int val)
virtualinherited

Set the 'levels' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getPeakPwr()

double OdimH5v20::Product_2D::getPeakPwr ( )
virtualinherited

Get the 'peakpwr' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setPeakPwr()

void OdimH5v20::Product_2D::setPeakPwr ( double val)
virtualinherited

Set the 'peakpwr' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getAvgPwr()

double OdimH5v20::Product_2D::getAvgPwr ( )
virtualinherited

Get the 'avgpwr' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setAvgPwr()

void OdimH5v20::Product_2D::setAvgPwr ( double val)
virtualinherited

Set the 'awgpwr' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getDynRange()

double OdimH5v20::Product_2D::getDynRange ( )
virtualinherited

Get the 'dynrange' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setDynRange()

void OdimH5v20::Product_2D::setDynRange ( double val)
virtualinherited

Set the 'dynrange' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getRAC()

double OdimH5v20::Product_2D::getRAC ( )
virtualinherited

Get the 'RAC' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setRAC()

void OdimH5v20::Product_2D::setRAC ( double val)
virtualinherited

Set the 'RAC' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getBBC()

bool OdimH5v20::Product_2D::getBBC ( )
virtualinherited

Get the 'BBC' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setBBC()

void OdimH5v20::Product_2D::setBBC ( bool val)
virtualinherited

Set the 'BBC' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getPAC()

double OdimH5v20::Product_2D::getPAC ( )
virtualinherited

Get the 'PAC' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setPAC()

void OdimH5v20::Product_2D::setPAC ( double val)
virtualinherited

Set the 'PAC' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getS2N()

double OdimH5v20::Product_2D::getS2N ( )
virtualinherited

Get the 'S2N' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setS2N()

void OdimH5v20::Product_2D::setS2N ( double val)
virtualinherited

Set the 'S2N' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getPolarization()

std::string OdimH5v20::Product_2D::getPolarization ( )
virtualinherited

Get the 'polarization' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ setPolarization()

void OdimH5v20::Product_2D::setPolarization ( const std::string & val)
virtualinherited

Set the 'polarization' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWPolarMetadata.

◆ getTaskOrProdGen()

std::string OdimH5v20::Product_2D::getTaskOrProdGen ( )
virtualinherited

Get the 'task' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ setTaskOrProdGen()

void OdimH5v20::Product_2D::setTaskOrProdGen ( const std::string & val)
virtualinherited

Set the 'task' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ getStartEpochs()

time_t OdimH5v20::Product_2D::getStartEpochs ( )
virtualinherited

Get the 'startepochs' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ setStartEpochs()

void OdimH5v20::Product_2D::setStartEpochs ( time_t val)
virtualinherited

Set the 'startepochs' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ getEndEpochs()

time_t OdimH5v20::Product_2D::getEndEpochs ( )
virtualinherited

Get the 'endepochs' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ setEndEpochs()

void OdimH5v20::Product_2D::setEndEpochs ( time_t val)
virtualinherited

Set the 'endepochs' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ getSystem()

std::string OdimH5v20::Product_2D::getSystem ( )
virtualinherited

Get the 'system' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ setSystem()

void OdimH5v20::Product_2D::setSystem ( const std::string & val)
virtualinherited

Set the 'system' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ getSoftware()

std::string OdimH5v20::Product_2D::getSoftware ( )
virtualinherited

Get the 'software' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ setSoftware()

void OdimH5v20::Product_2D::setSoftware ( const std::string & val)
virtualinherited

Set the 'software' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ getSoftwareVer()

std::string OdimH5v20::Product_2D::getSoftwareVer ( )
virtualinherited

Get the 'sw_version' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ setSoftwareVer()

void OdimH5v20::Product_2D::setSoftwareVer ( const std::string & val)
virtualinherited

Set the 'sw_version' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ getZR_A()

double OdimH5v20::Product_2D::getZR_A ( )
virtualinherited

Get the 'zr_a' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ setZR_A()

void OdimH5v20::Product_2D::setZR_A ( double val)
virtualinherited

Set the 'zr_a' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ getZR_B()

double OdimH5v20::Product_2D::getZR_B ( )
virtualinherited

Get the 'zr_b' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ setZR_B()

void OdimH5v20::Product_2D::setZR_B ( double val)
virtualinherited

Set the 'zr_b' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ getKR_A()

double OdimH5v20::Product_2D::getKR_A ( )
virtualinherited

Get the 'kr_a' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ setKR_A()

void OdimH5v20::Product_2D::setKR_A ( double val)
virtualinherited

Set the 'kr_a' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ getKR_B()

double OdimH5v20::Product_2D::getKR_B ( )
virtualinherited

Get the 'kr_b' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ setKR_B()

void OdimH5v20::Product_2D::setKR_B ( double val)
virtualinherited

Set the 'kr_b' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ getSimulated()

bool OdimH5v20::Product_2D::getSimulated ( )
virtualinherited

Get the 'simulated' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ setSimulated()

void OdimH5v20::Product_2D::setSimulated ( bool val)
virtualinherited

Set the 'simulated' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

◆ getBeamWidth() [1/2]

double OdimH5v20::Product_2D::getBeamWidth ( )
virtualinherited

Get the 'beamwidth' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ getBeamWidth() [2/2]

double OdimH5v20::Product_2D::getBeamWidth ( double defaultValue)
virtualinherited

Get the 'beamwidth' attribute value.

Parameters
defaultValuethe value to return if the attribute does not exists
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ setBeamWidth()

void OdimH5v20::Product_2D::setBeamWidth ( double val)
virtualinherited

Set the 'beamwidth' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ getWaveLength() [1/2]

double OdimH5v20::Product_2D::getWaveLength ( )
virtualinherited

Get the 'wavelength' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ getWaveLength() [2/2]

double OdimH5v20::Product_2D::getWaveLength ( double defaultValue)
virtualinherited

Get the 'wavelength' attribute value.

Parameters
defaultValuethe value to return if the attribute does not exists
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ setWaveLength()

void OdimH5v20::Product_2D::setWaveLength ( double val)
virtualinherited

Get the 'wavelength' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ getRPM() [1/2]

double OdimH5v20::Product_2D::getRPM ( )
virtualinherited

Get the 'prm' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ getRPM() [2/2]

double OdimH5v20::Product_2D::getRPM ( double defaultValue)
virtualinherited

Get the 'rpm' attribute value.

Parameters
defaultValuethe value to return if the attribute does not exists
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ setRPM()

void OdimH5v20::Product_2D::setRPM ( double val)
virtualinherited

Get the 'rpm' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ getPulseWidth() [1/2]

double OdimH5v20::Product_2D::getPulseWidth ( )
virtualinherited

Get the 'pulsewidth' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ getPulseWidth() [2/2]

double OdimH5v20::Product_2D::getPulseWidth ( double defaultValue)
virtualinherited

Get the 'pulsewidth' attribute value.

Parameters
defaultValuethe value to return if the attribute does not exists
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ setPulseWidth()

void OdimH5v20::Product_2D::setPulseWidth ( double val)
virtualinherited

Get the 'pulsewidth' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ getLowPRF() [1/2]

int OdimH5v20::Product_2D::getLowPRF ( )
virtualinherited

Get the 'lowprf' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ getLowPRF() [2/2]

int OdimH5v20::Product_2D::getLowPRF ( int defaultValue)
virtualinherited

Get the 'lowprf' attribute value.

Parameters
defaultValuethe value to return if the attribute does not exists
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ setLowPRF()

void OdimH5v20::Product_2D::setLowPRF ( int val)
virtualinherited

Get the 'lowprf' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ getHighPRF() [1/2]

int OdimH5v20::Product_2D::getHighPRF ( )
virtualinherited

Get the 'highprf' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ getHighPRF() [2/2]

int OdimH5v20::Product_2D::getHighPRF ( int defaultValue)
virtualinherited

Get the 'highprf' attribute value.

Parameters
defaultValuethe value to return if the attribute does not exists
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ setHighPRF()

void OdimH5v20::Product_2D::setHighPRF ( int val)
virtualinherited

Get the 'highprf' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWDatasetMetadata.

◆ createQuantityData()

Product_2D_Data * OdimH5v20::Product_2D::createQuantityData ( const char * name)
virtualinherited

Create a new group for a quantity in the product.

Parameters
nameThe quantity type to be created
Returns
The number of quantities
Exceptions
OdimH5ExceptionThrowed if an error occurs
Examples
image-visitor.cpp.

◆ getQuantityDataCount()

int OdimH5v20::Product_2D::getQuantityDataCount ( )
virtualinherited

Get number of quantities stored in the scan.

Returns
The number of quantities
Exceptions
OdimH5ExceptionThrowed if an error occurs
Examples
image-visitor.cpp.

◆ hasQuantityData()

bool OdimH5v20::Product_2D::hasQuantityData ( const char * name)
virtualinherited

Check if the scan contains the data associated to a quantity.

Check if the scan contains the data associated to a quantity using its OdimH5 name.

Parameters
nameThe quantity name to find
Exceptions
OdimH5ExceptionThrowed if an error occurs

◆ getQuantityDataIndex()

int OdimH5v20::Product_2D::getQuantityDataIndex ( const char * name)
virtualinherited

Return the index of the 'data' group containing the given quantity.

Parameters
nameThe quantity name to find
Returns
A non negative value if the given quantity is found, -1 otherwise
Exceptions
OdimH5ExceptionThrowed if an error occurs

◆ getQuantityData() [1/2]

Product_2D_Data * OdimH5v20::Product_2D::getQuantityData ( int index)
virtualinherited

Get the data associated to a quantity.

Get the data associated to a quantity using its index.

Returns
The object associated to the quantity
Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Examples
image-visitor.cpp.

◆ getQuantityData() [2/2]

Product_2D_Data * OdimH5v20::Product_2D::getQuantityData ( const char * name)
virtualinherited

Get the data associated to a quantity.

Get the data associated to a quantity using its OdimH5 name.

Returns
The object associated to the quantity
Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object

◆ getStoredQuantities()

std::set< std::string > OdimH5v20::Product_2D::getStoredQuantities ( )
inherited

Get the name of all quantities present in this scan.

Returns
A std::set containing the name of each quantity present in the scan
Exceptions
OdimH5ExceptionThrowed if an error occurs
Examples
image-visitor.cpp.

◆ removeQuantityData()

void OdimH5v20::Product_2D::removeQuantityData ( const char * name)
virtualinherited

Delete the data associated to a quantity.

Delete the data associated to a quantity using its OdimH5 name.

Exceptions
OdimH5ExceptionThrowed if an error occurs

◆ getH5Object()

H5::Group * OdimH5v20::OdimDataset::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::OdimDataset::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::OdimDataset::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::OdimDataset::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::OdimDataset::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::OdimDataset::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::OdimDataset::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.

◆ getDataCount()

int OdimH5v20::OdimDataset::getDataCount ( )
virtualinherited

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

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

◆ createData()

OdimData * OdimH5v20::OdimDataset::createData ( )
virtualinherited

Create a new group 'data' inside this dataset.

Returns
the object associated to the new 'data' group
Exceptions
OdimH5Exceptionif an unexpected error occurs
Remarks
User is responsible for deleting the returned object
Examples
create_delete.cpp, and create_odim_object.cpp.

◆ getData()

OdimData * OdimH5v20::OdimDataset::getData ( int index)
virtualinherited

Get an existing dataset using the given index.

Get an existing dataset using the given index

Parameters
indexthe dataset index from 0 to n-1
Returns
the OdimData 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

◆ removeData()

void OdimH5v20::OdimDataset::removeData ( int index)
virtualinherited

Remove a 'data' group from this dataset.

Remove a 'data' group from this dataset

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

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