peak::ipl::Gain Class Reference

Applies gain to the data. More...

#include <peak_ipl/algorithm/peak_ipl_gain.hpp>

Public Member Functions
	Gain ()
	Constructor for a new Gain instance. More...
	~Gain ()
	Destructor for the Gain instance. More...
	Gain (const Gain &other)
	Copy Constructor for a new Gain instance. More...
Gain &	operator= (const Gain &other)
	Copy assigment for Gain instance. More...
	Gain (Gain &&other) noexcept
	Move constructor for Gain instance. More...
Gain &	operator= (Gain &&other) noexcept
	Move assignment for Gain instance. More...
void	SetMasterGainValue (float masterGainValue)
	Sets the values of the master Gain. More...
void	SetRedGainValue (float redGainValue)
	Sets the values of the red Gain. More...
void	SetGreenGainValue (float greenGainValue)
	Sets the values of the green Gain. More...
void	SetBlueGainValue (float blueGainValue)
	Sets the values of the blue Gain. More...
void	ProcessInPlace (Image &image) const
	Applies the gain on the given image in place that is, it will change the input image. More...

Public Attributes
	PEAK_IPL_MAYBE_UNUSED = float MasterGainValue() const

Detailed Description

Applies gain to the data.

Constructor & Destructor Documentation

Gain() [1/3]

peak::ipl::Gain::Gain ( )

inline

Constructor for a new Gain instance.

Creates a new Gain instance.

Since

1.2.2

~Gain()

peak::ipl::Gain::~Gain ( )

inline

Destructor for the Gain instance.

Destroys a Gain instance.

Since

1.2.2

Gain() [2/3]

peak::ipl::Gain::Gain ( const Gain &  other )

inline

Copy Constructor for a new Gain instance.

Creates a new Gain instance.

Note

This only creates a shallow copy. See Shallow copy (since 1.8) for a detailed explanation.

Parameters

[in]

other

The other instance to acquire a reference for.

Since

1.2.2 Deleted

1.8 Implemented as shallow copy

Gain() [3/3]

peak::ipl::Gain::Gain ( Gain &&  other )

inlinenoexcept

Move constructor for Gain instance.

Moves the instance from other to this. Afterwards other is invalid.

Parameters

[in]

other

The other instance to move.

Since

1.2.2

Member Function Documentation

operator=() [1/2]

Gain & peak::ipl::Gain::operator= ( const Gain &  other )

inline

Copy assigment for Gain instance.

Acquires a reference from other to this instance. If this instance already has a reference, it will be destroyed.

Note

See Shallow copy (since 1.8) for a detailed explanation.

Parameters

[in]

other

The other instance to acquire a reference for.

Since

1.2.2 Deleted

1.8 Implemented as shallow copy

operator=() [2/2]

Gain & peak::ipl::Gain::operator= ( Gain &&  other )

inlinenoexcept

Move assignment for Gain instance.

Moves the instance from other to this. Afterwards other is invalid.

Parameters

[in]

other

The other instance to move.

Since

1.2.2

ProcessInPlace()

void peak::ipl::Gain::ProcessInPlace ( Image &  image ) const

inline

Applies the gain on the given image in place that is, it will change the input image.

Parameters

[in]

image

Image to process.

Exceptions

ImageFormatNotSupportedException

image has unsupported pixel format.

Since

1.3.2

SetBlueGainValue()

void peak::ipl::Gain::SetBlueGainValue ( float  blueGainValue )

inline

Sets the values of the blue Gain.

Parameters

[in]

blueGainValue

The value of the blue gain.

Exceptions

InvalidArgument

blueGainValue isn't supported.

Since

1.3.2

SetGreenGainValue()

void peak::ipl::Gain::SetGreenGainValue ( float  greenGainValue )

inline

Sets the values of the green Gain.

Parameters

[in]

greenGainValue

The value of the green gain.

Exceptions

InvalidArgument

greenGainValue isn't supported.

Since

1.3.2

SetMasterGainValue()

void peak::ipl::Gain::SetMasterGainValue ( float  masterGainValue )

inline

Sets the values of the master Gain.

Parameters

[in]

masterGainValue

The value of the master gain.

Exceptions

InvalidArgument

masterGainValue isn't supported.

Since

1.3.2

SetRedGainValue()

void peak::ipl::Gain::SetRedGainValue ( float  redGainValue )

inline

Sets the values of the red Gain.

Parameters

[in]

redGainValue

The value of the red gain.

Exceptions

InvalidArgument

redGainValue isn't supported.

Since

1.3.2

Member Data Documentation

PEAK_IPL_MAYBE_UNUSED

peak::ipl::Gain::PEAK_IPL_MAYBE_UNUSED = float MasterGainValue() const

---

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

• peak_ipl/algorithm/peak_ipl_gain.hpp