RVC::HISTOGRAM Class Reference

Manages RVC::OBJTYPE_Histogram objects. More...

#include <rvc/histogrm.h>

Inheritance diagram for RVC::HISTOGRAM:

[legend]

List of all members.

Classes
class	FILTER_COMPONENT
	Filter to determine which histogram object to select based on the RASTER::COMPONENT needed. More...
Public Member Functions
	HISTOGRAM (const RVC::HISTOGRAM &rhs)
	HISTOGRAM ()
virtual	~HISTOGRAM ()
ERRVALUE	ComputeFromRegion (const RVC::RASTER &RastObj, const REGION2D &Region, RVC::RASTER::COMPONENT Component=RVC::RASTER::COMPONENT_Default, const CREDENTIALS *Credentials=0)
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
RVC::RASTER::COMPONENT	GetComponent () const
UINT16	GetCountScale () 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 RVC::RASTER &parent, RVC::RASTER::COMPONENT Component=RVC::RASTER::COMPONENT_Default, const CREDENTIALS *Credentials=0)
RVC::HISTOGRAM &	operator= (const RVC::HISTOGRAM &rhs)
ERRVALUE	Read (const RVC::RASTER &parent, RVC::RASTER::COMPONENT Component=RVC::RASTER::COMPONENT_Default, const CREDENTIALS *Credentials=0)
void	SetBinRange (const DOUBLE_RANGE &range)
void	SetSampleIntervals (UINT16 LineInterval, UINT16 ColumnInterval)

---

Detailed Description

Manages RVC::OBJTYPE_Histogram objects.

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

Valid parents for this class:

• RVC::OBJTYPE_Raster

---

Constructor & Destructor Documentation

RVC::HISTOGRAM::HISTOGRAM

(

)

RVC::HISTOGRAM::HISTOGRAM

(

const RVC::HISTOGRAM &

rhs

)

virtual RVC::HISTOGRAM::~HISTOGRAM

(

)

[virtual]

---

Member Function Documentation

ERRVALUE RVC::HISTOGRAM::ComputeFromRegion	(	const RVC::RASTER &	RastObj,
		const REGION2D &	Region,
		RVC::RASTER::COMPONENT	Component = RVC::RASTER::COMPONENT_Default,
		const CREDENTIALS *	Credentials = 0
	)

Compute histogram from raster object inside the region boundaries.

Parameters:

Credentials

User credentials passed in, NULL for default behavior

int RVC::HISTOGRAM::GetBinIndexFromValue

(

double

CellValue

)

const

Get histogram bin index corresponding to specified cell value.

Returns:

Index, may not correspond to valid bin.

double RVC::HISTOGRAM::GetBinInterval

(

)

const

Get histogram bin interval.

Returns:

Bin interval

double RVC::HISTOGRAM::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::HISTOGRAM::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::HISTOGRAM::GetBinRange

(

)

const [inline]

Get range of histogram bin values.

UINT32 RVC::HISTOGRAM::GetCellCount

(

double

CellValue

)

const

Get cell count depending on cell value.

Returns:

Cell count of cell value

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

(

)

const

Get array of histogram cell counts.

Returns:

Cell count list

double RVC::HISTOGRAM::GetCellMaxValue

(

)

const [inline]

Get maximum cell value.

Returns:

Cell value, may be less than minimum bin value.

double RVC::HISTOGRAM::GetCellMinValue

(

)

const [inline]

Get minimum cell value.

void RVC::HISTOGRAM::GetCellRange

(

DOUBLE_RANGE &

CellRange

)

const [inline]

Get cell value range.

UINT16 RVC::HISTOGRAM::GetColumnSampleInterval

(

)

const

Get column sampling interval.

Returns:

Column sampling interval

RVC::RASTER::COMPONENT RVC::HISTOGRAM::GetComponent

(

)

const

Get raster component that this histogram was generated for.

Returns:

Raster Component (RVC::RASTER::COMPONENT)

UINT16 RVC::HISTOGRAM::GetCountScale

(

)

const [inline]

Get scale for "count" values.

UINT32 RVC::HISTOGRAM::GetGreaterThanCount

(

)

const

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

Returns:

Cell count.

UINT32 RVC::HISTOGRAM::GetLessThanCount

(

)

const

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

Returns:

Cell count.

UINT16 RVC::HISTOGRAM::GetLineSampleInterval

(

)

const

Get line sampling interval.

Returns:

Line sampling interval

double RVC::HISTOGRAM::GetMean

(

)

const

Get the computed mean histogram value.

Returns:

Mean value

UINT32 RVC::HISTOGRAM::GetNullCellCount

(

)

const

Get number of null cells in the raster.

Returns:

Number of raster null cells

ERRVALUE RVC::HISTOGRAM::GetStatistics

(

STAT_UNIVARIATE &

stats

)

const

Get statistics as STAT_UNIVARIATE.

Parameters:

stats

Statistics returned

double RVC::HISTOGRAM::GetStdDev

(

)

const

Get the computed standard deviation histogram value.

Returns:

Standard Deviation value

ERRVALUE RVC::HISTOGRAM::Make	(	const RVC::RASTER &	parent,
		RVC::RASTER::COMPONENT	Component = RVC::RASTER::COMPONENT_Default,
		const CREDENTIALS *	Credentials = 0
	)

Create a histogram.

Parameters:

Credentials

User credentials passed in, NULL for default behavior

RVC::HISTOGRAM& RVC::HISTOGRAM::operator=

(

const RVC::HISTOGRAM &

rhs

)

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

Reimplemented from RVC::OBJECT.

ERRVALUE RVC::HISTOGRAM::Read	(	const RVC::RASTER &	parent,
		RVC::RASTER::COMPONENT	Component = RVC::RASTER::COMPONENT_Default,
		const CREDENTIALS *	Credentials = 0
	)

Read a histogram under the raster object.

If the existing histogram is old or does not exist, a histogram is created.

Parameters:

Credentials

User credentials passed in, NULL for default behavior

void RVC::HISTOGRAM::SetBinRange

(

const DOUBLE_RANGE &

range

)

Set bin range.

void RVC::HISTOGRAM::SetSampleIntervals	(	UINT16	LineInterval,
		UINT16	ColumnInterval
	)

Set sampling intervals.

---

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

• rvc/histogrm.h