ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes
itk::MetaArrayReader Class Reference

#include <itkMetaArrayReader.h>

Inheritance diagram for itk::MetaArrayReader:
Collaboration diagram for itk::MetaArrayReader:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef MetaArrayReader Self
typedef LightProcessObject Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
int GetCovariantVectorDimension (void) const
MET_ValueEnumType GetDataType (void) const
template<typename TValueType >
void GetElement (TValueType &value, unsigned int i, unsigned int channel=0) const
virtual const char * GetFileName () const
MetaArray * GetMetaArrayPointer (void)
virtual const char * GetNameOfClass () const
int GetNumberOfComponents (void) const
int GetNumberOfElements (void) const
int GetVectorDimension (void) const
void SetBuffer (void *_buffer)
virtual void SetFileName (const char *_arg)
int Size (void) const
void Update ()
template<typename TValueType >
void GetOutput (MET_ValueEnumType _metaElementType, Array< TValueType > *_array, bool _letArrayManageData=true)
template<typename TValueType , unsigned int VLength>
bool GetOutput (MET_ValueEnumType, FixedArray< TValueType, VLength > *_array)
template<typename TValueType , unsigned int VLength>
bool GetOutput (MET_ValueEnumType, Vector< TValueType, VLength > *_vector)
template<typename TValueType , unsigned int VLength>
bool GetOutput (MET_ValueEnumType, CovariantVector< TValueType, VLength > *_vector)
template<typename TValueType >
void GetOutput (MET_ValueEnumType _metaElementType, VariableLengthVector< TValueType > *_vector, bool _letVectorManageData=true)
template<typename TValueType >
void GetMultiChannelOutput (MET_ValueEnumType _metaElementType, Array< TValueType > *_array)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

 MetaArrayReader ()
void PrintSelf (std::ostream &os, Indent indent) const
virtual ~MetaArrayReader ()

Private Attributes

void * m_Buffer
std::string m_FileName
MetaArray m_MetaArray

Detailed Description

Definition at line 29 of file itkMetaArrayReader.h.


Member Typedef Documentation

Reimplemented from itk::LightProcessObject.

Definition at line 37 of file itkMetaArrayReader.h.

Reimplemented from itk::LightProcessObject.

Definition at line 36 of file itkMetaArrayReader.h.

SmartPointer typedef support

Reimplemented from itk::LightProcessObject.

Definition at line 34 of file itkMetaArrayReader.h.

Reimplemented from itk::LightProcessObject.

Definition at line 35 of file itkMetaArrayReader.h.


Constructor & Destructor Documentation

itk::MetaArrayReader::MetaArrayReader ( ) [protected]
virtual itk::MetaArrayReader::~MetaArrayReader ( ) [protected, virtual]

Member Function Documentation

virtual::itk::LightObject::Pointer itk::MetaArrayReader::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.

int itk::MetaArrayReader::GetCovariantVectorDimension ( void  ) const [inline]

GetCovariantVectorDimension is used by itkVector

Definition at line 92 of file itkMetaArrayReader.h.

MET_ValueEnumType itk::MetaArrayReader::GetDataType ( void  ) const [inline]

Return the MetaIO type that corresponds to the element type

Definition at line 62 of file itkMetaArrayReader.h.

template<typename TValueType >
void itk::MetaArrayReader::GetElement ( TValueType &  value,
unsigned int  i,
unsigned int  channel = 0 
) const [inline]

GetElement is used by itkArray, itkFixedArray, and VariableLengthVector

Definition at line 99 of file itkMetaArrayReader.h.

virtual const char* itk::MetaArrayReader::GetFileName ( ) const [virtual]

Get the filename

MetaArray* itk::MetaArrayReader::GetMetaArrayPointer ( void  )

