radarlib  1.4.4
OdimH5v20::Object_2D Class Referenceabstract

OdimH5 v2.0 Object_2D. More...

#include <radarlib/odimh5v20_classes.hpp>

Inheritance diagram for OdimH5v20::Object_2D:
OdimH5v20::OdimObject OdimH5v20::HOWRootMetadata OdimH5v20::WHATRootMetadata OdimH5v20::HorizontalObject_2D OdimH5v20::XsecObject OdimH5v20::CompObject OdimH5v20::ImageObject

Public Member Functions

virtual std::string getTaskOrProdGen ()
 Get the 'task' attribute value. More...
 
virtual void setTaskOrProdGen (const std::string &val)
 Set the 'task' attribute value. More...
 
virtual time_t getStartEpochs ()
 Get the 'startepochs' attribute value. More...
 
virtual void setStartEpochs (time_t val)
 Set the 'startepochs' attribute value. More...
 
virtual time_t getEndEpochs ()
 Get the 'endepochs' attribute value. More...
 
virtual void setEndEpochs (time_t val)
 Set the 'endepochs' attribute value. More...
 
virtual std::string getSystem ()
 Get the 'system' attribute value. More...
 
virtual void setSystem (const std::string &val)
 Set the 'system' attribute value. More...
 
virtual std::string getSoftware ()
 Get the 'software' attribute value. More...
 
virtual void setSoftware (const std::string &val)
 Set the 'software' attribute value. More...
 
virtual std::string getSoftwareVer ()
 Get the 'sw_version' attribute value. More...
 
virtual void setSoftwareVer (const std::string &val)
 Set the 'sw_version' attribute value. More...
 
virtual double getZR_A ()
 Get the 'zr_a' attribute value. More...
 
virtual void setZR_A (double val)
 Set the 'zr_a' attribute value. More...
 
virtual double getZR_B ()
 Get the 'zr_b' attribute value. More...
 
virtual void setZR_B (double val)
 Set the 'zr_b' attribute value. More...
 
virtual double getKR_A ()
 Get the 'kr_a' attribute value. More...
 
virtual void setKR_A (double val)
 Set the 'kr_a' attribute value. More...
 
virtual double getKR_B ()
 Get the 'kr_b' attribute value. More...
 
virtual void setKR_B (double val)
 Set the 'kr_b' attribute value. More...
 
virtual bool getSimulated ()
 Get the 'simulated' attribute value. More...
 
virtual void setSimulated (bool val)
 Set the 'simulated' attribute value. More...
 
virtual int getProductCount ()
 Get the number of products dataset store in this volume. More...
 
virtual Product_2DcreateProduct2D (const char *type)
 Create a new generic 2D product in this volume. More...
 
virtual Product_PPIcreateProductPPI ()
 Create a new PPI product in this volume. More...
 
virtual Product_CAPPIcreateProductCAPPI ()
 Create a new CAPPI product in this volume. More...
 
virtual Product_PCAPPIcreateProductPCAPPI ()
 Create a new PCAPPI product in this volume. More...
 
virtual Product_ETOPcreateProductETOP ()
 Create a new ETOP product in this volume. More...
 
virtual Product_MAXcreateProductMAX ()
 Create a new MAX product in this volume. More...
 
virtual Product_RRcreateProductRR ()
 Create a new RR product in this volume. More...
 
virtual Product_VILcreateProductVIL ()
 Create a new VIL product in this volume. More...
 
virtual Product_LBMcreateProductLBM ()
 Create a new LBM product in this volume. More...
 
virtual Product_COMPcreateProductCOMP ()
 Create a new COMP product in this volume. More...
 
virtual Product_XSECcreateProductXSEC ()
 Create a new XSEC product in this volume. More...
 
virtual Product_RHIcreateProductRHI ()
 Create a new RHI product in this volume. More...
 
virtual Product_VSPcreateProductVSP ()
 Create a new VSP product in this volume. More...
 
