Applies gain to the data. More...

#include <peak_ipl/algorithm/peak_ipl_gain.hpp>

Public Member Functions
	Gain ()
	Constructor for a new Gain instance.

	~Gain ()
	Destructor for the Gain instance.

	Gain (const Gain &other)
	Copy Constructor for a new Gain instance.

Gain &	operator= (const Gain &other)
	Copy assigment for Gain instance.

	Gain (Gain &&other) noexcept
	Move constructor for Gain instance.

Gain &	operator= (Gain &&other) noexcept
	Move assignment for Gain instance.

void	SetMasterGainValue (float masterGainValue)
	Sets the values of the master Gain.

float	MasterGainValue () const
	Returns the value of the master gain.

float	MasterGainMin () const
	Returns the minimum value of the master gain.

float	MasterGainMax () const
	Returns the maximum value of the master gain.

void	SetRedGainValue (float redGainValue)
	Sets the values of the red Gain.

float	RedGainValue () const
	Returns the value of the red gain.

float	RedGainMin () const
	Returns the minimum value of the red gain.

float	RedGainMax () const
	Returns the maximum value of the red gain.

void	SetGreenGainValue (float greenGainValue)
	Sets the values of the green Gain.

float	GreenGainValue () const
	Returns the value of the green gain.

float	GreenGainMin () const
	Returns the minimum value of the green gain.

float	GreenGainMax () const
	Returns the maximum value of the green gain.

void	SetBlueGainValue (float blueGainValue)
	Sets the values of the blue Gain.

float	BlueGainValue () const
	Returns the value of the blue gain.

float	BlueGainMin () const
	Returns the minimum value of the blue gain.

float	BlueGainMax () const
	Returns the maximum value of the blue gain.

bool	IsPixelFormatSupported (PixelFormatName pixelFormatName) const
	Returns whether the gain supports the given pixel format.

void	ProcessInPlace (Image &image) const
	Applies the gain on the given image in place that is, it will change the input image.

Image	Process (const Image &inputImage) const
	Applies the gain on the given image.

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

◆ BlueGainMax()

float peak::ipl::Gain::BlueGainMax ( ) const

inline

Returns the maximum value of the blue gain.

Returns: blueGainMax The maximum value of the blue gain.

Since: 1.3.2

◆ BlueGainMin()

float peak::ipl::Gain::BlueGainMin ( ) const

inline

Returns the minimum value of the blue gain.

Returns: blueGainMin The minimum value of the blue gain.

Since: 1.3.2

◆ BlueGainValue()

float peak::ipl::Gain::BlueGainValue ( ) const

inline

Returns the value of the blue gain.

Returns: blueGainValue The value of the blue gain.

Since: 1.3.2

◆ GreenGainMax()

float peak::ipl::Gain::GreenGainMax ( ) const

inline

Returns the maximum value of the green gain.

Returns: greenGainMax The maximum value of the green gain.

Since: 1.3.2

◆ GreenGainMin()

float peak::ipl::Gain::GreenGainMin ( ) const

inline

Returns the minimum value of the green gain.

Returns: greenGainMin The minimum value of the green gain.

Since: 1.3.2

◆ GreenGainValue()

float peak::ipl::Gain::GreenGainValue ( ) const

inline

Returns the value of the green gain.

Returns: greenGainValue The value of the green gain.

Since: 1.3.2

◆ IsPixelFormatSupported()

bool peak::ipl::Gain::IsPixelFormatSupported ( PixelFormatName pixelFormatName ) const

inline

Returns whether the gain supports the given pixel format.

Returns: Flag whether the given pixel format is supported.

Parameters

[in] pixelFormatName The pixel format of interest.

Since: 1.3.2

◆ MasterGainMax()

float peak::ipl::Gain::MasterGainMax ( ) const

inline

Returns the maximum value of the master gain.

Returns: masterGainMax The maximum value of the master gain.

Since: 1.3.2

◆ MasterGainMin()

float peak::ipl::Gain::MasterGainMin ( ) const

inline

Returns the minimum value of the master gain.

Returns: masterGainMin The minimum value of the master gain.

Since: 1.3.2

◆ MasterGainValue()

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

inline

Returns the value of the master gain.

Returns: masterGainValue The value of the master gain.

Since: 1.3.2

◆ 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

◆ Process()

Image peak::ipl::Gain::Process ( const Image & inputImage ) const

inline

Applies the gain on the given image.

Parameters

[in] inputImage Image to process.

Note: Will not work with packed pixel formats. See Packed pixel format handling for the correct handling of this.; Will currently only work with unpacked Bayer and Mono Pixel Formats. Call Gain::IsPixelFormatSupported to check for support if in doubt.

Returns: A new created image containing the gamma-corrected pixels.

Exceptions

ImageFormatNotSupportedException image has unsupported pixel format.

Since: 1.3.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.

Note: Will not work with packed pixel formats. See Packed pixel format handling for the correct handling of this.; Will currently only work with unpacked Bayer and Mono Pixel Formats. Call Gain::IsPixelFormatSupported to check for support if in doubt.

Exceptions

ImageFormatNotSupportedException image has unsupported pixel format.

Since: 1.3.2

◆ RedGainMax()

float peak::ipl::Gain::RedGainMax ( ) const

inline

Returns the maximum value of the red gain.

Returns: redGainMax The maximum value of the red gain.

Since: 1.3.2

◆ RedGainMin()

float peak::ipl::Gain::RedGainMin ( ) const

inline

Returns the minimum value of the red gain.

Returns: redGainMin The minimum value of the red gain.

Since: 1.3.2

◆ RedGainValue()

float peak::ipl::Gain::RedGainValue ( ) const

inline

Returns the value of the red gain.

Returns: redGainValue The value of the red gain.

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

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

peak_ipl/algorithm/peak_ipl_gain.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Gain() [1/3]

◆ ~Gain()

◆ Gain() [2/3]

◆ Gain() [3/3]

Member Function Documentation

◆ BlueGainMax()

◆ BlueGainMin()

◆ BlueGainValue()

◆ GreenGainMax()

◆ GreenGainMin()

◆ GreenGainValue()

◆ IsPixelFormatSupported()

◆ MasterGainMax()

◆ MasterGainMin()

◆ MasterGainValue()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Process()

◆ ProcessInPlace()

◆ RedGainMax()

◆ RedGainMin()

◆ RedGainValue()

◆ SetBlueGainValue()

◆ SetGreenGainValue()

◆ SetMasterGainValue()

◆ SetRedGainValue()