reads xml representations of mitk::PointSets from a file More...

#include <mitkPointSetReader.h>

Inheritance diagram for mitk::PointSetReader:

[legend]

Collaboration diagram for mitk::PointSetReader:

[legend]

Public Member Functions
	mitkClassMacro (PointSetReader, FileReader)

Pointer	Clone () const

virtual void	SetFileName (const char *_arg)
	Sets the filename of the file to be read. More...

virtual const char *	GetFileName () const
	Returns the filename of the point set xml-file. More...

virtual void	SetFilePrefix (const char *_arg)

virtual const char *	GetFilePrefix () const

virtual void	SetFilePattern (const char *_arg)

virtual const char *	GetFilePattern () const

bool	GetSuccess () const

Public Member Functions inherited from mitk::PointSetSource
virtual std::vector< std::string >	GetClassHierarchy () const override

virtual const char *	GetClassName () const

Pointer	Clone () const

OutputType *	GetOutput ()

const OutputType *	GetOutput () const

OutputType *	GetOutput (DataObjectPointerArraySizeType idx)

const OutputType *	GetOutput (DataObjectPointerArraySizeType idx) const

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

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

Public Member Functions inherited from mitk::BaseDataSource
OutputType *	GetOutput ()

const OutputType *	GetOutput () const

OutputType *	GetOutput (DataObjectPointerArraySizeType idx)

const OutputType *	GetOutput (DataObjectPointerArraySizeType idx) const

virtual void	GraftOutput (OutputType *output)
	Graft the specified BaseData onto this BaseDataSource's output. More...

virtual void	GraftOutput (const DataObjectIdentifierType &key, OutputType *output)

virtual void	GraftNthOutput (unsigned int idx, OutputType *output)
	Graft the specified base data object onto this BaseDataSource's idx'th output. More...

bool	Updating () const
	Access itk::ProcessObject::m_Updating. More...

Public Member Functions inherited from mitk::FileReader
virtual std::vector< std::string >	GetClassHierarchy () const

	itkTypeMacroNoParent (FileReader) virtual const char *GetFileName() const =0
	Get the specified the file to load. More...

virtual bool	CanReadFromMemory ()
	Specifies, whether the file reader also can read a file from a memory buffer. More...

virtual void	SetReadFromMemory (bool read)
	Set/Get functions to advise the file reader to use a memory array for reading a file. More...

virtual bool	GetReadFromMemory ()

virtual void	SetMemoryBuffer (const char *dataArray, unsigned int size)
	To be used along with a call of SetReadFromMemory(true). This sets the memory buffer and the size from which the reader will read. More...

Static Public Member Functions
static Pointer	New ()

static bool	CanReadFile (const std::string filename, const std::string filePrefix, const std::string filePattern)

Static Public Member Functions inherited from mitk::PointSetSource
static const char *	GetStaticNameOfClass ()

static Pointer	New ()

Static Public Member Functions inherited from mitk::BaseDataSource
static const char *	GetStaticNameOfClass ()

Static Public Member Functions inherited from mitk::FileReader
static const char *	GetStaticNameOfClass ()

Protected Member Functions
	PointSetReader ()

	~PointSetReader () override

void	GenerateData () override

virtual mitk::PointSet::Pointer	ReadPoint (mitk::PointSet::Pointer newPointSet, const tinyxml2::XMLElement *currentTimeSeries, unsigned int currentTimeStep)

void	GenerateOutputInformation () override

virtual void	ResizeOutputs (const unsigned int &num)

virtual int	CanReadFile (const char *name)

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

	~PointSetSource () override

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

	~BaseDataSource () override

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

virtual	~FileReader ()

Protected Attributes
std::string	m_FileName

std::string	m_FilePrefix

std::string	m_FilePattern

bool	m_Success

Protected Attributes inherited from mitk::FileReader
bool	m_CanReadFromMemory

bool	m_ReadFromMemory

const char *	m_MemoryBuffer

unsigned int	m_MemorySize

Additional Inherited Members
Public Types inherited from mitk::PointSetSource
typedef PointSetSource	Self

typedef BaseDataSource	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef PointSet	OutputType

typedef OutputType::Pointer	OutputTypePointer

Public Types inherited from mitk::BaseDataSource
typedef BaseDataSource	Self

typedef itk::ProcessObject	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef BaseData	OutputType

typedef itk::DataObject::DataObjectIdentifierType	DataObjectIdentifierType

Public Types inherited from mitk::FileReader
typedef FileReader	Self

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer	New ()

Detailed Description

reads xml representations of mitk::PointSets from a file

Reader for xml files containing one or multiple xml representations of mitk::PointSets. If multiple mitk::PointSets are stored in one file, these are assigned to multiple outputs of the filter. The number of point sets which have be read can be retrieven by a call to GetNumberOfOutputs() after the pipeline update(). The reader is able to read the old 3D Pointsets without the "specification" and "timeseries" tags and the new 4D Pointsets.

