Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
mitk::PlanarFigureIO Class Reference

#include <mitkPlanarFigureIO.h>

Inheritance diagram for mitk::PlanarFigureIO:
Collaboration diagram for mitk::PlanarFigureIO:

Public Types

typedef mitk::PlanarFigure InputType
 
- Public Types inherited from mitk::IFileIO
enum  ConfidenceLevel { Unsupported, PartiallySupported, Supported }
 A confidence level describing the confidence of the reader or writer in handling the given data. More...
 
typedef std::map< std::string, us::AnyOptions
 Options for reading or writing data. More...
 
typedef mitk::MessageAbstractDelegate1< float > ProgressCallback
 

Public Member Functions

 PlanarFigureIO ()
 
ConfidenceLevel GetReaderConfidenceLevel () const override
 
void Write () override
 Write the base data to the specified location or output stream. More...
 
ConfidenceLevel GetWriterConfidenceLevel () const override
 
std::vector< itk::SmartPointer< BaseData > > Read () override
 Reads a path or stream and creates a list of BaseData objects. More...
 
DataStorage::SetOfObjects::Pointer Read (mitk::DataStorage &ds) override
 
- Public Member Functions inherited from mitk::AbstractFileIO
Options GetReaderOptions () const
 
us::Any GetReaderOption (const std::string &name) const
 
void SetReaderOptions (const Options &options)
 
void SetReaderOption (const std::string &name, const us::Any &value)
 
Options GetWriterOptions () const
 
us::Any GetWriterOption (const std::string &name) const
 
void SetWriterOptions (const Options &options)
 
void SetWriterOption (const std::string &name, const us::Any &value)
 
std::pair< us::ServiceRegistration< IFileReader >, us::ServiceRegistration< IFileWriter > > RegisterService (us::ModuleContext *context=us::GetModuleContext())
 
- Public Member Functions inherited from mitk::AbstractFileIOReader
ConfidenceLevel GetConfidenceLevel () const override
 The confidence level of the reader or writer implementation. More...
 
- Public Member Functions inherited from mitk::AbstractFileReader
void SetInput (const std::string &location) override
 Set the input location. More...
 
void SetInput (const std::string &location, std::istream *is) override
 Set an input stream to read from. More...
 
std::string GetInputLocation () const override
 Get the current input location. More...
 
std::istream * GetInputStream () const override
 Get the input stream. More...
 
MimeType GetRegisteredMimeType () const
 
std::vector< itk::SmartPointer< BaseData > > Read () override
 Reads a path or stream and creates a list of BaseData objects. More...
 
DataStorage::SetOfObjects::Pointer Read (mitk::DataStorage &ds) override
 Reads the specified file or input stream, loading its contents into the provided DataStorage. More...
 
ConfidenceLevel GetConfidenceLevel () const override
 The confidence level of the reader or writer implementation. More...
 
Options GetOptions () const override
 returns a list of the supported options More...
 
us::Any GetOption (const std::string &name) const override
 
void SetOptions (const Options &options) override
 
void SetOption (const std::string &name, const us::Any &value) override
 
void AddProgressCallback (const ProgressCallback &callback) override
 
void RemoveProgressCallback (const ProgressCallback &callback) override
 
us::ServiceRegistration< IFileReaderRegisterService (us::ModuleContext *context=us::GetModuleContext())
 
void UnregisterService ()
 
std::vector< std::string > GetReadFiles () override
 
void SetProperties (const PropertyList *properties) override
 Optionally provide base data properties as a source of meta data. More...
 
- Public Member Functions inherited from mitk::IFileReader
 ~IFileReader () override
 
virtual ~IFileReader ()
 
- Public Member Functions inherited from mitk::IFileIO
virtual ~IFileIO ()
 
- Public Member Functions inherited from mitk::AbstractFileIOWriter
ConfidenceLevel GetConfidenceLevel () const override
 The confidence level of the reader or writer implementation. More...
 
- Public Member Functions inherited from mitk::AbstractFileWriter
void SetInput (const BaseData *data) override
 Set the input data for writing. More...
 
const BaseDataGetInput () const override
 Get the input data set via SetInput(). More...
 
void SetOutputLocation (const std::string &location) override
 Set the output location. More...
 
std::string GetOutputLocation () const override
 Get the current output location. More...
 
void SetOutputStream (const std::string &location, std::ostream *os) override
 Set an output stream for writing. More...
 
std::ostream * GetOutputStream () const override
 Get the output stream. More...
 
ConfidenceLevel GetConfidenceLevel () const override
 The confidence level of the reader or writer implementation. More...
 
MimeType GetRegisteredMimeType () const
 
Options GetOptions () const override
 returns a list of the supported options More...
 
us::Any GetOption (const std::string &name) const override
 
void SetOptions (const Options &options) override
 
void SetOption (const std::string &name, const us::Any &value) override
 
void AddProgressCallback (const ProgressCallback &callback) override
 
void RemoveProgressCallback (const ProgressCallback &callback) override
 
us::ServiceRegistration< IFileWriterRegisterService (us::ModuleContext *context=us::GetModuleContext())
 
