#include <itkBMPImageIO.h>

Inheritance diagram for itk::BMPImageIO:

Collaboration diagram for itk::BMPImageIO:

Public Types
typedef SmartPointer< Self >	Pointer
typedef RGBPixel< unsigned char >	RGBPixelType
typedef BMPImageIO	Self
typedef ImageIOBase	Superclass
Public Types inherited from itk::ImageIOBase
typedef std::vector< std::string >	ArrayOfExtensionsType
typedef ::itk::OffsetValueType	BufferSizeType
enum	ByteOrder { BigEndian, LittleEndian, OrderNotApplicable }
enum	FileType { ASCII, Binary, TypeNotApplicable }
typedef ::itk::IndexValueType	IndexValueType
enum	IOComponentType { UNKNOWNCOMPONENTTYPE, UCHAR, CHAR, USHORT, SHORT, UINT, INT, ULONG, LONG, FLOAT, DOUBLE }
enum	IOPixelType { UNKNOWNPIXELTYPE, SCALAR, RGB, RGBA, OFFSET, VECTOR, POINT, COVARIANTVECTOR, SYMMETRICSECONDRANKTENSOR, DIFFUSIONTENSOR3D, COMPLEX, FIXEDARRAY, MATRIX }
typedef ::itk::intmax_t	SizeType
typedef ::itk::SizeValueType	SizeValueType
Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const Self >	ConstPointer
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
	BMPImageIO ()
virtual bool	CanReadFile (const char *)
virtual bool	CanWriteFile (const char *)
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	Read (void *buffer)
virtual void	ReadImageInformation ()
virtual void	Write (const void *buffer)
virtual void	WriteImageInformation ()
	~BMPImageIO ()
Public Member Functions inherited from itk::ImageIOBase
virtual bool	CanStreamRead ()
virtual bool	CanStreamWrite ()
virtual ImageIORegion	GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requested) const
virtual unsigned int	GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
std::string	GetByteOrderAsString (ByteOrder) const
virtual unsigned int	GetComponentSize () const
virtual IOComponentType	GetComponentType () const
virtual const std::type_info &	GetComponentTypeInfo () const
virtual std::vector< double >	GetDefaultDirection (unsigned int i) const
virtual unsigned int	GetDimensions (unsigned int i) const
virtual std::vector< double >	GetDirection (unsigned int i) const
std::string	GetFileTypeAsString (FileType) const
SizeType	GetImageSizeInBytes () const
SizeType	GetImageSizeInComponents () const
SizeType	GetImageSizeInPixels () const
virtual unsigned int	GetNumberOfDimensions () const
virtual double	GetOrigin (unsigned int i) const
virtual SizeType	GetPixelStride () const
virtual double	GetSpacing (unsigned int i) const
virtual ImageIORegion	GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
const ArrayOfExtensionsType &	GetSupportedReadExtensions () const
const ArrayOfExtensionsType &	GetSupportedWriteExtensions () const
void	SetByteOrderToLittleEndian ()
virtual void	SetComponentType (const IOComponentType _arg)
virtual void	SetDirection (unsigned int i, std::vector< double > &direction)
virtual void	SetDirection (unsigned int i, vnl_vector< double > &direction)
void	SetFileTypeToBinary ()
void	SetNumberOfDimensions (unsigned int)
virtual void	SetOrigin (unsigned int i, double origin)
template<class TPixel , unsigned VLength>
void	SetPixelTypeInfo (const SymmetricSecondRankTensor< TPixel, VLength > *)
template<typename TPixel >
void	SetPixelTypeInfo (const DiffusionTensor3D< TPixel > *)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const Matrix< TPixel, VLength, VLength > *)
template<typename TPixel >
void	SetPixelTypeInfo (const std::complex< TPixel > *)
template<unsigned VLength>
void	SetPixelTypeInfo (const Offset< VLength > *)
virtual void	SetSpacing (unsigned int i, double spacing)
template<typename TPixel >
void	SetTypeInfo (const TPixel *)
virtual bool	SupportsDimension (unsigned long dim)
virtual void	SetFileName (const char *_arg)
virtual const char *	GetFileName () const
virtual void	SetDimensions (unsigned int i, unsigned int dim)
virtual void	SetIORegion (ImageIORegion _arg)
virtual const ImageIORegion &	GetIORegion ()
virtual void	SetPixelType (const IOPixelType _arg)
virtual IOPixelType	GetPixelType () const
virtual void	SetNumberOfComponents (unsigned int _arg)
virtual const unsigned int &	GetNumberOfComponents ()
virtual void	SetUseCompression (bool _arg)
virtual bool	GetUseCompression () const
virtual void	UseCompressionOn ()
virtual void	UseCompressionOff ()
virtual void	SetUseStreamedReading (bool _arg)
virtual bool	GetUseStreamedReading () const
virtual void	UseStreamedReadingOn ()
virtual void	UseStreamedReadingOff ()
virtual void	SetUseStreamedWriting (bool _arg)
virtual bool	GetUseStreamedWriting () const
virtual void	UseStreamedWritingOn ()
virtual void	UseStreamedWritingOff ()
virtual void	SetFileType (const FileType _arg)
virtual FileType	GetFileType () const
void	SetFileTypeToASCII ()
virtual void	SetByteOrder (const ByteOrder _arg)
virtual ByteOrder	GetByteOrder () const
void	SetByteOrderToBigEndian ()
template<typename TPixel >
void	SetPixelTypeInfo (const TPixel *)
template<typename TPixel >
void	SetPixelTypeInfo (const RGBPixel< TPixel > *)
template<typename TPixel >
void	SetPixelTypeInfo (const RGBAPixel< TPixel > *)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const Vector< TPixel, VLength > *)
template<typename TPixel >
void	SetPixelTypeInfo (const VariableLengthVector< TPixel > *)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const CovariantVector< TPixel, VLength > *)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const FixedArray< TPixel, VLength > *)
Public Member Functions inherited from itk::LightProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual const bool &	GetAbortGenerateData ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)
virtual void	SetProgress (float _arg)
virtual const float &	GetProgress ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::ImageIOBase
static std::string	GetComponentTypeAsString (IOComponentType)
static IOComponentType	GetComponentTypeFromString (const std::string &typeString)
static std::string	GetPixelTypeAsString (IOPixelType)
static IOPixelType	GetPixelTypeFromString (const std::string &pixelString)