Note: loading point sets from multiple files according to a given file pattern is not yet supported!

Deprecated:: (as of 2014_10) Use mitk::IOUtils or mitk::FileReaderRegistry instead.

Definition at line 48 of file mitkPointSetReader.h.

Constructor & Destructor Documentation

◆ PointSetReader()

mitk::PointSetReader::PointSetReader ( )

protected

Constructor

◆ ~PointSetReader()

mitk::PointSetReader::~PointSetReader ( )

overrideprotected

Virtual destructor

Member Function Documentation

◆ CanReadFile() [1/2]

virtual int mitk::PointSetReader::CanReadFile ( const char * name )

protectedvirtual

Checks if the given file has appropriate read access.

Returns: true if the file exists and may be read or false otherwise.

◆ CanReadFile() [2/2]

static bool mitk::PointSetReader::CanReadFile	(	const std::string	filename,
		const std::string	filePrefix,
		const std::string	filePattern
	)

static

◆ Clone()

Pointer mitk::PointSetReader::Clone ( ) const

◆ GenerateData()

void mitk::PointSetReader::GenerateData ( )

overrideprotected

Actually reads the point sets from the given file

◆ GenerateOutputInformation()

void mitk::PointSetReader::GenerateOutputInformation ( )

overrideprotected

Does nothing in the current implementation

◆ GetFileName()

virtual const char* mitk::PointSetReader::GetFileName ( ) const

virtual

Returns the filename of the point set xml-file.

Returns: the filename of the point set xml-file.

◆ GetFilePattern()

virtual const char* mitk::PointSetReader::GetFilePattern ( ) const

virtual

Warning: multiple load not (yet) supported

Implements mitk::FileReader.

◆ GetFilePrefix()

virtual const char* mitk::PointSetReader::GetFilePrefix ( ) const

virtual

Warning: multiple load not (yet) supported

Implements mitk::FileReader.

◆ GetSuccess()

bool mitk::PointSetReader::GetSuccess ( ) const

Returns: whether the last read attempt was successful or not.

◆ mitkClassMacro()

mitk::PointSetReader::mitkClassMacro	(	PointSetReader	,
		FileReader
	)

◆ New()

static Pointer mitk::PointSetReader::New ( )

static

◆ ReadPoint()

virtual mitk::PointSet::Pointer mitk::PointSetReader::ReadPoint	(	mitk::PointSet::Pointer	newPointSet,
		const tinyxml2::XMLElement *	currentTimeSeries,
		unsigned int	currentTimeStep
	)

protectedvirtual

◆ ResizeOutputs()

virtual void mitk::PointSetReader::ResizeOutputs ( const unsigned int & num )

protectedvirtual

Resizes the output-objects according to the given number.

Parameters

num	the new number of output objects.

◆ SetFileName()

virtual void mitk::PointSetReader::SetFileName ( const char * _arg )

virtual

Sets the filename of the file to be read.

Parameters

_arg	the filename of the point set xml-file

Implements mitk::FileReader.

◆ SetFilePattern()

virtual void mitk::PointSetReader::SetFilePattern ( const char * _arg )

virtual

Warning: multiple load not (yet) supported

Implements mitk::FileReader.

◆ SetFilePrefix()

virtual void mitk::PointSetReader::SetFilePrefix ( const char * _arg )

virtual

Warning: multiple load not (yet) supported

Implements mitk::FileReader.

Member Data Documentation

◆ m_FileName

std::string mitk::PointSetReader::m_FileName

protected

Definition at line 135 of file mitkPointSetReader.h.

◆ m_FilePattern

std::string mitk::PointSetReader::m_FilePattern

protected

Definition at line 139 of file mitkPointSetReader.h.

◆ m_FilePrefix

std::string mitk::PointSetReader::m_FilePrefix

protected

Definition at line 137 of file mitkPointSetReader.h.

◆ m_Success

bool mitk::PointSetReader::m_Success

protected

Definition at line 141 of file mitkPointSetReader.h.

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

mitkPointSetReader.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PointSetReader()

◆ ~PointSetReader()

Member Function Documentation

◆ CanReadFile() [1/2]

◆ CanReadFile() [2/2]

◆ Clone()

◆ GenerateData()

◆ GenerateOutputInformation()

◆ GetFileName()

◆ GetFilePattern()

◆ GetFilePrefix()

◆ GetSuccess()

◆ mitkClassMacro()

◆ New()

◆ ReadPoint()

◆ ResizeOutputs()

◆ SetFileName()

◆ SetFilePattern()

◆ SetFilePrefix()

Member Data Documentation

◆ m_FileName

◆ m_FilePattern

◆ m_FilePrefix

◆ m_Success