PlainData< DT > Class Template Reference

Essential class for storing radar data. More...

#include <Data.h>

Inheritance diagram for PlainData< DT >:

Collaboration diagram for PlainData< DT >:

Public Types
typedef DT::tree_t	tree_t
typedef DT::image_t	image_t
typedef DT::odim_t	odim_t
Public Types inherited from TreeWrapper< DT >
typedef DT	datatype_t
typedef DT::tree_t	tree_t
typedef DT::tree_iter_t	tree_iter_t

Public Member Functions
	PlainData (typename DT::tree_t &tree)
	PlainData (typename DT::tree_t &tree, const std::string &quantity)
	Constructor referring to HDF5 structure.
template<typename DT2 >
	PlainData (const PlainData< DT2 > &d)
	Copy constructor, also for referencing non-const as const.
template<class T >
void	setEncoding (const T &type, const std::string &values="")
	Saves type and sets the type of the actual data array as well.
void	copyEncoding (const EncodingODIM &odim)
	Adjust data array and ODIM metadata to given encoding. Recommended form.
template<class DT2 >
void	copyEncoding (const PlainData< DT2 > &srcData)
	Adjust data array and ODIM metadata to given encoding. Recommended form.
void	setPhysicalRange (double min, double max)
void	setGeometry (size_t cols, size_t rows)
	Sets dimensions of data array and metadata.
void	setGeometry (const drain::image::AreaGeometry &geometry)
	Sets dimensions of data array and metadata.
void	setGeometry (const odim_t &odim)
	Copy dimensions of data array and resolution (rscale or xscale,yscale)
template<class DT2 >
void	copyGeometry (const PlainData< DT2 > &srcData)
	Copy dimensions of data array and resolution (rscale or xscale,yscale)
template<class T >
void	initialize (const T &type, size_t cols, size_t rows)
	Calls setEncoding() and setGeometry().
template<class T >
void	initialize (const T &type, const drain::image::AreaGeometry &geometry)
void	initializeBest ()
	Terminal step in initialisation: set actual data storage type and resize.
template<class ... T>
void	initializeBest (const std::type_info &type, const T &...args)
	Set storage type and other properties.
template<class ... T>
void	initializeBest (const std::string &type, const T &...args)
	Set storage type and other properties.
template<class ... T>
void	initializeBest (const drain::image::AreaGeometry &geometry, const T &...args)
	Set width and height of the data array, and set other properties.
template<class ... T>
void	initializeBest (const EncodingODIM &encoding, const T &...args)
	Set encoding and other properties.
void	setNyquist (double nyquistSpeed)
void	createSimpleQualityData (drain::image::Image &qualityImage, double dataQuality=1.0, double undetectQuality=0.5, double nodataQuality=0.0) const
	For this data, creates an on-off quality data.
void	createSimpleQualityData (PlainData< DT > &qualityData, double dataQuality=1.0, double undetectQuality=0.5, double nodataQuality=0.0) const
	For this data, creates an on-off quality data.
void	updateTree2 ()
	TODO: consider this to destructor.
Public Member Functions inherited from TreeWrapper< DT >
const drain::VariableMap &	getWhat () const
drain::VariableMap &	getWhat ()
const drain::VariableMap &	getWhere () const
drain::VariableMap &	getWhere ()
const drain::VariableMap &	getHow () const
drain::VariableMap &	getHow ()
void	setExcluded (bool exclude=true)
bool	isExcluded () const
virtual const tree_t &	getTree () const
virtual tree_t &	getTree ()

Public Attributes
image_t &	data
odim_t	odim

Additional Inherited Members
Protected Member Functions inherited from TreeWrapper< DT >
	TreeWrapper (tree_t &tree)
	TreeWrapper (const TreeWrapper &d)
template<ODIMPathElem::group_t G>
const drain::VariableMap &	getAttr () const
template<ODIMPathElem::group_t G>
drain::VariableMap &	getAttr ()
Protected Attributes inherited from TreeWrapper< DT >
tree_t &	tree
	General HDF5 data structure.

Detailed Description

template<typename DT>
class rack::PlainData< DT >

Essential class for storing radar data.

Combines 2D image data and metadata.

For metadata, uses ODIM variables, hence replacing native

Template Parameters

DT	- data type: SrcType<T> or DstType<T> with ODIM template T = [PolarODIM|CartesianODIM|...] (PolarSrc, PolarDst, CartesianSrc, CartesianDst, ...)

Constructor & Destructor Documentation

PlainData()

template<typename DT >

template<typename DT2 >

PlainData ( const PlainData< DT2 > &  d )

inline

Copy constructor, also for referencing non-const as const.

 Compiler returns error if odim types ar incompatible.

PlainData(const PlainData<DT> & d) : TreeWrapper

(d.getTree()), data(this->tree["data"].data.image), odim(data) // NEW { }

Member Function Documentation

copyEncoding() [1/2]

template<typename DT >

void copyEncoding ( const EncodingODIM &  odim )

inline

Adjust data array and ODIM metadata to given encoding. Recommended form.

Sets type, scaling, nodata and undetect .

copyEncoding() [2/2]

template<typename DT >

template<class DT2 >

void copyEncoding ( const PlainData< DT2 > &  srcData )

inline

Adjust data array and ODIM metadata to given encoding. Recommended form.

Sets type, scaling, nodata and undetect .

copyGeometry()

template<typename DT >

template<class DT2 >

void copyGeometry ( const PlainData< DT2 > &  srcData )

inline

Copy dimensions of data array and resolution (rscale or xscale,yscale)

Although templated, makes sense only across the Src and Dst types of same ODIM class.

createSimpleQualityData()

template<typename DT >

void createSimpleQualityData	(	drain::image::Image &	quality,
		double	dataQuality = 1.0,
		double	undetectQuality = 0.5,
		double	nodataQuality = 0.0
	)		const

For this data, creates an on-off quality data.

Template Parameters

DT	- data type (PolarSrc, PolarDst, CartesianSrc, CartesianDst, ...)

setEncoding()

template<typename DT >

template<class T >

void setEncoding ( const T &  type, const std::string &  values = ""  )

inline

Saves type and sets the type of the actual data array as well.

Sets nodata and undetect to type specific defaults.

setGeometry()

template<typename DT >

void setGeometry ( const odim_t &  odim )

inline

Copy dimensions of data array and resolution (rscale or xscale,yscale)

Although templated, makes sense only across the Src and Dst types of same ODIM class.

---

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

• src/data/Data.h