te::rp::IHSFusion::InputParameters Class Reference

IHSFusion input parameters. More...

#include <IHSFusion.h>

Inheritance diagram for te::rp::IHSFusion::InputParameters:
te::rp::AlgorithmInputParameters te::common::AbstractParameters

Public Types

enum  HRHistoFitMethod { NoHistoFitMethod = 0 , MeanStdDevHistoFitMethod = 1 , MinMaxHistoFitMethod = 2 }
 

Public Member Functions

AbstractParametersclone () const
 Create a clone copy of this instance. More...
 
 InputParameters ()
 
 InputParameters (const InputParameters &)
 
const InputParametersoperator= (const InputParameters &params)
 
void reset ()
 Clear all internal allocated resources and reset the parameters instance to its initial state. More...
 
bool serialize (AlgorithmParametersSerializer &serializer) const
 Returns a parameter serialization object. More...
 
 ~InputParameters ()
 

Public Attributes

bool m_autoAlignRasters
 If true, the HR image will be clipped and reprojected to mach the LR image area. More...
 
bool m_enableProgress
 Enable/Disable the progress interface (default:false). More...
 
bool m_enableRasterCache
 If true, raster cache will be used (default:true). More...
 
bool m_enableThreadedProcessing
 If true, threaded processing will be performed (best with multi-core or multi-processor systems (default:true). More...
 
unsigned int m_highResRasterBand
 Band to process from the high-resolution raster. More...
 
te::rst::Raster const * m_highResRasterPtr
 Input high-resolution raster. More...
 
HRHistoFitMethod m_hrHistoFitMethod
 High resolution image histogram fitting method (default: MeanStdDevHistoFitMethod). More...
 
te::rst::Interpolator::Method m_interpMethod
 The raster interpolator method (default:NearestNeighbor). More...
 
unsigned int m_lowResRasterBlueBandIndex
 The low-resolution raster blue band index (default:2). More...
 
unsigned int m_lowResRasterGreenBandIndex
 The low-resolution raster green band index (default:1). More...
 
te::rst::Raster const * m_lowResRasterPtr
 Input low-resolution multi-band raster. More...
 
unsigned int m_lowResRasterRedBandIndex
 The low-resolution raster red band index (default:0). More...
 
double m_RGBMax
 The used RGB maximum value (default:0 - leave zero for automatic detection based on the input images).
More...
 
double m_RGBMin
 The used RGB minimum value (default:0 - leave zero for automatic detection based on the input images). More...
 

Detailed Description

IHSFusion input parameters.

Definition at line 67 of file IHSFusion.h.

Member Enumeration Documentation

◆ HRHistoFitMethod

High resolution image histogram fitting method.

Enumerator
NoHistoFitMethod 

No fitting performed method.

MeanStdDevHistoFitMethod 

Fitting by using mean and Standard deviation.

MinMaxHistoFitMethod 

Fitting by using the mininum and maximum values.

Definition at line 74 of file IHSFusion.h.

Constructor & Destructor Documentation

◆ InputParameters() [1/2]

te::rp::IHSFusion::InputParameters::InputParameters ( )

◆ InputParameters() [2/2]

te::rp::IHSFusion::InputParameters::InputParameters ( const InputParameters )

◆ ~InputParameters()

te::rp::IHSFusion::InputParameters::~InputParameters ( )

Member Function Documentation

◆ clone()

AbstractParameters* te::rp::IHSFusion::InputParameters::clone ( ) const
virtual

Create a clone copy of this instance.

Returns
A clone copy of this instance.
Note
The caller will take the ownership of the returned pointer.

Implements te::common::AbstractParameters.

◆ operator=()

const InputParameters& te::rp::IHSFusion::InputParameters::operator= ( const InputParameters params)

◆ reset()

void te::rp::IHSFusion::InputParameters::reset ( )
virtual

Clear all internal allocated resources and reset the parameters instance to its initial state.

Implements te::common::AbstractParameters.

◆ serialize()

bool te::rp::IHSFusion::InputParameters::serialize ( AlgorithmParametersSerializer serializer) const
virtual

Returns a parameter serialization object.

Parameters
serializerThe output serialization object.
Returns
Returns true if ok, false on erros.

Reimplemented from te::rp::AlgorithmInputParameters.

Member Data Documentation

◆ m_autoAlignRasters

bool te::rp::IHSFusion::InputParameters::m_autoAlignRasters

If true, the HR image will be clipped and reprojected to mach the LR image area.

Definition at line 103 of file IHSFusion.h.

◆ m_enableProgress

bool te::rp::IHSFusion::InputParameters::m_enableProgress

Enable/Disable the progress interface (default:false).

Definition at line 93 of file IHSFusion.h.

◆ m_enableRasterCache

bool te::rp::IHSFusion::InputParameters::m_enableRasterCache

If true, raster cache will be used (default:true).

Definition at line 105 of file IHSFusion.h.

◆ m_enableThreadedProcessing

bool te::rp::IHSFusion::InputParameters::m_enableThreadedProcessing

If true, threaded processing will be performed (best with multi-core or multi-processor systems (default:true).

Definition at line 101 of file IHSFusion.h.

◆ m_highResRasterBand

unsigned int te::rp::IHSFusion::InputParameters::m_highResRasterBand

Band to process from the high-resolution raster.

Definition at line 91 of file IHSFusion.h.

◆ m_highResRasterPtr

te::rst::Raster const* te::rp::IHSFusion::InputParameters::m_highResRasterPtr

Input high-resolution raster.

Definition at line 89 of file IHSFusion.h.

◆ m_hrHistoFitMethod

HRHistoFitMethod te::rp::IHSFusion::InputParameters::m_hrHistoFitMethod

High resolution image histogram fitting method (default: MeanStdDevHistoFitMethod).

Definition at line 107 of file IHSFusion.h.

◆ m_interpMethod

te::rst::Interpolator::Method te::rp::IHSFusion::InputParameters::m_interpMethod

The raster interpolator method (default:NearestNeighbor).

Definition at line 95 of file IHSFusion.h.

◆ m_lowResRasterBlueBandIndex

unsigned int te::rp::IHSFusion::InputParameters::m_lowResRasterBlueBandIndex

The low-resolution raster blue band index (default:2).

Definition at line 87 of file IHSFusion.h.

◆ m_lowResRasterGreenBandIndex

unsigned int te::rp::IHSFusion::InputParameters::m_lowResRasterGreenBandIndex

The low-resolution raster green band index (default:1).

Definition at line 85 of file IHSFusion.h.

◆ m_lowResRasterPtr

te::rst::Raster const* te::rp::IHSFusion::InputParameters::m_lowResRasterPtr

Input low-resolution multi-band raster.

Definition at line 81 of file IHSFusion.h.

◆ m_lowResRasterRedBandIndex

unsigned int te::rp::IHSFusion::InputParameters::m_lowResRasterRedBandIndex

The low-resolution raster red band index (default:0).

Definition at line 83 of file IHSFusion.h.

◆ m_RGBMax

double te::rp::IHSFusion::InputParameters::m_RGBMax

The used RGB maximum value (default:0 - leave zero for automatic detection based on the input images).

Definition at line 99 of file IHSFusion.h.

◆ m_RGBMin

double te::rp::IHSFusion::InputParameters::m_RGBMin

The used RGB minimum value (default:0 - leave zero for automatic detection based on the input images).

Definition at line 97 of file IHSFusion.h.


The documentation for this class was generated from the following file: