#include <ImFusion/CT/FluoroFiducialDetectionAlgorithm.h>

Algorithm for detecting fiducials in fluoroscopy images with dedicated preprocessing. More...

Inheritance diagram for ImFusion::FluoroFiducialDetectionAlgorithm:

Detailed Description

Algorithm for detecting fiducials in fluoroscopy images with dedicated preprocessing.

Classes
struct	Fiducial

Public Types
enum class	DetectionMode { CV , ML }
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
	FluoroFiducialDetectionAlgorithm (SharedImageSet *img)
	Constructor.
	~FluoroFiducialDetectionAlgorithm () override
	Destructor.
void	compute () override
	Computes the fiducial detection.
OwningDataList	takeOutput () override
	Returns the output of the algorithm.
const std::vector< std::vector< Fiducial > > &	fiducials () const
	Returns the detected fiducials.
SharedImageSet *	input () const
	Returns the input image set.
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 bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
	Creates an instance if the data is compatible.
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< DetectionMode >	p_detectionMode = {"detectionMode", DetectionMode::CV, this}
	Detection mode.
Parameter< vec2f >	p_radiusRange = {"radiusRange", vec2f(25.0f, 50.0f), this}
	Radius range in pixels.
Parameter< float >	p_relativeThreshold = {"relativeThreshold", 0.3f, this}
	Relative threshold in range [0;1] as percentage of maximum intensity value.
Parameter< std::optional< float > >	p_minCircularity = {"minFiducialCircularity", 0.8f, this}
	Minimum fiducial circularity in range [0;1].
Parameter< std::optional< float > >	p_minConvexity = {"minFiducialConvexity", 0.7f, this}
	Minimum fiducial convexity in range [0;1].
Parameter< std::optional< float > >	p_minInertia = {"minFiducialInertia", 0.4f, this}
	Minimum fiducial inertia in range [0;1].
Parameter< float >	p_thresholdStep = {"thresholdStep", 5.0f, this}
	Threshold step used in bead detection.
Parameter< int >	p_minRepeatability = {"minRepeatability", 3, this}
	Number of repetitions a bead needs to be detected in different threshold images to be accepted.
Parameter< std::optional< Filesystem::Path > >	p_exportToFile = {"exportToFile", std::nullopt, this}
	Flag and path to export fiducials.
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

◆ DetectionMode

enum class ImFusion::FluoroFiducialDetectionAlgorithm::DetectionMode

strong

Enumerator
CV	Detection using Computer Vision.
ML	Detection using Machine Learning + Thresholding.

Constructor & Destructor Documentation

◆ FluoroFiducialDetectionAlgorithm()

ImFusion::FluoroFiducialDetectionAlgorithm::FluoroFiducialDetectionAlgorithm ( SharedImageSet * img )

explicit

Constructor.

Parameters

img	The input fluoroscopy image set

Member Function Documentation

◆ compute()

void ImFusion::FluoroFiducialDetectionAlgorithm::compute ( )

overridevirtual

Computes the fiducial detection.

Implements ImFusion::Algorithm.

◆ takeOutput()

OwningDataList ImFusion::FluoroFiducialDetectionAlgorithm::takeOutput ( )

overridevirtual

Returns the output of the algorithm.

Reimplemented from ImFusion::Algorithm.

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

ImFusion/CT/FluoroFiducialDetectionAlgorithm.h

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes