#include <mitkItkImageIO.h>

Inheritance diagram for mitk::ItkImageIO:

[legend]

Collaboration diagram for mitk::ItkImageIO:

[legend]

Public Member Functions
	ItkImageIO (itk::ImageIOBase::Pointer imageIO)

	ItkImageIO (const CustomMimeType &mimeType, itk::ImageIOBase::Pointer imageIO, int rank)

std::vector< itk::SmartPointer< BaseData > >	Read () override
	Reads a path or stream and creates a list of BaseData objects. More...

ConfidenceLevel	GetReaderConfidenceLevel () const override

void	Write () override
	Write the base data to the specified location or output stream. More...

ConfidenceLevel	GetWriterConfidenceLevel () const 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

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< IFileReader >	RegisterService (us::ModuleContext *context=us::GetModuleContext())

void	UnregisterService ()

std::vector< std::string >	GetReadFiles () override

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 BaseData *	GetInput () 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< IFileWriter >	RegisterService (us::ModuleContext *context=us::GetModuleContext())

void	UnregisterService ()

Public Member Functions inherited from mitk::IFileWriter
	~IFileWriter () override

Protected Member Functions
virtual std::vector< std::string >	FixUpImageIOExtensions (const std::string &imageIOName)

virtual void	FixUpCustomMimeTypeName (const std::string &imageIOName, CustomMimeType &customMimeType)

virtual void	InitializeDefaultMetaDataKeys ()

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 CustomMimeType *	GetMimeType () 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< CustomMimeType >	RegisterMimeType (us::ModuleContext *context)

void	SetMimeType (const CustomMimeType &mimeType)

const CustomMimeType *	GetMimeType () 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)

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< CustomMimeType >	RegisterMimeType (us::ModuleContext *context)

void	SetMimeType (const CustomMimeType &mimeType)

const CustomMimeType *	GetMimeType () 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

Additional Inherited Members
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::Any >	Options
	Options for reading or writing data. More...

typedef mitk::MessageAbstractDelegate1< float >	ProgressCallback

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

This class wraps ITK image IO objects as mitk::IFileReader and mitk::IFileWriter objects.

Instantiating this class with a given itk::ImageIOBase instance will register corresponding MITK reader/writer services for that ITK ImageIO object.

Definition at line 30 of file mitkItkImageIO.h.

Constructor & Destructor Documentation

◆ ItkImageIO() [1/2]

mitk::ItkImageIO::ItkImageIO ( itk::ImageIOBase::Pointer imageIO )

Definition at line 113 of file mitkItkImageIO.cpp.

References mitk::CustomMimeType::AddExtension(), mitk::IOMimeTypes::DEFAULT_BASE_NAME(), FixUpCustomMimeTypeName(), FixUpImageIOExtensions(), mitk::CustomMimeType::GetExtensions(), InitializeDefaultMetaDataKeys(), MITK_DEBUG, mitkThrow, mitk::AbstractFileIO::RegisterService(), mitk::CustomMimeType::SetCategory(), mitk::AbstractFileReader::SetMimeType(), mitk::AbstractFileWriter::SetMimeType(), mitk::AbstractFileReader::SetMimeTypePrefix(), mitk::AbstractFileIO::SetReaderDescription(), and mitk::AbstractFileIO::SetWriterDescription().

Referenced by GetWriterConfidenceLevel().

◆ ItkImageIO() [2/2]

mitk::ItkImageIO::ItkImageIO	(	const CustomMimeType &	mimeType,
		itk::ImageIOBase::Pointer	imageIO,
		int	rank
	)

Definition at line 197 of file mitkItkImageIO.cpp.

References mitk::IOMimeTypes::DEFAULT_BASE_NAME(), InitializeDefaultMetaDataKeys(), mitkThrow, mitk::AbstractFileIO::RegisterService(), mitk::AbstractFileReader::SetMimeTypePrefix(), mitk::AbstractFileReader::SetRanking(), and mitk::AbstractFileWriter::SetRanking().

Member Function Documentation

◆ FixUpCustomMimeTypeName()

void mitk::ItkImageIO::FixUpCustomMimeTypeName	(	const std::string &	imageIOName,
		CustomMimeType &	customMimeType
	)

protectedvirtual

Definition at line 97 of file mitkItkImageIO.cpp.

References mitk::AbstractFileReader::GetMimeTypePrefix(), and mitk::CustomMimeType::SetName().

Referenced by ItkImageIO().

◆ FixUpImageIOExtensions()

std::vector< std::string > mitk::ItkImageIO::FixUpImageIOExtensions ( const std::string & imageIOName )

protectedvirtual

