Background thread runnable for computing image statistics. More...

#include <QmitkImageStatisticsCalculationRunnable.h>

Inheritance diagram for QmitkImageStatisticsCalculationRunnable:

[legend]

Collaboration diagram for QmitkImageStatisticsCalculationRunnable:

[legend]

Public Types
typedef itk::Statistics::Histogram< double >	HistogramType
	ITK histogram type used for statistics computation. More...

Public Types inherited from QmitkDataGenerationJobBase
using	ResultMapType = std::map< std::string, mitk::BaseData::Pointer >
	Map type for results produced by the job. More...

Public Member Functions
	QmitkImageStatisticsCalculationRunnable ()
	Default constructor. Initializes with zero-ignore disabled and 100 histogram bins. More...

	~QmitkImageStatisticsCalculationRunnable ()
	Destructor. More...

void	Initialize (const mitk::Image image, const mitk::BaseData mask)
	Initializes the runnable with the image and optional mask data. More...

mitk::ImageStatisticsContainer *	GetStatisticsData () const
	Returns the computed statistics container. More...

const mitk::Image *	GetStatisticsImage () const
	Returns the input image used for statistics calculation. More...

const mitk::BaseData *	GetMaskData () const
	Returns the mask data used for statistics calculation. More...

void	SetIgnoreZeroValueVoxel (bool _arg)
	Sets whether zero-valued voxels should be ignored during computation. More...

bool	GetIgnoreZeroValueVoxel () const
	Returns whether zero-valued voxels are ignored during computation. More...

void	SetHistogramNBins (unsigned int nbins)
	Sets the number of bins for histogram computation. More...

unsigned int	GetHistogramNBins () const
	Returns the number of bins used for histogram computation. More...

ResultMapType	GetResults () const override
	Returns the computation results as a labeled map. More...

Public Member Functions inherited from QmitkDataGenerationJobBase
void	run () final
	Executes the job computation with error handling and result signalling. More...

bool	GetComputationSuccessFlag () const
	Returns whether the last computation completed successfully. More...

std::string	GetLastErrorMessage () const
	Returns the error message from the last failed computation. More...

bool	IsRunning () const
	Returns whether the job is currently executing. More...

Protected Member Functions
bool	RunComputation () override

Protected Member Functions inherited from QmitkDataGenerationJobBase
	QmitkDataGenerationJobBase ()=default

virtual	~QmitkDataGenerationJobBase ()=default

Additional Inherited Members
Signals inherited from QmitkDataGenerationJobBase
void	Error (QString err, const QmitkDataGenerationJobBase *job)
	Emitted when an error occurs during computation. More...

void	ResultsAvailable (ResultMapType results, const QmitkDataGenerationJobBase *job)
	Emitted when computation results are available. More...

Protected Attributes inherited from QmitkDataGenerationJobBase
std::string	m_LastErrorMessage

Detailed Description

Background thread runnable for computing image statistics.

This class derives from QmitkDataGenerationJobBase and performs image statistics calculation in a background thread, keeping the GUI responsive. It supports optional mask data (binary images, multi-label segmentations, or planar figures) and can be configured to ignore zero-valued voxels and to use a specific number of histogram bins.

The computed results include an mitk::ImageStatisticsContainer with relation rules connecting it to the source image and mask.

See also: QmitkDataGenerationJobBase; QmitkImageStatisticsDataGenerator; mitk::ImageStatisticsCalculator

Definition at line 42 of file QmitkImageStatisticsCalculationRunnable.h.

Member Typedef Documentation

◆ HistogramType

typedef itk::Statistics::Histogram<double> QmitkImageStatisticsCalculationRunnable::HistogramType

ITK histogram type used for statistics computation.

Definition at line 48 of file QmitkImageStatisticsCalculationRunnable.h.

Constructor & Destructor Documentation

◆ QmitkImageStatisticsCalculationRunnable()

