itk::RawImageIO< TPixel, VImageDimension > Class Template Reference
[Input and Output Filters]

#include <itkRawImageIO.h>

Inheritance diagram for itk::RawImageIO< TPixel, VImageDimension >:

[legend]Collaboration diagram for itk::RawImageIO< TPixel, VImageDimension >:

[legend]List of all members.

---

Detailed Description

template<class TPixel, unsigned int VImageDimension = 2>
class itk::RawImageIO< TPixel, VImageDimension >

Read and write raw binary images.

This class reads and writes 2D or 3D images. Because raw data has little useful information built into the format, so the user is responsible for specifying pixel type, dimensions, spacing, origin, header type, and so on. (Note: the pixel type and image dimension is defined via the template parameter.)

See also:

ImageFileReader

Definition at line 49 of file itkRawImageIO.h.

Public Types
enum	ByteOrder {   BigEndian,   LittleEndian,   OrderNotApplicable }
typedef ByteSwapper< ComponentType >	ByteSwapperType
typedef PixelTraits< PixelType >::ValueType	ComponentType
typedef SmartPointer< const Self >	ConstPointer
enum	FileType {   ASCII,   Binary,   TypeNotApplicable }
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 }
typedef TPixel	PixelType
typedef SmartPointer< Self >	Pointer
typedef RawImageIO	Self
typedef ImageIOBase	Superclass
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
Get the execution progress of a process object The progress is *a floating number	between (0, 1)
Set the execution progress of a process object The progress is *a floating number	between (0, 1)
virtual bool	CanReadFile (const char *)
virtual bool	CanStreamRead ()
virtual bool	CanStreamWrite ()
virtual bool	CanWriteFile (const char *)
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
These methods control whether the file is written binary or ASCII *Many file	formats (i.e., subclasses) ignore this flag.*/virtual void SetFileType(FileType _arg)
virtual const bool &	GetAbortGenerateData ()
virtual const ByteOrder &	GetByteOrder ()
std::string	GetByteOrderAsString (ByteOrder) const
Command *	GetCommand (unsigned long tag)
virtual const IOComponentType &	GetComponentType ()
std::string	GetComponentTypeAsString (IOComponentType) const
virtual const std::type_info &	GetComponentTypeInfo () const
bool	GetDebug () const
virtual unsigned int	GetDimensions (unsigned int i) const
Set Get the image dimensions in the etc directions *	GetDimensions () is typically used after reading the data
virtual std::vector< double >	GetDirection (unsigned int i) const
virtual unsigned long	GetFileDimensionality ()
virtual const char *	GetFileName () const
virtual const FileType &	GetFileType ()
std::string	GetFileTypeAsString (FileType) const
unsigned long	GetHeaderSize ()
Set Get the Data mask *virtual const unsigned short &	GetImageMask ()
unsigned int	GetImageSizeInBytes () const
unsigned int	GetImageSizeInComponents () const
unsigned int	GetImageSizeInPixels () const
virtual ImageIORegion	GetIORegion ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual const unsigned int &	GetNumberOfComponents ()
virtual unsigned int	GetNumberOfDimensions ()
virtual double	GetOrigin (unsigned int i) const
virtual unsigned int	GetPixelStride () const
virtual const IOPixelType &	GetPixelType ()
std::string	GetPixelTypeAsString (IOPixelType) const
meaning *the filter has completed execution *virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
virtual double	GetSpacing (unsigned int i) const
virtual const bool &	GetUseCompression ()
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Read (void *buffer)
virtual void	ReadHeader (const std::string=std::string())
virtual void	ReadImageInformation ()
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	SetAbortGenerateData (bool _arg)
void	SetByteOrderToBigEndian ()
void	SetByteOrderToLittleEndian ()
These methods indicate the byte ordering of the file you are *trying to read in These methods will then either swap or not *swap the bytes depending on the byte ordering of the machine it *is being run on For reading in a BigEndian file on a *BigEndian machine will result in no swapping Trying to read the *same file on a LittleEndian machine will result in swapping	SetByteOrderToLittleEndian () otherwise *SetByteOrderToBigEndian().Some ImageIOBase subclasses *ignore these methods.*/virtual void SetByteOrder(ByteOrder _arg)
Set Get the component type of the image This is always a native *type *virtual void	SetComponentType (IOComponentType _arg)
void	SetDebug (bool debugFlag) const
the *	SetDimensions () is used prior to writing the data.*/virtual void SetDimensions(unsigned int i
virtual void	SetDirection (unsigned int i, vnl_vector< double > &direction)
Set Get the image direction on an axis by axis basis The *	SetDirection () method is required when writing the image.*/virtual void SetDirection(unsigned int i
The number of dimensions stored in a file Defaults to two If *each file contains one slice If each file will contain one *volume *virtual void	SetFileDimensionality (unsigned long _arg)
Set Get the name of the file to be read *virtual void	SetFileName (const char *_arg)
void	SetFileTypeToASCII ()
void	SetFileTypeToBinary ()
If the data is in the tail end of the you want to *explicitly set the header size *void	SetHeaderSize (unsigned long size)
void	SetImageMask (unsigned long val)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
Set Get the number of components per pixel in the image This may *be set by the reading process For SCALAR pixel *NumberOfComponents will be For other pixel *NumberOfComponents will be greater than or equal to one *virtual void	SetNumberOfComponents (unsigned int _arg)
Set Get the number of independent rather the IORegion controls that *void	SetNumberOfDimensions (unsigned int)
Set Get the image origin on a axis by axis basis The	SetOrigin () method *is required when writing the image.*/virtual void SetOrigin(unsigned int i
Set Get the type of the pixel The PixelTypes provides context *to the IO mechanisms for data conversions PixelTypes can be INDEX If *the PIXELTYPE is then the NumberOfComponents should be *Anyother of PIXELTYPE will have more than one component *virtual void	SetPixelType (IOPixelType _arg)
virtual bool	SetPixelTypeInfo (const std::type_info &ptype)
meaning *the filter has completed execution *virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
Set Get the image spacing on an axis by axis basis The *	SetSpacing () method is required when writing the image.*/virtual void SetSpacing(unsigned int i
Set Get a boolean to use the compression or not *virtual void	SetUseCompression (bool _arg)
Specify the region of the image data to either read or *write The IORegion specifies the part of the image to read or *write Regions are defined with an index and a size vector These *vectors define the	start (lower-left corner) and length of the *region within the image.Make sure that the IORegion lies within *the image.*/virtual void SetIORegion(ImageIORegion _arg)
virtual bool	SupportsDimension (unsigned long dim)
virtual void	UnRegister () const
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)
Set Get the number of independent	variables (dimensions) in the *image being read or written.Note this is not necessarily what *is written
virtual void	Write (const void *buffer)
virtual void	WriteImageInformation (void)
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
Set Get the type of the pixel The PixelTypes provides context *to the IO mechanisms for data conversions PixelTypes can be	COVARIANTVECTOR
This is a global flag that controls whether any	debug
the *unsigned int	dim
Set Get the image direction on an axis by axis basis The *std::vector< double > &	direction
These methods indicate the byte ordering of the file you are *trying to read in These methods will then either swap or not *swap the bytes depending on the byte ordering of the machine it *is being run on For	example
If the data is in the tail end of the	file
These methods indicate the byte ordering of the file you are *trying to read in These methods will then either swap or not *swap the bytes depending on the byte ordering of the machine it *is being run on For reading in a BigEndian file on a *BigEndian machine will result in no swapping Trying to read the *same file on a LittleEndian machine will result in swapping *	Note: most UNIX machines are BigEndian while PC's and VAX's are * LittleEndian. So if the file you are reading in was generated on * a VAX or PC
Set Get the image origin on a axis by axis basis The double	origin
Set Get the type of the pixel The PixelTypes provides context *to the IO mechanisms for data conversions PixelTypes can be	POINT
Get the execution progress of a process object The progress is *a floating number meaning no	progress
Set the execution progress of a process object The progress is *a floating number meaning no	progress
Set Get the type of the pixel The PixelTypes provides context *to the IO mechanisms for data conversions PixelTypes can be	RGB
Set Get the type of the pixel The PixelTypes provides context *to the IO mechanisms for data conversions PixelTypes can be	RGBA
Set Get the type of the pixel The PixelTypes provides context *to the IO mechanisms for data conversions PixelTypes can be INDEX If *the PIXELTYPE is	SCALAR
Set Get the type of the pixel The PixelTypes provides context *to the IO mechanisms for data conversions PixelTypes can be *	SCALAR
Set Get the image spacing on an axis by axis basis The *double	spacing
The number of dimensions stored in a file Defaults to two If *each file contains one slice If	three
The number of dimensions stored in a file Defaults to two If	two
Set Get the number of components per pixel in the image This may *be set by the reading process For SCALAR pixel *NumberOfComponents will be For other pixel	types
Set Get the number of components per pixel in the image This may *be set by the reading process For SCALAR pixel	types
Set Get the type of the pixel The PixelTypes provides context *to the IO mechanisms for data conversions PixelTypes can be	VECTOR
Set Get the image dimensions in the	x
Set Get the image dimensions in the	y
Set Get the image dimensions in the	z
Protected Member Functions
void	ComputeStrides ()
virtual void	GenerateData ()
virtual unsigned int	GetComponentSize () const
unsigned int	GetComponentStride () const
virtual unsigned int	GetPixelSize () const
unsigned int	GetRowStride () const
unsigned int	GetSliceStride () const
void	OpenFileForReading (std::ifstream &is)
void	OpenFileForWriting (std::ofstream &os)
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	RawImageIO ()
void	ReadBufferAsASCII (std::istream &os, void *buffer, IOComponentType ctype, unsigned int numComp)
bool	ReadBufferAsBinary (std::istream &os, void *buffer, unsigned int numComp)
virtual void	Reset (const bool freeDynamic=true)
void	Resize (const unsigned int numDimensions, const unsigned int *dimensions)
void	WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentType ctype, unsigned int numComp)
	~RawImageIO ()
Protected Attributes
ByteOrder	m_ByteOrder
IOComponentType	m_ComponentType
std::vector< unsigned int >	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
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
std::vector< double >	m_Spacing
std::vector< unsigned int >	m_Strides
bool	m_UseCompression
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

template<class TPixel, unsigned int VImageDimension = 2> typedef ByteSwapper<ComponentType> itk::RawImageIO< TPixel, VImageDimension >::ByteSwapperType

Helper class to swap bytes when necessary Definition at line 71 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> typedef PixelTraits<PixelType>::ValueType itk::RawImageIO< TPixel, VImageDimension >::ComponentType

this type is used in case the pixel has several components Definition at line 68 of file itkRawImageIO.h.

typedef SmartPointer<const Self> itk::LightProcessObject::ConstPointer [inherited]

Reimplemented from itk::Object. Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::Statistics::BackPropagationLayer< TVector, TOutput >, itk::Statistics::BatchSupervisedTrainingFunction< TSample, TOutput, ScalarType >, itk::Statistics::CompletelyConnectedWeightSet< TVector, TOutput >, itk::Statistics::ErrorBackPropagationLearningFunctionBase< LayerType, TOutput >, itk::Statistics::ErrorBackPropagationLearningWithMomentum< LayerType, TOutput >, itk::Statistics::IterativeSupervisedTrainingFunction< TSample, TOutput, ScalarType >, itk::Statistics::LayerBase< TVector, TOutput >, itk::Statistics::LearningFunctionBase< LayerType, TOutput >, itk::Statistics::QuickPropLearningRule< LayerType, TOutput >, itk::Statistics::RBFBackPropagationLearningFunction< LayerType, TOutput >, itk::Statistics::RBFLayer< TVector, TOutput >, itk::Statistics::TrainingFunctionBase< TSample, TOutput, ScalarType >, itk::Statistics::WeightSetBase< TVector, TOutput >, itk::Statistics::SampleClassifier< TSample >, and itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >. Definition at line 78 of file itkLightProcessObject.h.

template<class TPixel, unsigned int VImageDimension = 2> typedef TPixel itk::RawImageIO< TPixel, VImageDimension >::PixelType

Pixel typedef support. Used to declare pixel type in filters or other operations. Definition at line 61 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> typedef SmartPointer<Self> itk::RawImageIO< TPixel, VImageDimension >::Pointer

Reimplemented from itk::ImageIOBase. Definition at line 55 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> typedef RawImageIO itk::RawImageIO< TPixel, VImageDimension >::Self

Standard class typedefs. Reimplemented from itk::ImageIOBase. Definition at line 53 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> typedef ImageIOBase itk::RawImageIO< TPixel, VImageDimension >::Superclass

Reimplemented from itk::ImageIOBase. Definition at line 54 of file itkRawImageIO.h.

---

Member Enumeration Documentation

enum itk::ImageIOBase::ByteOrder [inherited]

Enums used to specify byte order; whether Big Endian or Little Endian. Some subclasses use this, some ignore it. Enumeration values: BigEndian  LittleEndian  OrderNotApplicable  Definition at line 189 of file itkImageIOBase.h.

enum itk::ImageIOBase::FileType [inherited]

Enums used to specify write style: whether binary or ASCII. Some subclasses use this, some ignore it. Enumeration values: ASCII  Binary  TypeNotApplicable  Definition at line 185 of file itkImageIOBase.h.

enum itk::ImageIOBase::IOComponentType [inherited]

Enums used to manipulate the component type. The component type refers to the actual storage class associated with either a SCALAR pixel type or elements of a compound pixel. Enumeration values: UNKNOWNCOMPONENTTYPE  UCHAR  CHAR  USHORT  SHORT  UINT  INT  ULONG  LONG  FLOAT  DOUBLE  Definition at line 88 of file itkImageIOBase.h.

enum itk::ImageIOBase::IOPixelType [inherited]

Enums used to manipulate the pixel type. The pixel type provides context for automatic data conversions (for instance, RGB to SCALAR, VECTOR to SCALAR). Enumeration values: UNKNOWNPIXELTYPE  SCALAR  RGB  RGBA  OFFSET  VECTOR  POINT  COVARIANTVECTOR  SYMMETRICSECONDRANKTENSOR  DIFFUSIONTENSOR3D  COMPLEX  FIXEDARRAY  Definition at line 80 of file itkImageIOBase.h.

---

Constructor & Destructor Documentation

template<class TPixel, unsigned int VImageDimension = 2> itk::RawImageIO< TPixel, VImageDimension >::RawImageIO (   )  [protected]

template<class TPixel, unsigned int VImageDimension = 2> itk::RawImageIO< TPixel, VImageDimension >::~RawImageIO (   )  [protected]

---

Member Function Documentation

virtual void itk::LightProcessObject::AbortGenerateDataOff (   )  [virtual, inherited]

virtual void itk::LightProcessObject::AbortGenerateDataOn (   )  [virtual, inherited]

Turn on and off the AbortGenerateData flag.

Get the execution progress of a process object The progress is* a floating number itk::LightProcessObject::between (  0  , 1  )  [inherited]

Set the execution progress of a process object The progress is* a floating number itk::LightProcessObject::between (  0  , 1  )  [inherited]

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

template<class TPixel, unsigned int VImageDimension = 2> virtual bool itk::RawImageIO< TPixel, VImageDimension >::CanReadFile (  const char *   )  [inline, virtual]

Determine the file type. Returns true if this ImageIOBase can read the file specified. Always returns false because we don't want to use this reader unless absolutely sure (i.e., manual ImageIO creation). Implements itk::ImageIOBase. Definition at line 100 of file itkRawImageIO.h.

virtual bool itk::ImageIOBase::CanStreamRead (   )  [inline, virtual, inherited]

Determine if the ImageIO can stream reading from this file. Default is false. Definition at line 250 of file itkImageIOBase.h.

virtual bool itk::ImageIOBase::CanStreamWrite (   )  [inline, virtual, inherited]

Determine if the ImageIO can stream writing to this file. Default is false. Definition at line 268 of file itkImageIOBase.h.

template<class TPixel, unsigned int VImageDimension = 2> virtual bool itk::RawImageIO< TPixel, VImageDimension >::CanWriteFile (  const char *   )  [virtual]

Returns true if this ImageIO can write the specified file. False is only returned when the file name is not specified. Otherwise true is always returned. Implements itk::ImageIOBase.

void itk::ImageIOBase::ComputeStrides (   )  [protected, inherited]

Calculates the different strides (distance from one thing to the next). Upon return, strides[0] = bytes to get to the next component of a pixel, strides[1] = bytes to get to the next pixel in x direction, strides[2] = bytes to get to the next row in y direction, strides[3] = bytes to get to the next slice in z direction, etc.

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

These methods control whether the file is written binary or ASCII* Many file itk::ImageIOBase::formats (  i.  e., subclasses  )  [inherited]

virtual void itk::LightProcessObject::GenerateData (  void   )  [inline, protected, virtual, inherited]

This method causes the filter to generate its output. Reimplemented in itk::ClassifierBase< TDataContainer >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::Statistics::SampleClassifier< TSample >, itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >, itk::ClassifierBase< TInputImage >, and itk::ClassifierBase< TSample >. Definition at line 123 of file itkLightProcessObject.h.

virtual const bool& itk::LightProcessObject::GetAbortGenerateData (   )  [virtual, inherited]

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

virtual const ByteOrder& itk::ImageIOBase::GetByteOrder (   )  [virtual, inherited]

std::string itk::ImageIOBase::GetByteOrderAsString (  ByteOrder   )  const [inherited]

Convenience method returns the ByteOrder as a string. This can be used for writing output files.

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

virtual unsigned int itk::ImageIOBase::GetComponentSize (   )  const [protected, virtual, inherited]

Compute the size (in bytes) of the components of a pixel. For example, and RGB pixel of unsigned char would have a component size of 1 byte. This method can be invoked only after the component type is set. Reimplemented in itk::IPLCommonImageIO.

unsigned int itk::ImageIOBase::GetComponentStride (   )  const [protected, inherited]

Convenient method for accessing number of bytes to get to the next pixel component. Returns m_Strides[0].

virtual const IOComponentType& itk::ImageIOBase::GetComponentType (   )  [virtual, inherited]

std::string itk::ImageIOBase::GetComponentTypeAsString (  IOComponentType   )  const [inherited]

Convenience method returns the IOComponentType as a string. This can be used for writing output files.

virtual const std::type_info& itk::ImageIOBase::GetComponentTypeInfo (   )  const [virtual, inherited]

Reimplemented in itk::IPLCommonImageIO.

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

virtual unsigned int itk::ImageIOBase::GetDimensions (  unsigned int  i  )  const [inline, virtual, inherited]

Definition at line 102 of file itkImageIOBase.h.

Set Get the image dimensions in the etc directions* itk::ImageIOBase::GetDimensions (   )  [inherited]

virtual std::vector<double> itk::ImageIOBase::GetDirection (  unsigned int  i  )  const [inline, virtual, inherited]

Definition at line 124 of file itkImageIOBase.h.

template<class TPixel, unsigned int VImageDimension = 2> virtual unsigned long itk::RawImageIO< TPixel, VImageDimension >::GetFileDimensionality (   )  [virtual]

virtual const char* itk::ImageIOBase::GetFileName (   )  const [virtual, inherited]

virtual const FileType& itk::ImageIOBase::GetFileType (   )  [virtual, inherited]

std::string itk::ImageIOBase::GetFileTypeAsString (  FileType   )  const [inherited]

Convenience method returns the FileType as a string. This can be used for writing output files.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

template<class TPixel, unsigned int VImageDimension = 2> unsigned long itk::RawImageIO< TPixel, VImageDimension >::GetHeaderSize (   )

template<class TPixel, unsigned int VImageDimension = 2> Set Get the Data mask* virtual const unsigned short& itk::RawImageIO< TPixel, VImageDimension >::GetImageMask (   )  [virtual]

unsigned int itk::ImageIOBase::GetImageSizeInBytes (   )  const [inherited]

Return the number of bytes in the image.

unsigned int itk::ImageIOBase::GetImageSizeInComponents (   )  const [inherited]

Return the number of pixels times the number of components in the image.

unsigned int itk::ImageIOBase::GetImageSizeInPixels (   )  const [inherited]

Return the number of pixels in the image.

virtual ImageIORegion itk::ImageIOBase::GetIORegion (   )  [virtual, inherited]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

template<class TPixel, unsigned int VImageDimension = 2> virtual const char* itk::RawImageIO< TPixel, VImageDimension >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageIOBase.

virtual const unsigned int& itk::ImageIOBase::GetNumberOfComponents (   )  [virtual, inherited]

virtual unsigned int itk::ImageIOBase::GetNumberOfDimensions (   )  [virtual, inherited]

virtual double itk::ImageIOBase::GetOrigin (  unsigned int  i  )  const [inline, virtual, inherited]

Definition at line 109 of file itkImageIOBase.h.

virtual unsigned int itk::ImageIOBase::GetPixelSize (   )  const [protected, virtual, inherited]

Compute the size (in bytes) of the pixel. For example, and RGB pixel of unsigned char would have size 3 bytes.

virtual unsigned int itk::ImageIOBase::GetPixelStride (   )  const [virtual, inherited]

Convenient method for accessing the number of bytes to get to the next pixel. Returns m_Strides[1];

virtual const IOPixelType& itk::ImageIOBase::GetPixelType (   )  [virtual, inherited]

std::string itk::ImageIOBase::GetPixelTypeAsString (  IOPixelType   )  const [inherited]

Convenience method returns the IOPixelType as a string. This can be used for writing output files.

meaning* the filter has completed execution* virtual const float& itk::LightProcessObject::GetProgress (   )  [virtual, inherited]

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

unsigned int itk::ImageIOBase::GetRowStride (   )  const [protected, inherited]

Convenient method for accessing the number of bytes to get to the next row. Returns m_Strides[2].

unsigned int itk::ImageIOBase::GetSliceStride (   )  const [protected, inherited]

Convenient method for accessing the number of bytes to get to the next slice. Returns m_Strides[3].

virtual double itk::ImageIOBase::GetSpacing (  unsigned int  i  )  const [inline, virtual, inherited]

Definition at line 116 of file itkImageIOBase.h.

virtual const bool& itk::ImageIOBase::GetUseCompression (   )  [virtual, inherited]

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TPixel, unsigned int VImageDimension = 2> static Pointer itk::RawImageIO< TPixel, VImageDimension >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::LightProcessObject.

template<class TPixel, unsigned int VImageDimension = 2> void itk::RawImageIO< TPixel, VImageDimension >::OpenFileForReading (  std::ifstream &  is  )  [protected]

template<class TPixel, unsigned int VImageDimension = 2> void itk::RawImageIO< TPixel, VImageDimension >::OpenFileForWriting (  std::ofstream &  os  )  [protected]

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

template<class TPixel, unsigned int VImageDimension = 2> void itk::RawImageIO< TPixel, VImageDimension >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, 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::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::RawImageIO< TPixel, VImageDimension >::Read (  void *  buffer  )  [virtual]

Reads the data from disk into the memory buffer provided. Implements itk::ImageIOBase.

void itk::ImageIOBase::ReadBufferAsASCII (  std::istream &  os, void *  buffer, IOComponentType  ctype, unsigned int  numComp )  [protected, inherited]

Convenient method to read a buffer as ASCII text.

bool itk::ImageIOBase::ReadBufferAsBinary (  std::istream &  os, void *  buffer, unsigned int  numComp )  [protected, inherited]

Convenient method to read a buffer as binary. Return true on success.

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::RawImageIO< TPixel, VImageDimension >::ReadHeader (  const std::string  = std::string()  )  [inline, virtual]

Read a file's header to determine image dimensions, etc. Definition at line 122 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::RawImageIO< TPixel, VImageDimension >::ReadImageInformation (   )  [inline, virtual]

Binary files have no image information to read. This must be set by the user of the class. Implements itk::ImageIOBase. Definition at line 105 of file itkRawImageIO.h.

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

virtual void itk::ImageIOBase::Reset (  const bool  freeDynamic = true  )  [protected, virtual, inherited]

Return the object to an initialized state, ready to be used

void itk::ImageIOBase::Resize (  const unsigned int  numDimensions, const unsigned int *  dimensions )  [protected, inherited]

Resize the ImageIOBase object to new dimensions.

virtual void itk::LightProcessObject::SetAbortGenerateData (  bool  _arg  )  [virtual, inherited]

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

void itk::ImageIOBase::SetByteOrderToBigEndian (   )  [inline, inherited]

Definition at line 214 of file itkImageIOBase.h.

void itk::ImageIOBase::SetByteOrderToLittleEndian (   )  [inline, inherited]

Definition at line 216 of file itkImageIOBase.h.

These methods indicate the byte ordering of the file you are* trying to read in These methods will then either swap or not* swap the bytes depending on the byte ordering of the machine it* is being run on For reading in a BigEndian file on a* BigEndian machine will result in no swapping Trying to read the* same file on a LittleEndian machine will result in swapping itk::ImageIOBase::SetByteOrderToLittleEndian (   )  [inherited]

Set Get the component type of the image This is always a native* type* virtual void itk::ImageIOBase::SetComponentType (  IOComponentType  _arg  )  [virtual, inherited]

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

the* itk::ImageIOBase::SetDimensions (   )  [inherited]

virtual void itk::ImageIOBase::SetDirection (  unsigned int  i, vnl_vector< double > &  direction )  [virtual, inherited]

Set Get the image direction on an axis by axis basis The* itk::ImageIOBase::SetDirection (   )  [inherited]

template<class TPixel, unsigned int VImageDimension = 2> The number of dimensions stored in a file Defaults to two If * each file contains one slice If each file will contain one* volume* virtual void itk::RawImageIO< TPixel, VImageDimension >::SetFileDimensionality (  unsigned long  _arg  )  [virtual]

Set Get the name of the file to be read* virtual void itk::ImageIOBase::SetFileName (  const char *  _arg  )  [virtual, inherited]

void itk::ImageIOBase::SetFileTypeToASCII (   )  [inline, inherited]

Definition at line 195 of file itkImageIOBase.h.

void itk::ImageIOBase::SetFileTypeToBinary (   )  [inline, inherited]

Definition at line 197 of file itkImageIOBase.h.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<class TPixel, unsigned int VImageDimension = 2> If the data is in the tail end of the you want to* explicitly set the header size* void itk::RawImageIO< TPixel, VImageDimension >::SetHeaderSize (  unsigned long  size  )

template<class TPixel, unsigned int VImageDimension = 2> void itk::RawImageIO< TPixel, VImageDimension >::SetImageMask (  unsigned long  val  )  [inline]

Definition at line 113 of file itkRawImageIO.h.

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

Set Get the number of components per pixel in the image This may* be set by the reading process For SCALAR pixel * NumberOfComponents will be For other pixel * NumberOfComponents will be greater than or equal to one* virtual void itk::ImageIOBase::SetNumberOfComponents (  unsigned int  _arg  )  [virtual, inherited]

Set Get the number of independent rather the IORegion controls that* void itk::ImageIOBase::SetNumberOfDimensions (  unsigned  int  )  [inherited]

Set Get the image origin on a axis by axis basis The itk::ImageIOBase::SetOrigin (   )  [inherited]

Set Get the type of the pixel The PixelTypes provides context* to the IO mechanisms for data conversions PixelTypes can be INDEX If* the PIXELTYPE is then the NumberOfComponents should be* Anyother of PIXELTYPE will have more than one component* virtual void itk::ImageIOBase::SetPixelType (  IOPixelType  _arg  )  [virtual, inherited]

virtual bool itk::ImageIOBase::SetPixelTypeInfo (  const std::type_info &  ptype  )  [virtual, inherited]

SetPixelTypeInfo is used by writers to convert from an ITK strongly typed pixel to a ImageIO (weaker) typed pixel. This function sets these PixelType, ComponentType, and NumberOfComponents based on RTTI type_info structure passed in. The function returns false if the pixel type is not supported.

meaning* the filter has completed execution* virtual void itk::LightProcessObject::SetProgress (  float  _arg  )  [virtual, inherited]

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

Set Get the image spacing on an axis by axis basis The* itk::ImageIOBase::SetSpacing (   )  [inherited]

Set Get a boolean to use the compression or not* virtual void itk::ImageIOBase::SetUseCompression (  bool  _arg  )  [virtual, inherited]

Specify the region of the image data to either read or* write The IORegion specifies the part of the image to read or* write Regions are defined with an index and a size vector These* vectors define the itk::ImageIOBase::start (  lower-left  corner  )  [inherited]

template<class TPixel, unsigned int VImageDimension = 2> virtual bool itk::RawImageIO< TPixel, VImageDimension >::SupportsDimension (  unsigned long  dim  )  [inline, virtual]

The different types of ImageIO's can support data of varying dimensionality. For example, some file formats are strictly 2D while others can support 2D, 3D, or even n-D. This method returns true/false as to whether the ImageIO can support the dimension indicated. Reimplemented from itk::ImageIOBase. Definition at line 92 of file itkRawImageIO.h.

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

virtual void itk::LightProcessObject::UpdateOutputData (   )  [virtual, inherited]

Actually generate new output.

void itk::LightProcessObject::UpdateProgress (  float  amount  )  [inherited]

Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

Set Get the number of independent itk::ImageIOBase::variables (  dimensions   )  [inherited]

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::RawImageIO< TPixel, VImageDimension >::Write (  const void *  buffer  )  [virtual]

Writes the data to disk from the memory buffer provided. Implements itk::ImageIOBase.

void itk::ImageIOBase::WriteBufferAsASCII (  std::ostream &  os, const void *  buffer, IOComponentType  ctype, unsigned int  numComp )  [protected, inherited]

Convenient method to write a buffer as ASCII text.

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::RawImageIO< TPixel, VImageDimension >::WriteImageInformation (  void   )  [inline, virtual]

Binary files have no image information to read. Implements itk::ImageIOBase. Definition at line 132 of file itkRawImageIO.h.

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

Set Get the type of the pixel The PixelTypes provides context* to the IO mechanisms for data conversions PixelTypes can be itk::ImageIOBase::COVARIANTVECTOR [inherited]

Definition at line 135 of file itkImageIOBase.h.

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

the* unsigned int itk::ImageIOBase::dim [inherited]

Definition at line 101 of file itkImageIOBase.h.

Set Get the image direction on an axis by axis basis The* std::vector<double>& itk::ImageIOBase::direction [inherited]

Definition at line 122 of file itkImageIOBase.h.

These methods indicate the byte ordering of the file you are* trying to read in These methods will then either swap or not* swap the bytes depending on the byte ordering of the machine it* is being run on For itk::ImageIOBase::example [inherited]

Definition at line 204 of file itkImageIOBase.h.

template<class TPixel, unsigned int VImageDimension = 2> If the data is in the tail end of the itk::RawImageIO< TPixel, VImageDimension >::file

Definition at line 74 of file itkRawImageIO.h.

ByteOrder itk::ImageIOBase::m_ByteOrder [protected, inherited]

Big or Little Endian, and the type of the file. (May be ignored.) Definition at line 302 of file itkImageIOBase.h.

IOComponentType itk::ImageIOBase::m_ComponentType [protected, inherited]

Used internally to keep track of the type of the component. It is set when ComputeStrides() is invoked. Definition at line 299 of file itkImageIOBase.h.

std::vector<unsigned int> itk::ImageIOBase::m_Dimensions [protected, inherited]

The array which stores the number of pixels in the x, y, z directions. Definition at line 326 of file itkImageIOBase.h.

std::vector<std::vector<double> > itk::ImageIOBase::m_Direction [protected, inherited]

The arrays which store the direction cosines of the image. Definition at line 336 of file itkImageIOBase.h.

std::string itk::ImageIOBase::m_FileName [protected, inherited]

Filename to read Definition at line 309 of file itkImageIOBase.h.

FileType itk::ImageIOBase::m_FileType [protected, inherited]

Definition at line 303 of file itkImageIOBase.h.

bool itk::ImageIOBase::m_Initialized [protected, inherited]

Does the ImageIOBase object have enough info to be of use? Definition at line 306 of file itkImageIOBase.h.

ImageIORegion itk::ImageIOBase::m_IORegion [protected, inherited]

The region to read or write. The region contains information about the data within the region to read or write. Definition at line 323 of file itkImageIOBase.h.

unsigned int itk::ImageIOBase::m_NumberOfComponents [protected, inherited]

Stores the number of components per pixel. This will be 1 for grayscale images, 3 for RGBPixel images, and 4 for RGBPixelA images. Definition at line 313 of file itkImageIOBase.h.

unsigned int itk::ImageIOBase::m_NumberOfDimensions [protected, inherited]

The number of independent dimensions in the image. Definition at line 316 of file itkImageIOBase.h.

std::vector<double> itk::ImageIOBase::m_Origin [protected, inherited]

The array which stores the origin of the image. Definition at line 333 of file itkImageIOBase.h.

IOPixelType itk::ImageIOBase::m_PixelType [protected, inherited]

Used internally to keep track of the type of the pixel. Definition at line 295 of file itkImageIOBase.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

std::vector<double> itk::ImageIOBase::m_Spacing [protected, inherited]

The array which stores the spacing of pixels in the x, y, z directions. Definition at line 330 of file itkImageIOBase.h.

std::vector<unsigned int> itk::ImageIOBase::m_Strides [protected, inherited]

Stores the number of bytes it takes to get to the next 'thing' e.g. component, pixel, row, slice, etc. Definition at line 340 of file itkImageIOBase.h.

bool itk::ImageIOBase::m_UseCompression [protected, inherited]

Should we compress the data? Definition at line 319 of file itkImageIOBase.h.

These methods indicate the byte ordering of the file you are* trying to read in These methods will then either swap or not* swap the bytes depending on the byte ordering of the machine it* is being run on For reading in a BigEndian file on a* BigEndian machine will result in no swapping Trying to read the* same file on a LittleEndian machine will result in swapping* itk::ImageIOBase::Note [inherited]

Definition at line 204 of file itkImageIOBase.h.

Set Get the image origin on a axis by axis basis The double itk::ImageIOBase::origin [inherited]

Definition at line 108 of file itkImageIOBase.h.

Set Get the type of the pixel The PixelTypes provides context* to the IO mechanisms for data conversions PixelTypes can be itk::ImageIOBase::POINT [inherited]

Definition at line 135 of file itkImageIOBase.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

Get the execution progress of a process object The progress is* a floating number meaning no itk::LightProcessObject::progress [inherited]

Definition at line 104 of file itkLightProcessObject.h.

Set the execution progress of a process object The progress is* a floating number meaning no itk::LightProcessObject::progress [inherited]

Definition at line 98 of file itkLightProcessObject.h.

Set Get the type of the pixel The PixelTypes provides context* to the IO mechanisms for data conversions PixelTypes can be itk::ImageIOBase::RGB [inherited]

Definition at line 135 of file itkImageIOBase.h.

Set Get the type of the pixel The PixelTypes provides context* to the IO mechanisms for data conversions PixelTypes can be itk::ImageIOBase::RGBA [inherited]

Definition at line 135 of file itkImageIOBase.h.

Set Get the type of the pixel The PixelTypes provides context* to the IO mechanisms for data conversions PixelTypes can be INDEX If* the PIXELTYPE is itk::ImageIOBase::SCALAR [inherited]

Definition at line 135 of file itkImageIOBase.h.

Set Get the type of the pixel The PixelTypes provides context* to the IO mechanisms for data conversions PixelTypes can be* itk::ImageIOBase::SCALAR [inherited]

Definition at line 135 of file itkImageIOBase.h.

Set Get the image spacing on an axis by axis basis The* double itk::ImageIOBase::spacing [inherited]

Definition at line 115 of file itkImageIOBase.h.

template<class TPixel, unsigned int VImageDimension = 2> The number of dimensions stored in a file Defaults to two If * each file contains one slice If itk::RawImageIO< TPixel, VImageDimension >::three

Definition at line 80 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> The number of dimensions stored in a file Defaults to two If itk::RawImageIO< TPixel, VImageDimension >::two

Definition at line 80 of file itkRawImageIO.h.

Set Get the number of components per pixel in the image This may* be set by the reading process For SCALAR pixel * NumberOfComponents will be For other pixel itk::ImageIOBase::types [inherited]

Definition at line 163 of file itkImageIOBase.h.

Set Get the number of components per pixel in the image This may* be set by the reading process For SCALAR pixel itk::ImageIOBase::types [inherited]

Definition at line 163 of file itkImageIOBase.h.

Set Get the type of the pixel The PixelTypes provides context* to the IO mechanisms for data conversions PixelTypes can be itk::ImageIOBase::VECTOR [inherited]

Definition at line 135 of file itkImageIOBase.h.

Set Get the image dimensions in the itk::ImageIOBase::x [inherited]

Definition at line 95 of file itkImageIOBase.h.

Set Get the image dimensions in the itk::ImageIOBase::y [inherited]

Definition at line 95 of file itkImageIOBase.h.

Set Get the image dimensions in the itk::ImageIOBase::z [inherited]

Definition at line 95 of file itkImageIOBase.h.

---

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

• itkRawImageIO.h

---