virtual Product_HSPcreateProductHSP ()
 Create a new HSP product in this volume. More...
 
virtual Product_2DgetProduct (int index)
 Get a pointer to a generic 2D product of the volume. More...
 
virtual void removeProduct (int index)
 Get a pointer to a 2D-Horizonatl product of the volume. More...
 
virtual std::vector< std::string > getProductsType ()
 Get the pointers to all the product types in the file. More...
 
virtual std::vector< Product_2D * > getProducts ()
 Get the pointers to all the products in the file. More...
 
virtual std::string getConventions ()
 Get OdimH5 conventions attribute value. More...
 
virtual void setConventions ()
 Set OdimH5 conventions attribute value to the value required by OdimH5 specification. More...
 
virtual H5::H5File * getFile ()
 Get the associated HDF5 file object. More...
 
virtual H5::Group * getH5Object ()
 Get the HDF5 group associated to this object. More...
 
virtual bool existWhat ()
 Test is the WHAT attributes group exist. More...
 
virtual bool existWhere ()
 Test is the WHERE attributes group exist. More...
 
virtual bool existHow ()
 Test is the HOW attributes group exist. More...
 
virtual MetadataGroupgetWhat ()
 Get the WHAT attributes group. More...
 
virtual MetadataGroupgetWhere ()
 Get the WHERE attributes group. More...
 
virtual MetadataGroupgetHow ()
 Get the HOW attributes group. More...
 
virtual std::string getObject ()
 Get the value of 'object' attribute. More...
 
virtual void setObject (const std::string &val)
 Set the value of 'object' attribute. More...
 
virtual std::string getVersion ()
 Get the value of 'version' attribute. More...
 
virtual void setVersion (const std::string &val)
 Set the value of 'version' attribute. More...
 
virtual time_t getDateTime ()
 Get the joined value of 'date' and 'time' attributes. More...
 
virtual void setDateTime (const time_t val)
 Set the value of 'date' and 'time' attributes. More...
 
virtual SourceInfo getSource ()
 Get the value of 'source' attribute. More...
 
virtual void setSource (const SourceInfo &val)
 Set the value of 'source' attribute. More...
 
virtual int getDatasetCount ()
 Get the number of datasets in the file. More...
 
virtual OdimDatasetcreateDataset ()
 Create a new dataset. More...
 
virtual OdimDatasetgetDataset (int index)
 Get a dataset. More...
 
virtual void removeDataset (int index)
 Delete a odim dataset group from the odim object. More...
 

Detailed Description

OdimH5 v2.0 Object_2D.


This class represents an OdimH5 IMAGE composed of product objects.

Image specific attributes can be manipulated using specific methods.

Generic data manipulations can be done using methods provided by the OdimObject interface.

See Also
Product_2D

Member Function Documentation

std::string OdimH5v20::Object_2D::getTaskOrProdGen ( )
virtual

Get the 'task' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

void OdimH5v20::Object_2D::setTaskOrProdGen ( const std::string &  val)
virtual

Set the 'task' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

time_t OdimH5v20::Object_2D::getStartEpochs ( )
virtual

Get the 'startepochs' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

void OdimH5v20::Object_2D::setStartEpochs ( time_t  val)
virtual

Set the 'startepochs' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

time_t OdimH5v20::Object_2D::getEndEpochs ( )
virtual

Get the 'endepochs' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

void OdimH5v20::Object_2D::setEndEpochs ( time_t  val)
virtual

Set the 'endepochs' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

std::string OdimH5v20::Object_2D::getSystem ( )
virtual

Get the 'system' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

void OdimH5v20::Object_2D::setSystem ( const std::string &  val)
virtual

Set the 'system' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

std::string OdimH5v20::Object_2D::getSoftware ( )
virtual

Get the 'software' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

void OdimH5v20::Object_2D::setSoftware ( const std::string &  val)
virtual

Set the 'software' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

std::string OdimH5v20::Object_2D::getSoftwareVer ( )
virtual

