omni::proj::ChannelCorrection Class Reference

Brightness, contrast and gamma correction for a single color channel. More...

#include <ChannelCorrection.h>

Public Member Functions
double	gamma () const
	Return gamma value. More...
double	gamma (double v) const
	Calculate gamma for given value. More...
void	setGamma (double)
	Set new gamma value, value is clamped between -1 and 1. More...
double	brightness () const
	Return brightness value. More...
double	brightness (double v) const
	Calculate brightness for given value. More...
void	setBrightness (double)
	Set new brightness value, value is clamped between -1 and 1. More...
double	contrast () const
	Return contrast value. More...
double	contrast (double v) const
	Calculate contrast for given value. More...
void	setContrast (double)
	Set new contrast value, value is clamped between -1 and 1. More...
double	multiplier () const
	Value contrast, brightness and gamma are multiplied. More...
void	setMultiplier (double _multiplier)
	Set new multiplier value. More...
double	corrected (double _value) const
	Return corrected value, value is NOT clamped. More...

Private Attributes
double	gamma_ = 0.0
double	brightness_ = 0.0
	Brightness between -1 and 1. More...
double	contrast_ = 0.0
	Contrast between -1 and 1. More...
double	multiplier_ = 0.5
	Multiplier between 0.0 and 1.0. More...

Friends
bool	operator== (ChannelCorrection const &, ChannelCorrection const &)
	Test for equality. More...

Detailed Description

Brightness, contrast and gamma correction for a single color channel.

Member Function Documentation

double ChannelCorrection::brightness

(

)

const

Return brightness value.

                                                   {
            return brightness_;
        }

double ChannelCorrection::brightness

(

double

v

)

const

Calculate brightness for given value.

                                                           {
          return std::max(v + brightness() * multiplier(),0.0);
        }

double ChannelCorrection::contrast

(

)

const

Return contrast value.

                                                 {
            return contrast_;
        }

double ChannelCorrection::contrast

(

double

v

)

const

Calculate contrast for given value.

                                                         {
            double _c = (contrast() <= 0.0) ?
                contrast()*multiplier() + 1.0 :
                (1.0 / (1.0 - contrast()*multiplier()));
            return ((v - 0.5) * std::max(_c, 0.0)) + 0.5;
        }

double ChannelCorrection::corrected

(

double

_value

)

const

Return corrected value, value is NOT clamped.

                                                               {
            return brightness(contrast(gamma(_value)));
        }

double ChannelCorrection::gamma

(

)

const

Return gamma value.

                                              {
            return gamma_;
        }

double ChannelCorrection::gamma

(

double

v

)

const

Calculate gamma for given value.

                                                      {
            double g = 0.0;
            if (gamma() >= 0.0) {
              g = 1.0 / (1.0 + gamma() * multiplier());
            } else {
              g = (1.0 - gamma() * multiplier());
            }
            return std::pow(v,g*g*g*g);
        }

double ChannelCorrection::multiplier

(

)

const

Value contrast, brightness and gamma are multiplied.

                                                   {
            return multiplier_;
        }

void ChannelCorrection::setBrightness

(

double

_brightness

)

Set new brightness value, value is clamped between -1 and 1.

                                                                {
            brightness_ = qBound(-1.0, _brightness, 1.0);
        }

void ChannelCorrection::setContrast

(

double

_contrast

)

Set new contrast value, value is clamped between -1 and 1.

                                                            {
            contrast_ = qBound(-1.0, _contrast, 1.0);
        }

void ChannelCorrection::setGamma

(

double

_gamma

)

Set new gamma value, value is clamped between -1 and 1.

                                                      {
            gamma_ = qBound(-1.0, _gamma, 1.0);
        }

void ChannelCorrection::setMultiplier

(

double

_multiplier

)

Set new multiplier value.

                                                                {
            multiplier_ = qBound(0.0, _multiplier, 1.0);
        }

Friends And Related Function Documentation

bool operator== ( ChannelCorrection const &  _lhs, ChannelCorrection const &  _rhs  )

friend

Test for equality.

                                                                                      {
            return
                OMNI_TEST_MEMBER_EQUAL(gamma_) &&
                OMNI_TEST_MEMBER_EQUAL(brightness_) &&
                OMNI_TEST_MEMBER_EQUAL(contrast_) &&
                OMNI_TEST_MEMBER_EQUAL(multiplier_);
        }

Field Documentation

double omni::proj::ChannelCorrection::brightness_ = 0.0

private

Brightness between -1 and 1.

double omni::proj::ChannelCorrection::contrast_ = 0.0

private

Contrast between -1 and 1.

double omni::proj::ChannelCorrection::gamma_ = 0.0

private

double omni::proj::ChannelCorrection::multiplier_ = 0.5

private

Multiplier between 0.0 and 1.0.

---

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

• include/omni/proj/ChannelCorrection.h
• src/lib/proj/ChannelCorrection.cpp