Private Member Functions
	BMPImageIO (const Self &)
void	operator= (const Self &)
void	SwapBytesIfNecessary (void *buffer, SizeValueType numberOfPixels)
void	Write16BitsInteger (unsigned short value)
void	Write32BitsInteger (unsigned int value)

Private Attributes
bool	m_Allow8BitBMP
long	m_BitMapOffset
long	m_BMPCompression
unsigned long	m_BMPDataSize
std::vector< RGBPixelType >	m_ColorPalette
unsigned int	m_ColorTableSize
short	m_Depth
bool	m_FileLowerLeft
std::ifstream	m_Ifstream
unsigned short	m_NumberOfColors
std::ofstream	m_Ofstream

Additional Inherited Members
Protected Member Functions inherited from itk::ImageIOBase
void	AddSupportedReadExtension (const char *extension)
void	AddSupportedWriteExtension (const char *extension)
void	ComputeStrides ()
virtual unsigned int	GetActualNumberOfSplitsForWritingCanStreamWrite (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion) const
SizeType	GetComponentStride () const
virtual unsigned int	GetPixelSize () const
SizeType	GetRowStride () const
SizeType	GetSliceStride () const
virtual ImageIORegion	GetSplitRegionForWritingCanStreamWrite (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion) const
	ImageIOBase ()
virtual void	ReadBufferAsASCII (std::istream &os, void *buffer, IOComponentType ctype, SizeType numberOfBytesToBeRead)
bool	ReadBufferAsBinary (std::istream &os, void *buffer, SizeType numberOfBytesToBeRead)
virtual void	Reset (const bool freeDynamic=true)
void	Resize (const unsigned int numDimensions, const unsigned int *dimensions)
virtual void	WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentType ctype, SizeType numberOfBytesToWrite)
	~ImageIOBase ()
Protected Member Functions inherited from itk::LightProcessObject
	LightProcessObject ()
	~LightProcessObject ()
virtual void	GenerateData ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()
Protected Attributes inherited from itk::ImageIOBase
ByteOrder	m_ByteOrder
IOComponentType	m_ComponentType
std::vector< SizeValueType >	m_Dimensions
std::vector< std::vector < double > >	m_Direction
std::string	m_FileName
FileType	m_FileType
bool	m_Initialized
ImageIORegion	m_IORegion
unsigned int	m_NumberOfComponents
unsigned int	m_NumberOfDimensions
std::vector< double >	m_Origin
IOPixelType	m_PixelType
std::vector< double >	m_Spacing
std::vector< SizeType >	m_Strides
bool	m_UseCompression
bool	m_UseStreamedReading
bool	m_UseStreamedWriting

