ITK  4.10.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::PhilipsRECImageIO Class Reference
Data Processing Objects » Filters » Input and Output FiltersGroup IO » | Module ITKIOPhilipsREC

#include <itkPhilipsRECImageIO.h>

+ Inheritance diagram for itk::PhilipsRECImageIO:
+ Collaboration diagram for itk::PhilipsRECImageIO:

Detailed Description

Reads Philips REC/PAR image files.

Author
Don C. Bigler This class supports reading only and not writing.

Definition at line 54 of file itkPhilipsRECImageIO.h.

Public Types

typedef vnl_vector_fixed< double, 3 > AngulationMidSliceType
 
typedef VectorContainer< unsigned int, double > EchoTimesContainerType
 
typedef vnl_vector_fixed< float, 3 > FOVType
 
typedef VectorContainer< unsigned int, GradientBvalueType > GradientBvalueContainerType
 
typedef double GradientBvalueType
 
typedef VectorContainer< unsigned int, GradientDirectionType > GradientDirectionContainerType
 
typedef vnl_vector_fixed< double, 3 > GradientDirectionType
 
typedef VectorContainer< unsigned int, ImageTypeRescaleValuesType > ImageTypeRescaleValuesContainerType
 
typedef ImageTypeRescaleValuesContainerType::Pointer ImageTypeRescaleValuesContainerTypePtr
 
typedef vnl_vector_fixed< double, 3 > ImageTypeRescaleValuesType
 
typedef vnl_vector_fixed< int, 8 > ImageTypesType
 
typedef Superclass::IndexValueType IndexValueType
 
typedef VectorContainer< unsigned int, int > LabelTypesASLContainerType
 
typedef vnl_vector_fixed< double, 3 > OffCentreMidSliceType
 
typedef vnl_vector_fixed< float, 3 > PhaseEncodingVelocityType
 
typedef SmartPointer< Self > Pointer
 
typedef VectorContainer< unsigned int, double > RepetitionTimesContainerType
 
typedef VectorContainer< unsigned int, ImageTypeRescaleValuesContainerTypePtr > ScanningSequenceImageTypeRescaleValuesContainerType
 
typedef vnl_vector_fixed< int, 8 > ScanningSequencesType
 
typedef vnl_vector_fixed< int, 2 > ScanResolutionType
 
typedef PhilipsRECImageIO Self
 
typedef std::vector< IndexValueType > SliceIndexType
 
typedef ImageIOBase Superclass
 
typedef VectorContainer< unsigned int, double > TriggerTimesContainerType
 
- 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 SmartPointer< Self > Pointer
 
typedef ImageIOBase Self
 
typedef ::itk::intmax_t SizeType
 
typedef ::itk::SizeValueType SizeValueType
 
typedef LightProcessObject Superclass
 
- Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef LightProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef LightObject Self
 

Public Member Functions

virtual bool CanReadFile (const char *FileNameToRead) override
 
virtual bool CanWriteFile (const char *) override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
virtual void Read (void *buffer) override
 
virtual void ReadImageInformation () override
 
virtual void Write (const void *) override
 
virtual void WriteImageInformation () override
 
- 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 SizeValueType 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, const std::vector< double > &direction)
 
virtual void SetDirection (unsigned int i, const vnl_vector< double > &direction)
 
void SetFileTypeToBinary ()
 
void SetNumberOfDimensions (unsigned int)
 
virtual void SetOrigin (unsigned int i, double origin)
 
template<typename 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, SizeValueType dim)
 
virtual void SetIORegion (ImageIORegion _arg)
 
virtual const ImageIORegion & GetIORegion () const
 
virtual void SetPixelType (const IOPixelType _arg)
 
virtual IOPixelType GetPixelType () const
 
virtual void SetNumberOfComponents (unsigned int _arg)
 
virtual const unsigned int & GetNumberOfComponents () const
 
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 () const
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void UpdateOutputData ()
 
void UpdateProgress (float amount)
 
virtual void SetProgress (float _arg)
 
virtual const float & GetProgress () const
 
- 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 ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType 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 override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexcept override
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () 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)
 
