Reader for raw (headerless) binary image files. More...

#include <mitkRawImageFileReader.h>

Inheritance diagram for mitk::RawImageFileReaderService:

[legend]

Collaboration diagram for mitk::RawImageFileReaderService:

[legend]

Public Types
enum	IOPixelType { UCHAR , SCHAR , USHORT , SSHORT , UINT , SINT , FLOAT , DOUBLE }
	Supported pixel types for raw image data. More...

enum	EndianityType { LITTLE , BIG }
	Byte order of the raw image data. More...

Public Types inherited from mitk::IFileIO
enum	ConfidenceLevel { Unsupported , PartiallySupported , Supported }
	A confidence level describing the reader's or writer's ability to handle the given data or file format. More...

typedef std::map< std::string, us::Any >	Options
	Options for reading or writing data. More...

typedef mitk::MessageAbstractDelegate1< float >	ProgressCallback
	Callback delegate type for progress reporting. More...

Public Member Functions
	RawImageFileReaderService ()
	Construct and register the raw image reader service. More...

Public Member Functions inherited from mitk::AbstractFileReader
void	SetInput (const std::string &location) override
	Set the input file path, clearing any previously set input stream. More...

void	SetInput (const std::string &location, std::istream *is) override
	Set an input stream and associated location label. More...

std::string	GetInputLocation () const override
	Get the current input location. More...

std::istream *	GetInputStream () const override
	Get the current input stream. More...

MimeType	GetRegisteredMimeType () const
	Get the mime-type that was registered for this reader. More...

std::vector< itk::SmartPointer< BaseData > >	Read () override
	Read data and create a list of BaseData objects. More...

DataStorage::SetOfObjects::Pointer	Read (mitk::DataStorage &ds) override
	Read data and add it to the given DataStorage. More...

ConfidenceLevel	GetConfidenceLevel () const override
	Determine confidence for reading the current input. More...

Options	GetOptions () const override
	Get the current option values. More...

us::Any	GetOption (const std::string &name) const override
	Get the value of a specific option. More...

void	SetOptions (const Options &options) override
	Set multiple options at once. More...

void	SetOption (const std::string &name, const us::Any &value) override
	Set a single option value. More...

void	AddProgressCallback (const ProgressCallback &callback) override
	Register a progress callback. More...

void	RemoveProgressCallback (const ProgressCallback &callback) override
	Remove a previously registered progress callback. More...

us::ServiceRegistration< IFileReader >	RegisterService (us::ModuleContext *context=us::GetModuleContext())
	Register this reader as a CppMicroServices service. More...

void	UnregisterService ()
	Unregister this reader from the CppMicroServices registry. More...

std::vector< std::string >	GetReadFiles () override
	Get the list of files consumed during the last Read() call. More...

void	SetProperties (const PropertyList *properties) override
	Set base data properties as a source of meta data for reading. More...

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

virtual	~IFileReader ()

Public Member Functions inherited from mitk::IFileIO
virtual	~IFileIO ()

Protected Member Functions
	RawImageFileReaderService (const RawImageFileReaderService &other)
	Copy constructor. More...

std::vector< itk::SmartPointer< BaseData > >	DoRead () override
	Read a raw binary image file based on the configured options. More...

Protected Member Functions inherited from mitk::AbstractFileReader
	AbstractFileReader ()
	Default constructor. More...

	~AbstractFileReader () override

	AbstractFileReader (const AbstractFileReader &other)
	Copy constructor. More...

	AbstractFileReader (const CustomMimeType &mimeType, const std::string &description)
	Associate this reader instance with the given MIME type. More...

virtual us::ServiceProperties	GetServiceProperties () const
	Get the service properties for registration. More...

virtual us::ServiceRegistration< CustomMimeType >	RegisterMimeType (us::ModuleContext *context)
	Register a new CustomMimeType service object. More...

void	SetMimeType (const CustomMimeType &mimeType)
	Set the MIME type this reader can handle. More...

const CustomMimeType *	GetMimeType () const
	Get the MIME type this reader can handle. More...

void	SetMimeTypePrefix (const std::string &prefix)
	Set the prefix used for auto-generated MIME type names. More...

std::string	GetMimeTypePrefix () const
	Get the current MIME type name prefix. More...

void	SetDescription (const std::string &description)
	Set the human-readable description of this reader. More...

std::string	GetDescription () const
	Get the human-readable description of this reader. More...

void	SetDefaultOptions (const Options &defaultOptions)
	Set the default options for this reader. More...

Options	GetDefaultOptions () const
	Get the default options for this reader. More...

void	SetRanking (int ranking)
	Set the service ranking for this file reader. More...

int	GetRanking () const
	Get the service ranking for this file reader. More...

std::string	GetLocalFileName () const
	Get a local file name for reading. More...

virtual void	SetDefaultDataNodeProperties (DataNode *node, const std::string &filePath)
	Set default properties on a DataNode after reading. More...

const PropertyList *	GetProperties () const override
	Get the properties set via SetProperties(). More...

Additional Inherited Members
Static Public Member Functions inherited from mitk::IFileIO
static std::string	PROP_DESCRIPTION ()
	Service property name for a human-readable description. More...

static std::string	PROP_MIMETYPE ()
	Service property name for the mime-type associated with this reader or writer. More...

Protected Attributes inherited from mitk::AbstractFileReader
std::vector< std::string >	m_ReadFiles
	List of files consumed during the last Read() call. Must be filled by DoRead(). More...

Detailed Description

Reader for raw (headerless) binary image files.

Reads raw image data where the user must specify the dimensionality (2D or 3D), the size along each dimension, the pixel type, and the byte order (endianness) via reader options. If these parameters are incorrect, the image will not open or the visualization will be incorrect.

See also: AbstractFileReader

Definition at line 30 of file mitkRawImageFileReader.h.

Member Enumeration Documentation

◆ EndianityType

enum mitk::RawImageFileReaderService::EndianityType

Byte order of the raw image data.

Enumerator
LITTLE
BIG

Definition at line 37 of file mitkRawImageFileReader.h.

◆ IOPixelType

enum mitk::RawImageFileReaderService::IOPixelType

Supported pixel types for raw image data.

Enumerator
UCHAR
SCHAR
USHORT
SSHORT
UINT
SINT
FLOAT
DOUBLE

Definition at line 34 of file mitkRawImageFileReader.h.

Constructor & Destructor Documentation

◆ RawImageFileReaderService() [1/2]

mitk::RawImageFileReaderService::RawImageFileReaderService ( )

Construct and register the raw image reader service.

Sets up default options for pixel type, dimensionality, endianness, and image dimensions.

◆ RawImageFileReaderService() [2/2]

mitk::RawImageFileReaderService::RawImageFileReaderService ( const RawImageFileReaderService & other )

protected

Copy constructor.

Member Function Documentation

◆ DoRead()

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

overrideprotectedvirtual

Read a raw binary image file based on the configured options.

Determines pixel type, dimensionality, endianness, and dimensions from the reader options, then delegates to TypedRead for the actual I/O.

Returns: A vector containing the read Image.

Implements mitk::AbstractFileReader.

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

mitkRawImageFileReader.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members