te::rp::GeoMosaic::InputParameters Class Reference

GeoMosaic input parameters. More...

#include <GeoMosaic.h>

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

Public Types

enum  EqType {
  InvalidEqType = 0 , NoEqType = 1 , CenterEqType = 2 , TargetEqtype = 3 ,
  LocalEqType = 4
}
 

Public Member Functions

AbstractParametersclone () const
 Create a clone copy of this instance. More...
 
 InputParameters ()
 
 InputParameters (const InputParameters &)
 
const InputParametersoperator= (const InputParameters &params)
 
void reset () _NOEXCEPT_OP(false)
 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 ()
 

Static Public Member Functions

static void getEqTypesInfo (std::vector< std::pair< EqType, std::string > > &eqTypesInfo)
 Returns all current supported equalization type infos. More...
 

Public Attributes

bool m_abortOnFirstError
 if true the processing will be stopped on the first error, if false the processing of the next rasters will continue on the event of an error (default: true). More...
 
te::rp::Blender::BlendMethod m_blendMethod
 The pixel blending method (default: NoBlendMethod). More...
 
bool m_enableAutoValidAreaDetect
 Enable/disable the auto-detection of raster valid area pixels (this option allows better mosaic result for rasters with no-data pixels on borders. Default:true). More...
 
bool m_enableMultiThread
 Enable/disable the use of threads (default:true). More...
 
bool m_enableProgress
 Enable/Disable the progress interface (default:false). More...
 
EqType m_equalizationType
 Equalization type (default:CenterEqType ). More...
 
FeederConstRasterm_feederRasterPtr
 Input rasters feeder. More...
 
bool m_forceInputNoDataValue
 If true, m_noDataValue will be used as the no-data value for input rasters (defalt:false). More...
 
std::vector< std::vector< unsigned int > > m_inputRastersBands
 Bands to process for each input raster. More...
 
te::rst::Interpolator::Method m_interpMethod
 The raster interpolator method (default:NearestNeighbor). More...
 
unsigned int m_localEqMaxNeighborRasters
 Maximum number of neighbor rasters to use in Local equalization mode (default: 4). More...
 
std::vector< double > m_mosaicTargetMeans
 An empty vector for automatic mosaic target means calcule or a vector of target means for each mosaic baind. More...
 
std::vector< double > m_mosaicTargetStdDevs
 An empty vector for automatic mosaic target standart deviation values calcule or a vector of target standart deviantion values for each mosaic baind. More...
 
double m_noDataValue
 The pixel value used where no raster data is avaliable (defaul:0). More...
 
bool m_skipInsideRasters
 Rasters covering mosaic areas already covered by other rasters will be skipped (default: false). More...
 
bool m_useRasterCache
 Enable(true) or disable the use of raster caching (default:true). More...
 

Protected Attributes

BlenderRule const * m_blenderRulePtr
 

Friends

class GeoComposition
 
class GeoMosaic
 

Detailed Description

GeoMosaic input parameters.

Definition at line 58 of file GeoMosaic.h.

Member Enumeration Documentation

◆ EqType

The mosaic equalization type.

Enumerator
InvalidEqType 

Invalid equalization type.

NoEqType 

No equalization performed.

CenterEqType 

Mosaic will be equalized following the center raster.

TargetEqtype 

Mosaic will be equalized following the supplied target means (m_mosaicTargetMeans) and std devs (m_mosaicTargetStdDevs).

LocalEqType 

Mosaic will be equalized following a local strategy.

Definition at line 66 of file GeoMosaic.h.

Constructor & Destructor Documentation

◆ InputParameters() [1/2]

te::rp::GeoMosaic::InputParameters::InputParameters ( )

◆ InputParameters() [2/2]

te::rp::GeoMosaic::InputParameters::InputParameters ( const InputParameters )

◆ ~InputParameters()

te::rp::GeoMosaic::InputParameters::~InputParameters ( )

Member Function Documentation

◆ clone()

AbstractParameters* te::rp::GeoMosaic::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.

◆ getEqTypesInfo()

static void te::rp::GeoMosaic::InputParameters::getEqTypesInfo ( std::vector< std::pair< EqType, std::string > > &  eqTypesInfo)
static

Returns all current supported equalization type infos.

Parameters
eqTypesInfocurrent supported equalization type infos.

◆ operator=()

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

◆ reset()