Get the 'sw_version' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

void OdimH5v20::Object_2D::setSoftwareVer ( const std::string &  val)
virtual

Set the 'sw_version' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

double OdimH5v20::Object_2D::getZR_A ( )
virtual

Get the 'zr_a' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

void OdimH5v20::Object_2D::setZR_A ( double  val)
virtual

Set the 'zr_a' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

double OdimH5v20::Object_2D::getZR_B ( )
virtual

Get the 'zr_b' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

void OdimH5v20::Object_2D::setZR_B ( double  val)
virtual

Set the 'zr_b' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

double OdimH5v20::Object_2D::getKR_A ( )
virtual

Get the 'kr_a' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

void OdimH5v20::Object_2D::setKR_A ( double  val)
virtual

Set the 'kr_a' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

double OdimH5v20::Object_2D::getKR_B ( )
virtual

Get the 'kr_b' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

void OdimH5v20::Object_2D::setKR_B ( double  val)
virtual

Set the 'kr_b' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

bool OdimH5v20::Object_2D::getSimulated ( )
virtual

Get the 'simulated' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

void OdimH5v20::Object_2D::setSimulated ( bool  val)
virtual

Set the 'simulated' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

int OdimH5v20::Object_2D::getProductCount ( )
virtual

Get the number of products dataset store in this volume.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Examples:
image-visitor.cpp.
Product_2D * OdimH5v20::Object_2D::createProduct2D ( const char *  type)
virtual

Create a new generic 2D product in this volume.

Parameters
typeThe type of the product to be created
Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Examples:
image-visitor.cpp.
Product_PPI * OdimH5v20::Object_2D::createProductPPI ( )
virtual

Create a new PPI product in this volume.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Product_CAPPI * OdimH5v20::Object_2D::createProductCAPPI ( )
virtual

Create a new CAPPI product in this volume.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Product_PCAPPI * OdimH5v20::Object_2D::createProductPCAPPI ( )
virtual

Create a new PCAPPI product in this volume.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Product_ETOP * OdimH5v20::Object_2D::createProductETOP ( )
virtual

Create a new ETOP product in this volume.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Product_MAX * OdimH5v20::Object_2D::createProductMAX ( )
virtual

Create a new MAX product in this volume.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Product_RR * OdimH5v20::Object_2D::createProductRR ( )
virtual

Create a new RR product in this volume.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Product_VIL * OdimH5v20::Object_2D::createProductVIL ( )
virtual

Create a new VIL product in this volume.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Product_LBM * OdimH5v20::Object_2D::createProductLBM ( )
virtual

Create a new LBM product in this volume.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Product_COMP * OdimH5v20::Object_2D::createProductCOMP ( )
virtual

Create a new COMP product in this volume.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Product_XSEC * OdimH5v20::Object_2D::createProductXSEC ( )
virtual

Create a new XSEC product in this volume.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Product_RHI * OdimH5v20::Object_2D::createProductRHI ( )
virtual

Create a new RHI product in this volume.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Product_VSP * OdimH5v20::Object_2D::createProductVSP ( )
virtual

Create a new VSP product in this volume.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Product_HSP * OdimH5v20::Object_2D::createProductHSP ( )
virtual

Create a new HSP product in this volume.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Product_2D * OdimH5v20::Object_2D::getProduct ( int  index)
virtual

Get a pointer to a generic 2D product of the volume.

Parameters
indexThe scan number (from 0 to n-1)
Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Examples:
image-visitor.cpp.
void OdimH5v20::Object_2D::removeProduct ( int  index)
virtual

Get a pointer to a 2D-Horizonatl product of the volume.

Parameters
indexThe scan number (from 0 to n-1)
Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object

Get a pointer to a 2d-vertical product of the volume

Parameters
indexThe scan number (from 0 to n-1)
Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object

Remove a product dataset from the volume

Parameters
indexThe product dataset number (from 0 to n-1)
Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
std::vector< std::string > OdimH5v20::Object_2D::getProductsType ( )
virtual

