digiKam
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
Digikam::ImageHistogram Class Reference
+ Inheritance diagram for Digikam::ImageHistogram:

Public Types

enum  State { Inactive , Scheduled , Running , Deactivating }
 

Public Slots

void start ()
 
void stop ()
 
void wait ()
 

Signals

void calculationAboutToStart ()
 
void calculationFinished (bool success)
 
void calculationStarted ()
 
void finished ()
 
void starting ()
 

Public Member Functions

void calculate ()
 
void calculateInThread ()
 
double getCount (int channel, int start, int end) const
 
int getHistogramSegments () const
 
double getMaximum (int channel, int start, int end) const
 
int getMaxSegmentIndex () const
 
double getMean (int channel, int start, int end) const
 
int getMedian (int channel, int start, int end) const
 
double getPixels () const
 
double getStdDev (int channel, int start, int end) const
 
double getValue (int channel, int bin) const
 
 ImageHistogram (const DImg &img, QObject *const parent=nullptr)
 
bool isCalculating () const
 
bool isFinished () const
 
bool isRunning () const
 
bool isSixteenBit () const
 
bool isValid () const
 
QThread::Priority priority () const
 
void setEmitSignals (bool emitThem)
 
void setPriority (QThread::Priority priority)
 
State state () const
 
void stopCalculation ()
 
 ~ImageHistogram () override
 

Protected Member Functions

void run () override
 
bool runningFlag () const volatile
 
void shutDown ()
 
void start (QMutexLocker &locker)
 
void stop (QMutexLocker &locker)
 
QMutex * threadMutex () const
 
void wait (QMutexLocker &locker)
 

Member Enumeration Documentation

◆ State

enum Digikam::DynamicThread::State
inherited
Enumerator
Inactive 
Scheduled 
Running 
Deactivating 

Constructor & Destructor Documentation

◆ ImageHistogram()

Digikam::ImageHistogram::ImageHistogram ( const DImg &  img,
QObject *const  parent = nullptr 
)
explicit

◆ ~ImageHistogram()

Digikam::ImageHistogram::~ImageHistogram ( )
override

References stopCalculation().

Member Function Documentation

◆ calculate()

void Digikam::ImageHistogram::calculate ( )

Started computation: synchronous or threaded.

References calculationFinished(), calculationStarted(), isSixteenBit(), and Digikam::DynamicThread::runningFlag().

Referenced by Digikam::WBFilter::autoExposureAdjustement(), and run().

◆ calculateInThread()

void Digikam::ImageHistogram::calculateInThread ( )

References calculationAboutToStart(), calculationFinished(), and Digikam::DynamicThread::start().

Referenced by Digikam::HistogramWidget::setRenderingType(), and Digikam::HistogramWidget::updateData().

◆ calculationAboutToStart

void Digikam::ImageHistogram::calculationAboutToStart ( )
signal

when calculation in thread is initiated, from other thread

Referenced by calculateInThread().

◆ calculationFinished

void Digikam::ImageHistogram::calculationFinished ( bool  success)
signal

Referenced by calculate(), and calculateInThread().

◆ calculationStarted

void Digikam::ImageHistogram::calculationStarted ( )
signal

emitted from calculation thread

Referenced by calculate().

◆ finished

void Digikam::DynamicThread::finished ( )
signalinherited

Referenced by Digikam::ThumbnailImageCatcher::Private::harvest(), Digikam::DImgThreadedFilter::startFilter(), and Digikam::DImgThreadedFilter::startFilterDirectly().

◆ getCount()

double Digikam::ImageHistogram::getCount ( int  channel,
int  start,
int  end 
) const

References Digikam::AlphaChannel, Digikam::BlueChannel, Digikam::GreenChannel, Digikam::LuminosityChannel, Digikam::RedChannel, and Digikam::DynamicThread::start().

Referenced by getMean(), getMedian(), getStdDev(), Digikam::ImageLevels::levelsChannelAuto(), and Digikam::HistogramWidget::paintEvent().

◆ getHistogramSegments()

int Digikam::ImageHistogram::getHistogramSegments ( ) const

Referenced by Digikam::HistogramWidget::paintEvent().

◆ getMaximum()

double Digikam::ImageHistogram::getMaximum ( int  channel,
int  start,
int  end 
) const

References Digikam::AlphaChannel, Digikam::BlueChannel, Digikam::GreenChannel, Digikam::LuminosityChannel, Digikam::RedChannel, and Digikam::DynamicThread::start().

◆ getMaxSegmentIndex()

int Digikam::ImageHistogram::getMaxSegmentIndex ( ) const

◆ getMean()

double Digikam::ImageHistogram::getMean ( int  channel,
int  start,
int  end 
) const