QmitkImageStatisticsCalculationRunnable::QmitkImageStatisticsCalculationRunnable ( )

Default constructor. Initializes with zero-ignore disabled and 100 histogram bins.

◆ ~QmitkImageStatisticsCalculationRunnable()

QmitkImageStatisticsCalculationRunnable::~QmitkImageStatisticsCalculationRunnable ( )

Destructor.

Member Function Documentation

◆ GetHistogramNBins()

unsigned int QmitkImageStatisticsCalculationRunnable::GetHistogramNBins ( ) const

Returns the number of bins used for histogram computation.

Returns: The number of histogram bins.

◆ GetIgnoreZeroValueVoxel()

bool QmitkImageStatisticsCalculationRunnable::GetIgnoreZeroValueVoxel ( ) const

Returns whether zero-valued voxels are ignored during computation.

Returns: True if zero-valued voxels are ignored; false otherwise.

◆ GetMaskData()

const mitk::BaseData* QmitkImageStatisticsCalculationRunnable::GetMaskData ( ) const

Returns the mask data used for statistics calculation.

Returns: Pointer to the mask data, or nullptr if no mask was set.

◆ GetResults()

ResultMapType QmitkImageStatisticsCalculationRunnable::GetResults ( ) const

overridevirtual

Returns the computation results as a labeled map.

The result map contains a single entry with key "statistics" mapping to the computed mitk::ImageStatisticsContainer.

Returns: The result map.

Implements QmitkDataGenerationJobBase.

◆ GetStatisticsData()

mitk::ImageStatisticsContainer* QmitkImageStatisticsCalculationRunnable::GetStatisticsData ( ) const

Returns the computed statistics container.

Returns: Pointer to the ImageStatisticsContainer, or nullptr if computation has not run or failed.

◆ GetStatisticsImage()

const mitk::Image* QmitkImageStatisticsCalculationRunnable::GetStatisticsImage ( ) const

Returns the input image used for statistics calculation.

Returns: Pointer to the input image.

◆ Initialize()

void QmitkImageStatisticsCalculationRunnable::Initialize	(	const mitk::Image *	image,
		const mitk::BaseData *	mask
	)

Initializes the runnable with the image and optional mask data.

Parameters

[in]	image	The input image for which statistics will be calculated.
[in]	mask	Optional mask data. Supported types: mitk::MultiLabelSegmentation, mitk::Image (binary mask), or mitk::PlanarFigure. Pass nullptr for no mask.

Exceptions

mitk::Exception if the mask is not nullptr and not one of the supported types.

◆ RunComputation()

bool QmitkImageStatisticsCalculationRunnable::RunComputation ( )

overrideprotectedvirtual

Does the real computation. Returns true if there where results produced.

Implements QmitkDataGenerationJobBase.

◆ SetHistogramNBins()

void QmitkImageStatisticsCalculationRunnable::SetHistogramNBins ( unsigned int nbins )

Sets the number of bins for histogram computation.

Parameters

[in] nbins The number of histogram bins.

◆ SetIgnoreZeroValueVoxel()

void QmitkImageStatisticsCalculationRunnable::SetIgnoreZeroValueVoxel ( bool _arg )

Sets whether zero-valued voxels should be ignored during computation.

Parameters

[in] _arg True to ignore zero-valued voxels; false to include them.

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

QmitkImageStatisticsCalculationRunnable.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ HistogramType

Constructor & Destructor Documentation

◆ QmitkImageStatisticsCalculationRunnable()

◆ ~QmitkImageStatisticsCalculationRunnable()

Member Function Documentation

◆ GetHistogramNBins()

◆ GetIgnoreZeroValueVoxel()

◆ GetMaskData()

◆ GetResults()

◆ GetStatisticsData()

◆ GetStatisticsImage()

◆ Initialize()

◆ RunComputation()

◆ SetHistogramNBins()

◆ SetIgnoreZeroValueVoxel()