Get the pointers to all the product types in the file.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned objects
std::vector< Product_2D * > OdimH5v20::Object_2D::getProducts ( )
virtual

Get the pointers to all the products in the file.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
std::string OdimH5v20::OdimObject::getConventions ( )
virtualinherited

Get OdimH5 conventions attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples:
read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.
void OdimH5v20::OdimObject::setConventions ( )
virtualinherited

Set OdimH5 conventions attribute value to the value required by OdimH5 specification.

Exceptions
OdimH5Exceptionif an unexpected error occurs
H5::H5File * OdimH5v20::OdimObject::getFile ( )
virtualinherited

Get the associated HDF5 file object.

Get the associated HDF5 file object

Remarks
user must not delete this object
Exceptions
OdimH5Exceptionif an unexpected error occurs
H5::Group * OdimH5v20::OdimObject::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
bool OdimH5v20::OdimObject::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.
bool OdimH5v20::OdimObject::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.
bool OdimH5v20::OdimObject::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.
MetadataGroup * OdimH5v20::OdimObject::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:
copy_polar_volume_attributes.cpp, image-visitor.cpp, read_attributes.cpp, and write_attributes.cpp.
MetadataGroup * OdimH5v20::OdimObject::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:
copy_polar_volume_attributes.cpp, and image-visitor.cpp.
MetadataGroup * OdimH5v20::OdimObject::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:
copy_polar_volume_attributes.cpp, create_polar_volume.cpp, and image-visitor.cpp.
std::string OdimH5v20::OdimObject::getObject ( )
virtualinherited

Get the value of 'object' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

Examples:
image-visitor.cpp, odimh5scanner.cpp, read_attributes.cpp, read_polar_volume.cpp, read_polar_volume2.cpp, read_polar_volume_scans.cpp, and visitor.cpp.
void OdimH5v20::OdimObject::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.

Examples:
create_delete.cpp, create_odim_object.cpp, and write_attributes.cpp.
std::string OdimH5v20::OdimObject::getVersion ( )
virtualinherited

Get the value of 'version' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

Examples:
read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.
void OdimH5v20::OdimObject::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.

time_t OdimH5v20::OdimObject::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.

Examples:
image-visitor.cpp, odimh5scanner.cpp, read_attributes.cpp, read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.
void OdimH5v20::OdimObject::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.

Examples:
create_polar_volume.cpp, and write_attributes.cpp.
SourceInfo OdimH5v20::OdimObject::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.

Examples:
odimh5scanner.cpp, read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.
void OdimH5v20::OdimObject::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.

Examples:
create_polar_volume.cpp.
int OdimH5v20::OdimObject::getDatasetCount ( )
virtualinherited

Get the number of datasets in the file.

Get the number of datasets in the odim object

Exceptions
OdimH5Exceptionif an unexpected error occurs
OdimDataset * OdimH5v20::OdimObject::createDataset ( )
virtualinherited

Create a new dataset.

Create a new dataset in the odim object

Returns
the new OdimDataset object associated to the new HDF5 group
Exceptions
OdimH5Exceptionif an unexpected error occurs
Remarks
User is responsible for deleting the returned object
OdimDataset * OdimH5v20::OdimObject::getDataset ( int  index)
virtualinherited

Get a dataset.

Get the existing dataset with the given index

Parameters
indexthe dataset index from 0 to n-1
Returns
the OdimDataset object associated to the new HDF5 group or NULL if the dataset does not exist
Exceptions
OdimH5Exceptionif an unexpected error occurs
Remarks
User is responsible for deleting the returned object
void OdimH5v20::OdimObject::removeDataset ( int  index)
virtualinherited

Delete a odim dataset group from the odim object.

Delete the odim dataset with the given index. Nothing is done if the dataset does not exist

Parameters
indexthe dataset index from 0 to n-1
Exceptions
OdimH5Exceptionif an unexpected error occurs
Remarks
User is responsible for deleting the returned object

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