This class records NavigationData objects into NavigationDataSets. More...

#include <mitkNavigationDataRecorder.h>

Inheritance diagram for mitk::NavigationDataRecorder:

Collaboration diagram for mitk::NavigationDataRecorder:

Public Member Functions
	mitkClassMacro (NavigationDataRecorder, NavigationDataToNavigationDataFilter)

Pointer	Clone () const

virtual bool	GetRecording ()
	Returns whether the NavigationDataRecorder is currently recording or not. More...

virtual mitk::NavigationDataSet::Pointer	GetNavigationDataSet ()
	Returns the set that contains all of the recorded data. More...

virtual void	SetRecordCountLimit (int _arg)
	Sets a limit of recorded data sets / frames. Recording will be stopped if the number is reached. values < 1 disable this behaviour. Default is -1. More...

virtual bool	GetStandardizeTime ()
	Returns whether to use the navigationdata's time stamp or to create a new one upon recording. More...

virtual void	SetStandardizeTime (bool _arg)
	If set to false, the navigationDatas Timestamp will be used. If set to false, the recorder will generate a timestamp when it copies the data to the navigationdataset. More...

virtual void	StartRecording ()
	Starts recording NavigationData into the NAvigationDataSet. More...

virtual void	StopRecording ()
	Stops StopsRecording to the NavigationDataSet. More...

virtual void	ResetRecording ()
	Resets the Datasets and the timestamp, so a new recording can happen. More...

virtual int	GetNumberOfRecordedSteps ()
	Returns the number of time steps that were recorded in the current set. Warning: This Method does NOT Stop Recording! More...

Public Member Functions inherited from mitk::NavigationDataToNavigationDataFilter
	mitkClassMacro (NavigationDataToNavigationDataFilter, NavigationDataSource)

virtual void	SetInput (const NavigationData *nd)
	Set the input of this filter. More...

virtual void	SetInput (unsigned int idx, const NavigationData *nd)
	Set input with id idx of this filter. More...

const NavigationData *	GetInput (void) const
	Get the input of this filter. More...

const NavigationData *	GetInput (unsigned int idx) const
	Get the input with id idx of this filter. More...

const NavigationData *	GetInput (std::string navDataName) const
	Get the input with name navDataName of this filter. More...

DataObjectPointerArraySizeType	GetInputIndex (std::string navDataName)
	return the index of the input with name navDataName, throw std::invalid_argument exception if that name was not found More...

virtual void	ConnectTo (mitk::NavigationDataSource *UpstreamFilter)
	Connects the input of this filter to the outputs of the given NavigationDataSource. More...

Public Member Functions inherited from mitk::NavigationDataSource
	mitkClassMacroItkParent (NavigationDataSource, itk::ProcessObject)

virtual std::string	GetName ()

virtual void	SetName (std::string _arg)
	Sets the human readable name of this source. There is also a default name, but you can use this method if you need to define it on your own. More...

NavigationData *	GetOutput (void)
	return the output (output with id 0) of the filter More...

NavigationData *	GetOutput (DataObjectPointerArraySizeType idx)
	return the output with id idx of the filter More...

NavigationData *	GetOutput (const std::string &navDataName)
	return the output with name navDataName of the filter More...

DataObjectPointerArraySizeType	GetOutputIndex (std::string navDataName)
	return the index of the output with name navDataName, -1 if no output with that name was found More...

virtual void	RegisterAsMicroservice ()
	Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice(). More...

virtual void	UnRegisterMicroservice ()
	Registers this object as a Microservice, making it available to every module and/or plugin. More...

std::string	GetMicroserviceID ()
	Returns the id that this device is registered with. The id will only be valid, if the NavigationDataSource has been registered using RegisterAsMicroservice(). More...

virtual void	GraftNthOutput (unsigned int idx, itk::DataObject *graft)
	Graft the specified DataObject onto this ProcessObject's output. More...

virtual void	GraftOutput (itk::DataObject *graft)
	Graft the specified DataObject onto this ProcessObject's output. More...

virtual itk::DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType idx) override

virtual itk::DataObject::Pointer	MakeOutput (const DataObjectIdentifierType &name) override

virtual void	SetParameters (const mitk::PropertyList *)
	Set all filter parameters as the PropertyList p. More...

virtual mitk::PropertyList::ConstPointer	GetParameters () const
	Get all filter parameters as a PropertyList. More...

virtual void	Freeze ()

virtual void	UnFreeze ()

virtual bool	GetIsFrozen ()

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
virtual void	GenerateData () override

	NavigationDataRecorder ()

virtual	~NavigationDataRecorder ()

Protected Member Functions inherited from mitk::NavigationDataToNavigationDataFilter
	NavigationDataToNavigationDataFilter ()

virtual	~NavigationDataToNavigationDataFilter ()

void	CreateOutputsForAllInputs ()
	Create an output for each input. More...

Protected Member Functions inherited from mitk::NavigationDataSource
	NavigationDataSource ()

virtual	~NavigationDataSource ()

Protected Attributes
unsigned int	m_NumberOfInputs
	counts the numbers of added input NavigationDatas More...

mitk::NavigationDataSet::Pointer	m_NavigationDataSet

bool	m_Recording
	indicates whether the recording is started or not More...

bool	m_StandardizeTime

bool	m_StandardizedTimeInitialized

int	m_RecordCountLimit
	limits the number of frames, recording will be stopped if the limit is reached. -1 disables the limit More...

Protected Attributes inherited from mitk::NavigationDataSource
std::string	m_Name

bool	m_IsFrozen

Additional Inherited Members
Static Public Attributes inherited from mitk::NavigationDataSource
static const std::string	US_INTERFACE_NAME
	These Constants are used in conjunction with Microservices. More...

static const std::string	US_PROPKEY_DEVICENAME

static const std::string	US_PROPKEY_ID

static const std::string	US_PROPKEY_ISACTIVE

Detailed Description

This class records NavigationData objects into NavigationDataSets.

Documentation The recording is started with the call of the method StartRecording(). Now every Update() stores the current state of the added NavigationDatas into the NavigationDataSet. With StopRecording() the stream is stopped, but can be resumed anytime. To start recording to a new NavigationDataSet, call ResetRecording();

Warning: Do not add inputs while the recorder ist recording. The recorder can't handle that and will cause a nullpointer exception.

Definition at line 38 of file mitkNavigationDataRecorder.h.

Constructor & Destructor Documentation

mitk::NavigationDataRecorder::NavigationDataRecorder ( )

protected

Definition at line 20 of file mitkNavigationDataRecorder.cpp.

References m_NumberOfInputs, m_RecordCountLimit, m_Recording, and m_StandardizedTimeInitialized.

mitk::NavigationDataRecorder::~NavigationDataRecorder ( )

protectedvirtual

Definition at line 29 of file mitkNavigationDataRecorder.cpp.

Member Function Documentation

Pointer mitk::NavigationDataRecorder::Clone ( ) const

void mitk::NavigationDataRecorder::GenerateData ( )

overrideprotectedvirtual

Definition at line 34 of file mitkNavigationDataRecorder.cpp.

References clone(), mitk::IGTTimeStamp::GetElapsed(), mitk::IGTTimeStamp::GetInstance(), and mitk::NavigationData::New().

virtual mitk::NavigationDataSet::Pointer mitk::NavigationDataRecorder::GetNavigationDataSet ( )

virtual

Returns the set that contains all of the recorded data.

int mitk::NavigationDataRecorder::GetNumberOfRecordedSteps ( )

virtual

Returns the number of time steps that were recorded in the current set. Warning: This Method does NOT Stop Recording!

Definition at line 112 of file mitkNavigationDataRecorder.cpp.

virtual bool mitk::NavigationDataRecorder::GetRecording ( )

virtual

Returns whether the NavigationDataRecorder is currently recording or not.

virtual bool mitk::NavigationDataRecorder::GetStandardizeTime ( )

virtual

Returns whether to use the navigationdata's time stamp or to create a new one upon recording.

mitk::NavigationDataRecorder::mitkClassMacro	(	NavigationDataRecorder	,
		NavigationDataToNavigationDataFilter
	)

static Pointer mitk::NavigationDataRecorder::New ( )

static

Referenced by main().

void mitk::NavigationDataRecorder::ResetRecording ( )

virtual

Resets the Datasets and the timestamp, so a new recording can happen.

Do not forget to save the old Dataset, it will be lost after calling this function.

Definition at line 101 of file mitkNavigationDataRecorder.cpp.

References mitk::IGTTimeStamp::GetInstance(), mitk::New(), mitk::IGTTimeStamp::Start(), and mitk::IGTTimeStamp::Stop().

virtual void mitk::NavigationDataRecorder::SetRecordCountLimit ( int _arg )

virtual

Sets a limit of recorded data sets / frames. Recording will be stopped if the number is reached. values < 1 disable this behaviour. Default is -1.

virtual void mitk::NavigationDataRecorder::SetStandardizeTime ( bool _arg )

virtual

If set to false, the navigationDatas Timestamp will be used. If set to false, the recorder will generate a timestamp when it copies the data to the navigationdataset.

void mitk::NavigationDataRecorder::StartRecording ( )

virtual

Starts recording NavigationData into the NAvigationDataSet.

Definition at line 73 of file mitkNavigationDataRecorder.cpp.

References mitk::IGTTimeStamp::GetInstance(), MITK_WARN, mitk::New(), and mitk::IGTTimeStamp::Start().

void mitk::NavigationDataRecorder::StopRecording ( )

virtual

Stops StopsRecording to the NavigationDataSet.

Recording can be resumed to the same Dataset by just calling StartRecording() again. Call ResetRecording() to start recording to a new Dataset;

Definition at line 91 of file mitkNavigationDataRecorder.cpp.