Get a pointer to the metaArray so that you can change metaArray options (e.g., add comments and user-defined fields

template<typename TValueType >
void itk::MetaArrayReader::GetMultiChannelOutput ( MET_ValueEnumType  _metaElementType,
Array< TValueType > *  _array 
) [inline]

Get an itk Array of Arrays, itk::Array< itk::Array<short> >. Assumes all sub-arrays have the same length. Specify the MetaType of the elements of the Array< Array< * > > and provide a pointer to the Array of arrays. Elements are copied into the array of arrays.

Definition at line 226 of file itkMetaArrayReader.h.

References itk::Array< TValueType >::SetSize().

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

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

int itk::MetaArrayReader::GetNumberOfComponents ( void  ) const [inline]

GetNumberOfComponents is used by itkVector and itkCovariantVector

Definition at line 86 of file itkMetaArrayReader.h.

int itk::MetaArrayReader::GetNumberOfElements ( void  ) const [inline]

GetNumberOfElements is used by itkArray and VariableLengthVector

Definition at line 74 of file itkMetaArrayReader.h.

template<typename TValueType >
void itk::MetaArrayReader::GetOutput ( MET_ValueEnumType  _metaElementType,
VariableLengthVector< TValueType > *  _vector,
bool  _letVectorManageData = true 
) [inline]

Get itk VariableLengthVector Specify the MetaType of the elements of the VariableLengthVector and provide a pointer to the VariableLengthVector. The buffer of the VariableLengthVector is replaced by the buffer into which the data was directly read (a copy does not occur). If _letVectorManageData is true, the buffer persists even after this MetaArrayReader is destroyed. Otherwise, the buffer (and therefore the validity of the dat ain the VariableLengthVector) is destroyed when the MetaArrayReader is dstroyed.

Definition at line 202 of file itkMetaArrayReader.h.

References itk::VariableLengthVector< TValueType >::SetData().

template<typename TValueType >
void itk::MetaArrayReader::GetOutput ( MET_ValueEnumType  _metaElementType,
Array< TValueType > *  _array,
bool  _letArrayManageData = true 
) [inline]

Get itk Array Specify the MetaType of the elements of the Array and provide a pointer to the Array. The buffer of the Array is replaced by the buffer into which the data was directly read (a copy does not occur). If _letVectorManageData is true, the buffer persists even after this MetaArrayReader is destroyed. Otherwise, the buffer (and therefore the validity of the dat ain the Array) is destroyed when the MetaArrayReader is dstroyed.

Definition at line 115 of file itkMetaArrayReader.h.

References itk::Array< TValueType >::SetData().

template<typename TValueType , unsigned int VLength>
bool itk::MetaArrayReader::GetOutput ( MET_ValueEnumType  ,
Vector< TValueType, VLength > *  _vector 
) [inline]

Get itk Vector Specify the MetaType of the elements of the itkVector and provide a pointer to the itkVector into which the data should be copied

Definition at line 155 of file itkMetaArrayReader.h.

template<typename TValueType , unsigned int VLength>
bool itk::MetaArrayReader::GetOutput ( MET_ValueEnumType  ,
FixedArray< TValueType, VLength > *  _array 
) [inline]

Get itk FixedArray

Definition at line 135 of file itkMetaArrayReader.h.

template<typename TValueType , unsigned int VLength>
bool itk::MetaArrayReader::GetOutput ( MET_ValueEnumType  ,
CovariantVector< TValueType, VLength > *  _vector 
) [inline]

Get itk CovariantVector Specify the MetaType of the elements of the itkCovariantVector and provide a pointer to the itkCovariantVector into which the data should be copied

Definition at line 176 of file itkMetaArrayReader.h.

int itk::MetaArrayReader::GetVectorDimension ( void  ) const [inline]

GetVectorDimension is used by itkVector

Definition at line 80 of file itkMetaArrayReader.h.

static Pointer itk::MetaArrayReader::New ( ) [static]

Method for creation through the object factory

Reimplemented from itk::LightProcessObject.

void itk::MetaArrayReader::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::LightProcessObject.

void itk::MetaArrayReader::SetBuffer ( void *  _buffer)

Specify the buffer (already allocated) into which data should be read

virtual void itk::MetaArrayReader::SetFileName ( const char *  _arg) [virtual]

Set the filename

int itk::MetaArrayReader::Size ( void  ) const [inline]

Size is used by itkArray and VariableLengthVector

Definition at line 68 of file itkMetaArrayReader.h.

void itk::MetaArrayReader::Update ( )

Read the Array in MetaIO format


Member Data Documentation

Definition at line 260 of file itkMetaArrayReader.h.

std::string itk::MetaArrayReader::m_FileName [private]

Definition at line 258 of file itkMetaArrayReader.h.

MetaArray itk::MetaArrayReader::m_MetaArray [private]

Definition at line 256 of file itkMetaArrayReader.h.


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