- Static Public Member Functions inherited from itk::LightProcessObject
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 PhilipsRECImageIO ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~PhilipsRECImageIO ()
 
- 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 const ImageRegionSplitterBase * GetImageRegionSplitter () 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 OpenFileForReading (std::ifstream &inputStream, const std::string &filename, bool ascii=false)
 
virtual void OpenFileForWriting (std::ofstream &outputStream, const std::string &filename, bool truncate=true, bool ascii=false)
 
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
virtual void GenerateData ()
 
 LightProcessObject ()
 
 ~LightProcessObject ()
 
- 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 ()
 

Private Member Functions

IndexValueType GetSliceIndex (IndexValueType index) const
 
void operator= (const Self &) ITK_DELETE_FUNCTION
 
 PhilipsRECImageIO (const Self &) ITK_DELETE_FUNCTION
 
void SwapBytesIfNecessary (void *buffer, SizeValueType numberOfPixels)
 

Private Attributes

ImageIOBase::ByteOrder m_MachineByteOrder
 
SliceIndexType * m_SliceIndex
 

Additional Inherited Members

- 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
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

typedef vnl_vector_fixed< double, 3 > itk::PhilipsRECImageIO::AngulationMidSliceType

Definition at line 74 of file itkPhilipsRECImageIO.h.

typedef VectorContainer< unsigned int, double > itk::PhilipsRECImageIO::EchoTimesContainerType

Special types used for Philips PAR meta data.

Definition at line 66 of file itkPhilipsRECImageIO.h.

typedef vnl_vector_fixed< float, 3 > itk::PhilipsRECImageIO::FOVType

Definition at line 73 of file itkPhilipsRECImageIO.h.

typedef VectorContainer< unsigned int, GradientBvalueType > itk::PhilipsRECImageIO::GradientBvalueContainerType

Definition at line 96 of file itkPhilipsRECImageIO.h.

typedef double itk::PhilipsRECImageIO::GradientBvalueType

Definition at line 95 of file itkPhilipsRECImageIO.h.

typedef VectorContainer< unsigned int, GradientDirectionType > itk::PhilipsRECImageIO::GradientDirectionContainerType

Definition at line 98 of file itkPhilipsRECImageIO.h.

typedef vnl_vector_fixed< double, 3 > itk::PhilipsRECImageIO::GradientDirectionType

Definition at line 97 of file itkPhilipsRECImageIO.h.

typedef VectorContainer< unsigned int, ImageTypeRescaleValuesType > itk::PhilipsRECImageIO::ImageTypeRescaleValuesContainerType

Definition at line 90 of file itkPhilipsRECImageIO.h.

typedef ImageTypeRescaleValuesContainerType::Pointer itk::PhilipsRECImageIO::ImageTypeRescaleValuesContainerTypePtr

Definition at line 92 of file itkPhilipsRECImageIO.h.

typedef vnl_vector_fixed< double, 3 > itk::PhilipsRECImageIO::ImageTypeRescaleValuesType

Definition at line 88 of file itkPhilipsRECImageIO.h.

typedef vnl_vector_fixed< int, 8 > itk::PhilipsRECImageIO::ImageTypesType

Image types: 0 = Magnitude, 1 = Real, 2 = Imaginary, 3 = Phase, 4 = Special/Processed.

Definition at line 84 of file itkPhilipsRECImageIO.h.

typedef Superclass::IndexValueType itk::PhilipsRECImageIO::IndexValueType

Definition at line 86 of file itkPhilipsRECImageIO.h.

typedef VectorContainer< unsigned int, int > itk::PhilipsRECImageIO::LabelTypesASLContainerType

Definition at line 99 of file itkPhilipsRECImageIO.h.

typedef vnl_vector_fixed< double, 3 > itk::PhilipsRECImageIO::OffCentreMidSliceType

Definition at line 75 of file itkPhilipsRECImageIO.h.

typedef vnl_vector_fixed< float, 3 > itk::PhilipsRECImageIO::PhaseEncodingVelocityType

Definition at line 76 of file itkPhilipsRECImageIO.h.

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

Definition at line 60 of file itkPhilipsRECImageIO.h.

typedef VectorContainer< unsigned int, double > itk::PhilipsRECImageIO::RepetitionTimesContainerType