Definition at line 45 of file mitkItkImageIO.cpp.

References MITK_DEBUG.

Referenced by ItkImageIO().

◆ GetReaderConfidenceLevel()

AbstractFileIO::ConfidenceLevel mitk::ItkImageIO::GetReaderConfidenceLevel ( ) const

overridevirtual

Reimplemented from mitk::AbstractFileIO.

Definition at line 491 of file mitkItkImageIO.cpp.

References mitk::AbstractFileReader::GetLocalFileName(), mitk::IFileIO::Supported, and mitk::IFileIO::Unsupported.

◆ GetWriterConfidenceLevel()

AbstractFileIO::ConfidenceLevel mitk::ItkImageIO::GetWriterConfidenceLevel ( ) const

overridevirtual

Reimplemented from mitk::AbstractFileIO.

Definition at line 662 of file mitkItkImageIO.cpp.

References mitk::AbstractFileWriter::GetInput(), image, ItkImageIO(), mitk::IFileIO::PartiallySupported, mitk::IFileIO::Supported, and mitk::IFileIO::Unsupported.

◆ InitializeDefaultMetaDataKeys()

void mitk::ItkImageIO::InitializeDefaultMetaDataKeys ( )

protectedvirtual

Definition at line 691 of file mitkItkImageIO.cpp.

Referenced by ItkImageIO().

◆ Read()

std::vector< BaseData::Pointer > mitk::ItkImageIO::Read ( )

overridevirtual

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

This method must be implemented for each specific reader. Call GetInputStream() first and check for a non-null stream to read from. If the input stream is nullptr, use GetInputLocation() to read from a local file-system path.

If the reader cannot use streams directly, use GetLocalFileName() instead.

Returns: The created BaseData objects.

Exceptions

mitk::Exception

See also: GetLocalFileName(); IFileReader::Read()

Implements mitk::AbstractFileReader.

Definition at line 240 of file mitkItkImageIO.cpp.

References mitk::IPropertyPersistence::AddInfo(), mitk::PropertyPersistenceInfo::ANY_MIMETYPE_NAME(), mitk::ConvertMetaDataObjectToTimePointList(), mitk::BaseGeometry::GetCornerPoint(), mitk::BaseGeometry::GetIndexToWorldTransform(), mitk::IPropertyPersistence::GetInfoByKey(), mitk::AbstractFileReader::GetLocalFileName(), mitk::AbstractFileIO::GetMimeType(), mitk::CustomMimeType::GetName(), mitk::CoreServices::GetPropertyPersistence(), mitk::ProportionalTimeGeometry::GetStaticNameOfClass(), mitk::ArbitraryTimeGeometry::GetStaticNameOfClass(), image, info(), mitk::SlicedGeometry3D::InitializeEvenlySpaced(), mitk::MakePixelType(), mitk::Image::ManageMemory, MITK_ERROR, MITK_INFO, MITK_WARN, mitkThrow, mitk::PropertyPersistenceInfo::New(), mitk::ProportionalTimeGeometry::New(), mitk::ArbitraryTimeGeometry::New(), mitk::Image::New(), mbilog::replace, mitk::BaseGeometry::SetOrigin(), and mitk::BaseGeometry::SetSpacing().

◆ Write()

void mitk::ItkImageIO::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.

Definition at line 496 of file mitkItkImageIO.cpp.

References mitk::PixelType::GetComponentType(), mitk::AbstractFileWriter::LocalFile::GetFileName(), mitk::IPropertyPersistence::GetInfo(), mitk::AbstractFileWriter::GetInput(), mitk::AbstractFileIO::GetMimeType(), GetName(), mitk::PixelType::GetNumberOfComponents(), mitk::PixelType::GetPixelType(), mitk::CoreServices::GetPropertyPersistence(), mitk::ArbitraryTimeGeometry::GetStaticNameOfClass(), mitk::ArbitraryTimeGeometry::GetTimeBounds(), image, MITK_INFO, MITK_WARN, mitkThrow, mitk::PixelComponentUserType, mitk::PROPERTY_KEY_TIMEGEOMETRY_TIMEPOINTS, mitk::PROPERTY_KEY_TIMEGEOMETRY_TYPE, and mitk::BaseProperty::VALUE_CANNOT_BE_CONVERTED_TO_STRING.

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ItkImageIO() [1/2]

◆ ItkImageIO() [2/2]

Member Function Documentation

◆ FixUpCustomMimeTypeName()

◆ FixUpImageIOExtensions()

◆ GetReaderConfidenceLevel()

◆ GetWriterConfidenceLevel()

◆ InitializeDefaultMetaDataKeys()

◆ Read()

◆ Write()