#include <ImageReader.h>

Inheritance diagram for mirtk::ImageReader:

Collaboration diagram for mirtk::ImageReader:

Public Member Functions
virtual bool	CanRead (const char *) const =0
	Check if this reader can read a given image file.

	ImageReader ()
	Contructor.

virtual void	Initialize ()
	Open image file and read header information.

virtual void	Print () const
	Print image header information.

virtual BaseImage *	Run ()

virtual	~ImageReader ()
	Destructor.

Static Public Member Functions
static ImageReader *	New (const char *)

static ImageReader *	TryNew (const char *)

Protected Member Functions
virtual void	ReadHeader ()=0

Protected Member Functions inherited from mirtk::Cifstream
	Cifstream (const char *=NULL)
	Constructor.

void	Close ()
	Close file.

MIRTK_Common_DEPRECATED int	IsSwapped () const

MIRTK_Common_DEPRECATED void	IsSwapped (int)

void	Open (const char *)
	Open file.

bool	Read (char *, long, long)
	Read n data as array (possibly compressed) from offset.

bool	ReadAsChar (char *, long, long=-1)
	Read n data as array of char (possibly compressed) from offset.

bool	ReadAsDouble (double *, long, long=-1)
	Read n data as array of unsigned short (possibly compressed) from offset.

bool	ReadAsFloat (float *, long, long offset=-1)
	Read n data as array of short compressed) from offset.

bool	ReadAsInt (int *, long, long=-1)
	Read n data as array of short (possibly compressed) from offset.

bool	ReadAsShort (short *, long, long=-1)
	Read n data as array of short (possibly compressed) from offset.

bool	ReadAsString (char *, long, long=-1)
	Read n data as string (possibly compressed) from current position.

bool	ReadAsUChar (unsigned char *, long, long=-1)
	Read n data as array of unsigned char (possibly compressed) from offset.

bool	ReadAsUInt (unsigned int *, long, long=-1)
	Read n data as array of unsigned short (possibly compressed) from offset.

bool	ReadAsUShort (unsigned short *, long, long=-1)
	Read n data as array of unsigned short (possibly compressed) from offset.

void	Seek (long)
	Go to position in file.

long	Tell () const
	Current position in file.

	~Cifstream ()
	Destructor.

Protected Member Functions inherited from mirtk::Object
template<typename... Args>
void	Throw (ErrorType err, const char *func, Args... args) const

virtual const char *	NameOfClass () const =0
	Get name of class, which this object is an instance of.

virtual ParameterList	Parameter () const
	Get parameter name/value pairs.

bool	Parameter (const ParameterList &)
	Set parameters from name/value pairs.

virtual bool	Set (const char name, const char value)

virtual	~Object ()
	Destructor.

Protected Attributes
int	_ReflectX
	Flag whether to reflect X axis.

int	_ReflectY
	Flag whether to reflect Y axis.

int	_ReflectZ
	Flag whether to reflect Z axis.

int	_Start
	Start of image data.

Additional Inherited Members
Static Protected Member Functions inherited from mirtk::Object
template<typename... Args>
static void	ThrowStatic (ErrorType err, const char cls, const char func, Args... args)

static const char *	NameOfType ()
	Get name of this class type.

Detailed Description

Abstract base class for any general file to image filter.

This is the abstract base class which defines a common interface for all filters which take a filename (referrencing an image file) as input and produce an image as output. For each file format a derived class should be created. Each derived class has to implement abstract member functions ReadHeader() and CheckHeader().

Definition at line 40 of file ImageReader.h.

Member Function Documentation

§ New()

static ImageReader* mirtk::ImageReader::New ( const char * )

static

Static constructor. This constructor allocates a derived class which is then used to read the image file. This involves checking the file format of the file and dynamically allocating the corresonding derived class. The reader instance must be deleted by the caller.

§ ReadHeader()

virtual void mirtk::ImageReader::ReadHeader ( )

protectedpure virtual

Read header. This is an abstract function. Each derived class has to implement this function in order to initialize the read-only attributes of this class.

Implemented in mirtk::NiftiImageReader, mirtk::GIPLImageReader, and mirtk::PGMImageReader.

§ Run()

virtual BaseImage* mirtk::ImageReader::Run ( )

virtual

Read image from file

Returns: Newly read image. Must be deleted by caller.

§ TryNew()

static ImageReader* mirtk::ImageReader::TryNew ( const char * )

static

Static constructor. This constructor allocates a derived class which is then used to read the image file. This involves checking the file format of the file and dynamically allocating the corresonding derived class. The reader instance must be deleted by the caller.

Returns: Image reader instance or nullptr.

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

ImageReader.h

Public Member Functions

Static Public Member Functions

Protected Member Functions