AttributeBandDescription Class Reference

AttributeBandDescription provides generic information about a single attribute (used by DataSetStats). More...

#include "AttributeBandDescription.hpp"

Public Member Functions
bool	isSetName () const
bool	isSetType () const
bool	isSetTypeCount () const
bool	isSetStorageSize () const
bool	isSetCount () const
bool	isSetMin () const
bool	isSetMax () const
bool	isSetMean () const
bool	isSetStd () const
bool	isSetNoDataIndicator () const
bool	isSetColorInterpretation () const
bool	isSetValueFrequency () const
String	getName () const
	get attribute name
int	getType () const
	get attribute type (RasterDataType for raster and DM::ColumnType for attributes)
unsigned	getTypeCount () const
unsigned	getStorageSize () const
	storage size of attribute in bytes
long long	getCount () const
	number of elements
double	getMin () const
	minimum attribute value
double	getMax () const
	maximum attribute value
double	getMean () const
	mean attribute value
double	getStd () const
	standard deviation
NoDataType	getNoDataIndicator () const
	no value indicator
String	getColorInterpretation () const
DM::HistogramHandle	getValueFrequency () const
void	reset ()
void	setAttributeBandDescription (const String &Name, const int Type, const unsigned &StorageSize, const long long &Count, const double &Min, const double &Max, const double &Mean, const double &Std, const NoDataType &NoData, const String &ColorInterpretation)
void	setName (const String &Name)
void	setType (const int Type)
	use RasterDataType for raster and DM::ColumnType for attributes
void	setTypeCount (const unsigned typeCount)
void	setStorageSize (const unsigned &StorageSize)
void	setCount (const long long &Count)
void	setMin (const double &Min)
void	setMax (const double &Max)
void	setMean (const double &Mean)
void	setStd (const double &Std)
void	setNoDataIndicator (const NoDataType &NoData)
void	setColorInterpretation (const String &ColorInterpretation)
void	setValueFrequency (DM::HistogramHandle &freq)
String	logAttributeBandDescription (int precision=3) const
	for xml output
String	printAttributeBandDescription (opals::DataSetType mode) const
	for log output (in more readable format)

Static Public Member Functions
static String	printAttributeBandHeader (opals::DataSetType mode)
	for log the header line

Detailed Description

AttributeBandDescription provides generic information about a single attribute (used by DataSetStats).

Beside the name, type, storage size (in bytes) and a nodata indicator of the attribute the class provides basic statistic information such as min, max, mean and the standard deviation. If a specific information is really set, can be retrieved by the corresponding isSet function. Depending on the data type a specific no data value is used to indicate unset values.

Author

JO

Date

24.05.2012