A raster band description. More...

#include <BandProperty.h>

Classes
struct	ColorEntry
	An structure to represent a color tuple. More...

Public Member Functions
	BandProperty (const BandProperty &rhs)
	Copy constructor.

	BandProperty (std::size_t idx, int t, const std::string &desc=std::string(""))
	Constructor.

int	getType () const
	It returns the data type of the elements in the band.

const te::common::UnitOfMeasurePtr &	getUnitOfMeasure () const
	It returns the unit of measure of the values.

bool	isComplex () const

BandProperty &	operator= (const BandProperty &rhs)
	Assignment operator.

void	setUnitOfMeasure (te::common::UnitOfMeasurePtr u)
	Sets the unit of measure of the values;.

	~BandProperty ()
	Destructor.

Public Attributes
int	m_blkh
	Block height (pixels).

int	m_blkw
	Block width (pixels).

std::vector< std::string >	m_categoryNames
	Set of categoric names for the values contained in a dimension.

ColorInterp	m_colorInterp
	The color interpretation.

std::string	m_description
	A description.

std::size_t	m_idx
	The band index.

double	m_max
	Maximum pixel value (default is std::numeric_limits<double>::max() which means no value set).

double	m_mean
	Mean of all pixel values (default is std::numeric_limits<double>::max() which means no value set).

std::vector< std::pair< std::string, std::string > >	m_metadata
	A list of metadata where each element consists of a (key, value).

double	m_min
	Minimum pixel value (default is std::numeric_limits<double>::max() which means no value set).

int	m_nblocksx
	The number of blocks in x.

int	m_nblocksy
	The number of blocks in y.

double	m_noDataValue
	Value to indicate elements where there is no data, default is std::numeric_limits<double>::max().

std::vector< ColorEntry >	m_palette
	The color palette.

PaletteInterpretation	m_paletteInterp
	Pallete interpretation.

double	m_stdDev
	Standard deviation of all pixel values (default is std::numeric_limits<double>::max() which means no value set).

int	m_type
	The data type of the elements in the band ( See te::dt namespace basic data types for reference ).

std::complex< double >	m_valuesOffset
	Offset is the values (real and imaginary) to add to grid values for this sample dimension, default is 0.

std::complex< double >	m_valuesScale
	Scale is the values (real and imaginary) which is multiplied to grid values for this sample dimension, default is 1.

Protected Attributes
te::common::UnitOfMeasurePtr	m_unit
	The unit of values.

Detailed Description

A raster band description.

The band property describes how to interpret (and use) values that can be associated to each element of a raster, in one given dimension (e.g. a band of multi-hiperspectral remote sensing image). Each instance of this class refers to a particular dimension. This implementation defines a set of information commonly used to describe any raster.

See also: RasterProperty, Raster, Band

Definition at line 61 of file BandProperty.h.

Constructor & Destructor Documentation

◆ BandProperty() [1/2]

te::rst::BandProperty::BandProperty	(	std::size_t	idx,
		int	t,
		const std::string &	desc = `std::string("")`
	)

Constructor.

Parameters

idx	The band index in the set of bands.
t	The data type of the band elements.
desc	The band description.

◆ BandProperty() [2/2]

te::rst::BandProperty::BandProperty ( const BandProperty & rhs )

Copy constructor.

Parameters

rhs	The right-hand-side copy that would be used to copy from.

◆ ~BandProperty()

te::rst::BandProperty::~BandProperty ( )

Destructor.

Member Function Documentation

◆ getType()

int te::rst::BandProperty::getType ( ) const

inline

It returns the data type of the elements in the band.

Note: The types are listed in terralib/datatype/DataTypes.h

Returns: The data type of the elements in the band.

Definition at line 113 of file BandProperty.h.

Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator(), and te::rst::BandIteratorWindow< T >::BandIteratorWindow().

◆ getUnitOfMeasure()

const te::common::UnitOfMeasurePtr & te::rst::BandProperty::getUnitOfMeasure ( ) const

inline

It returns the unit of measure of the values.

Definition at line 116 of file BandProperty.h.

◆ isComplex()

bool te::rst::BandProperty::isComplex ( ) const

◆ operator=()

BandProperty & te::rst::BandProperty::operator= ( const BandProperty & rhs )

Assignment operator.

Parameters

rhs	The right-hand-side copy that would be used to copy from.

Returns: A reference to this object.

◆ setUnitOfMeasure()

void te::rst::BandProperty::setUnitOfMeasure ( te::common::UnitOfMeasurePtr u )

inline

Sets the unit of measure of the values;.

Parameters

u	The new unit of measure.

Note: The object does not take the ownership of the unit.

