te::rp::Restoration::InputParameters Class Reference

Restoration input parameters. More...

#include <Restoration.h>

Inheritance diagram for te::rp::Restoration::InputParameters:

Public Types
enum	SamplingFactorType {   INVALID_SAMPLING_FACTOR_TYPE , SAMPLING_FACTOR_1_BY_2 , SAMPLING_FACTOR_1_BY_3 , SAMPLING_FACTOR_1_BY_4 ,   SAMPLING_FACTOR_1_BY_5 , SAMPLING_FACTOR_1_BY_6 , SAMPLING_FACTOR_2_BY_3 , SAMPLING_FACTOR_3_BY_4 }
enum	SensorType {   INVALID_RESTORATION_TYPE , SPOTP , SPOTX , TM ,   ETMX , ETMP , LANDSAT_8 , CBERS_CCD ,   CBERS_CCRX , CBERS2_CCD , CBERS2B_CCD , CBERS2B_HRC ,   CBERS_4_MUX , CBERS_4_PAN10 , CBERS_4_PAN5 , CBERS_4_WFI ,   RAPIDEYE , QUICKBIRD , WORLDVIEW2 , MODIS_250 ,   MODIS_500 }

Public Member Functions
AbstractParameters *	clone () const
	Create a clone copy of this instance. More...
	InputParameters ()
	InputParameters (const InputParameters &)
const InputParameters &	operator= (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	getResolutionSamplingFactor (const InputParameters::SamplingFactorType &sFactortype, double &resSamplingFactor)
	Get Resolution sampling factor given the type. More...
static void	getSupportedSamplingFactorsTypes (std::map< SamplingFactorType, std::string > &infos)
	Returns all supported sampling factor types. More...
static void	getSupportedSensorTypes (std::map< SensorType, std::string > &infos)
	Returns all supported sensor types. More...

Public Attributes
bool	m_enableProgress
	Enable/Disable the progress interface (default:false). More...
bool	m_enableRasterCache
	Enable/Disable the use of a raster data cache (default:true). More...
std::vector< unsigned int >	m_inRasterBands
	Bands to be used from the input raster (starting from zero). More...
te::rst::Raster const *	m_inRasterPtr
	Input raster. More...
SamplingFactorType	m_samplingFactor
	The samnpling factor. More...
std::vector< unsigned int >	m_sensorBandDesignations
	Sensor band designations (starting from 1). More...
SensorType	m_sensorType
	The sensor type. More...

Detailed Description

Restoration input parameters.

Definition at line 55 of file Restoration.h.

Member Enumeration Documentation

SamplingFactorType

enum te::rp::Restoration::InputParameters::SamplingFactorType

Enumerator
INVALID_SAMPLING_FACTOR_TYPE
SAMPLING_FACTOR_1_BY_2
SAMPLING_FACTOR_1_BY_3
SAMPLING_FACTOR_1_BY_4
SAMPLING_FACTOR_1_BY_5
SAMPLING_FACTOR_1_BY_6
SAMPLING_FACTOR_2_BY_3
SAMPLING_FACTOR_3_BY_4

Definition at line 86 of file Restoration.h.

SensorType

enum te::rp::Restoration::InputParameters::SensorType

Enumerator
INVALID_RESTORATION_TYPE
SPOTP
SPOTX
TM
ETMX
ETMP
LANDSAT_8
CBERS_CCD
CBERS_CCRX
CBERS2_CCD
CBERS2B_CCD
CBERS2B_HRC
CBERS_4_MUX
CBERS_4_PAN10
CBERS_4_PAN5
CBERS_4_WFI
RAPIDEYE
QUICKBIRD
WORLDVIEW2
MODIS_250
MODIS_500

Definition at line 60 of file Restoration.h.

Constructor & Destructor Documentation

InputParameters() [1/2]

te::rp::Restoration::InputParameters::InputParameters

(

)

InputParameters() [2/2]

te::rp::Restoration::InputParameters::InputParameters

(

const InputParameters &

)

~InputParameters()

te::rp::Restoration::InputParameters::~InputParameters

(

)

Member Function Documentation

clone()

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

getResolutionSamplingFactor()

static void te::rp::Restoration::InputParameters::getResolutionSamplingFactor ( const InputParameters::SamplingFactorType &  sFactortype, double &  resSamplingFactor  )

static

Get Resolution sampling factor given the type.

Parameters

sFactortype	Sampling factor type.
resSamplingFactor	Resolution sampling factor type.

Note

Output_resolution = input_resolution * resSamplingFactor.

getSupportedSamplingFactorsTypes()

static void te::rp::Restoration::InputParameters::getSupportedSamplingFactorsTypes ( std::map< SamplingFactorType, std::string > &  infos )

static

Returns all supported sampling factor types.

Parameters

infos

All supported sampling factor types.

getSupportedSensorTypes()

static void te::rp::Restoration::InputParameters::getSupportedSensorTypes ( std::map< SensorType, std::string > &  infos )

static

Returns all supported sensor types.

Parameters

infos

All supported sensor types.

operator=()

const InputParameters& te::rp::Restoration::InputParameters::operator=

(

const InputParameters &

params

)

reset()

void te::rp::Restoration::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::Restoration::InputParameters::serialize ( AlgorithmParametersSerializer &  serializer ) const

virtual

Returns a parameter serialization object.

Parameters

serializer

The output serialization object.

Returns

Returns true if ok, false on erros.

Reimplemented from te::rp::AlgorithmInputParameters.

Member Data Documentation

m_enableProgress

bool te::rp::Restoration::InputParameters::m_enableProgress

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

Definition at line 109 of file Restoration.h.

m_enableRasterCache

bool te::rp::Restoration::InputParameters::m_enableRasterCache

Enable/Disable the use of a raster data cache (default:true).

Definition at line 111 of file Restoration.h.

m_inRasterBands

std::vector< unsigned int > te::rp::Restoration::InputParameters::m_inRasterBands

Bands to be used from the input raster (starting from zero).

Definition at line 105 of file Restoration.h.

m_inRasterPtr

te::rst::Raster const* te::rp::Restoration::InputParameters::m_inRasterPtr

Input raster.

Definition at line 103 of file Restoration.h.

m_samplingFactor

SamplingFactorType te::rp::Restoration::InputParameters::m_samplingFactor

The samnpling factor.

Definition at line 107 of file Restoration.h.

m_sensorBandDesignations

std::vector< unsigned int > te::rp::Restoration::InputParameters::m_sensorBandDesignations

Sensor band designations (starting from 1).

Definition at line 101 of file Restoration.h.

m_sensorType

SensorType te::rp::Restoration::InputParameters::m_sensorType

The sensor type.

Definition at line 99 of file Restoration.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/rp/Restoration.h