SPATMOD::IMAGE::FILTER_FOCAL Class Reference
Base class for focal filters. More...
#include <spatmod/imagefilterfocal.h>
Public Member Functions | |
| virtual | ~FILTER_FOCAL () |
| double | GetAmountFilter () const |
| double | GetAmountSource () const |
| UINT32 | GetNumFocalCells () const |
| UINT32 | GetNumFocalColumns () const |
| UINT32 | GetNumFocalRows () const |
| bool | IsUsingMask () const |
| void | SetOutputDataType (DATATYPE DataType) |
Protected Member Functions | |
| FILTER_FOCAL (STAGE *pSourceImage, bool TakeOwnershipSource, STAGE *pMaskImage, bool TakeOwnershipMask, UINT32 NumFocalRows, UINT32 NumFocalColumns, double AmountFilterPct=100) | |
| FILTER_FOCAL (STAGE *pSourceImage, bool TakeOwnershipSource, UINT32 NumFocalRows, UINT32 NumFocalColumns, double AmountFilterPct=100) | |
| ERRVALUE | PullSubBuffers (const SECTION &SubSection, BUFFER &BufSrc, BUFFER &BufMask) |
| virtual ERRVALUE | v_Initialize () |
| virtual ERRVALUE | v_PullBegin (const SECTION_ITERATOR &iterator) |
Detailed Description
Base class for focal filters.
Constructor & Destructor Documentation
| virtual SPATMOD::IMAGE::FILTER_FOCAL::~FILTER_FOCAL | ( | ) | [virtual] |
Destructor.
| SPATMOD::IMAGE::FILTER_FOCAL::FILTER_FOCAL | ( | STAGE * | pSourceImage, | |
| bool | TakeOwnershipSource, | |||
| UINT32 | NumFocalRows, | |||
| UINT32 | NumFocalColumns, | |||
| double | AmountFilterPct = 100 | |||
| ) | [protected] |
Constructor.
- Parameters:
-
pSourceImage Source image stage TakeOwnershipSource Filter takes ownership of source image NumFocalRows Number of rows in focal window NumFocalColumns Number of columns in focal window AmountFilterPct Percentage of output from filter
| SPATMOD::IMAGE::FILTER_FOCAL::FILTER_FOCAL | ( | STAGE * | pSourceImage, | |
| bool | TakeOwnershipSource, | |||
| STAGE * | pMaskImage, | |||
| bool | TakeOwnershipMask, | |||
| UINT32 | NumFocalRows, | |||
| UINT32 | NumFocalColumns, | |||
| double | AmountFilterPct = 100 | |||
| ) | [protected] |
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 NumFocalRows Number of rows in focal window NumFocalColumns Number of columns in focal window AmountFilterPct Percentage of output from filter
Member Function Documentation
| double SPATMOD::IMAGE::FILTER_FOCAL::GetAmountFilter | ( | ) | const [inline] |
Get amount of output coming from filter (0-1).
| double SPATMOD::IMAGE::FILTER_FOCAL::GetAmountSource | ( | ) | const [inline] |
Get amount of source coming from filter (0-1).
| UINT32 SPATMOD::IMAGE::FILTER_FOCAL::GetNumFocalCells | ( | ) | const [inline] |
Return number of cells in focal window.
| UINT32 SPATMOD::IMAGE::FILTER_FOCAL::GetNumFocalColumns | ( | ) | const [inline] |
Return number of columns in focal window.
| UINT32 SPATMOD::IMAGE::FILTER_FOCAL::GetNumFocalRows | ( | ) | const [inline] |
Return number of rows in focal window.
| bool SPATMOD::IMAGE::FILTER_FOCAL::IsUsingMask | ( | ) | const [inline] |
Determine whether a binary mask is used to define filtered areas.
| ERRVALUE SPATMOD::IMAGE::FILTER_FOCAL::PullSubBuffers | ( | const SECTION & | SubSection, | |
| BUFFER & | BufSrc, | |||
| BUFFER & | BufMask | |||
| ) | [protected] |
| void SPATMOD::IMAGE::FILTER_FOCAL::SetOutputDataType | ( | DATATYPE | DataType | ) | [inline] |
Set output datatype.
If not used, output type will usually be the same as the input. If used, must be called before Initialize.
| virtual ERRVALUE SPATMOD::IMAGE::FILTER_FOCAL::v_Initialize | ( | ) | [protected, virtual] |
Initialize stage before insertion into pipeline.
Must do the following (in order), checking for error after each call. Validate all class-specific settings. Open any data sources/files if required. Call v_Initialize() on base class (if not private in base). Call SetAllProperties OR call SetPixelProperties(), SetTotalDimensions(), and SetTransToCRS(). Optionally call SetTileDimensions, SetPixelRange and/or other Set... methods needed. Preprocessing of source stages to determine properties may be done here or the first time v_PullBegin is called if does not affect base image properties.
Implements SPATMOD::IMAGE::STAGE.
| virtual ERRVALUE SPATMOD::IMAGE::FILTER_FOCAL::v_PullBegin | ( | const SECTION_ITERATOR & | iterator | ) | [protected, virtual] |
Begin pull of a specific section.
Default implementation calls PullBegin() for earlier stages in pipeline. If derived class overrides it must either call the base v_PullBegin() with either the same iterator on one that has been suitably adjusted based on the filter's behavior, or call PullBegin() for all earlier stages directly. This would typically be done before doing any filter-specific processing.
Reimplemented from SPATMOD::IMAGE::FILTER.
The documentation for this class was generated from the following file:
- spatmod/imagefilterfocal.h
