RVC::HYPERHISTOGRAM Class Reference

Manages RVC::OBJTYPE_HyperspectralHistogram objects. More...

#include <rvc/hyperhistogram.h>

Inheritance diagram for RVC::HYPERHISTOGRAM:

[legend]

List of all members.

Public Member Functions
	HYPERHISTOGRAM (const RVC::HYPERHISTOGRAM &rhs)
	HYPERHISTOGRAM ()
virtual	~HYPERHISTOGRAM ()
INT32	GetBand () const
int	GetBinIndexFromValue (double CellValue) const
double	GetBinInterval () const
double	GetBinMaxValue () const
double	GetBinMinValue () const
const DOUBLE_RANGE &	GetBinRange () const
UINT32	GetCellCount (double CellValue) const
const SIMPLE_ARRAY< UINT32 > &	GetCellCounts () const
double	GetCellMaxValue () const
double	GetCellMinValue () const
void	GetCellRange (DOUBLE_RANGE &CellRange) const
UINT16	GetColumnSampleInterval () const
UINT32	GetGreaterThanCount () const
UINT32	GetLessThanCount () const
UINT16	GetLineSampleInterval () const
double	GetMean () const
UINT32	GetNullCellCount () const
ERRVALUE	GetStatistics (STAT_UNIVARIATE &stats) const
double	GetStdDev () const
ERRVALUE	Make (const HYPERSPECTRAL &parent, INT32 BandNum, const CREDENTIALS *Credentials=0)
HYPERHISTOGRAM &	operator= (const HYPERHISTOGRAM &rhs)
ERRVALUE	Read (const HYPERSPECTRAL &parent, INT32 BandNum, const CREDENTIALS *Credentials=0)
void	SetBinRange (const DOUBLE_RANGE &range)

---

Detailed Description

Manages RVC::OBJTYPE_HyperspectralHistogram objects.

RVC Object Types that this class supports: RVC::OBJTYPE_HyperspectralHistogram.

Valid parents for this class:

• RVC::OBJTYPE_Hyperspectral

---

Constructor & Destructor Documentation

RVC::HYPERHISTOGRAM::HYPERHISTOGRAM

(

)

RVC::HYPERHISTOGRAM::HYPERHISTOGRAM

(

const RVC::HYPERHISTOGRAM &

rhs

)

virtual RVC::HYPERHISTOGRAM::~HYPERHISTOGRAM

(

)

[virtual]

---

Member Function Documentation

INT32 RVC::HYPERHISTOGRAM::GetBand

(

)

const

Get hyperspectral band that this histogram was generated for.

Returns:

Band index

int RVC::HYPERHISTOGRAM::GetBinIndexFromValue

(

double

CellValue

)

const

Get histogram bin index corresponding to specified cell value.

Returns:

Index, may not correspond to valid bin.

double RVC::HYPERHISTOGRAM::GetBinInterval

(

)

const

Get histogram bin interval.

Returns:

Bin interval

double RVC::HYPERHISTOGRAM::GetBinMaxValue

(

)

const

Get maximum histogram bin value.

This returns the highest cell value which could be counted in last histogram bin.

Returns:

Maximum value, may be less than maximum cell value.

double RVC::HYPERHISTOGRAM::GetBinMinValue

(

)

const

Get minimum histogram bin value.

This returns the lowest cell value which could be counted in first histogram bin.

Returns:

Minimum value, may be greater than minimum cell value.

const DOUBLE_RANGE& RVC::HYPERHISTOGRAM::GetBinRange

(

)

const [inline]

Get range of histogram bin values.

UINT32 RVC::HYPERHISTOGRAM::GetCellCount

(

double

CellValue

)

const

Get cell count depending on cell value.

Returns:

Cell count of cell value

const SIMPLE_ARRAY<UINT32>& RVC::HYPERHISTOGRAM::GetCellCounts

(

)

const

Get array of histogram cell counts.

Returns:

Cell count list

double RVC::HYPERHISTOGRAM::GetCellMaxValue

(

)

const [inline]

Get maximum cell value.

Returns:

Cell value, may be less than minimum bin value.

double RVC::HYPERHISTOGRAM::GetCellMinValue

(

)

const [inline]

Get minimum cell value.

void RVC::HYPERHISTOGRAM::GetCellRange

(

DOUBLE_RANGE &

CellRange

)

const [inline]

Get cell value range.

UINT16 RVC::HYPERHISTOGRAM::GetColumnSampleInterval

(

)

const

Get column sampling interval.

Returns:

Column sampling interval

UINT32 RVC::HYPERHISTOGRAM::GetGreaterThanCount

(

)

const

Get number of cells with values greater than maximum bin value.

Returns:

Cell count.

UINT32 RVC::HYPERHISTOGRAM::GetLessThanCount

(

)

const

Get number of cells with values less than minimum bin value.

Returns:

Cell count.

UINT16 RVC::HYPERHISTOGRAM::GetLineSampleInterval

(

)

const

Get line sampling interval.

Returns:

Line sampling interval

double RVC::HYPERHISTOGRAM::GetMean

(

)

const

Get the computed mean histogram value.

Returns:

Mean value

UINT32 RVC::HYPERHISTOGRAM::GetNullCellCount

(

)

const

Get number of null cells in the raster.

Returns:

Number of raster null cells

ERRVALUE RVC::HYPERHISTOGRAM::GetStatistics

(

STAT_UNIVARIATE &

stats

)

const

Get statistics as STAT_UNIVARIATE.

Parameters:

stats

Statistics returned

double RVC::HYPERHISTOGRAM::GetStdDev

(

)

const

Get the computed standard deviation histogram value.

Returns:

Standard Deviation value

ERRVALUE RVC::HYPERHISTOGRAM::Make	(	const HYPERSPECTRAL &	parent,
		INT32	BandNum,
		const CREDENTIALS *	Credentials = 0
	)

Create a histogram.

Parameters:

Credentials

User credentials passed in, NULL for default behavior

HYPERHISTOGRAM& RVC::HYPERHISTOGRAM::operator=

(

const HYPERHISTOGRAM &

rhs

)

Assignment. Will close if necessary and reopen if 'rhs' is open.

Reimplemented from RVC::OBJECT.

ERRVALUE RVC::HYPERHISTOGRAM::Read	(	const HYPERSPECTRAL &	parent,
		INT32	BandNum,
		const CREDENTIALS *	Credentials = 0
	)

Read a histogram under the hyperspectral object for the given band.

If the existing histogram is old or does not exist, a histogram is created. If a different band is given that from the previous Read(), the previous band information is replaced.

Parameters:

Credentials

User credentials passed in, NULL for default behavior

void RVC::HYPERHISTOGRAM::SetBinRange

(

const DOUBLE_RANGE &

range

)

Set bin range.

---

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

• rvc/hyperhistogram.h