SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC Class Reference
Purpose of this filter is to compute topographic properties from an input DEM raster. More...
#include <spatmod/imagefilterfocaltopographic.h>
Classes | |
| class | SETTINGS |
| Settings class for the FILTER_FOCALTOPOGRAPHIC class. More... | |
Public Types | |
| enum | CURVATURE_UNITS { CURVATURE_UNITS_RadiansPerMeter, CURVATURE_UNITS_RadiansPer100Meter } |
| enum | SHADING_METHOD { SHADING_METHOD_HighContrast = 0, SHADING_METHOD_Display = 1 } |
| enum | SLOPE_UNITS { SLOPE_UNITS_Percent, SLOPE_UNITS_Degrees } |
| enum | SURFACE_FITTING_METHOD { SURFACE_FITTING_METHOD_FourNearest = 0, SURFACE_FITTING_METHOD_QLSF = 1, SURFACE_FITTING_METHOD_QLSFOverDistance = 2, SURFACE_FITTING_METHOD_QLSFOverDistanceSquared = 3, SURFACE_FITTING_METHOD_QLSFMatchCentral = 4 } |
Public Member Functions | |
| FILTER_FOCALTOPOGRAPHIC (STAGE *pPreviousStage, bool TakeOwnership, const SETTINGS &settings) | |
| virtual | ~FILTER_FOCALTOPOGRAPHIC () |
| void | SetSeparatePlanValidity (bool SeparatePlanValidity) |
Protected Member Functions | |
| virtual ERRVALUE | v_Initialize () |
| virtual ERRVALUE | v_PullBegin (const SECTION_ITERATOR &iterator) |
| virtual ERRVALUE | v_PullSubSection (const SECTION §ion, BUFFER &target) |
Detailed Description
Purpose of this filter is to compute topographic properties from an input DEM raster.
Member Enumeration Documentation
Constructor & Destructor Documentation
| SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::FILTER_FOCALTOPOGRAPHIC | ( | STAGE * | pPreviousStage, | |
| bool | TakeOwnership, | |||
| const SETTINGS & | settings | |||
| ) |
Constructor.
| virtual SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::~FILTER_FOCALTOPOGRAPHIC | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SetSeparatePlanValidity | ( | bool | SeparatePlanValidity | ) | [inline] |
Set to output separate validity band for plan curvature.
| virtual ERRVALUE SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::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_FOCALTOPOGRAPHIC::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.
| virtual ERRVALUE SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::v_PullSubSection | ( | const SECTION & | SubSection, | |
| BUFFER & | buffer | |||
| ) | [protected, virtual] |
Pull data for specified subsection into buffer.
Buffer provided may be larger than needed for subsection, in which case data not overwritten in buffer may be left unchanged for efficiency.
Implements SPATMOD::IMAGE::STAGE.
The documentation for this class was generated from the following file:
- spatmod/imagefilterfocaltopographic.h
