albaVMEOutput Class Reference

#include <albaVMEOutput.h>

Inheritance diagram for albaVMEOutput:

Collaboration diagram for albaVMEOutput:

Public Types
enum	VMEOUTPUT_WIDGET_ID { ID_FIRST = MINID , ID_LAST }

Public Member Functions
	albaVMEOutput ()
virtual	~albaVMEOutput ()
	albaAbstractTypeMacro (albaVMEOutput, albaObject)
albaVME *	GetVME () const
void	SetVME (albaVME *vme)
virtual void	Print (std::ostream &os, const int tabs=0)
void	GetPose (double &x, double &y, double &z, double &rx, double &ry, double &rz, albaTimeStamp t=-1) const
void	GetPose (double xyz[3], double rxyz[3], albaTimeStamp t=-1) const
virtual void	GetMatrix (albaMatrix &matrix, albaTimeStamp t=-1) const
albaMatrix *	GetMatrix () const
virtual albaTransformBase *	GetTransform () const
virtual void	SetTransform (albaTransformBase *trans)
void	GetAbsMatrix (albaMatrix &matrix, albaTimeStamp t=-1) const
albaMatrix *	GetAbsMatrix () const
virtual albaTransformBase *	GetAbsTransform () const
void	GetAbsPose (double &x, double &y, double &z, double &rx, double &ry, double &rz, albaTimeStamp t=-1) const
void	GetAbsPose (double xyz[3], double rxyz[3], albaTimeStamp t=-1) const
virtual const char *	GetDataType () const
virtual void	Update ()
void	GetTimeBounds (albaTimeStamp tbounds[2]) const
void	GetLocalTimeBounds (albaTimeStamp tbounds[2]) const
void	GetVME4DBounds (double bounds[6]) const
void	GetVME4DBounds (albaOBB &bounds) const
void	Get4DBounds (double bounds[6]) const
void	Get4DBounds (albaOBB &bounds) const
void	GetBounds (double bounds[6]) const
virtual void	GetBounds (albaOBB &bounds, albaTimeStamp t=-1, albaVMEIterator *iter=NULL) const
void	GetVMEBounds (double bounds[6]) const
virtual void	GetVMEBounds (albaOBB &bounds, albaTimeStamp t=-1, albaVMEIterator *iter=NULL) const
void	GetVMELocalBounds (double bounds[6]) const
virtual void	GetVMELocalBounds (albaOBB &bounds, albaTimeStamp t=-1, albaVMEIterator *iter=NULL) const
albaTimeStamp	GetTimeStamp () const
void	SetBounds (const albaOBB &bounds)
albaGUI *	GetGui ()
void	DeleteGui ()
Public Member Functions inherited from albaObject
	albaObject ()
virtual	~albaObject ()
virtual void	Delete ()
virtual const char *	GetTypeName () const
virtual bool	IsA (const char *type_name) const
virtual bool	IsA (const albaTypeID &type_id) const
virtual albaObject *	NewObjectInstance () const =0
virtual const albaTypeID &	GetTypeId () const
virtual void	Print (std::ostream &os, const int indent=0) const
	albaObject (const albaObject &c)

Protected Member Functions
virtual albaGUI *	CreateGui ()
virtual void	GetDataBounds (albaOBB &bounds, albaTimeStamp t) const

Protected Attributes
albaVME *	m_VME
albaString	m_DataType
albaOBB	m_Bounds
albaGUI *	m_Gui
albaAutoPointer< albaTransformBase >	m_Transform
Protected Attributes inherited from albaObject
bool	m_HeapFlag

Additional Inherited Members
Static Public Member Functions inherited from albaObject
static const char *	GetStaticTypeName ()
static bool	IsStaticType (const char *type_name)
static bool	IsStaticType (const albaTypeID &type_id)
static const albaTypeID &	GetStaticTypeId ()
static albaObject *	SafeDownCast (albaObject *o)

Detailed Description

albaVMEOutput - the output data structure of a VME node.

albaVMEOutput is the output produced by a VME node.

Todo:

• add a GetITKMesh
• add a GetITKImage
• try to remove the restore of old data_pipe timestamp inside GetDataBounds()

Definition at line 55 of file albaVMEOutput.h.

Member Enumeration Documentation

VMEOUTPUT_WIDGET_ID

enum albaVMEOutput::VMEOUTPUT_WIDGET_ID

