SPATMOD::IMAGE::FILTER_SCALEOFFSET Class Reference
Filter to apply scale and offset to samples in image. More...
#include <spatmod/imagefilterscaleoffset.h>
Inheritance diagram for SPATMOD::IMAGE::FILTER_SCALEOFFSET:
Public Member Functions | |
| FILTER_SCALEOFFSET (STAGE *pPreviousStage, bool TakeOwnership) | |
| virtual | ~FILTER_SCALEOFFSET () |
| double | GetOffset (UINT16 SampleNum) const |
| void | GetOffsets (MIMATRIX &Offsets) const |
| double | GetScale (UINT16 SampleNum) const |
| void | GetScales (MIMATRIX &Scales) const |
| void | SetDoFloor (bool DoFloor=true) |
| ERRVALUE | SetScaleOffset (UINT16 SampleNum, double scale, double offset) |
| void | SetScaleOffsets (const double *Scales, const double *Offsets) |
| ERRVALUE | SetScaleOffsets (const MIMATRIX &Scales, const MIMATRIX &Offsets) |
Detailed Description
Filter to apply scale and offset to samples in image.
If applied to integer data resulting values will be rounded.
Constructor & Destructor Documentation
| SPATMOD::IMAGE::FILTER_SCALEOFFSET::FILTER_SCALEOFFSET | ( | STAGE * | pPreviousStage, | |
| bool | TakeOwnership | |||
| ) |
Constructor.
- Parameters:
-
pPreviousStage Pointer to previous stage TakeOwnership Filter takes ownership of previous stage and will delete when needed
| virtual SPATMOD::IMAGE::FILTER_SCALEOFFSET::~FILTER_SCALEOFFSET | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| double SPATMOD::IMAGE::FILTER_SCALEOFFSET::GetOffset | ( | UINT16 | SampleNum | ) | const |
Get offset for sample.
If sample index is out of range then 0 will be returned.
- Parameters:
-
SampleNum Sample index
| void SPATMOD::IMAGE::FILTER_SCALEOFFSET::GetOffsets | ( | MIMATRIX & | Offsets | ) | const |
Get offsets as MIMATRIX.
- Parameters:
-
Offsets Offset matrix returned
| double SPATMOD::IMAGE::FILTER_SCALEOFFSET::GetScale | ( | UINT16 | SampleNum | ) | const |
Get scale for sample.
If sample index is out of range then 0 will be returned.
- Parameters:
-
SampleNum Sample index
| void SPATMOD::IMAGE::FILTER_SCALEOFFSET::GetScales | ( | MIMATRIX & | Scales | ) | const |
Get scales as MIMATRIX.
- Parameters:
-
Scales Scale matrix returned
| void SPATMOD::IMAGE::FILTER_SCALEOFFSET::SetDoFloor | ( | bool | DoFloor = true |
) | [inline] |
Set to use "floor" when processing integer data (default is to round).
| ERRVALUE SPATMOD::IMAGE::FILTER_SCALEOFFSET::SetScaleOffset | ( | UINT16 | SampleNum, | |
| double | scale, | |||
| double | offset | |||
| ) |
Set constant for sample.
- Parameters:
-
SampleNum Sample index scale Scale to set offset Offset value to add after applying scale
| void SPATMOD::IMAGE::FILTER_SCALEOFFSET::SetScaleOffsets | ( | const double * | Scales, | |
| const double * | Offsets | |||
| ) |
Set constant scales for all samples.
- Parameters:
-
Scales Scale array, must have size based on number of samples. Offsets Offset array, must have size based on number of samples.
| ERRVALUE SPATMOD::IMAGE::FILTER_SCALEOFFSET::SetScaleOffsets | ( | const MIMATRIX & | Scales, | |
| const MIMATRIX & | Offsets | |||
| ) |
Set constant scales for all samples.
Matrix must be vector of with size corresponding to number of samples.
- Parameters:
-
Scales Scales as vector matrix Offsets Offsets as vector matrix
The documentation for this class was generated from the following file:
- spatmod/imagefilterscaleoffset.h
