PlusFidPatternRecognition Class Reference

#include <src/PlusCalibration/PatternLocAlgo/PlusFidPatternRecognition.h>

Collaboration diagram for PlusFidPatternRecognition:

Public Types
enum	PatternRecognitionError { PATTERN_RECOGNITION_ERROR_NO_ERROR, PATTERN_RECOGNITION_ERROR_UNKNOWN, PATTERN_RECOGNITION_ERROR_TOO_MANY_CANDIDATES }

Public Member Functions
void	DrawDots (PlusFidSegmentation::PixelType *image)
void	DrawResults (PlusFidSegmentation::PixelType *image)
PlusFidLabeling *	GetFidLabeling ()
PlusFidLineFinder *	GetFidLineFinder ()
PlusFidSegmentation *	GetFidSegmentation ()
std::vector< PlusFidPattern * > &	GetPatterns ()
	PlusFidPatternRecognition ()
PlusStatus	ReadConfiguration (vtkXMLDataElement *rootConfigElement)
PlusStatus	ReadPhantomDefinition (vtkXMLDataElement *rootConfigElement)
PlusStatus	RecognizePattern (vtkIGSIOTrackedFrameList *trackedFrameList, PatternRecognitionError &patternRecognitionError, int *numberOfSuccessfullySegmentedImages=NULL, std::vector< unsigned int > *segmentedFramesIndices=NULL)
PlusStatus	RecognizePattern (igsioTrackedFrame *trackedFrame, PatternRecognitionError &patternRecognitionError, unsigned int frameIndex)
PlusStatus	RecognizePattern (igsioTrackedFrame *trackedFrame, PlusPatternRecognitionResult &patternRecognitionResult, PatternRecognitionError &patternRecognitionError, unsigned int frameIndex)
void	SetMaxLineLengthToleranceMm (double value)
void	SetNumberOfMaximumFiducialPointCandidates (int aMax)
virtual	~PlusFidPatternRecognition ()

Protected Attributes
PlusFidLabeling	m_FidLabeling
PlusFidLineFinder	m_FidLineFinder
PlusFidSegmentation	m_FidSegmentation
double	m_MaxLineLengthToleranceMm
std::vector< PlusFidPattern * >	m_Patterns

Detailed Description

Definition at line 28 of file PlusFidPatternRecognition.h.

Member Enumeration Documentation

PatternRecognitionError

enum PlusFidPatternRecognition::PatternRecognitionError

Enumerator
PATTERN_RECOGNITION_ERROR_NO_ERROR
PATTERN_RECOGNITION_ERROR_UNKNOWN
PATTERN_RECOGNITION_ERROR_TOO_MANY_CANDIDATES

Definition at line 32 of file PlusFidPatternRecognition.h.

Constructor & Destructor Documentation

PlusFidPatternRecognition()

PlusFidPatternRecognition::PlusFidPatternRecognition

(

)

Definition at line 21 of file PlusFidPatternRecognition.cxx.

~PlusFidPatternRecognition()

PlusFidPatternRecognition::~PlusFidPatternRecognition ( )

virtual

Definition at line 28 of file PlusFidPatternRecognition.cxx.

Member Function Documentation

DrawDots()

void PlusFidPatternRecognition::DrawDots

(

PlusFidSegmentation::PixelType *

image

)

Draw dots for debug purpose

Definition at line 220 of file PlusFidPatternRecognition.cxx.

DrawResults()

void PlusFidPatternRecognition::DrawResults

(

PlusFidSegmentation::PixelType *

image

)

Draw the results on an image for debug purpose

Definition at line 246 of file PlusFidPatternRecognition.cxx.

GetFidLabeling()

PlusFidLabeling* PlusFidPatternRecognition::GetFidLabeling ( )

inline

Get the FidLabeling element, his element finds the pattern from the detected n-points lines

Definition at line 84 of file PlusFidPatternRecognition.h.

GetFidLineFinder()

PlusFidLineFinder* PlusFidPatternRecognition::GetFidLineFinder ( )

inline

Get the FidLineFinder element, this element finds the n-points lines from the segmented dots

Definition at line 81 of file PlusFidPatternRecognition.h.

GetFidSegmentation()

PlusFidSegmentation* PlusFidPatternRecognition::GetFidSegmentation ( )

inline

Get the FidSegmentation element, this element handles the segmentation part of the algorithm

Definition at line 78 of file PlusFidPatternRecognition.h.

GetPatterns()

