RASTER_FILTER_PARMS Class Reference

Class to hold settings for raster spatial filter. More...

#include <mi32/rasterfilterparms.h>

List of all members.

Public Types
enum	GRADIENTTYPE { GRADIENTTYPE_Sobel = 0, GRADIENTTYPE_Roberts = 1, GRADIENTTYPE_Prewitt = 2, GRADIENTTYPE_UserDefined = 3 }
Public Member Functions
	RASTER_FILTER_PARMS ()
	~RASTER_FILTER_PARMS ()
ERRVALUE	CreateFilter (SPATMOD::IMAGE::STAGE *pSourceImage, bool TakeOwnershipSource, SPATMOD::IMAGE::STAGE *pMaskImage, bool TakeOwnershipMask, SPATMOD::IMAGE::STAGE_AUTOPTR &PtrStage)
ERRVALUE	CreateFilter (SPATMOD::IMAGE::STAGE *pSourceImage, bool TakeOwnershipSource, SPATMOD::IMAGE::STAGE_AUTOPTR &PtrStage)
double	GetAmount () const
RVC::SPATIALFILTER::FILTERTYPE	GetFilterType () const
GRADIENTTYPE	GetGradientType () const
void	GetMatrixA (MIMATRIX &Matrix) const
void	GetMatrixB (MIMATRIX &Matrix) const
UINT32	GetNumColumns () const
UINT32	GetNumRows () const
double	GetParamA () const
double	GetParamB () const
bool	IsEnabled () const
void	SetAmount (double Amount)
void	SetEnabled (bool bIsEnabled)
void	SetFilterType (RVC::SPATIALFILTER::FILTERTYPE FilterType)
void	SetGradientType (GRADIENTTYPE GradientType)
void	SetMatrixA (const MIMATRIX &MatrixA)
void	SetMatrixB (const MIMATRIX &MatrixB)
void	SetNumColumns (UINT32 NumColumns)
void	SetNumRows (UINT32 NumRows)
void	SetParamA (double ParamA)
void	SetParamB (double ParamB)
Static Public Member Functions
static const SERIALIZERITEM *	SerialGetItemDef ()

---

Detailed Description

Class to hold settings for raster spatial filter.

---

Member Enumeration Documentation

enum RASTER_FILTER_PARMS::GRADIENTTYPE

Gradient Types.

Enumerator:

GRADIENTTYPE_Sobel
GRADIENTTYPE_Roberts
GRADIENTTYPE_Prewitt
GRADIENTTYPE_UserDefined

---

Constructor & Destructor Documentation

RASTER_FILTER_PARMS::RASTER_FILTER_PARMS

(

)

Default Constructor.

RASTER_FILTER_PARMS::~RASTER_FILTER_PARMS

(

)

Destructor.

---

Member Function Documentation

ERRVALUE RASTER_FILTER_PARMS::CreateFilter	(	SPATMOD::IMAGE::STAGE *	pSourceImage,
		bool	TakeOwnershipSource,
		SPATMOD::IMAGE::STAGE *	pMaskImage,
		bool	TakeOwnershipMask,
		SPATMOD::IMAGE::STAGE_AUTOPTR &	PtrStage
	)

Return filter_focal stage based on source stage, mask image and current parms settings.

ERRVALUE RASTER_FILTER_PARMS::CreateFilter	(	SPATMOD::IMAGE::STAGE *	pSourceImage,
		bool	TakeOwnershipSource,
		SPATMOD::IMAGE::STAGE_AUTOPTR &	PtrStage
	)

Return filter_focal stage based on source stage and current parms settings.

double RASTER_FILTER_PARMS::GetAmount

(

)

const [inline]

Return amount of filter to be applied.

RVC::SPATIALFILTER::FILTERTYPE RASTER_FILTER_PARMS::GetFilterType

(

)

const [inline]

Get filter type.

GRADIENTTYPE RASTER_FILTER_PARMS::GetGradientType

(

)

const [inline]

Get gradient filter type.

void RASTER_FILTER_PARMS::GetMatrixA

(

MIMATRIX &

Matrix

)

const

Get kernel A.

void RASTER_FILTER_PARMS::GetMatrixB

(

MIMATRIX &

Matrix

)

const

Get kernel B.

UINT32 RASTER_FILTER_PARMS::GetNumColumns

(

)

const [inline]

Get column size of kernel.

UINT32 RASTER_FILTER_PARMS::GetNumRows

(

)

const [inline]

Get row size of kernel.

double RASTER_FILTER_PARMS::GetParamA

(

)

const [inline]

Get value of slider A.

double RASTER_FILTER_PARMS::GetParamB

(

)

const [inline]

Get value of slider B.

bool RASTER_FILTER_PARMS::IsEnabled

(

)

const [inline]

Get whether filter is set to be applied.

static const SERIALIZERITEM* RASTER_FILTER_PARMS::SerialGetItemDef

(

)

[static]

Get item definition array for serialization.

void RASTER_FILTER_PARMS::SetAmount

(

double

Amount

)

[inline]

Set amount of filter to be applied.

void RASTER_FILTER_PARMS::SetEnabled

(

bool

bIsEnabled

)

[inline]

Set wheter filter is to be applied.

void RASTER_FILTER_PARMS::SetFilterType

(

RVC::SPATIALFILTER::FILTERTYPE

FilterType

)

[inline]

Set filter type.

void RASTER_FILTER_PARMS::SetGradientType

(

GRADIENTTYPE

GradientType

)

[inline]

Set gradient filter type.

void RASTER_FILTER_PARMS::SetMatrixA

(

const MIMATRIX &

MatrixA

)

Set kernel A.

void RASTER_FILTER_PARMS::SetMatrixB

(

const MIMATRIX &

MatrixB

)

Set kernel B.

void RASTER_FILTER_PARMS::SetNumColumns

(

UINT32

NumColumns

)

[inline]

Set column size of kernel.

void RASTER_FILTER_PARMS::SetNumRows

(

UINT32

NumRows

)

[inline]

Set row size of kernel.

void RASTER_FILTER_PARMS::SetParamA

(

double

ParamA

)

[inline]

Set value of slider A.

void RASTER_FILTER_PARMS::SetParamB

(

double

ParamB

)

[inline]

Set value of slider B.

---

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

• mi32/rasterfilterparms.h