Detailed Description

Read BMPImage file format.

Definition at line 37 of file itkBMPImageIO.h.

Member Typedef Documentation

typedef SmartPointer< Self > itk::BMPImageIO::Pointer

Reimplemented from itk::ImageIOBase.

Definition at line 43 of file itkBMPImageIO.h.

typedef RGBPixel< unsigned char > itk::BMPImageIO::RGBPixelType

Definition at line 44 of file itkBMPImageIO.h.

typedef BMPImageIO itk::BMPImageIO::Self

Standard class typedefs.

Reimplemented from itk::ImageIOBase.

Definition at line 41 of file itkBMPImageIO.h.

typedef ImageIOBase itk::BMPImageIO::Superclass

Reimplemented from itk::ImageIOBase.

Definition at line 42 of file itkBMPImageIO.h.

Constructor & Destructor Documentation

itk::BMPImageIO::BMPImageIO ( )

itk::BMPImageIO::~BMPImageIO ( )

itk::BMPImageIO::BMPImageIO ( const Self & )

private

Member Function Documentation

virtual bool itk::BMPImageIO::CanReadFile ( const char * )

virtual

Determine the file type. Returns true if this ImageIO can read the file specified.

Implements itk::ImageIOBase.

virtual bool itk::BMPImageIO::CanWriteFile ( const char * )

virtual

Determine the file type. Returns true if this ImageIO can write the file specified.

Implements itk::ImageIOBase.

virtual::itk::LightObject::Pointer itk::BMPImageIO::CreateAnother ( void ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightProcessObject.

virtual const char* itk::BMPImageIO::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageIOBase.

static Pointer itk::BMPImageIO::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::LightProcessObject.

void itk::BMPImageIO::operator= ( const Self & )

private

This method causes the filter to generate its output.

Reimplemented from itk::ImageIOBase.

void itk::BMPImageIO::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

virtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageIOBase.

virtual void itk::BMPImageIO::Read ( void * buffer )

virtual

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

virtual void itk::BMPImageIO::ReadImageInformation ( )

virtual

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

void itk::BMPImageIO::SwapBytesIfNecessary	(	void *	buffer,
		SizeValueType	numberOfPixels
	)

private

virtual void itk::BMPImageIO::Write ( const void * buffer )

virtual

Writes the data to disk from the memory buffer provided. Make sure that the IORegions has been set properly.

Implements itk::ImageIOBase.

void itk::BMPImageIO::Write16BitsInteger ( unsigned short value )

private

void itk::BMPImageIO::Write32BitsInteger ( unsigned int value )

private

This methods ensures that the endianness is respected

virtual void itk::BMPImageIO::WriteImageInformation ( )

virtual

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

Member Data Documentation

bool itk::BMPImageIO::m_Allow8BitBMP

private

Definition at line 97 of file itkBMPImageIO.h.

long itk::BMPImageIO::m_BitMapOffset

private

Definition at line 94 of file itkBMPImageIO.h.

long itk::BMPImageIO::m_BMPCompression

private

Definition at line 100 of file itkBMPImageIO.h.

unsigned long itk::BMPImageIO::m_BMPDataSize

private

Definition at line 101 of file itkBMPImageIO.h.

std::vector< RGBPixelType > itk::BMPImageIO::m_ColorPalette

private

Definition at line 102 of file itkBMPImageIO.h.

unsigned int itk::BMPImageIO::m_ColorTableSize

private

Definition at line 99 of file itkBMPImageIO.h.

short itk::BMPImageIO::m_Depth

private

Definition at line 96 of file itkBMPImageIO.h.

bool itk::BMPImageIO::m_FileLowerLeft

private

Definition at line 95 of file itkBMPImageIO.h.

std::ifstream itk::BMPImageIO::m_Ifstream

private

Definition at line 92 of file itkBMPImageIO.h.

unsigned short itk::BMPImageIO::m_NumberOfColors

private

Definition at line 98 of file itkBMPImageIO.h.

std::ofstream itk::BMPImageIO::m_Ofstream

private

Definition at line 93 of file itkBMPImageIO.h.

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

itkBMPImageIO.h

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation