te::rst::BandSummary Struct Reference

A summary of a raster band (most statistics). More...

#include <BandSummary.h>

Public Member Functions

 BandSummary ()
 Constructor. More...
 
 BandSummary (const BandSummary &rhs)
 Copy constructor. More...
 
void clear ()
 Clears all attributes from this class. More...
 
BandSummaryoperator= (const BandSummary &rhs)
 Assignment operator. More...
 
 ~BandSummary ()
 Destructor. More...
 

Public Attributes

std::map< double, unsigned int > * m_histogramI
 The histogram (a map of occurring values and frequency) of the imaginary part of a band. More...
 
std::map< double, unsigned int > * m_histogramR
 The histogram (a map of occurring values and frequency) of the real part of a band. More...
 
std::complex< double > * m_maxVal
 The maximum occurring values (real and imaginary), default is std::numeric_limits<double>::max(). More...
 
std::complex< double > * m_meanVal
 The mean of the occurring values (real and imaginary), default is 0.0. More...
 
std::complex< double > * m_minVal
 The minimum occurring values (real and imaginary), default is std::numeric_limits<double>::min(). More...
 
std::complex< double > * m_stdVal
 The standard deviation of the occurring values (real and imaginary), default is 1.0. More...
 

Detailed Description

A summary of a raster band (most statistics).

Definition at line 47 of file BandSummary.h.

Constructor & Destructor Documentation

te::rst::BandSummary::BandSummary ( )

Constructor.

te::rst::BandSummary::BandSummary ( const BandSummary rhs)

Copy constructor.

Parameters
rhsThe right-hand-side copy used to copy from.
te::rst::BandSummary::~BandSummary ( )

Destructor.

Member Function Documentation

void te::rst::BandSummary::clear ( )

Clears all attributes from this class.

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

Assignment operator.

Parameters
rhsThe right-hand-side copy used to copy from.
Returns
A reference to this object.

Member Data Documentation

std::map<double, unsigned int>* te::rst::BandSummary::m_histogramI

The histogram (a map of occurring values and frequency) of the imaginary part of a band.

Definition at line 83 of file BandSummary.h.

std::map<double, unsigned int>* te::rst::BandSummary::m_histogramR

The histogram (a map of occurring values and frequency) of the real part of a band.

Definition at line 82 of file BandSummary.h.

std::complex<double>* te::rst::BandSummary::m_maxVal

The maximum occurring values (real and imaginary), default is std::numeric_limits<double>::max().

Definition at line 79 of file BandSummary.h.

std::complex<double>* te::rst::BandSummary::m_meanVal

The mean of the occurring values (real and imaginary), default is 0.0.

Definition at line 81 of file BandSummary.h.

std::complex<double>* te::rst::BandSummary::m_minVal

The minimum occurring values (real and imaginary), default is std::numeric_limits<double>::min().

Definition at line 78 of file BandSummary.h.

std::complex<double>* te::rst::BandSummary::m_stdVal

The standard deviation of the occurring values (real and imaginary), default is 1.0.

Definition at line 80 of file BandSummary.h.


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