SoImageVizEngineAnalysisOutput< AnalysisResultType > Class Template Reference

Image Processing output class to convert SoImageAnalysisResult to result details. More...

#include <ImageViz/Engines/SoImageVizEngineAnalysisOutput.h>

Inheritance diagram for SoImageVizEngineAnalysisOutput< AnalysisResultType >:

Public Member Functions
	SoImageVizEngineAnalysisOutput ()
	Constructor.
virtual	~SoImageVizEngineAnalysisOutput ()
	Destructor.
AnalysisResultType	getDetail (size_t index=0) const
	Return index-th detail of the given image analysis output.
size_t	getNumDetails () const
	Returns the number of details available in the image analysis output.
Public Member Functions inherited from SoImageVizEngineOutput< SoSFImageAnalysisResult, SoImageAnalysisResult * >
	SoImageVizEngineOutput ()
	Constructor.
virtual	~SoImageVizEngineOutput ()
	Destructor.
SoImageAnalysisResult *	getValue () const
	Return the cached output value.
void	setValue (SoImageAnalysisResult * value)
	Set the cached output value.
Public Member Functions inherited from SoEngineOutput
SoType	getConnectionType () const
	Returns the type of field this output can connect to.
int	getForwardConnections (SoFieldList &list) const
	Returns the number of fields this output is writing to, and adds references to those fields to the given list.
void	enable (SbBool flag)
	Enables or disables all connections from this output.
SbBool	isEnabled () const
	Returns TRUE if this output is currently enabled.
SoEngine *	getContainer () const
	Returns containing engine.
int	getNumConnections () const
	Number of connections this output currently has.

Detailed Description

template<typename AnalysisResultType>
class SoImageVizEngineAnalysisOutput< AnalysisResultType >

Image Processing output class to convert SoImageAnalysisResult to result details.

This class is similar to SoImageVizEngineOutput but provide a methods to get back the detailed values of an image analysis as an object that contains a member for each specific value.

Detailed object are retrieved using the getDetail() method.

Definition at line 49 of file SoImageVizEngineAnalysisOutput.h.

Constructor & Destructor Documentation

SoImageVizEngineAnalysisOutput()

template<typename AnalysisResultType >

SoImageVizEngineAnalysisOutput< AnalysisResultType >::SoImageVizEngineAnalysisOutput ( )

inline

Constructor.

Definition at line 53 of file SoImageVizEngineAnalysisOutput.h.

~SoImageVizEngineAnalysisOutput()

template<typename AnalysisResultType >

virtual SoImageVizEngineAnalysisOutput< AnalysisResultType >::~SoImageVizEngineAnalysisOutput ( )

inlinevirtual

Destructor.

Definition at line 57 of file SoImageVizEngineAnalysisOutput.h.

Member Function Documentation

getDetail()

template<typename AnalysisResultType >

AnalysisResultType SoImageVizEngineAnalysisOutput< AnalysisResultType >::getDetail ( size_t  index = 0 ) const

inline

Return index-th detail of the given image analysis output.

In general there is as many detail than there is slices in the analyzed image (or one detail with 3D input image). But some image analysis engine's output can generate multiple detail per slices (or per volume in 3D).

The requested index must be in the range 0..getNumDetails() if not an invalid range exception is thrown.

Definition at line 67 of file SoImageVizEngineAnalysisOutput.h.

getNumDetails()

template<typename AnalysisResultType >

size_t SoImageVizEngineAnalysisOutput< AnalysisResultType >::getNumDetails ( ) const

inline

Returns the number of details available in the image analysis output.

Definition at line 77 of file SoImageVizEngineAnalysisOutput.h.

---

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

• ImageViz/Engines/SoImageVizEngineAnalysisOutput.h