Detailed Description

Algorithm to bin image sets according to a gating signal.

Public Types
enum class	GatingType { Binning = 0 , SimilarityThreshold = 1 , PeakDistance = 2 }
	Different types of gating.

Public Types inherited from Algorithm
enum	Status { Unknown = -1 , Success = 0 , Error = 1 , InvalidInput , IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU , UnknownAction , AbortedByUser , User = 1000 }
	Status codes. More...

Public Member Functions
	ImageGatingAlgorithm (SharedImageSet images, SharedImageSet refImgWithGatingInfo=0)
	Creates the algorithm instance with a series of images.

virtual	~ImageGatingAlgorithm () override
	Destructor.

Public Member Functions inherited from 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 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

Parameters
Parameter< GatingType >	p_gatingType = {"gatingType", GatingType::Binning, this}

Parameter< double >	p_threshold = {"threshold", 0.5, this}
	Used for gating type SimilarityThreshold (in interval [0,1]) to generate two output sets.

Parameter< vec2i >	p_peakDistances = {"peakDistances", vec2i(5, 10), this}
	Used for gating type PeakDistance (number of frames from the peaks before/after) to generate two output sets.

Parameter< int >	p_numberOfBins = {"numberOfBins", 8, this}
	Number of bins. Only used for gating type Binning.

Parameter< int >	p_reduceToSingleBin = {"reduceToSingleBin", -1, this}
	If set to a bin between 0 and p_numberOfBins-1, the input image set will to be reduced to this bin only, and all other images will be discarded.

Methods implementing the algorithm interface
void	compute () override
	Applies the processing.

OwningDataList	takeOutput () override
	If new data was created, make it available here.

static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)

Additional Inherited Members
Static Public Member Functions inherited from 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 inherited from 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 Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' `signalValueChanged` signal was emitted.

Protected Member Functions inherited from 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 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 Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

◆ createCompatible()

static bool createCompatible	(	const DataList &	data,
		Algorithm **	a = nullptr )

static

Factory method to check for applicability or to create the algorithm

◆ compute()

void compute ( )

overridevirtual

Applies the processing.

Implements Algorithm.

◆ takeOutput()

OwningDataList takeOutput ( )

overridevirtual

If new data was created, make it available here.

Reimplemented from Algorithm.

Member Data Documentation

◆ p_gatingType

Parameter<GatingType> p_gatingType = {"gatingType", GatingType::Binning, this}

Type of gating

◆ p_reduceToSingleBin

Parameter<int> p_reduceToSingleBin = {"reduceToSingleBin", -1, this}

If set to a bin between 0 and p_numberOfBins-1, the input image set will to be reduced to this bin only, and all other images will be discarded.

Only used for gating type Binning.

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

ImFusion/Base/ImageGatingAlgorithm.h

Detailed Description

Public Types

Public Member Functions

Parameters

Methods implementing the algorithm interface