#include <SpinePlugin/include/ImFusion/Spine/SpineLocalization2DAlgorithm.h>

Localization algorithm that detects vertebrae and other structures in X-Ray images. More...

Inheritance diagram for SpineLocalization2DAlgorithm:

Detailed Description

Localization algorithm that detects vertebrae and other structures in X-Ray images.

Resulting detections can be acquired using the detections() method.

Classes
struct	ModelSet
	Configuration for a set of models to be used for localization in 2D. More...

Public Types
using	ModelFactory = AnatomyPlugin::ModelFactory

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
ModelFactory &	modelFactory ()
	Returns the model factory used by this algorithm. This is initialized with a copy of the global model factory instance.

const ModelFactory &	modelFactory () const
	Returns the model factory used by this algorithm. This is initialized with a copy of the global model factory instance.

	SpineLocalization2DAlgorithm (SharedImageSet &source)
	Constructor. The input image can be a single image or a multi-frame image set.

void	compute () override
	Runs all of the models contained in the selected model set version.

virtual Algorithm::Status	localizeVertebrae ()

virtual Algorithm::Status	segmentVertebrae ()

virtual Algorithm::Status	detectSacrum ()

virtual Algorithm::Status	detectFemurs ()

virtual Algorithm::Status	detectClavicles ()

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

void	configure (const Properties *prop) override
	Configure this object instance by de-serializing the given Properties.

SharedImageSet &	input ()

ASCSet *	ascSet ()

const ASCSet *	ascSet () const

SpineData *	spineData ()

const SpineData *	spineData () const

void	registerModel (const std::string &modelName, ModelSet modelSet)
	Register a model set with a name.

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	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

Public Member Functions inherited from SignalReceiver
	SignalReceiver ()=default
	Default constructor.

	SignalReceiver (const SignalReceiver &other)
	Copy constructor, does not copy any existing signal connections from other.

SignalReceiver &	operator= (SignalReceiver rhs)
	Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs.

virtual	~SignalReceiver ()
	Virtual destructor disconnects from all connected signals.

Static Public Member Functions
static const ModelFactory &	globalModelFactoryInstance ()
	Global model factory instance initialized to public models, the algorithm creates a copy on construction.

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

static double	updateSpineDataFromKeypoints (SpineData &spineDataInOut, const std::vector< std::vector< vec3 > > &vertebraKeypoints, double approximateVertebraScale, bool splitVertebrae)
	Associate different types of keypoints and add corresponding OrientedVertebra instances to spineDataInOut approximateVertebraScale is a scale parameter that that should be set to (approximately) the width of a vertebra body on the x-ray.

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
Parameter< bool >	p_splitVertebrae = {"splitVertebrae", true, this}
	If set to false, extracted keypoints are directly added as pointclouds at the global level instead of associating to individual vertebrae.

Parameter< std::string >	p_modelSet = {"modelSet", "ImFusion Standard", this}

Parameter< std::string >	p_modelSetVersion = {"modelSetVersion", "", this}

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.

Additional Inherited Members
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 Member Functions inherited from SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.

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

◆ compute()

void compute ( )

overridevirtual

Runs all of the models contained in the selected model set version.

Implements Algorithm.

◆ takeOutput()

OwningDataList 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 Algorithm.

◆ configure()

void configure ( const Properties * p )

overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also: configuration() for the inverse functionality

Reimplemented from Configurable.

◆ updateSpineDataFromKeypoints()

static double updateSpineDataFromKeypoints	(	SpineData &	spineDataInOut,
		const std::vector< std::vector< vec3 > > &	vertebraKeypoints,
		double	approximateVertebraScale,
		bool	splitVertebrae )

static

Associate different types of keypoints and add corresponding OrientedVertebra instances to spineDataInOut approximateVertebraScale is a scale parameter that that should be set to (approximately) the width of a vertebra body on the x-ray.

Returns a refined version of approximateVertebraScale based on the detected keypoints.

◆ registerModel()

void registerModel	(	const std::string &	modelName,
		ModelSet	modelSet )

Register a model set with a name.

Deprecated: "Use the modelFactory member function directly instead"

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

SpinePlugin/include/ImFusion/Spine/SpineLocalization2DAlgorithm.h

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Member Function Documentation

◆ compute()

◆ takeOutput()

◆ configure()

◆ updateSpineDataFromKeypoints()

◆ registerModel()