OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
mvd::VectorImageSettings Class Reference

#include <mvdVectorImageSettings.h>

+ Inheritance diagram for mvd::VectorImageSettings:
+ Collaboration diagram for mvd::VectorImageSettings:

Public Types

typedef UIntVector ChannelVector
 
- Public Types inherited from mvd::ImageSettings
typedef unsigned int SizeType
 
typedef double ValueType
 

Public Member Functions

double GetGamma () const
 
unsigned int GetGrayChannel () const
 
const ParametersTypeGetGrayDynamicsParams () const
 
ParametersType::ValueType GetHighIntensity (RgbwChannel channel) const
 
ParametersType::ValueType GetLowIntensity (RgbwChannel channel) const
 
const ChannelVector::value_type & GetRgbChannel (ChannelVector::size_type i) const
 
const ChannelVectorGetRgbChannels () const
 
const ParametersTypeGetRgbDynamicsParams () const
 
ChannelVector::value_type GetRgbwChannel (RgbwChannel channel) const
 
ChannelVector::value_type GetSmartChannel (RgbwChannel channel) const
 
ParametersType GetSmartDynamicsParams () const
 
bool IsGrayscaleActivated () const
 
void SetGamma (double gamma)
 
void SetGrayChannel (unsigned int)
 
void SetGrayDynamicsParams (const ParametersType &params)
 
void SetGrayscaleActivated (bool activated)
 
void SetHighIntensity (RgbwChannel channel, ParametersType::ValueType intensity)
 
void SetLowIntensity (RgbwChannel channel, ParametersType::ValueType intensity)
 
void SetRgbChannel (ChannelVector::size_type i, const ChannelVector::value_type &channel)
 
void SetRgbChannels (const ChannelVector &rgb)
 
void SetRgbDynamicsParams (const ParametersType &params)
 
 VectorImageSettings ()
 
 VectorImageSettings (const VectorImageSettings &other)
 
 ~VectorImageSettings () override
 
void GetSmartChannels (ChannelVector &channels) const
 
- Public Member Functions inherited from mvd::ImageSettings
void ClearModified ()
 
double GetAlpha () const
 
Effect GetEffect () const
 
const char * GetEffectName () const
 
unsigned int GetSize () const
 
double GetValue () const
 
const char * GetValueName () const
 
bool HasSize () const
 
bool HasValue () const
 
 ImageSettings ()
 
bool IsApplied () const
 
bool IsModified () const
 
void SetAlpha (double)
 
void SetApplied ()
 
void SetEffect (Effect)
 
void SetSize (unsigned int)
 
void SetValue (double)
 
virtual ~ImageSettings ()
 

Private Member Functions

const ParametersType::ValueTypeGetGrayDynamicsParam (bool high) const
 
const ParametersType::ValueTypeGetRgbDynamicsParam (CountType i) const
 
void SetGrayDynamicsParam (bool high, const ParametersType::ValueType &param)
 
void SetRgbDynamicsParam (CountType i, const ParametersType::ValueType &param)
 

Private Attributes

double m_Gamma
 
ChannelVector::value_type m_GrayChannel
 
ParametersType m_GrayDynamicsParams
 
bool m_IsGrayscaleActivated
 
ChannelVector m_RgbChannels
 
ParametersType m_RgbDynamicsParams
 

Additional Inherited Members

- Protected Member Functions inherited from mvd::ImageSettings
void SetModified ()
 

Detailed Description

WIP.

Definition at line 77 of file mvdVectorImageSettings.h.

Member Typedef Documentation

Definition at line 87 of file mvdVectorImageSettings.h.

Constructor & Destructor Documentation

mvd::VectorImageSettings::VectorImageSettings ( )

Constructor.

mvd::VectorImageSettings::VectorImageSettings ( const VectorImageSettings other)

Copy constructor.

Parameters
otherCopy settings POD content without the modified flag.
mvd::VectorImageSettings::~VectorImageSettings ( )
override

Destructor.

Member Function Documentation

double mvd::VectorImageSettings::GetGamma ( ) const
inline

Definition at line 663 of file mvdVectorImageSettings.h.

unsigned int mvd::VectorImageSettings::GetGrayChannel ( ) const
inline
Returns
White (gray) channel index.

Definition at line 571 of file mvdVectorImageSettings.h.

const ParametersType::ValueType & mvd::VectorImageSettings::GetGrayDynamicsParam ( bool  high) const
inlineprivate

Definition at line 620 of file mvdVectorImageSettings.h.

const ParametersType & mvd::VectorImageSettings::GetGrayDynamicsParams ( ) const
inline

Definition at line 611 of file mvdVectorImageSettings.h.

ParametersType::ValueType mvd::VectorImageSettings::GetHighIntensity ( RgbwChannel  channel) const
ParametersType::ValueType mvd::VectorImageSettings::GetLowIntensity ( RgbwChannel  channel) const
const VectorImageSettings::ChannelVector::value_type & mvd::VectorImageSettings::GetRgbChannel ( ChannelVector::size_type  i) const
inline

Definition at line 442 of file mvdVectorImageSettings.h.

const VectorImageSettings::ChannelVector & mvd::VectorImageSettings::GetRgbChannels ( ) const
inline

Definition at line 398 of file mvdVectorImageSettings.h.

