peak::ipl::GammaCorrector Class Reference

Applies gamma correction to the data. More...

#include <peak_ipl/algorithm/peak_ipl_gamma_corrector.hpp>

Public Member Functions
	GammaCorrector ()
	Constructor for a new GammaCorrector instance. More...
	~GammaCorrector ()
	Destructor for the GammaCorrector instance. More...
	GammaCorrector (const GammaCorrector &other)
	Copy Constructor for a new GammaCorrector instance. More...
GammaCorrector &	operator= (const GammaCorrector &other)
	Copy assigment for GammaCorrector instance. More...
	GammaCorrector (GammaCorrector &&other) noexcept
	Move constructor for GammaCorrector instance. More...
GammaCorrector &	operator= (GammaCorrector &&other) noexcept
	Move assignment for GammaCorrector instance. More...
void	SetGammaCorrectionValue (float gammaValue)
	Sets the values of the gamma correction. More...
PEAK_IPL_NO_DISCARD float	GammaCorrectionValue () const
	Returns the value of the gamma correction. More...
PEAK_IPL_NO_DISCARD float	GammaCorrectionMin () const
	Returns the minimum value of the gamma correction. More...
PEAK_IPL_NO_DISCARD float	GammaCorrectionMax () const
	Returns the maximum value of the gamma correction. More...
PEAK_IPL_NO_DISCARD bool	IsPixelFormatSupported (PixelFormatName pixelFormatName) const
	Returns whether the gamma corrector supports the given pixel format. More...
void	ProcessInPlace (Image &image) const
	Corrects the gammas of the given image in place that is, it will change the input image. More...
PEAK_IPL_NO_DISCARD Image	Process (const Image &inputImage) const
	Corrects the gammas of the given image. More...

Detailed Description

Applies gamma correction to the data.

Constructor & Destructor Documentation

GammaCorrector() [1/3]

peak::ipl::GammaCorrector::GammaCorrector ( )

inline

Constructor for a new GammaCorrector instance.

Creates a new GammaCorrector instance.

Since

1.2.2

~GammaCorrector()

peak::ipl::GammaCorrector::~GammaCorrector ( )

inline

Destructor for the GammaCorrector instance.

Destroys a GammaCorrector instance.

Since

1.2.2

GammaCorrector() [2/3]

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

inline

Copy Constructor for a new GammaCorrector instance.

Creates a new GammaCorrector 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

GammaCorrector() [3/3]

peak::ipl::GammaCorrector::GammaCorrector ( GammaCorrector &&  other )

inlinenoexcept

Move constructor for GammaCorrector 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

GammaCorrectionMax()

float peak::ipl::GammaCorrector::GammaCorrectionMax ( ) const

inline

Returns the maximum value of the gamma correction.

Returns

gammaMax The maximum value of the gamma correction.

Since

1.2.2

GammaCorrectionMin()

float peak::ipl::GammaCorrector::GammaCorrectionMin ( ) const

inline

Returns the minimum value of the gamma correction.

Returns

gammaMin The minimum value of the gamma correction.

Since

1.2.2

GammaCorrectionValue()

float peak::ipl::GammaCorrector::GammaCorrectionValue ( ) const

inline

Returns the value of the gamma correction.

Returns

gammaValue The value of the gamma correction.

Since

1.2.2

IsPixelFormatSupported()

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

inline

Returns whether the gamma corrector supports the given pixel format.

Returns

Flag whether the given pixel format is supported.

Parameters

[in]

pixelFormatName

The pixel format of interest.

Since

1.2.2

operator=() [1/2]

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

inline

Copy assigment for GammaCorrector 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]

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

inlinenoexcept

Move assignment for GammaCorrector 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::GammaCorrector::Process ( const Image &  inputImage ) const

inline

Corrects the gammas of the given image.

Parameters

[in]

inputImage

Image to process.

Returns

A new created image containing the gamma-corrected pixels.

Exceptions

ImageFormatNotSupportedException

image has unsupported pixel format.

Since

1.2.2

ProcessInPlace()

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

inline

Corrects the gammas of 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.2.2

SetGammaCorrectionValue()

void peak::ipl::GammaCorrector::SetGammaCorrectionValue ( float  gammaValue )

inline

Sets the values of the gamma correction.

Parameters

[in]

gammaValue

The value of the gamma correction.

Exceptions

InvalidArgument

gammaValue isn't supported.

Since

1.2.2

---

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

• peak_ipl/algorithm/peak_ipl_gamma_corrector.hpp