ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::MetaArrayWriter Class Reference

#include <itkMetaArrayWriter.h>

+ Inheritance diagram for itk::MetaArrayWriter:
+ Collaboration diagram for itk::MetaArrayWriter:

Detailed Description

Definition at line 30 of file itkMetaArrayWriter.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef MetaArrayWriter Self
 
typedef LightProcessObject Superclass
 
- Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

void ConvertTo (MET_ValueEnumType _metaElementType)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual bool GetBinary () const
 
virtual const char * GetDataFileName () const
 
virtual const char * GetFileName () const
 
virtual const char * GetNameOfClass () const
 
virtual void SetBinary (bool _arg)
 
virtual void SetDataFileName (const char *_arg)
 
virtual void SetFileName (const char *_arg)
 
void Update ()
 
template<typename TValue >
void SetInput (MET_ValueEnumType _metaElementType, const Array< TValue > *_array)
 
template<typename TValue , unsigned int VLength>
void SetInput (MET_ValueEnumType _metaElementType, const FixedArray< TValue, VLength > *_array)
 
template<typename TValue , unsigned int VLength>
void SetInput (MET_ValueEnumType _metaElementType, const Vector< TValue, VLength > *_vector)
 
template<typename TValue , unsigned int VLength>
void SetInput (MET_ValueEnumType _metaElementType, const CovariantVector< TValue, VLength > *_vector)
 
template<typename TValue >
void SetInput (MET_ValueEnumType _metaElementType, const VariableLengthVector< TValue > *_vector)
 
template<typename TValue >
void SetMultiChannelInput (MET_ValueEnumType _metaElementType, int, const Array< TValue > *_array)
 
virtual void SetPrecision (unsigned int _arg)
 
virtual unsigned int GetPrecision () const
 
- 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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

 MetaArrayWriter ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE
 
virtual ~MetaArrayWriter ()
 
- 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

bool m_Binary
 
const void * m_Buffer
 
std::string m_DataFileName
 
std::string m_FileName
 
MetaArray m_MetaArray
 
unsigned int m_Precision
 

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

Definition at line 39 of file itkMetaArrayWriter.h.

Definition at line 38 of file itkMetaArrayWriter.h.

SmartPointer typedef support

Definition at line 35 of file itkMetaArrayWriter.h.

Definition at line 36 of file itkMetaArrayWriter.h.

Constructor & Destructor Documentation

itk::MetaArrayWriter::MetaArrayWriter ( )
protected
virtual itk::MetaArrayWriter::~MetaArrayWriter ( )
protectedvirtual

Member Function Documentation

void itk::MetaArrayWriter::ConvertTo ( MET_ValueEnumType  _metaElementType)

Set the data type written to the file

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

virtual bool itk::MetaArrayWriter::GetBinary ( ) const
virtual

Returns true if the file to be produced will store the data in binary (instead of ascii) format

virtual const char* itk::MetaArrayWriter::GetDataFileName ( ) const
virtual

Get the filename to which the data will be written

virtual const char* itk::MetaArrayWriter::GetFileName ( ) const
virtual

Get the filename

virtual const char* itk::MetaArrayWriter::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

virtual unsigned int itk::MetaArrayWriter::GetPrecision ( ) const
virtual

Copies the elements from an array of arrays into the output buffer. Requires all sub-arrays to have the same length. length of the major array is the "length" of the array, while the length of the sub-arrays is the "number of channels" at each array position. Expected form itk::Array< itk::Array< * > >. May work for other sub-array-types that define the [] operator and the GetSize() function.

static Pointer itk::MetaArrayWriter::New ( )
static

Method for creation through the object factory

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

virtual void itk::MetaArrayWriter::SetBinary ( bool  _arg)
virtual

Set the writer to store the array as binary data

virtual void itk::MetaArrayWriter::SetDataFileName ( const char *  _arg)
virtual

Set the filename to which the data is written Optional param - use if header and data should be in separate files.

virtual void itk::MetaArrayWriter::SetFileName ( const char *  _arg)
virtual

Set the filename

template<typename TValue >
void itk::MetaArrayWriter::SetInput ( MET_ValueEnumType  _metaElementType,
const Array< TValue > *  _array 
)
inline

Set the input itk Array to write

Definition at line 70 of file itkMetaArrayWriter.h.

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

template<typename TValue , unsigned int VLength>
void itk::MetaArrayWriter::SetInput ( MET_ValueEnumType  _metaElementType,
const FixedArray< TValue, VLength > *  _array 
)
inline

Set the input itk FixedArray to write

Definition at line 81 of file itkMetaArrayWriter.h.

References itk::FixedArray< TValue, VLength >::GetDataPointer().

template<typename TValue , unsigned int VLength>
void itk::MetaArrayWriter::SetInput ( MET_ValueEnumType  _metaElementType,
const Vector< TValue, VLength > *  _vector 
)
inline

Set the input itk Vector to write

Definition at line 92 of file itkMetaArrayWriter.h.

References itk::FixedArray< T, NVectorDimension >::GetDataPointer().

template<typename TValue , unsigned int VLength>
void itk::MetaArrayWriter::SetInput ( MET_ValueEnumType  _metaElementType,
const CovariantVector< TValue, VLength > *  _vector 
)
inline

Set the input itk CovariantVector to write

Definition at line 103 of file itkMetaArrayWriter.h.

References itk::FixedArray< T, NVectorDimension >::GetDataPointer().

template<typename TValue >
void itk::MetaArrayWriter::SetInput ( MET_ValueEnumType  _metaElementType,
const VariableLengthVector< TValue > *  _vector 
)
inline
template<typename TValue >
void itk::MetaArrayWriter::SetMultiChannelInput ( MET_ValueEnumType  _metaElementType,
int  ,
const Array< TValue > *  _array 
)
inline

Copies the elements from an array of arrays into the output buffer. Requires all sub-arrays to have the same length. length of the major array is the "length" of the array, while the length of the sub-arrays is the "number of channels" at each array position. Expected form itk::Array< itk::Array< * > >. May work for other sub-array-types that define the [] operator and the GetSize() function.

Definition at line 131 of file itkMetaArrayWriter.h.

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

virtual void itk::MetaArrayWriter::SetPrecision ( unsigned int  _arg)
virtual

Set/Get the precision of the writing

void itk::MetaArrayWriter::Update ( )

Write out the array

Member Data Documentation

bool itk::MetaArrayWriter::m_Binary
private

Definition at line 174 of file itkMetaArrayWriter.h.

const void* itk::MetaArrayWriter::m_Buffer
private

Definition at line 183 of file itkMetaArrayWriter.h.

std::string itk::MetaArrayWriter::m_DataFileName
private

Definition at line 179 of file itkMetaArrayWriter.h.

std::string itk::MetaArrayWriter::m_FileName
private

Definition at line 178 of file itkMetaArrayWriter.h.

MetaArray itk::MetaArrayWriter::m_MetaArray
private

Definition at line 181 of file itkMetaArrayWriter.h.

unsigned int itk::MetaArrayWriter::m_Precision
private

Definition at line 176 of file itkMetaArrayWriter.h.


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