Contrast enhancement.
More...
#include <Contrast.h>
|
static bool | getGainAndOffset (const InputParameters::ContrastType &type, const double &inRangeMin, const double &inRangeMax, const double &outRangeMin, const double &outRangeMax, double &gain, double &offset1, double &offset2) |
| Returns gain and offset values for contrast types (when applicable). More...
|
|
|
typedef void(Contrast::* | RemapFuncPtrT) (const double &inValue, double &outValue) |
| Type definition for a remapping function pointer. More...
|
|
Contrast enhancement.
Apply contrast enhencement on the selected bands.
Definition at line 57 of file Contrast.h.
◆ RemapFuncPtrT
typedef void(Contrast::* te::rp::Contrast::RemapFuncPtrT) (const double &inValue, double &outValue) |
|
protected |
Type definition for a remapping function pointer.
Definition at line 254 of file Contrast.h.
◆ Contrast()
te::rp::Contrast::Contrast |
( |
| ) |
|
◆ ~Contrast()
te::rp::Contrast::~Contrast |
( |
| ) |
|
◆ DecorrelationEnhancementRemap()
void te::rp::Contrast::DecorrelationEnhancementRemap |
( |
const double & |
inValue, |
|
|
double & |
outValue |
|
) |
| |
|
inlineprotected |
Remap on gray level using two offsets and gain.
- Parameters
-
inValue | Input gray level. |
outValue | Output gray level. |
Definition at line 391 of file Contrast.h.
◆ execDecorrelationEnhancement()
bool te::rp::Contrast::execDecorrelationEnhancement |
( |
| ) |
|
|
protected |
Execute the decorrelation enhancement contrast following the internal parameters.
- Returns
- true if OK, false on errors.
◆ execHistogramEqualizationContrast()
bool te::rp::Contrast::execHistogramEqualizationContrast |
( |
| ) |
|
|
protected |
Execute the histogram equalization contrast following the internal parameters.
- Returns
- true if OK, false on errors.
◆ execLinearContrast()
bool te::rp::Contrast::execLinearContrast |
( |
| ) |
|
|
protected |
Execute a linear contrast following the internal parameters.
- Returns
- true if OK, false on errors.
◆ execLogContrast()
bool te::rp::Contrast::execLogContrast |
( |
| ) |
|
|
protected |
Execute a log contrast following the internal parameters.
- Returns
- true if OK, false on errors.
◆ execSetMeanAndStdContrast()
bool te::rp::Contrast::execSetMeanAndStdContrast |
( |
| ) |
|
|
protected |
Execute the histogram equalization contrast following the internal parameters.
- Returns
- true if OK, false on errors.
◆ execSquareContrast()
bool te::rp::Contrast::execSquareContrast |
( |
| ) |
|
|
protected |
Execute a square contrast following the internal parameters.
- Returns
- true if OK, false on errors.
◆ execSquareRootContrast()
bool te::rp::Contrast::execSquareRootContrast |
( |
| ) |
|
|
protected |
Execute a square root contrast following the internal parameters.
- Returns
- true if OK, false on errors.
◆ execute()
Executes the algorithm using the supplied parameters.
- Parameters
-
outputParams | Output parameters. |
- Returns
- true if OK, false on errors.
- Note
- A return error string can be obtained via Algorithm::getErrorMessage()
Implements te::rp::Algorithm.
◆ getErrorMessage()
const std::string& te::rp::Algorithm::getErrorMessage |
( |
| ) |
const |
|
inherited |
Return the current error message if there is any.
- Returns
- Return the current error message if there is any.
◆ getGainAndOffset()
static bool te::rp::Contrast::getGainAndOffset |
( |
const InputParameters::ContrastType & |
type, |
|
|
const double & |
inRangeMin, |
|
|
const double & |
inRangeMax, |
|
|
const double & |
outRangeMin, |
|
|
const double & |
outRangeMax, |
|
|
double & |
gain, |
|
|
double & |
offset1, |
|
|
double & |
offset2 |
|
) |
| |
|
static |
Returns gain and offset values for contrast types (when applicable).
- Parameters
-
inRangeMin | Input values range minimum value. |
inRangeMax | Input values range maximum value. |
outRangeMin | Output values range minimum value. |
outRangeMax | Output values range maximum value. |
gain | Calculated gain. |
offset1 | Calculated offset 1. |
offset2 | Calculated offset 2. |
- Returns
- true if OK, false on errors.
◆ histogramEqualizationRemap()
void te::rp::Contrast::histogramEqualizationRemap |
( |
const double & |
inValue, |
|
|
double & |
outValue |
|
) |
| |
|
inlineprotected |
Remap on gray level using two offsets and gain.
- Parameters
-
inValue | Input gray level. |
outValue | Output gray level. |
Definition at line 403 of file Contrast.h.
◆ initialize()
Initialize the algorithm instance making it ready for execution.
- Parameters
-
inputParams | Input parameters. |
- Returns
- true if OK, false on errors.
- Note
- A return error string can be obtained via Algorithm::getErrorMessage()
Implements te::rp::Algorithm.
◆ isInitialized()
bool te::rp::Contrast::isInitialized |
( |
| ) |
const |
|
virtual |
Returns true if the algorithm instance is initialized and ready for execution.
- Returns
- true if the algorithm instance is initialized and ready for execution.
Implements te::rp::Algorithm.
◆ logRemap()
void te::rp::Contrast::logRemap |
( |
const double & |
inValue, |
|
|
double & |
outValue |
|
) |
| |
|
inlineprotected |
Remap on gray level using a log.
- Parameters
-
inValue | Input gray level. |
outValue | Output gray level. |
- Note
- outValue = m_logRemap_gain * std::log10( inValue + m_logRemap_offset + 1.0 );
Definition at line 381 of file Contrast.h.
◆ offSetGainRemap()
void te::rp::Contrast::offSetGainRemap |
( |
const double & |
inValue, |
|
|
double & |
outValue |
|
) |
| |
|
inlineprotected |
Remap on gray level using an offset and gain.
- Parameters
-
inValue | Input gray level. |
outValue | Output gray level. |
- Note
- outValue = ( ( inValue + m_offSetGainRemap_offset1 ) * m_offSetGainRemap_gain ) + m_offSetGainRemap_offset2
Definition at line 347 of file Contrast.h.
◆ remapBandLevels()
Band gray levels remap using a remap function.
- Parameters
-
inRasterBand | Input raster band. |
outRasterBand | Output raster band. |
remapFuncPtr | The remap function pointer used. |
enableProgress | Enable the use of a progress interface. |
- Returns
- true if OK, false on errors.
◆ reset()
void te::rp::Contrast::reset |
( |
| ) |
|
throw | ( | te::rp::Exception |
| ) | | |
|
virtual |
Clear all internal allocated objects and reset the algorithm to its initial state.
Reimplemented from te::rp::Algorithm.
◆ setErrorMessage()
void te::rp::Algorithm::setErrorMessage |
( |
const std::string & |
newErrorMessage | ) |
|
|
protectedinherited |
Set the current error message.
- Parameters
-
newErrorMessage | New error message; |
◆ squareRemap()
void te::rp::Contrast::squareRemap |
( |
const double & |
inValue, |
|
|
double & |
outValue |
|
) |
| |
|
inlineprotected |
Remap on gray level using a square.
- Parameters
-
inValue | Input gray level. |
outValue | Output gray level. |
- Note
- outValue = m_squareRemap_factor * std::pow( inValue, 2.0 )
Definition at line 359 of file Contrast.h.
◆ squareRootRemap()
void te::rp::Contrast::squareRootRemap |
( |
const double & |
inValue, |
|
|
double & |
outValue |
|
) |
| |
|
inlineprotected |
Remap on gray level using a square root.
- Parameters
-
inValue | Input gray level. |
outValue | Output gray level. |
- Note
- outValue = m_squareRootRemap_gain * std::sqrt( inValue );
Definition at line 370 of file Contrast.h.
◆ m_decorrelationEnhancementRemap_gain
double te::rp::Contrast::m_decorrelationEnhancementRemap_gain |
|
protected |
◆ m_decorrelationEnhancementRemap_offset1
double te::rp::Contrast::m_decorrelationEnhancementRemap_offset1 |
|
protected |
◆ m_decorrelationEnhancementRemap_offset2
double te::rp::Contrast::m_decorrelationEnhancementRemap_offset2 |
|
protected |
◆ m_histogramEqualizationRemap_cdf
std::map<double, double> te::rp::Contrast::m_histogramEqualizationRemap_cdf |
|
protected |
◆ m_histogramEqualizationRemap_cDFMin
double te::rp::Contrast::m_histogramEqualizationRemap_cDFMin |
|
protected |
◆ m_histogramEqualizationRemap_gain
double te::rp::Contrast::m_histogramEqualizationRemap_gain |
|
protected |
◆ m_inputParameters
◆ m_isInitialized
bool te::rp::Contrast::m_isInitialized |
|
protected |
Tells if this instance is initialized.
Definition at line 260 of file Contrast.h.
◆ m_logRemap_gain
double te::rp::Contrast::m_logRemap_gain |
|
protected |
◆ m_logRemap_offset
double te::rp::Contrast::m_logRemap_offset |
|
protected |
◆ m_offSetGainRemap_gain
double te::rp::Contrast::m_offSetGainRemap_gain |
|
protected |
◆ m_offSetGainRemap_offset1
double te::rp::Contrast::m_offSetGainRemap_offset1 |
|
protected |
◆ m_offSetGainRemap_offset2
double te::rp::Contrast::m_offSetGainRemap_offset2 |
|
protected |
◆ m_outputParametersPtr
◆ m_squareRemap_gain
double te::rp::Contrast::m_squareRemap_gain |
|
protected |
◆ m_squareRootRemap_gain
double te::rp::Contrast::m_squareRootRemap_gain |
|
protected |
The documentation for this class was generated from the following file:
- /home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/rp/Contrast.h