Definition at line 125 of file BandProperty.h.

Member Data Documentation

◆ m_blkh

int te::rst::BandProperty::m_blkh

Block height (pixels).

Definition at line 144 of file BandProperty.h.

Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator().

◆ m_blkw

int te::rst::BandProperty::m_blkw

Block width (pixels).

Definition at line 143 of file BandProperty.h.

Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator().

◆ m_categoryNames

std::vector<std::string> te::rst::BandProperty::m_categoryNames

Set of categoric names for the values contained in a dimension.

Definition at line 139 of file BandProperty.h.

◆ m_colorInterp

ColorInterp te::rst::BandProperty::m_colorInterp

The color interpretation.

Definition at line 140 of file BandProperty.h.

◆ m_description

std::string te::rst::BandProperty::m_description

A description.

Definition at line 134 of file BandProperty.h.

◆ m_idx

std::size_t te::rst::BandProperty::m_idx

The band index.

Definition at line 132 of file BandProperty.h.

◆ m_max

double te::rst::BandProperty::m_max

Maximum pixel value (default is std::numeric_limits<double>::max() which means no value set).

Definition at line 148 of file BandProperty.h.

◆ m_mean

double te::rst::BandProperty::m_mean

Mean of all pixel values (default is std::numeric_limits<double>::max() which means no value set).

Definition at line 149 of file BandProperty.h.

◆ m_metadata

std::vector<std::pair<std::string, std::string> > te::rst::BandProperty::m_metadata

A list of metadata where each element consists of a (key, value).

Definition at line 135 of file BandProperty.h.

◆ m_min

double te::rst::BandProperty::m_min

Minimum pixel value (default is std::numeric_limits<double>::max() which means no value set).

Definition at line 147 of file BandProperty.h.

◆ m_nblocksx

int te::rst::BandProperty::m_nblocksx

The number of blocks in x.

Definition at line 145 of file BandProperty.h.

Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator().

◆ m_nblocksy

int te::rst::BandProperty::m_nblocksy

The number of blocks in y.

Definition at line 146 of file BandProperty.h.

Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator(), te::rst::BandIterator< T >::end(), te::rst::BandIteratorWithMask< T >::end(), te::rst::BandIteratorWindow< T >::end(), and te::rst::ConstBandIterator< T >::end().

◆ m_noDataValue

double te::rst::BandProperty::m_noDataValue

Value to indicate elements where there is no data, default is std::numeric_limits<double>::max().

Definition at line 136 of file BandProperty.h.

◆ m_palette

std::vector<ColorEntry> te::rst::BandProperty::m_palette

The color palette.

Definition at line 142 of file BandProperty.h.

◆ m_paletteInterp

PaletteInterpretation te::rst::BandProperty::m_paletteInterp

Pallete interpretation.

Definition at line 141 of file BandProperty.h.

◆ m_stdDev

double te::rst::BandProperty::m_stdDev

Standard deviation of all pixel values (default is std::numeric_limits<double>::max() which means no value set).

Definition at line 150 of file BandProperty.h.

◆ m_type

int te::rst::BandProperty::m_type

The data type of the elements in the band ( See te::dt namespace basic data types for reference ).

Definition at line 133 of file BandProperty.h.

◆ m_unit

te::common::UnitOfMeasurePtr te::rst::BandProperty::m_unit

protected

The unit of values.

Definition at line 154 of file BandProperty.h.

◆ m_valuesOffset

std::complex<double> te::rst::BandProperty::m_valuesOffset

Offset is the values (real and imaginary) to add to grid values for this sample dimension, default is 0.

Definition at line 137 of file BandProperty.h.

◆ m_valuesScale

std::complex<double> te::rst::BandProperty::m_valuesScale

Scale is the values (real and imaginary) which is multiplied to grid values for this sample dimension, default is 1.

Definition at line 138 of file BandProperty.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/raster/BandProperty.h

Classes

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BandProperty() [1/2]

◆ BandProperty() [2/2]

◆ ~BandProperty()

Member Function Documentation

◆ getType()

◆ getUnitOfMeasure()

◆ isComplex()

◆ operator=()

◆ setUnitOfMeasure()

Member Data Documentation

◆ m_blkh

◆ m_blkw

◆ m_categoryNames

◆ m_colorInterp

◆ m_description

◆ m_idx

◆ m_max

◆ m_mean

◆ m_metadata

◆ m_min

◆ m_nblocksx

◆ m_nblocksy

◆ m_noDataValue

◆ m_palette

◆ m_paletteInterp

◆ m_stdDev

◆ m_type

◆ m_unit

◆ m_valuesOffset

◆ m_valuesScale