#include <ImFusion/Base/OtsuThresholdAlgorithm.h>

Computes the Otsu threshold of an image. More...

Inheritance diagram for ImFusion::OtsuThresholdAlgorithm:

Detailed Description

Computes the Otsu threshold of an image.

In Mode::CenterAtZero, the algorithm subtracts the computed threshold from a float-converted copy of the input so that the threshold is centered at zero. In Mode::BinaryMask, it returns a binary mask with value 1 for pixels above or equal to the threshold and 0 otherwise.

In Mode::CenterAtZero, the output keeps the input modality. In Mode::BinaryMask, the output modality is set to Data::LABEL. The input must be a single-frame, single-channel image of any scalar pixel type.

A public static helper is also provided to compute the Otsu threshold directly from a valid image.

Note: Sets status to Status::Error if the input has no intensity variation (constant image), since no meaningful threshold can be computed in that case.

Public Types
enum class	Mode { CenterAtZero , BinaryMask }
	Output modes. More...
Public Types inherited from ImFusion::Algorithm
enum	Status { Unknown = -1 , Success = 0 , Error = 1 , InvalidInput , IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU , UnknownAction , AbortedByUser , User = 1000 }
	Status codes. More...

Public Member Functions
	OtsuThresholdAlgorithm (const SharedImageSet &image)
void	compute () override
	Execute the algorithm.
OwningDataList	takeOutput () override
	Return any new Data that was created by the Algorithm during the last call to compute().
Public Member Functions inherited from ImFusion::Algorithm
	Algorithm ()
	Default constructor will registers a single "compute" action that calls compute() and returns status().
virtual void	setProgress (Progress *progress)
	Sets a Progress interface the algorithm can use to notify observers about its computing progress.
Progress *	progress () const
	Returns the progress interface if set.
virtual int	status () const
	Indicates the status of the last call to compute().
virtual bool	survivesDataDeletion (const Data *) const
	Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list.
const FactoryInfo &	factoryInfo () const
	Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory.
void	setFactoryInfo (const FactoryInfo &value)
	Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory.
Status	runAction (const std::string &id)
	Run the action with name id if it exists.
const std::vector< Action > &	actions ()
	Get a mapping from Action id to Action as registered in this algorithm.
Public Member Functions inherited from ImFusion::Configurable
virtual void	configure (const Properties *p)
	Configure this object instance by de-serializing the given Properties.
virtual void	configuration (Properties *p) const
	Serialize the current object configuration into the given Properties object.
virtual void	configureDefaults ()
	Retrieve the properties of this object, replaces values with their defaults and sets it again.
void	registerParameter (ParameterBase *param)
	Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
void	unregisterParameter (const ParameterBase *param)
	Remove the given Parameter or SubProperty from the list of registered parameters.
	Configurable (const Configurable &rhs)
	Configurable (Configurable &&rhs) noexcept
Configurable &	operator= (const Configurable &)
Configurable &	operator= (Configurable &&) noexcept

Static Public Member Functions
static double	computeOtsuThreshold (const SharedImageSet &image, int numBins=256)
	Computes the Otsu threshold of a valid image.
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
Static Public Member Functions inherited from ImFusion::Algorithm
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
	Factory function to check algorithm compatibility with input data and optionally instantiate it.

Public Attributes
Parameter< Mode >	p_mode = {"mode", Mode::CenterAtZero, this}
	Controls whether the output is a zero-centered float image or a binary label image.
Parameter< int >	p_numBins = {"numBins", 256, this}
	Number of histogram bins used to estimate the Otsu threshold, minimum valid value is 2.
Public Attributes inherited from ImFusion::Algorithm
Signal	signalOutputChanged
	Signal should be emitted by Algorithms when their output/result has changed.
Signal	signalParametersChanged
	Signal should be emitted by Algorithms when their parameter configuration has changed.
Public Attributes inherited from ImFusion::Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members
Protected Member Functions inherited from ImFusion::Algorithm
void	loadDefaults ()
void	registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action)
	Register an action to be run via runAction.
template<typename D>
void	registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void))
	Template version of runAction that can be used with a pointer to a member function.
void	registerAction (const Action &action)
	Register an action.
Protected Attributes inherited from ImFusion::Algorithm
std::string	m_name
	Algorithm name.
Progress *	m_progress = nullptr
	Non-owing pointer to a progress interface. May be a nullptr.
FactoryInfo	m_factoryInfo = {}
	Record describing how this algorithm was instantiated by the AlgorithmFactory.
int	m_status = Status::Unknown
	Algorithm status after last call to compute().
std::vector< Action >	m_actions
	Map of key given by the id of the action, of the available actions of this algorithm.
Protected Attributes inherited from ImFusion::Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Enumeration Documentation

◆ Mode

enum class ImFusion::OtsuThresholdAlgorithm::Mode

strong

Output modes.

Enumerator
CenterAtZero	Return a float image with the Otsu threshold centered at zero.
BinaryMask	Return a uint8 mask with value 1 for pixels above or equal to the threshold and 0 otherwise.

Constructor & Destructor Documentation

◆ OtsuThresholdAlgorithm()

ImFusion::OtsuThresholdAlgorithm::OtsuThresholdAlgorithm ( const SharedImageSet & image )

explicit

Parameters

image Input image on which the Otsu threshold will be computed.

Member Function Documentation

◆ computeOtsuThreshold()

double ImFusion::OtsuThresholdAlgorithm::computeOtsuThreshold	(	const SharedImageSet &	image,
		int	numBins = 256 )

static

Computes the Otsu threshold of a valid image.

The threshold is returned in the original pixel value domain.

Parameters

image	Input image. Must contain exactly one single-channel image with non-zero intensity range.
numBins	Number of histogram bins used to estimate the threshold. Must be at least 2.

Returns: Otsu threshold in the original pixel value domain.

◆ compute()

void ImFusion::OtsuThresholdAlgorithm::compute ( )

overridevirtual

Execute the algorithm.

Implements ImFusion::Algorithm.

◆ takeOutput()

OwningDataList ImFusion::OtsuThresholdAlgorithm::takeOutput ( )

overridevirtual

Return any new Data that was created by the Algorithm during the last call to compute().

The default implementation will return an empty list.

Note: Since ownership of the data is transferred, you can call this method only once between calls to compute().

Reimplemented from ImFusion::Algorithm.

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

ImFusion/Base/OtsuThresholdAlgorithm.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members