KisHistogram::Calculations Class Reference

#include <kis_histogram.h>

Public Member Functions
	Calculations ()
quint32	getCount ()
	This function return the number of pixels used by the histogram.
quint32	getHighest ()
	This function return the highest value of the histogram.
quint32	getLowest ()
	This function return the lowest value of the histogram.
double	getMax ()
double	getMean ()
	This function return the mean of value of the histogram.
double	getMin ()
double	getTotal ()

Private Attributes
quint32	m_count {0}
quint32	m_high {0}
quint32	m_low {0}
double	m_max {0.0}
double	m_mean {0.0}
double	m_min {0.0}
double	m_total {0.0}

Friends
class	KisHistogram

Detailed Description

Class that stores the result of histogram calculations. Doubles are in the 0-1 range, use the producer's positionToString function to display it.

Definition at line 44 of file kis_histogram.h.

Constructor & Destructor Documentation

Calculations()

KisHistogram::Calculations::Calculations ( )

inline

Definition at line 60 of file kis_histogram.h.

        {
        }

Member Function Documentation

getCount()

quint32 KisHistogram::Calculations::getCount ( )

inline

This function return the number of pixels used by the histogram.

Definition at line 92 of file kis_histogram.h.

                                  {
            return m_count;
        }

getHighest()

quint32 KisHistogram::Calculations::getHighest ( )

inline

This function return the highest value of the histogram.

Definition at line 78 of file kis_histogram.h.

                                    {
            return m_high;
        }

getLowest()

quint32 KisHistogram::Calculations::getLowest ( )

inline

This function return the lowest value of the histogram.

Definition at line 82 of file kis_histogram.h.

                                   {
            return m_low;
        }

getMax()

double KisHistogram::Calculations::getMax ( )

inline

This function return the maximum bound of the histogram (values at greater position than the maximum are null)

Definition at line 67 of file kis_histogram.h.

                               {
            return m_max;
        }

getMean()

double KisHistogram::Calculations::getMean ( )

inline

This function return the mean of value of the histogram.

Definition at line 86 of file kis_histogram.h.

                                {
            return m_mean;
        }

getMin()

double KisHistogram::Calculations::getMin ( )

inline

This function return the minimum bound of the histogram (values at smaller position than the minimum are null)

Definition at line 74 of file kis_histogram.h.

                               {
            return m_min;
        }

getTotal()

double KisHistogram::Calculations::getTotal ( )

inline

The sum of (the contents of every bin * the double value of that bin)

Definition at line 96 of file kis_histogram.h.

                                 {
            return m_total;
        }

Friends And Related Symbol Documentation

KisHistogram

friend class KisHistogram

friend

Definition at line 56 of file kis_histogram.h.

Member Data Documentation

m_count

quint32 KisHistogram::Calculations::m_count {0}

private

Definition at line 54 of file kis_histogram.h.

{0};

m_high

quint32 KisHistogram::Calculations::m_high {0}

private

Definition at line 52 of file kis_histogram.h.

{0};

m_low

quint32 KisHistogram::Calculations::m_low {0}

private

Definition at line 53 of file kis_histogram.h.

{0};

m_max

double KisHistogram::Calculations::m_max {0.0}

private

Definition at line 47 of file kis_histogram.h.

{0.0};

m_mean

double KisHistogram::Calculations::m_mean {0.0}

private

Definition at line 49 of file kis_histogram.h.

{0.0};

m_min

double KisHistogram::Calculations::m_min {0.0}

private

Definition at line 48 of file kis_histogram.h.

{0.0};

m_total

double KisHistogram::Calculations::m_total {0.0}

private

Definition at line 50 of file kis_histogram.h.

{0.0};

---

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

• libs/image/kis_histogram.h