void te::rp::GeoMosaic::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::GeoMosaic::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.

Friends And Related Function Documentation

◆ GeoComposition

friend class GeoComposition
friend

Definition at line 63 of file GeoMosaic.h.

◆ GeoMosaic

friend class GeoMosaic
friend

Definition at line 62 of file GeoMosaic.h.

Member Data Documentation

◆ m_abortOnFirstError

bool te::rp::GeoMosaic::InputParameters::m_abortOnFirstError

if true the processing will be stopped on the first error, if false the processing of the next rasters will continue on the event of an error (default: true).

Definition at line 101 of file GeoMosaic.h.

◆ m_blenderRulePtr

BlenderRule const* te::rp::GeoMosaic::InputParameters::m_blenderRulePtr
protected

Definition at line 133 of file GeoMosaic.h.

◆ m_blendMethod

te::rp::Blender::BlendMethod te::rp::GeoMosaic::InputParameters::m_blendMethod

The pixel blending method (default: NoBlendMethod).

Definition at line 85 of file GeoMosaic.h.

◆ m_enableAutoValidAreaDetect

bool te::rp::GeoMosaic::InputParameters::m_enableAutoValidAreaDetect

Enable/disable the auto-detection of raster valid area pixels (this option allows better mosaic result for rasters with no-data pixels on borders. Default:true).

Definition at line 95 of file GeoMosaic.h.

◆ m_enableMultiThread

bool te::rp::GeoMosaic::InputParameters::m_enableMultiThread

Enable/disable the use of threads (default:true).

Definition at line 93 of file GeoMosaic.h.

◆ m_enableProgress

bool te::rp::GeoMosaic::InputParameters::m_enableProgress

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

Definition at line 91 of file GeoMosaic.h.

◆ m_equalizationType

EqType te::rp::GeoMosaic::InputParameters::m_equalizationType

Equalization type (default:CenterEqType ).

Definition at line 87 of file GeoMosaic.h.

◆ m_feederRasterPtr

FeederConstRaster* te::rp::GeoMosaic::InputParameters::m_feederRasterPtr

Input rasters feeder.

Definition at line 75 of file GeoMosaic.h.

◆ m_forceInputNoDataValue

bool te::rp::GeoMosaic::InputParameters::m_forceInputNoDataValue

If true, m_noDataValue will be used as the no-data value for input rasters (defalt:false).

Definition at line 83 of file GeoMosaic.h.

◆ m_inputRastersBands

std::vector< std::vector< unsigned int > > te::rp::GeoMosaic::InputParameters::m_inputRastersBands

Bands to process for each input raster.

Definition at line 77 of file GeoMosaic.h.

◆ m_interpMethod

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

The raster interpolator method (default:NearestNeighbor).

Definition at line 79 of file GeoMosaic.h.

◆ m_localEqMaxNeighborRasters

unsigned int te::rp::GeoMosaic::InputParameters::m_localEqMaxNeighborRasters

Maximum number of neighbor rasters to use in Local equalization mode (default: 4).

Definition at line 105 of file GeoMosaic.h.

◆ m_mosaicTargetMeans

std::vector< double > te::rp::GeoMosaic::InputParameters::m_mosaicTargetMeans

An empty vector for automatic mosaic target means calcule or a vector of target means for each mosaic baind.

Definition at line 97 of file GeoMosaic.h.

◆ m_mosaicTargetStdDevs

std::vector< double > te::rp::GeoMosaic::InputParameters::m_mosaicTargetStdDevs

An empty vector for automatic mosaic target standart deviation values calcule or a vector of target standart deviantion values for each mosaic baind.

Definition at line 99 of file GeoMosaic.h.

◆ m_noDataValue

double te::rp::GeoMosaic::InputParameters::m_noDataValue

The pixel value used where no raster data is avaliable (defaul:0).

Definition at line 81 of file GeoMosaic.h.

◆ m_skipInsideRasters

bool te::rp::GeoMosaic::InputParameters::m_skipInsideRasters

Rasters covering mosaic areas already covered by other rasters will be skipped (default: false).

Definition at line 103 of file GeoMosaic.h.

◆ m_useRasterCache

bool te::rp::GeoMosaic::InputParameters::m_useRasterCache

Enable(true) or disable the use of raster caching (default:true).

Definition at line 89 of file GeoMosaic.h.


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