Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
mirtk::PGMImageReader Class Reference

#include <PGMImageReader.h>

Inheritance diagram for mirtk::PGMImageReader:
Inheritance graph
Collaboration diagram for mirtk::PGMImageReader:
Collaboration graph

Public Member Functions

virtual bool CanRead (const char *) const
 Check if this reader can read a given image file.
 
- Public Member Functions inherited from mirtk::ImageReader
 ImageReader ()
 Contructor.
 
virtual void Initialize ()
 Open image file and read header information.
 
virtual void Print () const
 Print image header information.
 
virtual BaseImageRun ()
 
virtual ~ImageReader ()
 Destructor.
 

Static Public Member Functions

static bool CheckHeader (const char *)
 Return whether file has correct header.
 
- Static Public Member Functions inherited from mirtk::ImageReader
static ImageReaderNew (const char *)
 
static ImageReaderTryNew (const char *)
 

Protected Member Functions

virtual void ReadHeader ()
 Read header of PGM file.
 
- 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.
 

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.
 
- Protected Attributes inherited from mirtk::ImageReader
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.
 

Detailed Description

Class for reading images in PGM file format.

This is a class which reads images in PGM file format and converts them into images. The PGM (portable graymap) file format is a file format for 2D images and is defined in pgm(1). At the moment only images in PGM raw file format are supported.

Definition at line 37 of file PGMImageReader.h.


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