DMRITool  v0.1.1-139-g860d86b4
Diffusion MRI Tool
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage > Class Template Reference

#include <itkSpatiallyDenseSparseVectorImageFileWriter.h>

+ Inheritance diagram for itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >:
+ Collaboration diagram for itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >:

Detailed Description

template<class TInputImage>
class itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >

Writes sparse vector image data to key and value files.

Author
Pew-Thian Yap (ptyap.nosp@m.@med.nosp@m..unc..nosp@m.edu)

Definition at line 35 of file itkSpatiallyDenseSparseVectorImageFileWriter.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef InputImageType::DirectionType InputImageDirectionType
 
typedef InputImageType::IndexType InputImageIndexType
 
typedef InputImageType::InternalPixelType InputImageInternalPixelType
 
typedef InputImageType::KeyType InputImageKeyType
 
typedef InputImageType::PixelContainerConstPointer InputImagePixelContainerConstPointerType
 
typedef InputImageType::PixelContainer InputImagePixelContainerType
 
typedef InputImageType::PixelMapConstIterator InputImagePixelMapConstIteratorType
 
typedef InputImageType::PixelMapType InputImagePixelPixelMapType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::PointType InputImagePointType
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef InputImageType::SizeType InputImageSizeType
 
typedef InputImageType::SpacingType InputImageSpacingType
 
typedef TInputImage InputImageType
 
typedef InputImageType::ValueType InputImageValueType
 
typedef KeyImageFileWriterType::Pointer KeyImageFileWriterPointer
 
typedef ImageFileWriter< KeyImageTypeKeyImageFileWriterType
 
typedef KeyImageType::Pointer KeyImagePointer
 
typedef Image< InputImageKeyType, 1 > KeyImageType
 
typedef SmartPointer< SelfPointer
 
typedef SpatiallyDenseSparseVectorImageFileWriter Self
 
typedef ProcessObject Superclass
 
typedef ValueImageFileWriterType::Pointer ValueImageFileWriterPointer
 
typedef ImageFileWriter< ValueImageTypeValueImageFileWriterType
 
typedef ValueImageType::Pointer ValueImagePointer
 
typedef Image< InputImageValueType, 1 > ValueImageType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetFileName () const
 
const InputImageTypeGetInput (void)
 
const InputImageTypeGetInput (unsigned int idx)
 
virtual const char * GetNameOfClass () const
 
virtual const bool & GetUseCompression ()
 
virtual void SetFileName (const char *_arg)
 
void SetInput (const InputImageType *input)
 
virtual void SetUseCompression (bool _arg)
 
virtual void Update () ITK_OVERRIDE
 
virtual void UseCompressionOff ()
 
virtual void UseCompressionOn ()
 
virtual void Write (void)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

void GenerateData (void) ITK_OVERRIDE
 
void PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE
 
 SpatiallyDenseSparseVectorImageFileWriter ()
 
 ~SpatiallyDenseSparseVectorImageFileWriter ()
 

Protected Attributes

KeyImagePointer m_KeyImage
 
KeyImageFileWriterPointer m_KeyImageFileWriter
 
ValueImagePointer m_ValueImage
 
ValueImageFileWriterPointer m_ValueImageFileWriter
 

Private Member Functions

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

Private Attributes

std::string m_FileName
 
bool m_UseCompression
 

Member Typedef Documentation

template<class TInputImage>
typedef SmartPointer<const Self> itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::ConstPointer
template<class TInputImage>
typedef InputImageType::DirectionType itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::InputImageDirectionType
template<class TInputImage>
typedef InputImageType::IndexType itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::InputImageIndexType
template<class TInputImage>
typedef InputImageType::InternalPixelType itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::InputImageInternalPixelType
template<class TInputImage>
typedef InputImageType::KeyType itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::InputImageKeyType
template<class TInputImage>
typedef InputImageType::PixelContainerConstPointer itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::InputImagePixelContainerConstPointerType
template<class TInputImage>
typedef InputImageType::PixelContainer itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::InputImagePixelContainerType
template<class TInputImage>
typedef InputImageType::PixelMapConstIterator itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::InputImagePixelMapConstIteratorType
template<class TInputImage>
typedef InputImageType::PixelMapType itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::InputImagePixelPixelMapType
template<class TInputImage>
typedef InputImageType::Pointer itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::InputImagePointer
template<class TInputImage>
typedef InputImageType::PointType itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::InputImagePointType
template<class TInputImage>
typedef InputImageType::RegionType itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::InputImageRegionType
template<class TInputImage>
typedef InputImageType::SizeType itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::InputImageSizeType
template<class TInputImage>
typedef InputImageType::SpacingType itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::InputImageSpacingType
template<class TInputImage>
typedef TInputImage itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::InputImageType

Some convenient typedefs.

Definition at line 48 of file itkSpatiallyDenseSparseVectorImageFileWriter.h.

