ITK
4.1.0
Insight Segmentation and Registration Toolkit
|
#include <itkRawImageIO.h>
Public Types | |
typedef ByteSwapper < ComponentType > | ByteSwapperType |
typedef PixelTraits< PixelType > ::ValueType | ComponentType |
typedef TPixel | PixelType |
typedef SmartPointer< Self > | Pointer |
typedef RawImageIO | Self |
typedef Superclass::SizeValueType | SizeValueType |
typedef ImageIOBase | Superclass |
Public Member Functions | |
virtual bool | CanReadFile (const char *) |
virtual bool | CanWriteFile (const char *) |
virtual ::itk::LightObject::Pointer | CreateAnother (void) const |
SizeValueType | GetHeaderSize () |
virtual const char * | GetNameOfClass () const |
virtual void | Read (void *buffer) |
virtual void | ReadHeader (const std::string=std::string()) |
virtual void | ReadImageInformation () |
void | SetHeaderSize (SizeValueType size) |
virtual bool | SupportsDimension (unsigned long dim) |
virtual void | Write (const void *buffer) |
virtual void | WriteImageInformation (void) |
virtual void | SetFileDimensionality (unsigned long _arg) |
virtual unsigned long | GetFileDimensionality () const |
virtual const unsigned short & | GetImageMask () |
void | SetImageMask (unsigned long val) |
Static Public Member Functions | |
static Pointer | New () |
Protected Member Functions | |
void | OpenFileForReading (std::ifstream &is) |
void | OpenFileForWriting (std::ofstream &os) |
void | PrintSelf (std::ostream &os, Indent indent) const |
RawImageIO () | |
~RawImageIO () | |
Private Member Functions | |
void | operator= (const Self &) |
RawImageIO (const Self &) | |
Private Attributes | |
unsigned long | m_FileDimensionality |
SizeValueType | m_HeaderSize |
unsigned short | m_ImageMask |
std::string | m_InternalFileName |
bool | m_ManualHeaderSize |
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, 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.)
Definition at line 48 of file itkRawImageIO.h.
typedef ByteSwapper< ComponentType > itk::RawImageIO< TPixel, VImageDimension >::ByteSwapperType |
Helper class to swap bytes when necessary
Definition at line 73 of file itkRawImageIO.h.
typedef PixelTraits< PixelType >::ValueType itk::RawImageIO< TPixel, VImageDimension >::ComponentType |
this type is used in case the pixel has several components
Definition at line 70 of file itkRawImageIO.h.
typedef TPixel itk::RawImageIO< TPixel, VImageDimension >::PixelType |
Pixel typedef support. Used to declare pixel type in filters or other operations.
Definition at line 60 of file itkRawImageIO.h.
typedef SmartPointer< Self > itk::RawImageIO< TPixel, VImageDimension >::Pointer |
Reimplemented from itk::ImageIOBase.
Definition at line 54 of file itkRawImageIO.h.
typedef RawImageIO itk::RawImageIO< TPixel, VImageDimension >::Self |
Standard class typedefs.
Reimplemented from itk::ImageIOBase.
Definition at line 52 of file itkRawImageIO.h.
typedef Superclass::SizeValueType itk::RawImageIO< TPixel, VImageDimension >::SizeValueType |
Type used for counting elements.
Reimplemented from itk::ImageIOBase.
Definition at line 67 of file itkRawImageIO.h.
typedef ImageIOBase itk::RawImageIO< TPixel, VImageDimension >::Superclass |
Reimplemented from itk::ImageIOBase.
Definition at line 53 of file itkRawImageIO.h.
itk::RawImageIO< TPixel, VImageDimension >::RawImageIO | ( | ) | [protected] |
itk::RawImageIO< TPixel, VImageDimension >::~RawImageIO | ( | ) | [protected] |
itk::RawImageIO< TPixel, VImageDimension >::RawImageIO | ( | const Self & | ) | [private] |
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 101 of file itkRawImageIO.h.
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.
virtual::itk::LightObject::Pointer itk::RawImageIO< TPixel, VImageDimension >::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 unsigned long itk::RawImageIO< TPixel, VImageDimension >::GetFileDimensionality | ( | ) | const [virtual] |
The number of dimensions stored in a file. Defaults to two. If two, each file contains one "slice". If three, each file will contain one "volume".
SizeValueType itk::RawImageIO< TPixel, VImageDimension >::GetHeaderSize | ( | ) |
virtual const unsigned short& itk::RawImageIO< TPixel, VImageDimension >::GetImageMask | ( | ) | [virtual] |
Set/Get the Data mask.
virtual const char* itk::RawImageIO< TPixel, VImageDimension >::GetNameOfClass | ( | ) | const [virtual] |
Run-time type information (and related methods).
Reimplemented from itk::ImageIOBase.
static Pointer itk::RawImageIO< TPixel, VImageDimension >::New | ( | ) | [static] |
Method for creation through the object factory.
Reimplemented from itk::LightProcessObject.
void itk::RawImageIO< TPixel, VImageDimension >::OpenFileForReading | ( | std::ifstream & | is | ) | [protected] |
void itk::RawImageIO< TPixel, VImageDimension >::OpenFileForWriting | ( | std::ofstream & | os | ) | [protected] |
void itk::RawImageIO< TPixel, VImageDimension >::operator= | ( | const Self & | ) | [private] |
This method causes the filter to generate its output.
Reimplemented from itk::ImageIOBase.
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::RawImageIO< TPixel, VImageDimension >::Read | ( | void * | buffer | ) | [virtual] |
Reads the data from disk into the memory buffer provided.
Implements itk::ImageIOBase.
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 121 of file itkRawImageIO.h.
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::RawImageIO< TPixel, VImageDimension >::SetFileDimensionality | ( | unsigned long | _arg | ) | [virtual] |
The number of dimensions stored in a file. Defaults to two. If two, each file contains one "slice". If three, each file will contain one "volume".
void itk::RawImageIO< TPixel, VImageDimension >::SetHeaderSize | ( | SizeValueType | size | ) |
If the data is in the tail end of the file, you want to explicitly set the header size.
void itk::RawImageIO< TPixel, VImageDimension >::SetImageMask | ( | unsigned long | val | ) | [inline] |
Set/Get the Data mask.
Definition at line 112 of file itkRawImageIO.h.
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 93 of file itkRawImageIO.h.
virtual void itk::RawImageIO< TPixel, VImageDimension >::Write | ( | const void * | buffer | ) | [virtual] |
Writes the data to disk from the memory buffer provided.
Implements itk::ImageIOBase.
virtual void itk::RawImageIO< TPixel, VImageDimension >::WriteImageInformation | ( | void | ) | [inline, virtual] |
Binary files have no image information to read.
Implements itk::ImageIOBase.
Definition at line 131 of file itkRawImageIO.h.
unsigned long itk::RawImageIO< TPixel, VImageDimension >::m_FileDimensionality [private] |
Definition at line 152 of file itkRawImageIO.h.
SizeValueType itk::RawImageIO< TPixel, VImageDimension >::m_HeaderSize [private] |
Definition at line 154 of file itkRawImageIO.h.
unsigned short itk::RawImageIO< TPixel, VImageDimension >::m_ImageMask [private] |
Definition at line 155 of file itkRawImageIO.h.
std::string itk::RawImageIO< TPixel, VImageDimension >::m_InternalFileName [private] |
Definition at line 150 of file itkRawImageIO.h.
bool itk::RawImageIO< TPixel, VImageDimension >::m_ManualHeaderSize [private] |
Definition at line 153 of file itkRawImageIO.h.