itk::MetaArrayWriter Class Reference

#include <itkMetaArrayWriter.h>

Inheritance diagram for itk::MetaArrayWriter:

Collaboration diagram for itk::MetaArrayWriter:

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer

typedef SmartPointer< Self > Pointer

typedef MetaArrayWriter Self

typedef LightProcessObject Superclass

Public Member Functions

virtual void AbortGenerateDataOff ()

virtual void AbortGenerateDataOn ()

void ConvertTo (MET_ValueEnumType _metaElementType)

virtual LightObject::Pointer CreateAnother () const

virtual void DebugOff () const

virtual void DebugOn () const

virtual void Delete ()

virtual const bool & GetAbortGenerateData ()

virtual bool GetBinary () const

Command * GetCommand (unsigned long tag)

virtual const char * GetDataFileName () const

bool GetDebug () const

virtual const char * GetFileName () const

const MetaDataDictionary & GetMetaDataDictionary (void) const

MetaDataDictionary & GetMetaDataDictionary (void)

virtual unsigned long GetMTime () const

virtual const char * GetNameOfClass () const

virtual int GetReferenceCount () const

bool HasObserver (const EventObject &event) const

void InvokeEvent (const EventObject &) const

void InvokeEvent (const EventObject &)

virtual void Modified () const

void Print (std::ostream &os, Indent indent=0) const

virtual void Register () const

void RemoveAllObservers ()

void RemoveObserver (unsigned long tag)

virtual void SetAbortGenerateData (bool _arg)

virtual void SetBinary (bool _arg)

virtual void SetDataFileName (const char *_arg)

void SetDebug (bool debugFlag) const

virtual void SetFileName (const char *_arg)

void SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void SetReferenceCount (int)

virtual void UnRegister () const

void Update ()

virtual void UpdateOutputData ()

void UpdateProgress (float amount)

unsigned long AddObserver (const EventObject &event, Command *) const

unsigned long AddObserver (const EventObject &event, Command *)

virtual unsigned int GetPrecision () const

virtual void SetPrecision (unsigned int _arg)

virtual const float & GetProgress ()

template<typename TValueType >

void SetInput (MET_ValueEnumType _metaElementType, const VariableLengthVector< TValueType > *_vector)

template<typename TValueType , unsigned int VLength>

void SetInput (MET_ValueEnumType _metaElementType, const CovariantVector< TValueType, VLength > *_vector)

template<typename TValueType , unsigned int VLength>

void SetInput (MET_ValueEnumType _metaElementType, const Vector< TValueType, VLength > *_vector)

template<typename TValueType , unsigned int VLength>

void SetInput (MET_ValueEnumType _metaElementType, const FixedArray< TValueType, VLength > *_array)

template<typename TValueType >

void SetInput (MET_ValueEnumType _metaElementType, const Array< TValueType > *_array)

template<typename TValueType >

void SetMultiChannelInput (MET_ValueEnumType _metaElementType, int _NumberOfChannels, const Array< TValueType > *_array)

virtual void SetProgress (float _arg)

Static Public Member Functions

static void BreakOnError ()

static Pointer New ()

static bool GetGlobalWarningDisplay ()

static void GlobalWarningDisplayOff ()

static void GlobalWarningDisplayOn ()

static void SetGlobalWarningDisplay (bool flag)

Protected Types

typedef int InternalReferenceCountType

Protected Member Functions

virtual void GenerateData ()

MetaArrayWriter ()

bool PrintObservers (std::ostream &os, Indent indent) const

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

virtual ~MetaArrayWriter ()

virtual void PrintHeader (std::ostream &os, Indent indent) const

virtual void PrintTrailer (std::ostream &os, Indent indent) const

Protected Attributes

InternalReferenceCountType m_ReferenceCount

SimpleFastMutexLock m_ReferenceCountLock

Detailed Description

Definition at line 31 of file itkMetaArrayWriter.h.

Member Typedef Documentation

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

Reimplemented from itk::LightProcessObject.

Definition at line 40 of file itkMetaArrayWriter.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

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

Reimplemented from itk::LightProcessObject.

Definition at line 39 of file itkMetaArrayWriter.h.

typedef MetaArrayWriter itk::MetaArrayWriter::Self

SmartPointer typedef support

Reimplemented from itk::LightProcessObject.

Definition at line 36 of file itkMetaArrayWriter.h.

typedef LightProcessObject itk::MetaArrayWriter::Superclass

Reimplemented from itk::LightProcessObject.

Definition at line 37 of file itkMetaArrayWriter.h.

Constructor & Destructor Documentation

itk::MetaArrayWriter::MetaArrayWriter ( ) [protected]

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

Member Function Documentation

virtual void itk::LightProcessObject::AbortGenerateDataOff ( ) [virtual, inherited]

virtual void itk::LightProcessObject::AbortGenerateDataOn ( ) [virtual, inherited]

Turn on and off the AbortGenerateData flag.

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

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

Set the data type written to the file

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

virtual void itk::LightProcessObject::GenerateData ( void ) [inline, protected, virtual, inherited]

This method causes the filter to generate its output.

Reimplemented in itk::ClassifierBase< TDataContainer >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::Statistics::SampleClassifier< TSample >, itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >, itk::ClassifierBase< TSample >, itk::ClassifierBase< TInputImage >, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, and itk::LevelSetNeighborhoodExtractor< TLevelSet >.