References Digikam::AlphaChannel, Digikam::BlueChannel, getCount(), Digikam::GreenChannel, Digikam::LuminosityChannel, Digikam::RedChannel, and Digikam::DynamicThread::start().

Referenced by getStdDev(), and Digikam::HistogramWidget::paintEvent().

◆ getMedian()

int Digikam::ImageHistogram::getMedian ( int  channel,
int  start,
int  end 
) const

References Digikam::AlphaChannel, Digikam::BlueChannel, getCount(), Digikam::GreenChannel, Digikam::LuminosityChannel, Digikam::RedChannel, and Digikam::DynamicThread::start().

Referenced by Digikam::HistogramWidget::paintEvent().

◆ getPixels()

double Digikam::ImageHistogram::getPixels ( ) const

Referenced by Digikam::HistogramWidget::paintEvent().

◆ getStdDev()

double Digikam::ImageHistogram::getStdDev ( int  channel,
int  start,
int  end 
) const

References Digikam::AlphaChannel, Digikam::BlueChannel, getCount(), getMean(), Digikam::GreenChannel, Digikam::LuminosityChannel, Digikam::RedChannel, and Digikam::DynamicThread::start().

Referenced by Digikam::HistogramWidget::paintEvent().

◆ getValue()

double Digikam::ImageHistogram::getValue ( int  channel,
int  bin 
) const

References Digikam::AlphaChannel, Digikam::BlueChannel, Digikam::GreenChannel, Digikam::LuminosityChannel, Digikam::RedChannel, and value.

Referenced by Digikam::WBFilter::autoExposureAdjustement(), and Digikam::ImageLevels::levelsChannelAuto().

◆ isCalculating()

bool Digikam::ImageHistogram::isCalculating ( ) const

References Digikam::DynamicThread::isRunning().

Referenced by Digikam::HistogramWidget::setRenderingType().

◆ isFinished()

bool Digikam::DynamicThread::isFinished ( ) const
inherited

References Digikam::DynamicThread::Inactive.

◆ isRunning()

bool Digikam::DynamicThread::isRunning ( ) const
inherited

References Digikam::DynamicThread::Deactivating, Digikam::DynamicThread::Running, and Digikam::DynamicThread::Scheduled.

Referenced by Digikam::DImgThreadedFilter::cancelFilter(), and isCalculating().

◆ isSixteenBit()

bool Digikam::ImageHistogram::isSixteenBit ( ) const

Methods to access the histogram data.

Referenced by calculate().

◆ isValid()

bool Digikam::ImageHistogram::isValid ( ) const

Referenced by Digikam::HistogramWidget::setRenderingType().

◆ priority()

QThread::Priority Digikam::DynamicThread::priority ( ) const
inherited

Referenced by Digikam::DynamicThread::setPriority().

◆ run()

void Digikam::ImageHistogram::run ( )
overrideprotectedvirtual

Implement this pure virtual function in your subclass.

Implements Digikam::DynamicThread.

References calculate().

◆ runningFlag()

bool Digikam::DynamicThread::runningFlag ( ) const volatile
protectedinherited

In you run() method, you shall regularly check for runningFlag() and cleanup and return if false.

Referenced by calculate(), Digikam::RawProcessingFilter::continueQuery(), Digikam::LoadSaveThread::run(), Digikam::ScanStateFilter::run(), and Digikam::NREstimate::startAnalyse().

◆ setEmitSignals()

void Digikam::DynamicThread::setEmitSignals ( bool  emitThem)
inherited

◆ setPriority()

void Digikam::DynamicThread::setPriority ( QThread::Priority  priority)
inherited

Sets the priority for this dynamic thread. Can be set anytime. If the thread is currently not running, the priority will be set when it is run next time. When you set QThread::InheritPriority (default), the priority is not changed but inherited from the thread pool.

References Digikam::DynamicThread::priority().

Referenced by Digikam::FacePipeline::Private::applyPriority(), and Digikam::FacePipeline::Private::createThumbnailLoadThread().

◆ shutDown()

void Digikam::DynamicThread::shutDown ( )
protectedinherited

If you are deleting data in your destructor which is accessed from the thread, do one of the following from your destructor to guarantee a safe shutdown: 1) Call this method 2) Call stop() and wait(), knowing that nothing will call start() anymore after this 3) Be sure the thread will never be running at destruction. Note: This irrevocably stops this object. Note: It is not sufficient that your parent class does this. Calling this method, or providing one of the above mentioned equivalent guarantees, must be done by every single last class in the hierarchy with an implemented destructor deleting data. (the base class destructor is always called after the derived class)

References Digikam::DynamicThread::stop(), and Digikam::DynamicThread::wait().