void UnregisterService ()
 
- Public Member Functions inherited from mitk::IFileWriter
 ~IFileWriter () override
 

Protected Types

using DoubleList = std::list< double >
 

Protected Member Functions

std::vector< itk::SmartPointer< BaseData > > DoRead () override
 Reads a number of mitk::PlanarFigures from the file system. More...
 
DoubleList GetDoubleAttributeListFromXMLNode (const tinyxml2::XMLElement *e, const char *attributeNameBase, unsigned int count)
 parses the element for the attributes name0 to nameN, where "name" and the number of attributes to read are passed as argument. Returns a list of double vales. More...
 
- Protected Member Functions inherited from mitk::AbstractFileIO
 AbstractFileIO (const AbstractFileIO &other)
 
 AbstractFileIO (const std::string &baseDataType)
 
 AbstractFileIO (const std::string &baseDataType, const CustomMimeType &mimeType, const std::string &description)
 
void SetMimeType (const CustomMimeType &mimeType)
 
const CustomMimeTypeGetMimeType () const
 
void SetReaderDescription (const std::string &description)
 
std::string GetReaderDescription () const
 
void SetWriterDescription (const std::string &description)
 
std::string GetWriterDescription () const
 
void SetDefaultReaderOptions (const Options &defaultOptions)
 
Options GetDefaultReaderOptions () const
 
void SetDefaultWriterOptions (const Options &defaultOptions)
 
Options GetDefaultWriterOptions () const
 
void SetReaderRanking (int ranking)
 Set the service ranking for this file reader. More...
 
int GetReaderRanking () const
 
void SetWriterRanking (int ranking)
 
int GetWriterRanking () const
 
- Protected Member Functions inherited from mitk::AbstractFileIOReader
 AbstractFileIOReader ()
 
 AbstractFileIOReader (const CustomMimeType &mimeType, const std::string &description)
 
- Protected Member Functions inherited from mitk::AbstractFileReader
 AbstractFileReader ()
 
 ~AbstractFileReader () override
 
 AbstractFileReader (const AbstractFileReader &other)
 
 AbstractFileReader (const CustomMimeType &mimeType, const std::string &description)
 
virtual us::ServiceProperties GetServiceProperties () const
 
virtual us::ServiceRegistration< CustomMimeTypeRegisterMimeType (us::ModuleContext *context)
 
void SetMimeType (const CustomMimeType &mimeType)
 
const CustomMimeTypeGetMimeType () const
 
void SetMimeTypePrefix (const std::string &prefix)
 
std::string GetMimeTypePrefix () const
 
void SetDescription (const std::string &description)
 
std::string GetDescription () const
 
void SetDefaultOptions (const Options &defaultOptions)
 
Options GetDefaultOptions () const
 
void SetRanking (int ranking)
 Set the service ranking for this file reader. More...
 
int GetRanking () const
 
std::string GetLocalFileName () const
 Get a local file name for reading. More...
 
virtual void SetDefaultDataNodeProperties (DataNode *node, const std::string &filePath)
 
const PropertyListGetProperties () const override
 
- Protected Member Functions inherited from mitk::AbstractFileIOWriter
 AbstractFileIOWriter (const std::string &baseDataType)
 
 AbstractFileIOWriter (const std::string &baseDataType, const CustomMimeType &mimeType, const std::string &description)
 
- Protected Member Functions inherited from mitk::AbstractFileWriter
 ~AbstractFileWriter () override
 
 AbstractFileWriter (const AbstractFileWriter &other)
 
 AbstractFileWriter (const std::string &baseDataType)
 
 AbstractFileWriter (const std::string &baseDataType, const CustomMimeType &mimeType, const std::string &description)
 
virtual us::ServiceProperties GetServiceProperties () const
 
virtual us::ServiceRegistration< CustomMimeTypeRegisterMimeType (us::ModuleContext *context)
 
void SetMimeType (const CustomMimeType &mimeType)
 
const CustomMimeTypeGetMimeType () const
 
void SetMimeTypePrefix (const std::string &prefix)
 
std::string GetMimeTypePrefix () const
 
void SetDescription (const std::string &description)
 Sets a human readable description of this writer. More...
 
std::string GetDescription () const
 
void SetDefaultOptions (const Options &defaultOptions)
 
Options GetDefaultOptions () const
 
void SetRanking (int ranking)
 Set the service ranking for this file writer. More...
 
int GetRanking () const
 
void SetBaseDataType (const std::string &baseDataType)
 Sets the name of the mitk::Basedata that this writer is able to handle. More...
 
virtual std::string GetBaseDataType () const
 
void ValidateOutputLocation () const
 

Static Protected Member Functions

static mitk::Vector3D GetVectorFromXMLNode (const tinyxml2::XMLElement *e)
 parses the element for the attributes x,y,z and returns a mitk::Vector3D filled with these values More...
 
static mitk::Point3D GetPointFromXMLNode (const tinyxml2::XMLElement *e)
 parses the element for the attributes x,y,z and returns a mitk::Point3D filled with these values More...
 
