Référence de la classe KoHistogramProducer

#include <KoHistogramProducer.h>

Graphe d'héritage de KoHistogramProducer:

[légende]
Liste de tous les membres

Fonctions membres publiques

 KoHistogramProducer ()
virtual ~KoHistogramProducer ()
virtual void clear ()=0
virtual void addRegionToBin (const quint8 *pixels, const quint8 *selectionMask, quint32 nPixels, KoColorSpace *colorSpace)=0
virtual void setView (double from, double width)=0
virtual void setSkipTransparent (bool set)
virtual void setSkipUnselected (bool set)
virtual const KoIDid () const=0
virtual Q3ValueVector< KoChannelInfo * > channels ()=0
virtual qint32 numberOfBins ()=0
virtual QString positionToString (double pos) const=0
virtual double viewFrom () const=0
virtual double viewWidth () const=0
virtual double maximalZoom () const=0
virtual qint32 count ()=0
virtual qint32 getBinAt (qint32 channel, qint32 position)=0
virtual qint32 outOfViewLeft (qint32 channel)=0
virtual qint32 outOfViewRight (qint32 channel)=0

Attributs protégés

bool m_skipTransparent
bool m_skipUnselected

Description détaillée

This class is an interface used in the generation of a histogram. It is a container of data, all mathematically interesting things will calculated by a KisHistogram.

The default view will be the entire range each color can be in. And don't let the numberOfBins return anything else then 256 unless you have a very good reason for it.

About the views: a view is a zoom combined with a start level: the entire range of a channel is 0.0 - 1.0: this is the position. Combined with a zoom, we can calculate what part of a channel will fall in a bin. This gives us an interface to that the views that is not dependent of the actual colorspace of the histogram. The 'size' value is the size, again from 0.0 to 1.0 of the displayed range.

For comfort of the GUI, and because it is logical, channels are accessed in the order in which they are found in the channels() method. This is potentially different from the order in which they are internally ordered!

Définition à la ligne 51 du fichier KoHistogramProducer.h.


Documentation des contructeurs et destructeur

KoHistogramProducer::KoHistogramProducer (  )  [inline]

Définition à la ligne 53 du fichier KoHistogramProducer.h.

virtual KoHistogramProducer::~KoHistogramProducer (  )  [inline, virtual]

Définition à la ligne 54 du fichier KoHistogramProducer.h.


Documentation des fonctions membres

virtual void KoHistogramProducer::clear (  )  [pure virtual]

Clears the data in this producer, but keeps its other settings

Implémenté dans KoBasicHistogramProducer.

virtual void KoHistogramProducer::addRegionToBin ( const quint8 *  pixels,
const quint8 *  selectionMask,
quint32  nPixels,
KoColorSpace colorSpace 
) [pure virtual]

Adds the values from the specified array of pixels to the bins -- does not reset anything.

Paramètres:
pixels A pointer an array of pixeldata in the given colorspace
selectionMask a pointer to an array of bytes, where 0 is unselected and 1-255 is degree of selectedness. The array must be just as long as the array of pixels.
nPixels The number of pixels
colorSpace the colorspace that can decode the pixel data.

Implémenté dans KoBasicU8HistogramProducer, KoBasicU16HistogramProducer, KoBasicF32HistogramProducer, KoGenericRGBHistogramProducer, et KoGenericLabHistogramProducer.

virtual void KoHistogramProducer::setView ( double  from,
double  width 
) [pure virtual]

Implémenté dans KoBasicHistogramProducer.

virtual void KoHistogramProducer::setSkipTransparent ( bool  set  )  [inline, virtual]

Définition à la ligne 75 du fichier KoHistogramProducer.h.

Références m_skipTransparent.

virtual void KoHistogramProducer::setSkipUnselected ( bool  set  )  [inline, virtual]

Définition à la ligne 76 du fichier KoHistogramProducer.h.

Références m_skipUnselected.

virtual const KoID& KoHistogramProducer::id (  )  const [pure virtual]

Implémenté dans KoBasicHistogramProducer.

virtual Q3ValueVector<KoChannelInfo *> KoHistogramProducer::channels (  )  [pure virtual]

Implémenté dans KoBasicHistogramProducer, KoGenericRGBHistogramProducer, et KoGenericLabHistogramProducer.

virtual qint32 KoHistogramProducer::numberOfBins (  )  [pure virtual]

Implémenté dans KoBasicHistogramProducer.

virtual QString KoHistogramProducer::positionToString ( double  pos  )  const [pure virtual]

Implémenté dans KoBasicU8HistogramProducer, KoBasicU16HistogramProducer, KoBasicF32HistogramProducer, KoGenericRGBHistogramProducer, et KoGenericLabHistogramProducer.

virtual double KoHistogramProducer::viewFrom (  )  const [pure virtual]

Implémenté dans KoBasicHistogramProducer.

virtual double KoHistogramProducer::viewWidth (  )  const [pure virtual]

Implémenté dans KoBasicHistogramProducer.

virtual double KoHistogramProducer::maximalZoom (  )  const [pure virtual]

Implémenté dans KoBasicU8HistogramProducer, KoBasicU16HistogramProducer, KoBasicF32HistogramProducer, KoGenericRGBHistogramProducer, et KoGenericLabHistogramProducer.

virtual qint32 KoHistogramProducer::count (  )  [pure virtual]

Implémenté dans KoBasicHistogramProducer.

virtual qint32 KoHistogramProducer::getBinAt ( qint32  channel,
qint32  position 
) [pure virtual]

virtual qint32 KoHistogramProducer::outOfViewLeft ( qint32  channel  )  [pure virtual]

virtual qint32 KoHistogramProducer::outOfViewRight ( qint32  channel  )  [pure virtual]


Documentation des données membres

bool KoHistogramProducer::m_skipTransparent [protected]

Définition à la ligne 93 du fichier KoHistogramProducer.h.

Référencé par KoGenericLabHistogramProducer::addRegionToBin(), KoGenericRGBHistogramProducer::addRegionToBin(), KoBasicF32HistogramProducer::addRegionToBin(), KoBasicU16HistogramProducer::addRegionToBin(), KoBasicU8HistogramProducer::addRegionToBin(), et setSkipTransparent().

bool KoHistogramProducer::m_skipUnselected [protected]

Définition à la ligne 94 du fichier KoHistogramProducer.h.

Référencé par KoGenericLabHistogramProducer::addRegionToBin(), KoGenericRGBHistogramProducer::addRegionToBin(), KoBasicF32HistogramProducer::addRegionToBin(), KoBasicU16HistogramProducer::addRegionToBin(), KoBasicU8HistogramProducer::addRegionToBin(), et setSkipUnselected().


La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Wed Nov 22 23:46:00 2006 pour KPlato par  doxygen 1.5.1-p1