itk::MetaArrayReader Class Reference

#include <itkMetaArrayReader.h>

Inheritance diagram for itk::MetaArrayReader:

Collaboration diagram for itk::MetaArrayReader:

Detailed Description

Definition at line 30 of file itkMetaArrayReader.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef MetaArrayReader	Self
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 ::itk::LightObject::Pointer	CreateAnother (void) const
int	GetCovariantVectorDimension (void) const
MET_ValueEnumType	GetDataType (void) const
template<typename TValue >
void	GetElement (TValue &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 TValue >
void	GetOutput (MET_ValueEnumType _metaElementType, Array< TValue > *_array, bool _letArrayManageData=true)
template<typename TValue , unsigned int VLength>
bool	GetOutput (MET_ValueEnumType, FixedArray< TValue, VLength > *_array)
template<typename TValue , unsigned int VLength>
bool	GetOutput (MET_ValueEnumType, Vector< TValue, VLength > *_vector)
template<typename TValue , unsigned int VLength>
bool	GetOutput (MET_ValueEnumType, CovariantVector< TValue, VLength > *_vector)
template<typename TValue >
void	GetOutput (MET_ValueEnumType _metaElementType, VariableLengthVector< TValue > *_vector, bool _letVectorManageData=true)
template<typename TValue >
void	GetMultiChannelOutput (MET_ValueEnumType _metaElementType, Array< TValue > *_array)
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 (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) 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 ITK_OVERRIDE
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) ITK_OVERRIDE
virtual void	UnRegister () const ITK_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::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
	MetaArrayReader ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE
virtual	~MetaArrayReader ()
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 Attributes
void *	m_Buffer
std::string	m_FileName
MetaArray	m_MetaArray

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType
Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

typedef SmartPointer< const Self > itk::MetaArrayReader::ConstPointer

Definition at line 38 of file itkMetaArrayReader.h.

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

Definition at line 37 of file itkMetaArrayReader.h.

typedef MetaArrayReader itk::MetaArrayReader::Self

SmartPointer typedef support

Definition at line 35 of file itkMetaArrayReader.h.

typedef LightProcessObject itk::MetaArrayReader::Superclass

Definition at line 36 of file itkMetaArrayReader.h.

Constructor & Destructor Documentation

itk::MetaArrayReader::MetaArrayReader ( )

protected

virtual itk::MetaArrayReader::~MetaArrayReader ( )

protectedvirtual

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 93 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 63 of file itkMetaArrayReader.h.

template<typename TValue >

void itk::MetaArrayReader::GetElement ( TValue &  value, unsigned int  i, unsigned int  channel = 0  ) const

inline

GetElement is used by itkArray, itkFixedArray, and VariableLengthVector

Definition at line 100 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 TValue >

void itk::MetaArrayReader::GetMultiChannelOutput ( MET_ValueEnumType  _metaElementType, Array< TValue > *  _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 227 of file itkMetaArrayReader.h.

References itk::Array< TValue >::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 87 of file itkMetaArrayReader.h.

int itk::MetaArrayReader::GetNumberOfElements ( void  ) const

inline

GetNumberOfElements is used by itkArray and VariableLengthVector

Definition at line 75 of file itkMetaArrayReader.h.

template<typename TValue >

void itk::MetaArrayReader::GetOutput ( MET_ValueEnumType  _metaElementType, Array< TValue > *  _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 116 of file itkMetaArrayReader.h.

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

template<typename TValue , unsigned int VLength>

bool itk::MetaArrayReader::GetOutput ( MET_ValueEnumType  , FixedArray< TValue, VLength > *  _array  )

inline

Get itk FixedArray

Definition at line 136 of file itkMetaArrayReader.h.

template<typename TValue , unsigned int VLength>

bool itk::MetaArrayReader::GetOutput ( MET_ValueEnumType  , Vector< TValue, 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 156 of file itkMetaArrayReader.h.

template<typename TValue , unsigned int VLength>

bool itk::MetaArrayReader::GetOutput ( MET_ValueEnumType  , CovariantVector< TValue, 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 177 of file itkMetaArrayReader.h.

template<typename TValue >

void itk::MetaArrayReader::GetOutput ( MET_ValueEnumType  _metaElementType, VariableLengthVector< TValue > *  _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 203 of file itkMetaArrayReader.h.

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

int itk::MetaArrayReader::GetVectorDimension ( void  ) const

inline

GetVectorDimension is used by itkVector

Definition at line 81 of file itkMetaArrayReader.h.

static Pointer itk::MetaArrayReader::New ( )

static

Method for creation through the object factory

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

protectedvirtual

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 69 of file itkMetaArrayReader.h.

void itk::MetaArrayReader::Update

(

)

Read the Array in MetaIO format

Member Data Documentation

void* itk::MetaArrayReader::m_Buffer

private

Definition at line 261 of file itkMetaArrayReader.h.

std::string itk::MetaArrayReader::m_FileName

private

Definition at line 259 of file itkMetaArrayReader.h.

MetaArray itk::MetaArrayReader::m_MetaArray

private

Definition at line 257 of file itkMetaArrayReader.h.

---

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

• itkMetaArrayReader.h