Referenced by Digikam::ManagedLoadSaveThread::shutDown(), Digikam::DynamicThread::~DynamicThread(), and Digikam::LoadSaveThread::~LoadSaveThread().

◆ start [1/2]

void Digikam::DynamicThread::start ( )
slotinherited

Referenced by calculateInThread(), Digikam::FacePreviewLoader::checkRestart(), getCount(), getMaximum(), getMean(), getMedian(), getStdDev(), Digikam::LoadSaveThread::load(), Digikam::ManagedLoadSaveThread::load(), Digikam::ManagedLoadSaveThread::loadThumbnail(), Digikam::DImgThreadedFilter::multithreadedSteps(), Digikam::ManagedLoadSaveThread::preloadThumbnail(), Digikam::ManagedLoadSaveThread::preloadThumbnailGroup(), Digikam::ManagedLoadSaveThread::prependThumbnailGroup(), Digikam::ScanStateFilter::process(), Digikam::LoadSaveThread::save(), Digikam::ManagedLoadSaveThread::save(), and Digikam::DImgThreadedFilter::startFilter().

◆ start() [2/2]

void Digikam::DynamicThread::start ( QMutexLocker &  locker)
protectedinherited

Doing the same as start(), stop() and wait above, provide it with a locked QMutexLocker on mutex(). Note the start() will unlock and relock for scheduling once, after state change.

References Digikam::ThreadManager::instance(), and Digikam::ThreadManager::schedule().

◆ starting

void Digikam::DynamicThread::starting ( )
signalinherited

Emitted if emitSignals is enabled

◆ state()

DynamicThread::State Digikam::DynamicThread::state ( ) const
inherited

Referenced by Digikam::ThumbnailImageCatcher::Private::harvest(), and Digikam::ThumbnailImageCatcher::Private::reset().

◆ stop [1/2]

void Digikam::DynamicThread::stop ( )
slotinherited

Stop computation, sets the running flag to false.

Referenced by Digikam::WBFilter::autoExposureAdjustement(), Digikam::DImgThreadedFilter::cancelFilter(), Digikam::DImgThreadedFilter::multithreadedSteps(), Digikam::LoadSaveThread::run(), Digikam::ScanStateFilter::run(), Digikam::DynamicThread::shutDown(), Digikam::FacePreviewLoader::slotImageLoaded(), Digikam::FacePipeline::Private::stop(), and stopCalculation().

◆ stop() [2/2]

void Digikam::DynamicThread::stop ( QMutexLocker &  locker)
protectedinherited

◆ stopCalculation()

void Digikam::ImageHistogram::stopCalculation ( )

Stop threaded computation.

References Digikam::DynamicThread::stop(), and Digikam::DynamicThread::wait().

Referenced by ~ImageHistogram().

◆ threadMutex()

QMutex * Digikam::DynamicThread::threadMutex ( ) const
protectedinherited

This is the non-recursive mutex used to protect state variables and waiting in this class. You can use it if you want to protect your memory in the same scope as calling start, stop or wait, then using the QMutexLocker variants below. Note that when you have locked this mutex, you must use these variants, as the mutex is non-recursive.

Referenced by Digikam::ScanStateFilter::dispatch(), Digikam::LoadSaveThread::load(), Digikam::ManagedLoadSaveThread::load(), Digikam::ManagedLoadSaveThread::loadThumbnail(), Digikam::ManagedLoadSaveThread::preloadThumbnail(), Digikam::ManagedLoadSaveThread::preloadThumbnailGroup(), Digikam::ManagedLoadSaveThread::prependThumbnailGroup(), Digikam::ScanStateFilter::process(), Digikam::LoadSaveThread::run(), Digikam::ScanStateFilter::run(), Digikam::LoadSaveThread::save(), Digikam::ManagedLoadSaveThread::save(), Digikam::ManagedLoadSaveThread::shutDown(), Digikam::ManagedLoadSaveThread::stopAllTasks(), Digikam::ManagedLoadSaveThread::stopLoading(), Digikam::ManagedLoadSaveThread::stopSaving(), and Digikam::LoadSaveThread::taskHasFinished().

◆ wait [1/2]

void Digikam::DynamicThread::wait ( )
slotinherited

Waits until the thread finishes. Typically, call stop() before.

Referenced by Digikam::DImgThreadedFilter::cancelFilter(), Digikam::ThumbnailLoadThread::cleanUp(), Digikam::DynamicThread::shutDown(), Digikam::FacePreviewLoader::slotImageLoaded(), stopCalculation(), and Digikam::FacePipeline::Private::wait().

◆ wait() [2/2]

void Digikam::DynamicThread::wait ( QMutexLocker &  locker)
protectedinherited
The documentation for this class was generated from the following files: