itk::TransformFileWriter Class Reference

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

void itk::TransformFileWriter::AddTransform ( const TransformType * transform )

Add a transform to be written

void itk::TransformFileWriter::AddTransform ( const TransformType * transform )

Add a transform to be written

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

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

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.

bool itk::TransformFileWriter::GetAppendMode ( )

Set/Get the write mode (append/overwrite) for the Filter

bool itk::TransformFileWriter::GetAppendMode ( )

Set/Get the write mode (append/overwrite) for the Filter

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.

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

Get the value of the debug flag.

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

Get the filename

virtual const char* itk::TransformFileWriter::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.

ConstTransformPointer itk::TransformFileWriter::GetInput ( void ) [inline]

Set/Get the input transform to write

Definition at line 64 of file itkTransformFileWriterWithFactory.h.

const TransformType* itk::TransformFileWriter::GetInput ( void ) [inline]

Set/Get the input transform to write

Definition at line 74 of file itkTransformFileWriter.h.

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::TransformFileWriter::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

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

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

virtual unsigned int itk::TransformFileWriter::GetPrecision ( ) const [virtual]

Set/Get the precision of the writing

virtual unsigned int itk::TransformFileWriter::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::TransformFileWriter::New ( ) [static]

Method for creation through the object factory

Reimplemented from itk::LightProcessObject.

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

Method for creation through the object factory

Reimplemented from itk::LightProcessObject.

void itk::TransformFileWriter::operator= ( const Self & ) [protected]

Reimplemented from itk::LightProcessObject.

void itk::TransformFileWriter::operator= ( const Self & ) [protected]

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.

void itk::TransformFileWriter::SetAppendMode ( bool mode )

Set/Get the write mode (append/overwrite) for the Filter

void itk::TransformFileWriter::SetAppendMode ( bool mode )

Set/Get the write mode (append/overwrite) for the Filter

void itk::TransformFileWriter::SetAppendOff ( )

Set/Get the write mode (append/overwrite) for the Filter

void itk::TransformFileWriter::SetAppendOff ( )

Set/Get the write mode (append/overwrite) for the Filter

void itk::TransformFileWriter::SetAppendOn ( )

Set/Get the write mode (append/overwrite) for the Filter

void itk::TransformFileWriter::SetAppendOn ( )

Set/Get the write mode (append/overwrite) for the Filter

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::TransformFileWriter::SetFileName ( const char * _arg ) [virtual]

Set the filename

virtual void itk::TransformFileWriter::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().

void itk::TransformFileWriter::SetInput ( const TransformType * transform )

Set/Get the input transform to write

void itk::TransformFileWriter::SetInput ( const TransformType * transform )

Set/Get the input transform to write

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

Returns:: Set the MetaDataDictionary

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

Set/Get the precision of the writing

virtual void itk::TransformFileWriter::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::TransformFileWriter::Update ( )

Write out the transform

void itk::TransformFileWriter::Update ( )

Write out the transform

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

std::string itk::TransformFileWriter::m_FileName [protected]

Definition at line 92 of file itkTransformFileWriter.h.

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 files:


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TransformIOBase::ConstTransformListType	ConstTransformListType
typedef TransformIOBase::ConstTransformPointer	ConstTransformPointer
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< Self >	Pointer
typedef TransformFileWriter	Self
typedef TransformFileWriter	Self
typedef LightProcessObject	Superclass
typedef TransformType::Pointer	TransformPointer
typedef TransformBase	TransformType
typedef TransformBase	TransformType
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
void	AddTransform (const TransformType *transform)
void	AddTransform (const TransformType *transform)
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual const char *	GetFileName () 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)
void	SetDebug (bool debugFlag) const
virtual void	SetFileName (const char *_arg)
virtual void	SetFileName (const char *_arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
void	Update ()
void	Update ()
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)

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

bool	GetAppendMode ()
void	SetAppendMode (bool mode)
void	SetAppendOff ()
void	SetAppendOn ()

bool	GetAppendMode ()
void	SetAppendMode (bool mode)
void	SetAppendOff ()
void	SetAppendOn ()

ConstTransformPointer	GetInput ()
void	SetInput (const TransformType *transform)

const TransformType *	GetInput ()
void	SetInput (const TransformType *transform)

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

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

virtual const float &	GetProgress ()

virtual void	SetProgress (float _arg)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()
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 ()
void	operator= (const Self &)
void	operator= (const Self &)
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
	TransformFileWriter ()
	TransformFileWriter (const Self &)
	TransformFileWriter ()
	TransformFileWriter (const Self &)
virtual	~TransformFileWriter ()
virtual	~TransformFileWriter ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
std::string	m_FileName
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
typedef Object	Superclass
virtual const char *	GetNameOfClass () const