Definition at line 123 of file itkLightProcessObject.h.

virtual const bool& itk::LightProcessObject::GetAbortGenerateData ( ) [virtual, inherited]

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

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

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

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

Get the filename to which the data will be written

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

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

Get the filename

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

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]

Set/Get the precision of the writing

virtual const float& itk::LightProcessObject::GetProgress ( ) [virtual, inherited]

Get the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

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

Method for creation through the object factory

Reimplemented from itk::LightProcessObject.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

void itk::LightProcessObject::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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::Object.

Referenced by itk::Statistics::LearningFunctionBase< LayerType::LayerInterfaceType, TTargetVector >::PrintSelf().

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

virtual void itk::LightProcessObject::SetAbortGenerateData ( bool _arg ) [virtual, inherited]

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

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.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

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

Set the filename

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<typename TValueType >

void itk::MetaArrayWriter::SetInput	(	MET_ValueEnumType	_metaElementType,
		const VariableLengthVector< TValueType > *	_vector
	)			`[inline]`

Set the input itk VariableLengthVector to write

Definition at line 115 of file itkMetaArrayWriter.h.

References itk::VariableLengthVector< TValueType >::GetDataPointer(), and itk::VariableLengthVector< TValueType >::Size().

template<typename TValueType , unsigned int VLength>

void itk::MetaArrayWriter::SetInput	(	MET_ValueEnumType	_metaElementType,
		const CovariantVector< TValueType, VLength > *	_vector
	)			`[inline]`

Set the input itk CovariantVector to write

Definition at line 104 of file itkMetaArrayWriter.h.

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

template<typename TValueType , unsigned int VLength>

void itk::MetaArrayWriter::SetInput	(	MET_ValueEnumType	_metaElementType,
		const Vector< TValueType, VLength > *	_vector
	)			`[inline]`

Set the input itk Vector to write

Definition at line 93 of file itkMetaArrayWriter.h.

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

template<typename TValueType , unsigned int VLength>

void itk::MetaArrayWriter::SetInput	(	MET_ValueEnumType	_metaElementType,
		const FixedArray< TValueType, VLength > *	_array
	)			`[inline]`

Set the input itk FixedArray to write

Definition at line 82 of file itkMetaArrayWriter.h.

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

template<typename TValueType >

void itk::MetaArrayWriter::SetInput	(	MET_ValueEnumType	_metaElementType,
		const Array< TValueType > *	_array
	)			`[inline]`

Set the input itk Array to write

Definition at line 71 of file itkMetaArrayWriter.h.

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

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

template<typename TValueType >

void itk::MetaArrayWriter::SetMultiChannelInput	(	MET_ValueEnumType	_metaElementType,
		int	_NumberOfChannels,
		const Array< TValueType > *	_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 teh 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 132 of file itkMetaArrayWriter.h.

References itk::Array< TValueType >::GetSize(), and NULL.

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

Set/Get the precision of the writing

virtual void itk::LightProcessObject::SetProgress ( float _arg ) [virtual, inherited]

Set the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

void itk::MetaArrayWriter::Update ( )

Write out the array

virtual void itk::LightProcessObject::UpdateOutputData ( ) [virtual, inherited]

Actually generate new output.

void itk::LightProcessObject::UpdateProgress ( float amount ) [inherited]

Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

Member Data Documentation

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

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

itkMetaArrayWriter.h


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef MetaArrayWriter	Self
typedef LightProcessObject	Superclass
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
void	ConvertTo (MET_ValueEnumType _metaElementType)
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual const bool &	GetAbortGenerateData ()
virtual bool	GetBinary () const
Command *	GetCommand (unsigned long tag)
virtual const char *	GetDataFileName () const
bool	GetDebug () const
virtual const char *	GetFileName () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetBinary (bool _arg)
virtual void	SetDataFileName (const char *_arg)
void	SetDebug (bool debugFlag) const
virtual void	SetFileName (const char *_arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
void	Update ()
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

virtual unsigned int	GetPrecision () const
virtual void	SetPrecision (unsigned int _arg)

virtual const float &	GetProgress ()

template<typename TValueType >
void	SetInput (MET_ValueEnumType _metaElementType, const VariableLengthVector< TValueType > *_vector)

template<typename TValueType , unsigned int VLength>
void	SetInput (MET_ValueEnumType _metaElementType, const CovariantVector< TValueType, VLength > *_vector)

template<typename TValueType , unsigned int VLength>
void	SetInput (MET_ValueEnumType _metaElementType, const Vector< TValueType, VLength > *_vector)

template<typename TValueType , unsigned int VLength>
void	SetInput (MET_ValueEnumType _metaElementType, const FixedArray< TValueType, VLength > *_array)

template<typename TValueType >
void	SetInput (MET_ValueEnumType _metaElementType, const Array< TValueType > *_array)

template<typename TValueType >
void	SetMultiChannelInput (MET_ValueEnumType _metaElementType, int _NumberOfChannels, const Array< TValueType > *_array)

virtual void	SetProgress (float _arg)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Types

typedef int	InternalReferenceCountType
Protected Member Functions
virtual void	GenerateData ()
	MetaArrayWriter ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~MetaArrayWriter ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock