TrackedImageSetImFusionFilePlugin Class Reference

#include <ImFusion/Base/TrackedImageSetImFusionFilePlugin.h>

Plugin for loading tracked image sets via ImFusion files. More...

Inheritance diagram for TrackedImageSetImFusionFilePlugin:

Detailed Description

Plugin for loading tracked image sets via ImFusion files.

Public Member Functions
Data *	loadInstance (unsigned int type, unsigned int headerSize) override
	Create TrackedSharedImageSet instance for correct data type or return null otherwise.
unsigned int	saveType (const Data *data) override
	Return corresponding type for saving an ultrasound sweep.
bool	load (unsigned int headerSize, Data *data, std::istream &file, Progress *p=0) override
	Load tracking sequences and further information from file.
bool	save (Data *data, std::ostream &file, Progress *p=0) override
	Save tracking sequences and other information to the file.
bool	loadCustomProperties (Data *data, Properties *prop) override
	Load custom properties as returned previously by customPropertiesToSave()
void	applyFlipToEnsureConsistency (Data *data) override
	Flips the calibration of the main tracking sequence, so that sweep is correct again.
Public Member Functions inherited from ImFusionFilePlugin
virtual	~ImFusionFilePlugin ()=default
	Destructor.
virtual std::unique_ptr< Properties >	customPropertiesToSave (Data *)
	Lets plugin save custom properties as part of the global file metadata.
virtual bool	beginBlockWrite (std::iostream &)
	Initialize plugin with current file pointer.
virtual unsigned long long	endBlockWrite ()
	Indicate to plugin that the block it is writing needs to be finished.
virtual bool	beginBlockRead (std::iostream &, unsigned long long)
	Initialize plugin with current file pointer.
virtual bool	endBlockRead ()
	Indicate to plugin that it will lose read access to the file pointer after this call.
virtual void	setBlockType (unsigned int type)
	Set the type of current data block which is being loaded/saved.

Protected Member Functions
bool	loadTrackingSequencesAndMeta (TrackedSharedImageSet *tsis, unsigned int headerSize, std::istream &file)
	Load tracking sequences and further information from file.
bool	saveTrackingSequencesAndMeta (TrackedSharedImageSet *tsis, std::ostream &file)
	Save tracking sequences and further information of tsis to file.

Protected Attributes
std::array< int, 10 >	m_iPars
	Integer meta information holding: 0 - number of TrackingSequence instances 1 - number of currently used TrackingSequence instance 2 - number of time stamps stored as part of the block (either size of image set or 0) 3 - 1 if time stamps are used, otherwise 0 4-9 - for free usage in derived classes.
std::array< double, 10 >	m_dPars
	Double meta information for free usage in derived classes.
Protected Attributes inherited from ImFusionFilePlugin
unsigned int	m_blockType = 0
	Keeps the type of currently saving/loading data block.

Member Function Documentation

loadInstance()

Data * loadInstance ( unsigned int type, unsigned int headerSize )

overridevirtual

Create TrackedSharedImageSet instance for correct data type or return null otherwise.

Implements ImFusionFilePlugin.

saveType()

unsigned int saveType ( const Data * data )

overridevirtual

Return corresponding type for saving an ultrasound sweep.

Implements ImFusionFilePlugin.

load()

bool load ( unsigned int headerSize, Data * data, std::istream & file, Progress * p = 0 )

overridevirtual

Load tracking sequences and further information from file.

Reimplemented from ImFusionFilePlugin.

save()

bool save ( Data * data, std::ostream & file, Progress * p = 0 )

overridevirtual

Save tracking sequences and other information to the file.

Reimplemented from ImFusionFilePlugin.

loadCustomProperties()

bool loadCustomProperties ( Data * data, Properties * prop )

overridevirtual

Load custom properties as returned previously by customPropertiesToSave()

Returns

true if successful, false otherwise

Reimplemented from ImFusionFilePlugin.

applyFlipToEnsureConsistency()

void applyFlipToEnsureConsistency ( Data * data )

overridevirtual

Flips the calibration of the main tracking sequence, so that sweep is correct again.

Reimplemented from ImFusionFilePlugin.

loadTrackingSequencesAndMeta()

bool loadTrackingSequencesAndMeta ( TrackedSharedImageSet * tsis, unsigned int headerSize, std::istream & file )

protected

Load tracking sequences and further information from file.

Stores the loaded streams in tsis, and saves the meta information in m_iPars and m_dPars. Returns true if loading was successful.

saveTrackingSequencesAndMeta()

bool saveTrackingSequencesAndMeta ( TrackedSharedImageSet * tsis, std::ostream & file )

protected

Save tracking sequences and further information of tsis to file.

Uses the last item of m_iPars (the first four are overridden) and all items of m_dPars, so make sure to set them to meaningful value for the desired data type, e.g. ultrasound geometry. Returns true if loading was successful.

---

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

• ImFusion/Base/TrackedImageSetImFusionFilePlugin.h