Definition at line 71 of file itkPhilipsRECImageIO.h.

typedef VectorContainer< unsigned int, ImageTypeRescaleValuesContainerTypePtr > itk::PhilipsRECImageIO::ScanningSequenceImageTypeRescaleValuesContainerType

Definition at line 94 of file itkPhilipsRECImageIO.h.

typedef vnl_vector_fixed< int, 8 > itk::PhilipsRECImageIO::ScanningSequencesType

Definition at line 85 of file itkPhilipsRECImageIO.h.

typedef vnl_vector_fixed< int, 2 > itk::PhilipsRECImageIO::ScanResolutionType

Definition at line 72 of file itkPhilipsRECImageIO.h.

typedef PhilipsRECImageIO itk::PhilipsRECImageIO::Self

Standard class typedefs.

Definition at line 58 of file itkPhilipsRECImageIO.h.

typedef std::vector< IndexValueType > itk::PhilipsRECImageIO::SliceIndexType

Definition at line 87 of file itkPhilipsRECImageIO.h.

typedef ImageIOBase itk::PhilipsRECImageIO::Superclass

Definition at line 59 of file itkPhilipsRECImageIO.h.

typedef VectorContainer< unsigned int, double > itk::PhilipsRECImageIO::TriggerTimesContainerType

Definition at line 70 of file itkPhilipsRECImageIO.h.

Constructor & Destructor Documentation

itk::PhilipsRECImageIO::PhilipsRECImageIO ( )
protected
itk::PhilipsRECImageIO::~PhilipsRECImageIO ( )
protected
itk::PhilipsRECImageIO::PhilipsRECImageIO ( const Self &  )
private

Member Function Documentation

virtual bool itk::PhilipsRECImageIO::CanReadFile ( const char *  FileNameToRead)
overridevirtual

Determine if the file can be read with this ImageIO implementation.

Author
Don C. Bigler
Parameters
FileNameToReadThe name of the file to test for reading.
Returns
Returns true if this ImageIO can read the file specified.

Implements itk::ImageIOBase.

virtual bool itk::PhilipsRECImageIO::CanWriteFile ( const char *  )
inlineoverridevirtual

Determine if the file can be written with this ImageIO implementation. FileNameToWrite The name of the file to test for writing.

Author
Don C. Bigler
Postcondition
This function will always return false (Not implemented).
Returns
Returns true if this ImageIO can write the file specified.

Implements itk::ImageIOBase.

Definition at line 124 of file itkPhilipsRECImageIO.h.

virtual::itk::LightObject::Pointer itk::PhilipsRECImageIO::CreateAnother ( ) 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::PhilipsRECImageIO::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageIOBase.

IndexValueType itk::PhilipsRECImageIO::GetSliceIndex ( IndexValueType  index) const
private
static Pointer itk::PhilipsRECImageIO::New ( )
static

Method for creation through the object factory.

void itk::PhilipsRECImageIO::operator= ( const Self &  )
private
void itk::PhilipsRECImageIO::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::PhilipsRECImageIO::Read ( void *  buffer)
overridevirtual

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

virtual void itk::PhilipsRECImageIO::ReadImageInformation ( )
overridevirtual

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

void itk::PhilipsRECImageIO::SwapBytesIfNecessary ( void *  buffer,
SizeValueType  numberOfPixels 
)
private
virtual void itk::PhilipsRECImageIO::Write ( const void *  )
inlineoverridevirtual

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

Implements itk::ImageIOBase.

Definition at line 137 of file itkPhilipsRECImageIO.h.

virtual void itk::PhilipsRECImageIO::WriteImageInformation ( void  )
inlineoverridevirtual

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

Definition at line 130 of file itkPhilipsRECImageIO.h.

Member Data Documentation

ImageIOBase::ByteOrder itk::PhilipsRECImageIO::m_MachineByteOrder
private

Definition at line 157 of file itkPhilipsRECImageIO.h.

SliceIndexType* itk::PhilipsRECImageIO::m_SliceIndex
private

Definition at line 156 of file itkPhilipsRECImageIO.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Fri May 27 2016 16:35:39 for ITK by   doxygen 1.8.11