std::vector<PlusFidPattern*>& PlusFidPatternRecognition::GetPatterns ( )

inline

Get the pattern structure vector, this defines the patterns that the algorithm finds

Definition at line 87 of file PlusFidPatternRecognition.h.

ReadConfiguration()

PlusStatus PlusFidPatternRecognition::ReadConfiguration

(

vtkXMLDataElement *

rootConfigElement

)

Read the configuration file from a vtk XML data element

Definition at line 34 of file PlusFidPatternRecognition.cxx.

ReadPhantomDefinition()

PlusStatus PlusFidPatternRecognition::ReadPhantomDefinition

(

vtkXMLDataElement *

rootConfigElement

)

Reads the phantom definition and computes the NWires intersection if needed

Definition at line 301 of file PlusFidPatternRecognition.cxx.

RecognizePattern() [1/3]

PlusStatus PlusFidPatternRecognition::RecognizePattern	(	vtkIGSIOTrackedFrameList *	trackedFrameList,
		PatternRecognitionError &	patternRecognitionError,
		int *	numberOfSuccessfullySegmentedImages = NULL,
		std::vector< unsigned int > *	segmentedFramesIndices = NULL
	)

Run pattern recognition on a tracked frame list. It only segments the tracked frames which were not already segmented

Parameters

trackedFrameList	Tracked frame list to segment
numberOfSuccessfullySegmentedImages	Out parameter holding the number of segmented images in this call (it is only equals the number of all segmented images in the tracked frame if it was not segmented at all)
segmentedFramesIndices	Indices of the frames that were properly segmented

Definition at line 161 of file PlusFidPatternRecognition.cxx.

RecognizePattern() [2/3]

PlusStatus PlusFidPatternRecognition::RecognizePattern	(	igsioTrackedFrame *	trackedFrame,
		PatternRecognitionError &	patternRecognitionError,
		unsigned int	frameIndex
	)

Run pattern recognition on a tracked frame list.

Parameters

trackedFrame	image to segment
patternRecognitionError	returns detailed information about the success of the recognition
frameIndex	index of the current frame, only used for saving debug information (determine output image file name)

Definition at line 78 of file PlusFidPatternRecognition.cxx.

RecognizePattern() [3/3]

PlusStatus PlusFidPatternRecognition::RecognizePattern	(	igsioTrackedFrame *	trackedFrame,
		PlusPatternRecognitionResult &	patternRecognitionResult,
		PatternRecognitionError &	patternRecognitionError,
		unsigned int	frameIndex
	)

Run pattern recognition on a tracked frame list.

Parameters

trackedFrame	image to segment
patternRecognitionResult	object to store the pattern recognition result
patternRecognitionError	returns detailed information about the success of the recognition
frameIndex	index of the current frame, only used for saving debug information (determine output image file name)

Definition at line 54 of file PlusFidPatternRecognition.cxx.

SetMaxLineLengthToleranceMm()

void PlusFidPatternRecognition::SetMaxLineLengthToleranceMm

(

double

value

)

Set the maximum tolerance on the line length in Mm

Definition at line 286 of file PlusFidPatternRecognition.cxx.

SetNumberOfMaximumFiducialPointCandidates()

void PlusFidPatternRecognition::SetNumberOfMaximumFiducialPointCandidates

(

int

aMax

)

Set the maximum number of candidates to consider

Definition at line 550 of file PlusFidPatternRecognition.cxx.

Member Data Documentation

m_FidLabeling

PlusFidLabeling PlusFidPatternRecognition::m_FidLabeling

protected

Definition at line 102 of file PlusFidPatternRecognition.h.

m_FidLineFinder

PlusFidLineFinder PlusFidPatternRecognition::m_FidLineFinder

protected

Definition at line 101 of file PlusFidPatternRecognition.h.

m_FidSegmentation

PlusFidSegmentation PlusFidPatternRecognition::m_FidSegmentation

protected

Definition at line 100 of file PlusFidPatternRecognition.h.

m_MaxLineLengthToleranceMm

double PlusFidPatternRecognition::m_MaxLineLengthToleranceMm

protected

Definition at line 105 of file PlusFidPatternRecognition.h.

m_Patterns

std::vector<PlusFidPattern*> PlusFidPatternRecognition::m_Patterns

protected

Definition at line 103 of file PlusFidPatternRecognition.h.

---

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

• src/PlusCalibration/PatternLocAlgo/PlusFidPatternRecognition.h
• src/PlusCalibration/PatternLocAlgo/PlusFidPatternRecognition.cxx