IDs for the GUI.

Enumerator
ID_FIRST
ID_LAST

Definition at line 172 of file albaVMEOutput.h.

Constructor & Destructor Documentation

albaVMEOutput()

albaVMEOutput::albaVMEOutput

(

)

~albaVMEOutput()

virtual albaVMEOutput::~albaVMEOutput ( )

virtual

Member Function Documentation

albaAbstractTypeMacro()

albaVMEOutput::albaAbstractTypeMacro	(	albaVMEOutput	,
		albaObject
	)

GetVME()

albaVME * albaVMEOutput::GetVME ( ) const

inline

return the VME connected to this object

Definition at line 64 of file albaVMEOutput.h.

SetVME()

void albaVMEOutput::SetVME ( albaVME *  vme )

inline

internally used to set the VME connected to this object

Definition at line 67 of file albaVMEOutput.h.

Print()

virtual void albaVMEOutput::Print ( std::ostream &  os, const int  tabs = 0  )

virtual

print a dump of this object

GetPose() [1/2]

void albaVMEOutput::GetPose	(	double &	x,
		double &	y,
		double &	z,
		double &	rx,
		double &	ry,
		double &	rz,
		albaTimeStamp	t = -1
	)		const

Return the VME pose, this function queries the MatrixPipe for producing a matrix.

GetPose() [2/2]

void albaVMEOutput::GetPose	(	double	xyz[3],
		double	rxyz[3],
		albaTimeStamp	t = -1
	)		const

Return the VME pose.

GetMatrix() [1/2]

virtual void albaVMEOutput::GetMatrix ( albaMatrix &  matrix, albaTimeStamp  t = -1  ) const

virtual

Return the VME pose.

GetMatrix() [2/2]

albaMatrix * albaVMEOutput::GetMatrix

(

)

const

Return the VME pose matrix for the current time.

GetTransform()

virtual albaTransformBase * albaVMEOutput::GetTransform ( ) const

virtual

Return the transform generating the pose matrix of the VME.

SetTransform()

virtual void albaVMEOutput::SetTransform ( albaTransformBase *  trans )

virtual

Used by source VME to set internal pointer to Transform: do not use this method directly, use instead albaVME::SetMatrix()

GetAbsMatrix() [1/2]

void albaVMEOutput::GetAbsMatrix	(	albaMatrix &	matrix,
		albaTimeStamp	t = -1
	)		const

Get the global pose matrix of this VME for the given time "t".

GetAbsMatrix() [2/2]

albaMatrix * albaVMEOutput::GetAbsMatrix

(

)

const

Get the global pose matrix of this VME for the given time "t".

GetAbsTransform()

virtual albaTransformBase * albaVMEOutput::GetAbsTransform ( ) const

virtual

