ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
itk::MetaImageIO Class Reference

#include <itkMetaImageIO.h>

+ Inheritance diagram for itk::MetaImageIO:
+ Collaboration diagram for itk::MetaImageIO:

List of all members.

Public Types

typedef SmartPointer< SelfPointer
typedef MetaImageIO Self
typedef ImageIOBase Superclass

Public Member Functions

virtual bool CanReadFile (const char *)
virtual bool CanWriteFile (const char *)
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual ImageIORegion GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requested) const
virtual unsigned int GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
MetaImage * GetMetaImagePointer (void)
virtual const char * GetNameOfClass () const
virtual ImageIORegion GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
virtual void Read (void *buffer)
virtual void ReadImageInformation ()
virtual void SetDataFileName (const char *filename)
virtual void SetDoublePrecision (unsigned int precision)
virtual bool SupportsDimension (unsigned long)
virtual void Write (const void *buffer)
virtual void WriteImageInformation ()
virtual bool CanStreamRead ()
virtual bool CanStreamWrite ()

Static Public Member Functions

static Pointer New ()

Private Member Functions

 MetaImageIO (const Self &)
void operator= (const Self &)

Private Attributes

MetaImage m_MetaImage
unsigned int m_SubSamplingFactor
virtual void SetSubSamplingFactor (unsigned int _arg)
virtual unsigned int GetSubSamplingFactor () const
 MetaImageIO ()
 ~MetaImageIO ()
void PrintSelf (std::ostream &os, Indent indent) const

Detailed Description

Read MetaImage file format.

Definition at line 36 of file itkMetaImageIO.h.


Member Typedef Documentation

Reimplemented from itk::ImageIOBase.

Definition at line 42 of file itkMetaImageIO.h.

Standard class typedefs.

Reimplemented from itk::ImageIOBase.

Definition at line 40 of file itkMetaImageIO.h.

Reimplemented from itk::ImageIOBase.

Definition at line 41 of file itkMetaImageIO.h.


Constructor & Destructor Documentation

Determing the subsampling factor in case we want a coarse version of the image/

Warning:
this is only used when streaming is on.

Determing the subsampling factor in case we want a coarse version of the image/

Warning:
this is only used when streaming is on.
itk::MetaImageIO::MetaImageIO ( const Self ) [private]

Member Function Documentation

virtual bool itk::MetaImageIO::CanReadFile ( const char *  ) [virtual]

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

Implements itk::ImageIOBase.

virtual bool itk::MetaImageIO::CanStreamRead ( void  ) [inline, virtual]

Determine if the ImageIO can stream reading from this file. Only time cannot stream read/write is if compression is used. CanRead must be called prior to this function.

Reimplemented from itk::ImageIOBase.

Definition at line 120 of file itkMetaImageIO.h.

virtual bool itk::MetaImageIO::CanStreamWrite ( void  ) [inline, virtual]

Determine if the ImageIO can stream writing to this file. Only time cannot stream read/write is if compression is used. Assumes file passes a CanRead call and its pixels are of the same type as the template of the writer. Can verify by first calling CanRead and then CanStreamRead prior to calling CanStreamWrite.

Reimplemented from itk::ImageIOBase.

Definition at line 135 of file itkMetaImageIO.h.

virtual bool itk::MetaImageIO::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::MetaImageIO::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.

Method for supporting streaming. Given a requested region, calculate what could be the region that we can read from the file. This is called the streamable region, which will be smaller than the LargestPossibleRegion and greater or equal to the RequestedRegion

Reimplemented from itk::ImageIOBase.

virtual unsigned int itk::MetaImageIO::GetActualNumberOfSplitsForWriting ( unsigned int  numberOfRequestedSplits,
const ImageIORegion pasteRegion,
const ImageIORegion largestPossibleRegion 
) [virtual]

Before this method is called all the configuration will be done, that is Streaming/PasteRegion/Compression/Filename etc If pasting is being used the number of requested splits is for that region not the largest. The derived ImageIO class should verify that the file is capable of being writen with this configuration. If pasted is enabled and is not support or does not work with the file, then an excepetion should be thrown.

The default implementation depends on CanStreamWrite. If false then 1 is returned (unless pasting is indicated), so that the whole file will be updated in one region. If true then its assumed that any arbitrary region can be writen to any file. So the users request will be respected. If a derived class has more restictive conditions then they should be checked

Reimplemented from itk::ImageIOBase.

virtual const char* itk::MetaImageIO::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ImageIOBase.

virtual ImageIORegion itk::MetaImageIO::GetSplitRegionForWriting ( unsigned int  ithPiece,
unsigned int  numberOfActualSplits,
const ImageIORegion pasteRegion,
const ImageIORegion largestPossibleRegion 
) [virtual]

returns the ith IORegion

numberOfActualSplits should be the value returned from GetActualNumberOfSplitsForWriting with the same parameters

Derieved classes should overload this method to return a compatible region

Reimplemented from itk::ImageIOBase.

virtual unsigned int itk::MetaImageIO::GetSubSamplingFactor ( ) const [virtual]

Determing the subsampling factor in case we want a coarse version of the image/

Warning:
this is only used when streaming is on.
static Pointer itk::MetaImageIO::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::LightProcessObject.

void itk::MetaImageIO::operator= ( const Self ) [private]

This method causes the filter to generate its output.

Reimplemented from itk::ImageIOBase.

void itk::MetaImageIO::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

Determing the subsampling factor in case we want a coarse version of the image/

Warning:
this is only used when streaming is on.

Reimplemented from itk::ImageIOBase.

virtual void itk::MetaImageIO::Read ( void *  buffer) [virtual]

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

virtual void itk::MetaImageIO::ReadImageInformation ( ) [virtual]

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

virtual void itk::MetaImageIO::SetDataFileName ( const char *  filename) [virtual]

Set the filename for the Data file. Setting this will make the Writer to use the non-Local mode and save header and data in independent files

virtual void itk::MetaImageIO::SetDoublePrecision ( unsigned int  precision) [inline, virtual]

set the precision in the MetaImage member

Definition at line 94 of file itkMetaImageIO.h.

virtual void itk::MetaImageIO::SetSubSamplingFactor ( unsigned int  _arg) [virtual]

Determing the subsampling factor in case we want a coarse version of the image/

Warning:
this is only used when streaming is on.
virtual bool itk::MetaImageIO::SupportsDimension ( unsigned long  ) [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 55 of file itkMetaImageIO.h.

virtual void itk::MetaImageIO::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.

virtual void itk::MetaImageIO::WriteImageInformation ( ) [virtual]

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.


Member Data Documentation

MetaImage itk::MetaImageIO::m_MetaImage [private]

Definition at line 158 of file itkMetaImageIO.h.

unsigned int itk::MetaImageIO::m_SubSamplingFactor [private]

Definition at line 163 of file itkMetaImageIO.h.


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