SPATMOD::IMAGE::FILTER_STATISTICS Class Reference

Filter to compute various statistics for each pixel. More...

#include <spatmod/imagefilterstatistics.h>

Inheritance diagram for SPATMOD::IMAGE::FILTER_STATISTICS:

[legend]

List of all members.

Public Types
enum	VALUES {   VALUE_None = 0, VALUE_Count = 0x0001, VALUE_Diversity = 0x0002, VALUE_Minimum = 0x0004,   VALUE_Maximum = 0x0008, VALUE_Median = 0x0010, VALUE_Mode = 0x0020, VALUE_Mean = 0x0040,   VALUE_Sum = 0x0080, VALUE_StdDev = 0x0100, VALUE_Variance = 0x0200, VALUE_RegressionSlope = 0x0400,   VALUE_RegressionOffset = 0x0800, VALUE_All = 0x0FFF, VALUE_LAST = 0x0800 }
Public Member Functions
	FILTER_STATISTICS (STAGE_ARRAY &PreviousStages, bool TakeOwnership, VALUES values, DATATYPE DataTypeMinMaxMedMode, DATATYPE DataTypeMean, DATATYPE DataTypeSum, DATATYPE DataTypeStdVarReg)
	FILTER_STATISTICS (STAGE_ARRAY &PreviousStages, bool TakeOwnership, VALUES values)
virtual	~FILTER_STATISTICS ()
Static Public Member Functions
static TEXTID	GetValueName (VALUES value)

---

Detailed Description

Filter to compute various statistics for each pixel.

Output pixels will be "valid" if any input sample is valid. If only a single input sample is valid, output for StdDev, Variance and RegressionSlope will be 0.

---

Member Enumeration Documentation

enum SPATMOD::IMAGE::FILTER_STATISTICS::VALUES

< Values which may be computed.

Enumerator:

VALUE_None
VALUE_Count	Number of valid component values.
VALUE_Diversity	Number of different component values.
VALUE_Minimum	Minimum value.
VALUE_Maximum	Maximum value.
VALUE_Median	Median value.
VALUE_Mode	Value occuring most frequently.
VALUE_Mean	Mean of values.
VALUE_Sum	Sum of values.
VALUE_StdDev	Standard deviation.
VALUE_Variance	Variance.
VALUE_RegressionSlope	Regression line slope, input sample number is X.
VALUE_RegressionOffset	Regression line y-intercept with input sample number as X.
VALUE_All
VALUE_LAST

---

Constructor & Destructor Documentation

SPATMOD::IMAGE::FILTER_STATISTICS::FILTER_STATISTICS	(	STAGE_ARRAY &	PreviousStages,
		bool	TakeOwnership,
		VALUES	values
	)

Construct with automatic datatype selection.

Data types will be chosen such that overflow cannot occur. If no input has DATATYPE_FLOAT64, then DATATYPE_FLOAT32 will be used for Mean, Sum, StdDev, Variance and Regression.

Parameters:

values

Values to output

SPATMOD::IMAGE::FILTER_STATISTICS::FILTER_STATISTICS	(	STAGE_ARRAY &	PreviousStages,
		bool	TakeOwnership,
		VALUES	values,
		DATATYPE	DataTypeMinMaxMedMode,
		DATATYPE	DataTypeMean,
		DATATYPE	DataTypeSum,
		DATATYPE	DataTypeStdVarReg
	)

Construct with specific output datatypes.

Parameters:

	values	Values to output
	DataTypeMinMaxMedMode	Data type for Minimum, Maximum, Median and Mode, DATATYPE_Invalid to determine automatically
	DataTypeMean	Data type for Mean, DATATYPE_Invalid to determine automatically
	DataTypeSum	Data type for Sum, DATATYPE_Invalid to determine automatically
	DataTypeStdVarReg	Data type for StdDev, Variance and Regression, DATATYPE_Invalid to determine automatically

virtual SPATMOD::IMAGE::FILTER_STATISTICS::~FILTER_STATISTICS

(

)

[virtual]

---

Member Function Documentation

static TEXTID SPATMOD::IMAGE::FILTER_STATISTICS::GetValueName

(

VALUES

value

)

[static]

Get TEXTID for value name.

---

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

• spatmod/imagefilterstatistics.h