const ParametersType::ValueType & mvd::VectorImageSettings::GetRgbDynamicsParam ( CountType  i) const
inlineprivate

Definition at line 513 of file mvdVectorImageSettings.h.

const ParametersType & mvd::VectorImageSettings::GetRgbDynamicsParams ( ) const
inline

Definition at line 495 of file mvdVectorImageSettings.h.

ChannelVector::value_type mvd::VectorImageSettings::GetRgbwChannel ( RgbwChannel  channel) const
Returns
the band-index for the given component not taking the grayscale-mode activation state flag into account.
VectorImageSettings::ChannelVector::value_type mvd::VectorImageSettings::GetSmartChannel ( RgbwChannel  channel) const
inline
Returns
the band-index for the given component taking the grayscale-mode activation state flag into account.

Definition at line 451 of file mvdVectorImageSettings.h.

References mvd::RGBW_CHANNEL_WHITE.

void mvd::VectorImageSettings::GetSmartChannels ( VectorImageSettings::ChannelVector channels) const
inline
Returns
the channels band-index vector taking the grayscale-mode activation state flag into account.

Definition at line 407 of file mvdVectorImageSettings.h.

ParametersType mvd::VectorImageSettings::GetSmartDynamicsParams ( ) const
inline

Definition at line 504 of file mvdVectorImageSettings.h.

bool mvd::VectorImageSettings::IsGrayscaleActivated ( ) const
inline
Returns
Grayscale-mode activation state flag.

Definition at line 539 of file mvdVectorImageSettings.h.

void mvd::VectorImageSettings::SetGamma ( double  gamma)
inline

Definition at line 652 of file mvdVectorImageSettings.h.

void mvd::VectorImageSettings::SetGrayChannel ( unsigned int  index)
inline

Set white (gray) channel index.

Parameters
indexThe new index of white (gray) channel.

Definition at line 580 of file mvdVectorImageSettings.h.

void mvd::VectorImageSettings::SetGrayDynamicsParam ( bool  high,
const ParametersType::ValueType param 
)
inlineprivate

Definition at line 629 of file mvdVectorImageSettings.h.

void mvd::VectorImageSettings::SetGrayDynamicsParams ( const ParametersType params)
inline

Definition at line 591 of file mvdVectorImageSettings.h.

void mvd::VectorImageSettings::SetGrayscaleActivated ( bool  activated)
inline

Set/clear grayscale-mode activation-state flag for image.

Definition at line 548 of file mvdVectorImageSettings.h.

References mvd::EFFECT_LUT_LOCAL_JET, mvd::EFFECT_NORMAL, and mvd::EFFECT_SPECTRAL_ANGLE.

void mvd::VectorImageSettings::SetHighIntensity ( RgbwChannel  channel,
ParametersType::ValueType  intensity 
)

Set high-intensity dynamics parameter for given channel. If channel is RGBW_CHANNEL_WHITE, this method sets all RGB channels.

Parameters
channelThe RGB/W channel to set high-intensity dynamics for.
intensityhigh-intensity value.
void mvd::VectorImageSettings::SetLowIntensity ( RgbwChannel  channel,
ParametersType::ValueType  intensity 
)

Set low-intensity dynamics parameter for given channel. If channel is RGBW_CHANNEL_WHITE, this method sets all RGB channels.

Parameters
channelThe RGB/W channel to set low-intensity dynamics for.
intensitylow-intensity value.
void mvd::VectorImageSettings::SetRgbChannel ( ChannelVector::size_type  i,
const ChannelVector::value_type &  channel 
)
inline

Definition at line 425 of file mvdVectorImageSettings.h.

void mvd::VectorImageSettings::SetRgbChannels ( const ChannelVector rgb)
inline

Assignment operator.

Parameters
other

Definition at line 379 of file mvdVectorImageSettings.h.

void mvd::VectorImageSettings::SetRgbDynamicsParam ( CountType  i,
const ParametersType::ValueType param 
)
inlineprivate

Definition at line 522 of file mvdVectorImageSettings.h.

void mvd::VectorImageSettings::SetRgbDynamicsParams ( const ParametersType params)
inline

Definition at line 475 of file mvdVectorImageSettings.h.

Member Data Documentation

double mvd::VectorImageSettings::m_Gamma
private

Definition at line 325 of file mvdVectorImageSettings.h.

ChannelVector::value_type mvd::VectorImageSettings::m_GrayChannel
private

Grayscale-mode band-index.

Definition at line 315 of file mvdVectorImageSettings.h.

ParametersType mvd::VectorImageSettings::m_GrayDynamicsParams
private

Color-dynamics parameters (.

See Also
HistogramModel::Quantile()).

Definition at line 321 of file mvdVectorImageSettings.h.

bool mvd::VectorImageSettings::m_IsGrayscaleActivated
private

Grayscale-mode activation state.

Definition at line 310 of file mvdVectorImageSettings.h.

ChannelVector mvd::VectorImageSettings::m_RgbChannels
private

Color-composition setup (file-component to video RGB-components).

Definition at line 299 of file mvdVectorImageSettings.h.

ParametersType mvd::VectorImageSettings::m_RgbDynamicsParams
private

Color-dynamics parameters (.

See Also
HistogramModel::Quantile()).

Definition at line 305 of file mvdVectorImageSettings.h.


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