static tinyxml2::XMLElement * CreateXMLVectorElement (tinyxml2::XMLDocument &doc, const char *name, itk::FixedArray< mitk::ScalarType, 3 > v)
 creates a TinyXML element that contains x, y, and z values More...
 

Additional Inherited Members

- Static Public Member Functions inherited from mitk::IFileIO
static std::string PROP_DESCRIPTION ()
 Service property name for a description. More...
 
static std::string PROP_MIMETYPE ()
 Service property name for the mime-type associated with this file writer. More...
 
- Static Public Member Functions inherited from mitk::IFileWriter
static std::string PROP_BASEDATA_TYPE ()
 Service property name for the supported mitk::BaseData sub-class. More...
 
- Protected Attributes inherited from mitk::AbstractFileReader
std::vector< std::string > m_ReadFiles
 

Detailed Description

Reads/Writes a PlanarFigure to a file

Definition at line 31 of file mitkPlanarFigureIO.h.

Member Typedef Documentation

◆ DoubleList

using mitk::PlanarFigureIO::DoubleList = std::list<double>
protected

Definition at line 57 of file mitkPlanarFigureIO.h.

◆ InputType

Constructor & Destructor Documentation

◆ PlanarFigureIO()

mitk::PlanarFigureIO::PlanarFigureIO ( )

Member Function Documentation

◆ CreateXMLVectorElement()

static tinyxml2::XMLElement* mitk::PlanarFigureIO::CreateXMLVectorElement ( tinyxml2::XMLDocument &  doc,
const char *  name,
itk::FixedArray< mitk::ScalarType, 3 >  v 
)
staticprotected

creates a TinyXML element that contains x, y, and z values

Documentation

Parameters
[in]doc
[in]namethe name of the XML element
[in]vthe vector or point that contains the x, y and z values
Returns
returns a XML element named name and three attributes x, y and z.

◆ DoRead()

std::vector<itk::SmartPointer<BaseData> > mitk::PlanarFigureIO::DoRead ( )
overrideprotectedvirtual

Reads a number of mitk::PlanarFigures from the file system.

Returns
a vector of mitk::PlanarFigures
Exceptions
throwsan mitk::Exception if an error occurs during parsing the nrrd header

Implements mitk::AbstractFileReader.

◆ GetDoubleAttributeListFromXMLNode()

DoubleList mitk::PlanarFigureIO::GetDoubleAttributeListFromXMLNode ( const tinyxml2::XMLElement *  e,
const char *  attributeNameBase,
unsigned int  count 
)
protected

parses the element for the attributes name0 to nameN, where "name" and the number of attributes to read are passed as argument. Returns a list of double vales.

Parameters
[in]ethe XML element that will be parsed
[in]attributeNameBasethe basic name of the parameters
[in]countthe number of parameters
Returns
returns a mitk::Point3D with the values x,y,z

◆ GetPointFromXMLNode()

static mitk::Point3D mitk::PlanarFigureIO::GetPointFromXMLNode ( const tinyxml2::XMLElement *  e)
staticprotected

parses the element for the attributes x,y,z and returns a mitk::Point3D filled with these values

Parameters
[in]ethe XML element that will be parsed
Returns
returns a mitk::Point3D with the values x,y,z

◆ GetReaderConfidenceLevel()

ConfidenceLevel mitk::PlanarFigureIO::GetReaderConfidenceLevel ( ) const
overridevirtual

Reimplemented from mitk::AbstractFileIO.

◆ GetVectorFromXMLNode()

static mitk::Vector3D mitk::PlanarFigureIO::GetVectorFromXMLNode ( const tinyxml2::XMLElement *  e)
staticprotected

parses the element for the attributes x,y,z and returns a mitk::Vector3D filled with these values

Parameters
[in]ethe XML element that will be parsed
Returns
returns a mitk::Vector3D with the values x,y,z

◆ GetWriterConfidenceLevel()

ConfidenceLevel mitk::PlanarFigureIO::GetWriterConfidenceLevel ( ) const
overridevirtual

Reimplemented from mitk::AbstractFileIO.

◆ Read() [1/2]

std::vector<itk::SmartPointer<BaseData> > mitk::AbstractFileReader::Read
override

Reads a path or stream and creates a list of BaseData objects.

The default implementation of this method (1) calls DoRead() (Implement the specific reader operation there) and (2) it adds general meta information about the loading process.

◆ Read() [2/2]

DataStorage::SetOfObjects::Pointer mitk::AbstractFileReader::Read
override

◆ Write()

void mitk::PlanarFigureIO::Write ( )
overridevirtual

Write the base data to the specified location or output stream.

This method must be implemented for each specific writer. Call GetOutputStream() first and check for a non-null stream to write to. If the output stream is nullptr, use GetOutputLocation() to write to a local file-system path.

If the reader cannot use streams directly, use GetLocalFile() to retrieve a temporary local file name instead.

Exceptions
mitk::Exception
See also
GetLocalFile()
IFileWriter::Write()

Implements mitk::AbstractFileWriter.


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