template<class TInputImage>
typedef InputImageType::ValueType itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::InputImageValueType
template<class TInputImage>
typedef KeyImageFileWriterType::Pointer itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::KeyImageFileWriterPointer
template<class TInputImage>
typedef ImageFileWriter<KeyImageType> itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::KeyImageFileWriterType
template<class TInputImage>
typedef KeyImageType::Pointer itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::KeyImagePointer
template<class TInputImage>
typedef Image<InputImageKeyType, 1> itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::KeyImageType
template<class TInputImage>
typedef SmartPointer<Self> itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::Pointer

Standard class typedefs.

Definition at line 39 of file itkSpatiallyDenseSparseVectorImageFileWriter.h.

template<class TInputImage>
typedef ProcessObject itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::Superclass
template<class TInputImage>
typedef ValueImageFileWriterType::Pointer itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::ValueImageFileWriterPointer
template<class TInputImage>
typedef ImageFileWriter<ValueImageType> itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::ValueImageFileWriterType
template<class TInputImage>
typedef ValueImageType::Pointer itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::ValueImagePointer
template<class TInputImage>
typedef Image<InputImageValueType, 1> itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::ValueImageType

Constructor & Destructor Documentation

template<class TInputImage >
itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::SpatiallyDenseSparseVectorImageFileWriter ( )
protected

By default the MetaDataDictionary is taken from the input image and passed to the ImageIO. In some cases, however, a user may prefer to introduce her/his own MetaDataDictionary. This is often the case of the ImageSeriesWriter. This flag defined whether the MetaDataDictionary to use will be the one from the input image or the one already set in the ImageIO object.

Definition at line 28 of file itkSpatiallyDenseSparseVectorImageFileWriter.hxx.

References itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::~SpatiallyDenseSparseVectorImageFileWriter().

+ Here is the call graph for this function:

template<class TInputImage >
itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::~SpatiallyDenseSparseVectorImageFileWriter ( )
protected
template<class TInputImage>
itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::SpatiallyDenseSparseVectorImageFileWriter ( const Self )
private

Member Function Documentation

template<class TInputImage>
virtual::itk::LightObject::Pointer itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::CreateAnother ( void  ) const
template<class TInputImage >
void itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::GenerateData ( void  )
protected

Does the actual work.

Definition at line 108 of file itkSpatiallyDenseSparseVectorImageFileWriter.hxx.

References itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::PrintSelf().

Referenced by itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::Write().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

template<class TInputImage>
virtual const char* itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::GetFileName ( ) const
virtual
template<class TInputImage >
const SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::InputImageType * itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::GetInput ( void  )

Definition at line 58 of file itkSpatiallyDenseSparseVectorImageFileWriter.hxx.

Referenced by itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::SetInput().

+ Here is the caller graph for this function:

template<class TInputImage >
const SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::InputImageType * itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::GetInput ( unsigned int  idx)

Definition at line 73 of file itkSpatiallyDenseSparseVectorImageFileWriter.hxx.

References itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::Write().

+ Here is the call graph for this function:

template<class TInputImage>
virtual const char* itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

template<class TInputImage>
virtual const bool& itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::GetUseCompression ( )
virtual
template<class TInputImage>
static Pointer itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::New ( )
static

Method for creation through the object factory.

template<class TInputImage>
void itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::operator= ( const Self )
private
template<class TInputImage >
void itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protected

Definition at line 342 of file itkSpatiallyDenseSparseVectorImageFileWriter.hxx.

Referenced by itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::GenerateData().

+ Here is the caller graph for this function:

template<class TInputImage>
virtual void itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::SetFileName ( const char *  _arg)
virtual

Specify the names of the output files to write.

template<class TInputImage >
void itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::SetInput ( const InputImageType input)
template<class TInputImage>
virtual void itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::SetUseCompression ( bool  _arg)
virtual

Set the compression On or Off

template<class TInputImage>
virtual void itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::Update ( )
inlinevirtual

Aliased to the Write() method to be consistent with the rest of the pipeline.

Definition at line 98 of file itkSpatiallyDenseSparseVectorImageFileWriter.h.

References ITK_OVERRIDE.

template<class TInputImage>
virtual void itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::UseCompressionOff ( )
virtual
template<class TInputImage>
virtual void itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::UseCompressionOn ( )
virtual
template<class TInputImage >
void itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::Write ( void  )
virtual

A special version of the Update() method for writers. It invokes start and end events and handles releasing data. It eventually calls GenerateData() which does the actual writing. Note: the write method will write data specified by the IORegion. If not set, then then the whole image is written. Note that the region will be cropped to fit the input image's LargestPossibleRegion.

Definition at line 82 of file itkSpatiallyDenseSparseVectorImageFileWriter.hxx.

References itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::GenerateData().

Referenced by itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::GetInput().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

template<class TInputImage>
std::string itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::m_FileName
private
template<class TInputImage>
KeyImagePointer itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::m_KeyImage
protected
template<class TInputImage>
KeyImageFileWriterPointer itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::m_KeyImageFileWriter
protected
template<class TInputImage>
bool itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::m_UseCompression
private
template<class TInputImage>
ValueImagePointer itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::m_ValueImage
protected
template<class TInputImage>
ValueImageFileWriterPointer itk::SpatiallyDenseSparseVectorImageFileWriter< TInputImage >::m_ValueImageFileWriter
protected

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