SPATMOD::IMAGE::FILTER_FOCAL_MULTIPLICATIVE Class Reference
Filter to apply a single kernel on samples in image. Calculates a weighted average of the cells in the current filter window. More...
#include <spatmod/imagefilterfocal.h>
Inheritance diagram for SPATMOD::IMAGE::FILTER_FOCAL_MULTIPLICATIVE:
Public Member Functions | |
| FILTER_FOCAL_MULTIPLICATIVE (STAGE *pSourceImage, bool TakeOwnershipSource, STAGE *pMaskImage, bool TakeOwnershipMask, const MIMATRIX &matrix, double AmountFilterPct=100.0, bool UseCenterForNull=false) | |
| FILTER_FOCAL_MULTIPLICATIVE (STAGE *pSourceImage, bool TakeOwnershipSource, const MIMATRIX &matrix, double AmountFilterPct=100.0, bool UseCenterForNull=false) | |
| virtual | ~FILTER_FOCAL_MULTIPLICATIVE () |
| const MIMATRIX & | GetMatrix () const |
| void | SetMatrix (const MIMATRIX &matrix) |
| void | SetTestWeightGreaterThanOne () |
Detailed Description
Filter to apply a single kernel on samples in image. Calculates a weighted average of the cells in the current filter window.
Constructor & Destructor Documentation
| SPATMOD::IMAGE::FILTER_FOCAL_MULTIPLICATIVE::FILTER_FOCAL_MULTIPLICATIVE | ( | STAGE * | pSourceImage, | |
| bool | TakeOwnershipSource, | |||
| const MIMATRIX & | matrix, | |||
| double | AmountFilterPct = 100.0, |
|||
| bool | UseCenterForNull = false | |||
| ) |
Constructor.
- Parameters:
-
pSourceImage Source image stage TakeOwnershipSource Filter takes ownership of source image, matrix Set kernel from matrix AmountFilterPct Amount of filter to apply (percentage, 0-100) UseCenterForNull If null value found, use center value for calculations, otherwise skip it
| SPATMOD::IMAGE::FILTER_FOCAL_MULTIPLICATIVE::FILTER_FOCAL_MULTIPLICATIVE | ( | STAGE * | pSourceImage, | |
| bool | TakeOwnershipSource, | |||
| STAGE * | pMaskImage, | |||
| bool | TakeOwnershipMask, | |||
| const MIMATRIX & | matrix, | |||
| double | AmountFilterPct = 100.0, |
|||
| bool | UseCenterForNull = false | |||
| ) |
Constructor with mask to determine areas to filter.
- Parameters:
-
pSourceImage Source image stage TakeOwnershipSource Filter takes ownership of source image pMaskImage Mask, must have single component sample TakeOwnershipMask Filter takes ownership of mask stage and will delete when needed, matrix Set kernel from matrix AmountFilterPct Amount of filter to apply (percentage, 0-100) UseCenterForNull If null value found, use center value for calculations, otherwise skip it
| virtual SPATMOD::IMAGE::FILTER_FOCAL_MULTIPLICATIVE::~FILTER_FOCAL_MULTIPLICATIVE | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| const MIMATRIX& SPATMOD::IMAGE::FILTER_FOCAL_MULTIPLICATIVE::GetMatrix | ( | ) | const [inline] |
Get matrix kernel.
| void SPATMOD::IMAGE::FILTER_FOCAL_MULTIPLICATIVE::SetMatrix | ( | const MIMATRIX & | matrix | ) | [inline] |
Use matrix to define kernel.
| void SPATMOD::IMAGE::FILTER_FOCAL_MULTIPLICATIVE::SetTestWeightGreaterThanOne | ( | ) | [inline] |
The documentation for this class was generated from the following file:
- spatmod/imagefilterfocal.h