return the transform representing the Abs pose (typically the VME's AbsMatrix pipe)

GetAbsPose() [1/2]

void albaVMEOutput::GetAbsPose	(	double &	x,
		double &	y,
		double &	z,
		double &	rx,
		double &	ry,
		double &	rz,
		albaTimeStamp	t = -1
	)		const

Get the global pose of this VME for the given time "t".

GetAbsPose() [2/2]

void albaVMEOutput::GetAbsPose	(	double	xyz[3],
		double	rxyz[3],
		albaTimeStamp	t = -1
	)		const

Get the global pose of this VME for the given time "t".

GetDataType()

virtual const char * albaVMEOutput::GetDataType ( ) const

inlinevirtual

Return the DataType to be produced as output.

This can be used to avoid calling update for checking about data type directly in the output dataset and thus without actually loading the data from file.

Definition at line 116 of file albaVMEOutput.h.

Update()

virtual void albaVMEOutput::Update ( )

virtual

Update all the output data structures (data, bounds, matrix and abs matrix).

GetTimeBounds()

void albaVMEOutput::GetTimeBounds

(

albaTimeStamp

tbounds[2]

)

const

Return the TimeBounds of the whole subtree, i.e recurse the GetLocalTimeBounds() function over all the VME in the subtree.

GetLocalTimeBounds()

void albaVMEOutput::GetLocalTimeBounds

(

albaTimeStamp

tbounds[2]

)

const

Get TimeBounds for this VME.

TimeBounds interval is defined by the minimum and maximum time stamps against the MatrixVector and VMEItems time stamps. If only the pose time stamps are required use the albaMatrixVector::GetTimeBounds() function. For the time bounds of the VME items only use the albaVMEGenericAbstract::GetItemsTimesList()

GetVME4DBounds() [1/2]

void albaVMEOutput::GetVME4DBounds

(

double

bounds[6]

)

const

Extract the 4D bounds for this VME only, i.e.

the space bounds along all the time range for this VME.

GetVME4DBounds() [2/2]

void albaVMEOutput::GetVME4DBounds

(

albaOBB &

bounds

)

const

Get4DBounds() [1/2]

void albaVMEOutput::Get4DBounds

(

double

bounds[6]

)

const

Extract the 4D bounds for all the subtree starting a this VME, i.e.

the space bounds along all the time for the VME in the subtree.

Get4DBounds() [2/2]

void albaVMEOutput::Get4DBounds

(

albaOBB &

bounds

)

const

GetBounds() [1/2]

void albaVMEOutput::GetBounds

(

double

bounds[6]

)

const

Return the space bound of the subtree for the current time, taking in consideration the current data bounds and the current pose matrix.

GetBounds() [2/2]

virtual void albaVMEOutput::GetBounds ( albaOBB &  bounds, albaTimeStamp  t = -1, albaVMEIterator *  iter = NULL  ) const

virtual

GetVMEBounds() [1/2]

void albaVMEOutput::GetVMEBounds

(

double

bounds[6]

)

const

Return the space bound of the VME (not the subtree) for the current time, taking in consideration the current data bounds and the current pose matrix.

GetVMEBounds() [2/2]

virtual void albaVMEOutput::GetVMEBounds ( albaOBB &  bounds, albaTimeStamp  t = -1, albaVMEIterator *  iter = NULL  ) const

virtual

GetVMELocalBounds() [1/2]

void albaVMEOutput::GetVMELocalBounds

(

double

bounds[6]

)

const

Return the local space bound (in local coordinates) of the VME (not the whole subtree) for the current time, taking in consideration the current data bounds and the current pose matrix.

GetVMELocalBounds() [2/2]

virtual void albaVMEOutput::GetVMELocalBounds ( albaOBB &  bounds, albaTimeStamp  t = -1, albaVMEIterator *  iter = NULL  ) const

virtual

GetTimeStamp()

albaTimeStamp albaVMEOutput::GetTimeStamp

(

)

const

return the time for which this output was computed

SetBounds()

void albaVMEOutput::SetBounds

(

const albaOBB &

bounds

)

Used by source VME to set internal bounds structure: never use this method directly.

GetGui()

albaGUI * albaVMEOutput::GetGui

(

)

create and return the GUI for changing the node parameters

DeleteGui()

void albaVMEOutput::DeleteGui

(

)

destroy the Gui

CreateGui()

virtual albaGUI * albaVMEOutput::CreateGui ( )

protectedvirtual

Internally used to create a new instance of the GUI.

This function should be overridden by subclasses to create specialized GUIs. Each subclass should append its own widgets and define the enum of IDs for the widgets as an extension of the superclass enum. The last id value must be defined as "LAST_ID" to allow the subclass to continue the ID enumeration from it. For appending the widgets in the same pannel GUI, each CreateGUI() function should first call the superclass' one.

GetDataBounds()

virtual void albaVMEOutput::GetDataBounds ( albaOBB &  bounds, albaTimeStamp  t  ) const

protectedvirtual

retrieve bounds of the output data not considering the VME pose matrix and the visibility.

Member Data Documentation

m_VME

albaVME* albaVMEOutput::m_VME

protected

pointer to source VME

Definition at line 197 of file albaVMEOutput.h.

m_DataType

albaString albaVMEOutput::m_DataType

protected

the type of data stored in object expressed as a string

Definition at line 198 of file albaVMEOutput.h.

m_Bounds

albaOBB albaVMEOutput::m_Bounds

protected

bounds of the output data (i.e. for current time)

Definition at line 199 of file albaVMEOutput.h.

m_Gui

albaGUI* albaVMEOutput::m_Gui

protected

user interface

Definition at line 200 of file albaVMEOutput.h.

m_Transform

albaAutoPointer<albaTransformBase> albaVMEOutput::m_Transform

protected

the transform generating the output pose matrix

Definition at line 202 of file albaVMEOutput.h.

---

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

• albaVMEOutput.h