eVision C++ API 26.10.0-beta.2.dev
Loading...
Searching...
No Matches
eVision::EMantiukToneMapperParameters Class Reference

Container holding the parameters for a Mantiuk tone-mapper algorithm. More...

#include <eVision/EasyImage/EMantiukToneMapperParameters.h>

Inheritance diagram for eVision::EMantiukToneMapperParameters:
Collaboration diagram for eVision::EMantiukToneMapperParameters:

Public Member Functions

 EMantiukToneMapperParameters (const eVision::EMantiukToneMapperParameters &other)
 Copy operator.
 EMantiukToneMapperParameters ()
 Copy operator.
virtual ~EMantiukToneMapperParameters () throw ()
bool operator== (const eVision::EMantiukToneMapperParameters &rhs) const
 Checks if this EMantiukToneMapperParameters instance is strictly equal to another.
eVision::EMantiukToneMapperParameters & operator= (const eVision::EMantiukToneMapperParameters &other)
 Copy operator.
float GetScale () const
 Gets the scale parameter.
void SetScale (float scale)
 Sets the scale parameter.
float GetSaturation () const
 Gets the saturation parameter.
void SetSaturation (float saturation)
 Sets the saturation parameter.
 EMantiukToneMapperParameters (CppWrapperInternal::InternalConstructor)
Public Member Functions inherited from eVision::EToneMapperParameters
 EToneMapperParameters (const eVision::EToneMapperParameters &other)
 Copy operator.
 EToneMapperParameters ()
 Copy operator.
virtual ~EToneMapperParameters () throw ()
bool operator== (const eVision::EToneMapperParameters &rhs) const
 Checks if this EToneMapperParameters instance is strictly equal to another.
eVision::EToneMapperParameters & operator= (const eVision::EToneMapperParameters &other)
 Copy operator.
float GetGamma () const
 Gets gamma parameter.
void SetGamma (float gamma)
 Sets the gamma parameter. Controls the gamma correction applied on the input image.
eVision::EToneMapperType GetToneMapperType () const
 Return the type of the tone-mapper defined by this set of parameters.
 EToneMapperParameters (CppWrapperInternal::InternalConstructor)

Additional Inherited Members

Public Attributes inherited from eVision::EToneMapperParameters
CppWrapperInternal::WrappedClass wrappedClass_

Detailed Description

Container holding the parameters for a Mantiuk tone-mapper algorithm.

License(s): EasyImage

Constructor & Destructor Documentation

◆ EMantiukToneMapperParameters() [1/3]

eVision::EMantiukToneMapperParameters::EMantiukToneMapperParameters ( const eVision::EMantiukToneMapperParameters & other)

Copy operator.

Parameters
otherOther parameters container to copy from.

◆ EMantiukToneMapperParameters() [2/3]

eVision::EMantiukToneMapperParameters::EMantiukToneMapperParameters ( )

Copy operator.

◆ ~EMantiukToneMapperParameters()

eVision::EMantiukToneMapperParameters::~EMantiukToneMapperParameters ( )
throw ( )
virtual

◆ EMantiukToneMapperParameters() [3/3]

eVision::EMantiukToneMapperParameters::EMantiukToneMapperParameters ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ GetSaturation()

float eVision::EMantiukToneMapperParameters::GetSaturation ( ) const

Gets the saturation parameter.

◆ GetScale()

float eVision::EMantiukToneMapperParameters::GetScale ( ) const

Gets the scale parameter.

◆ operator=()

eVision::EMantiukToneMapperParameters & eVision::EMantiukToneMapperParameters::operator= ( const eVision::EMantiukToneMapperParameters & other)

Copy operator.

Parameters
otherOther parameters container to copy from.

◆ operator==()

bool eVision::EMantiukToneMapperParameters::operator== ( const eVision::EMantiukToneMapperParameters & rhs) const

Checks if this EMantiukToneMapperParameters instance is strictly equal to another.

Parameters
rhsReference to the other EMantiukToneMapperParameters instance

◆ SetSaturation()

void eVision::EMantiukToneMapperParameters::SetSaturation ( float saturation)

Sets the saturation parameter.

Higher saturation values result in an image with more vivid colors while lower values generate an image with more muted colors. Value must be between 0 and 1.

Parameters
saturationNew saturation value.

◆ SetScale()

void eVision::EMantiukToneMapperParameters::SetScale ( float scale)

Sets the scale parameter.

Higher scale values result in a brighter image while lower scale values generate a darker image. Values must be between 0 and 8.

Parameters
scaleNew scale value.