Represent a closed path through ND Space by its frequency components. More...

#include <itkFourierSeriesPath.h>

Inheritance diagram for itk::FourierSeriesPath< VDimension >:

Collaboration diagram for itk::FourierSeriesPath< VDimension >:

Public Types
typedef CoefficientsType::Pointer	CoefficientsPointer
typedef VectorContainer < unsigned, VectorType >	CoefficientsType
typedef SmartPointer< const Self >	ConstPointer
typedef ContinuousIndex < double, VDimension >	ContinuousIndexType
typedef Index< VDimension >	IndexType
typedef Superclass::InputType	InputType
typedef Offset< VDimension >	OffsetType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef FourierSeriesPath	Self
typedef ParametricPath < VDimension >	Superclass
typedef Vector< double, VDimension >	VectorType

Public Member Functions
void	AddHarmonic (const VectorType &CosCoefficients, const VectorType &SinCoefficients)
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
void	Clear ()
virtual void	CopyInformation (const DataObject *)
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
void	DataHasBeenGenerated ()
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
void	DisconnectPipeline ()
virtual InputType	EndOfInput () const
virtual OutputType	Evaluate (const InputType &input) const
virtual OutputType	Evaluate (const InputType &input) const =0
virtual VectorType	EvaluateDerivative (const InputType &input) const
virtual VectorType	EvaluateDerivative (const InputType &input) const
virtual IndexType	EvaluateToIndex (const InputType &input) const
virtual IndexType	EvaluateToIndex (const InputType &input) const =0
Command *	GetCommand (unsigned long tag)
bool	GetDataReleased () const
bool	GetDebug () const
virtual const InputType &	GetDefaultInputStepSize ()
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual const unsigned long &	GetPipelineMTime ()
virtual int	GetReferenceCount () const
virtual const bool &	GetReleaseDataFlag ()
SmartPointerForwardReference < ProcessObject >	GetSource () const
unsigned int	GetSourceOutputIndex () const
virtual unsigned long	GetUpdateMTime () const
virtual void	Graft (const DataObject *)
bool	HasObserver (const EventObject &event) const
virtual OffsetType	IncrementInput (InputType &input) const =0
virtual OffsetType	IncrementInput (InputType &input) const
virtual void	Initialize (void)
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	PrepareForNewData ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PropagateRequestedRegion ()
virtual void	Register () const
void	ReleaseData ()
virtual void	ReleaseDataFlagOff ()
virtual void	ReleaseDataFlagOn ()
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual void	ResetPipeline ()
void	SetDebug (bool debugFlag) const
virtual void	SetDefaultInputStepSize (InputType _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetPipelineMTime (unsigned long time)
virtual void	SetReferenceCount (int)
void	SetReleaseDataFlag (bool flag)
virtual void	SetRequestedRegion (DataObject *)
virtual void	SetRequestedRegionToLargestPossibleRegion ()
bool	ShouldIReleaseData () const
virtual InputType	StartOfInput () const
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateOutputData ()
virtual void	UpdateOutputInformation ()
virtual bool	VerifyRequestedRegion ()

Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalReleaseDataFlag ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalReleaseDataFlagOff ()
static void	GlobalReleaseDataFlagOn ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalReleaseDataFlag (bool val)
static void	SetGlobalWarningDisplay (bool flag)

Static Public Attributes
static const unsigned int	PathDimension

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	FourierSeriesPath ()
	~FourierSeriesPath ()
virtual IndexType	GetZeroIndex () const
virtual OffsetType	GetZeroOffset () const
virtual void	PrintHeader (std::ostream &os, Indent indent) const
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()

Protected Attributes
InputType	m_DefaultInputStepSize
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Private Member Functions
	FourierSeriesPath (const Self &)
void	operator= (const Self &)

Private Attributes
CoefficientsPointer	m_CosCoefficients
CoefficientsPointer	m_SinCoefficients

Detailed Description

template<unsigned int VDimension>
class itk::FourierSeriesPath< VDimension >

Represent a closed path through ND Space by its frequency components.

This class is intended to represent closed parametric paths through an image which are defined by their Fourier coeficients (frequency components). The paths must be closed and defined over the interval [0,1], where the paths' values at input 0 and input 1 are identical. The user can control how many harmonics (how high of frequency components) are represented by a given instantiation of this class. Classic applications of this class include smoothing other closed paths (by finding and using only the first n harmonics of their frequency components) and interpolating exact derivatives of other closed paths by first converting the other paths to FourierSeriesPaths, which have an exactly defined algebraic derivative. (As many harmonics as are necessary to adequately approximate the original path should be used when approximating derivatives.)

See also:: OrthogonallyCorrectedParametricPath; EllipseParametricPath; PolyLineParametricPath; ParametricPath; ChainCodePath; Path; ContinuousIndex; Index; Offset; Vector

Definition at line 61 of file itkFourierSeriesPath.h.

Member Typedef Documentation

template<unsigned int VDimension>

typedef CoefficientsType::Pointer itk::FourierSeriesPath< VDimension >::CoefficientsPointer

Definition at line 87 of file itkFourierSeriesPath.h.

template<unsigned int VDimension>

typedef VectorContainer<unsigned, VectorType> itk::FourierSeriesPath< VDimension >::CoefficientsType

Definition at line 86 of file itkFourierSeriesPath.h.

template<unsigned int VDimension>

typedef SmartPointer<const Self> itk::FourierSeriesPath< VDimension >::ConstPointer

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 69 of file itkFourierSeriesPath.h.

template<unsigned int VDimension>

typedef ContinuousIndex<double,VDimension> itk::FourierSeriesPath< VDimension >::ContinuousIndexType

Basic data-structure types used

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 82 of file itkFourierSeriesPath.h.

template<unsigned int VDimension>

typedef Index< VDimension > itk::FourierSeriesPath< VDimension >::IndexType

All paths must be mapable to index space

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 83 of file itkFourierSeriesPath.h.

template<unsigned int VDimension>

typedef Superclass::InputType itk::FourierSeriesPath< VDimension >::InputType

Input type

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 72 of file itkFourierSeriesPath.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

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

Definition at line 137 of file itkLightObject.h.

template<unsigned int VDimension>

typedef Offset< VDimension > itk::FourierSeriesPath< VDimension >::OffsetType

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 84 of file itkFourierSeriesPath.h.

template<unsigned int VDimension>

typedef Superclass::OutputType itk::FourierSeriesPath< VDimension >::OutputType

Output type

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 78 of file itkFourierSeriesPath.h.

template<unsigned int VDimension>

typedef SmartPointer<Self> itk::FourierSeriesPath< VDimension >::Pointer

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 68 of file itkFourierSeriesPath.h.

template<unsigned int VDimension>

typedef FourierSeriesPath itk::FourierSeriesPath< VDimension >::Self

Standard class typedefs.

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 66 of file itkFourierSeriesPath.h.

template<unsigned int VDimension>

typedef ParametricPath<VDimension> itk::FourierSeriesPath< VDimension >::Superclass

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 67 of file itkFourierSeriesPath.h.

template<unsigned int VDimension>

typedef Vector<double,VDimension> itk::FourierSeriesPath< VDimension >::VectorType

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 85 of file itkFourierSeriesPath.h.

Constructor & Destructor Documentation

template<unsigned int VDimension>

itk::FourierSeriesPath< VDimension >::FourierSeriesPath ( )

protected

Constructor

Definition at line 100 of file itkFourierSeriesPath.txx.

template<unsigned int VDimension>

itk::FourierSeriesPath< VDimension >::~FourierSeriesPath ( )

inlineprotected

Definition at line 120 of file itkFourierSeriesPath.h.

template<unsigned int VDimension>

itk::FourierSeriesPath< VDimension >::FourierSeriesPath ( const Self & )

private

Member Function Documentation

template<unsigned int VDimension>

void itk::FourierSeriesPath< VDimension >::AddHarmonic	(	const VectorType &	CosCoefficients,
		const VectorType &	SinCoefficients
	)

Add another harmonic's frequency coefficients.

Definition at line 84 of file itkFourierSeriesPath.txx.

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

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

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::LightObject::BreakOnError ( )

staticinherited

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

Definition at line 149 of file itkLightObject.cxx.

template<unsigned int VDimension>

void itk::FourierSeriesPath< VDimension >::Clear ( void )

inline

Clear all frequency coefficients (including the "DC" coefficients).

Definition at line 102 of file itkFourierSeriesPath.h.

virtual void itk::DataObject::CopyInformation ( const DataObject * )

inlinevirtualinherited

Copy information from the specified data set. This method is part of the pipeline execution model. By default, a ProcessObject will copy meta-data from the first input to all of its outputs. See ProcessObject::GenerateOutputInformation(). Each subclass of DataObject is responsible for being able to copy whatever meta-data it needs from from another DataObject. The default implementation of this method is empty. If a subclass overrides this method, it should always call its superclass' version.

Definition at line 435 of file itkDataObject.h.

template<unsigned int VDimension>

virtual::itk::LightObject::Pointer itk::FourierSeriesPath< VDimension >::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::Object.

void itk::DataObject::DataHasBeenGenerated ( )

inherited

Inform the pipeline mechanism that data has been generated. This method is called by ProcessObject::UpdateOutputData() once the process object has finished generating its data. This essentially marks the DataObject as being updated and ready for use.

Definition at line 428 of file itkDataObject.cxx.

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

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.

Delete a 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.

Definition at line 88 of file itkLightObject.cxx.

void itk::DataObject::DisconnectPipeline ( )

inherited

Separate this data object from the pipeline. This routine disconnects a data object from the upstream pipeline. Hence an Update() from downstream will not propagate back past this data object. To completely isolate this data object from the pipeline, the application must remove this data object from any filters which it is connected as the input.

Definition at line 216 of file itkDataObject.cxx.

virtual InputType itk::Path< double , ContinuousIndex< double, VDimension > , VDimension >::EndOfInput ( ) const

inlinevirtualinherited

Where does the path end (what is the last valid input value)? This value is sometimes used by IncrementInput() to go to the end of a path.

Reimplemented in itk::OrthogonallyCorrected2DParametricPath, and itk::PolyLineParametricPath< VDimension >.

Definition at line 86 of file itkPath.h.

template<unsigned int VDimension>

FourierSeriesPath< VDimension >::OutputType itk::FourierSeriesPath< VDimension >::Evaluate ( const InputType & input ) const

virtual

Return the location of the parametric path at the specified location.

Definition at line 30 of file itkFourierSeriesPath.txx.

References PI.

virtual OutputType itk::Path< double , ContinuousIndex< double, VDimension > , VDimension >::Evaluate ( const InputType & input ) const

pure virtualinherited

Evaluate the path at specified location along the path. Return data is the path's "natural" format.

template<unsigned int VDimension>

FourierSeriesPath< VDimension >::VectorType itk::FourierSeriesPath< VDimension >::EvaluateDerivative ( const InputType & input ) const

virtual

Evaluate the first derivative of the ND output with respect to the 1D input. This is an exact, algebraic function.

Definition at line 58 of file itkFourierSeriesPath.txx.

References itk::FixedArray< TValueType, VLength >::Fill(), PI, and itk::FixedArray< TValueType, VLength >::Size().

template<unsigned int VDimension>

ParametricPath< VDimension >::VectorType itk::ParametricPath< VDimension >::EvaluateDerivative ( const InputType & input ) const

virtualinherited

Evaluate the first derivative of the ND output with respect to the 1D input. This is a very simple and naive numerical derivative, and it sould be overloaded with a proper closed-form derivative function in all children. Nevertheless, users who need to create their own parametric classes for their private research need not reimplement this function if their work does not need the derivative operator.

Definition at line 127 of file itkParametricPath.txx.

template<unsigned int VDimension>

ParametricPath< VDimension >::IndexType itk::ParametricPath< VDimension >::EvaluateToIndex ( const InputType & input ) const

virtualinherited

Return the nearest index to the parametric path at the specified location. This is a wrapper to Evaluate().

Definition at line 41 of file itkParametricPath.txx.

virtual IndexType itk::Path< double , ContinuousIndex< double, VDimension > , VDimension >::EvaluateToIndex ( const InputType & input ) const

pure virtualinherited

Like Evaluate(), except always returns an index

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.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::DataObject::GetDataReleased ( ) const

inlineinherited

Get the flag indicating the data has been released.

Definition at line 332 of file itkDataObject.h.

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

template<unsigned int VDimension>

virtual const InputType& itk::ParametricPath< VDimension >::GetDefaultInputStepSize ( )

virtualinherited

Referenced by itk::OrthogonallyCorrected2DParametricPath::SetOriginalPath().

bool itk::DataObject::GetGlobalReleaseDataFlag ( )

staticinherited

Definition at line 189 of file itkDataObject.cxx.

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns:: A constant reference to this objects MetaDataDictionary.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 543 of file itkObject.cxx.

References NULL.

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

template<unsigned int VDimension>

virtual const char* itk::FourierSeriesPath< VDimension >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ParametricPath< VDimension >.

virtual const unsigned long& itk::DataObject::GetPipelineMTime ( )

virtualinherited

Referenced by itk::ProcessObject::UpdateOutputInformation().

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

virtual const bool& itk::DataObject::GetReleaseDataFlag ( )

virtualinherited

SmartPointerForwardReference< ProcessObject > itk::DataObject::GetSource ( void ) const

inherited

Get the process object that generated this data object. If there is no process object, then the data object has been disconnected from the pipeline, or the data object was created manually. (Note: we cannot use the GetObjectMacro() defined in itkMacro because the mutual dependency of DataObject and ProcessObject causes compile problems. Also, a forward reference smart pointer is returned, not a smart pointer, because of the circular dependency between the process and data object.)

GetSource() returns a SmartPointerForwardReference and not a WeakPointer because it is assumed the code calling GetSource() wants to hold a long term reference to the source.

Definition at line 288 of file itkDataObject.cxx.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

unsigned int itk::DataObject::GetSourceOutputIndex ( ) const

inherited

Which of the source's outputs corresponds to this data object?

Definition at line 296 of file itkDataObject.cxx.

Referenced by itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GenerateOutputRequestedRegion().

unsigned long itk::DataObject::GetUpdateMTime ( ) const

virtualinherited

MTime for the last time this DataObject was generated.

Definition at line 438 of file itkDataObject.cxx.

virtual IndexType itk::Path< double , ContinuousIndex< double, VDimension > , VDimension >::GetZeroIndex ( ) const

protectedvirtualinherited

virtual OffsetType itk::Path< double , ContinuousIndex< double, VDimension > , VDimension >::GetZeroOffset ( ) const

protectedvirtualinherited

static void itk::DataObject::GlobalReleaseDataFlagOff ( )

inlinestaticinherited

Definition at line 318 of file itkDataObject.h.

static void itk::DataObject::GlobalReleaseDataFlagOn ( )

inlinestaticinherited

Definition at line 316 of file itkDataObject.h.

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

virtual void itk::DataObject::Graft ( const DataObject * )

inlinevirtualinherited

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

Definition at line 449 of file itkDataObject.h.

Referenced by otb::AtmosphericCorrectionParametersTo6SAtmosphericRadiativeTerms::GraftNthOutput(), otb::VectorDataSource< TOutputVectorData >::GraftNthOutput(), otb::PointSetSource< TOutputPointSet >::GraftNthOutput(), itk::MeshSource< TOutputMesh >::GraftNthOutput(), otb::ObjectListSource< TOutputList >::GraftNthOutput(), and itk::ImageSource< TOutputImage >::GraftNthOutput().

bool itk::Object::HasObserver ( const EventObject & event ) const

inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

virtual OffsetType itk::Path< double , ContinuousIndex< double, VDimension > , VDimension >::IncrementInput ( InputType & input ) const

pure virtualinherited

Increment the input variable passed by reference such that the ND index of the path moves to its next vertex-connected (8-connected in 2D) neighbor. Return the Index-space offset of the path from its prior input to its new input. If the path is unable to increment, input is not changed and an offset of Zero is returned. Children are not required to implement general bounds checking, but are required to return an offset of zero when trying to increment from the final valid input value.

template<unsigned int VDimension>

ParametricPath< VDimension >::OffsetType itk::ParametricPath< VDimension >::IncrementInput ( InputType & input ) const

virtualinherited

Increment the input variable passed by reference such that the ND index of the path moves to its next vertex-connected (8-connected in 2D) neighbor. Return the Index-space offset of the path from its prior input to its new input. If the path is unable to increment, input is not changed and an offset of Zero is returned. Children are not required to implement bounds checking.

This is a fairly slow, iterative algorithm that numerically converges to the next index along the path, in a vertex-connected (8-connected in 2D) fashion. When possible, children of this class should overload this function with something more efficient.

WARNING: This default implementation REQUIRES that the ND endpoint of the path be either unique or coincident only with the startpoint, since it uses the endpoint as a stopping condition.

Definition at line 60 of file itkParametricPath.txx.

template<unsigned int VDimension>

virtual void itk::FourierSeriesPath< VDimension >::Initialize ( void )

inlinevirtual

Needed for Pipelining

Reimplemented from itk::DataObject.

Definition at line 113 of file itkFourierSeriesPath.h.

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

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

Definition at line 457 of file itkObject.cxx.

void itk::Object::Modified ( void ) const

virtualinherited

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

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

template<unsigned int VDimension>

static Pointer itk::FourierSeriesPath< VDimension >::New ( )

static

New() method for dynamic construction

Reimplemented from itk::Object.

template<unsigned int VDimension>

void itk::FourierSeriesPath< VDimension >::operator= ( const Self & )

private

Reimplemented from itk::ParametricPath< VDimension >.

virtual void itk::DataObject::PrepareForNewData ( )

inlinevirtualinherited

Setup a DataObject to receive new data. This method is called by the pipeline mechanism on each output of filter that needs to execute. The default implementation is to return a DataObject to its initial state. This may involve releasing previously allocated bulk data. Subclasses of DataObject may want to override this method and/or the Initialize() method if they want a different default behavior (for instance a DataObject might want finer control over its bulk data memory management).

Definition at line 385 of file itkDataObject.h.

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

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

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

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

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

protectedinherited

Definition at line 478 of file itkObject.cxx.

template<unsigned int VDimension>

void itk::FourierSeriesPath< VDimension >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

Standard "PrintSelf" method

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 114 of file itkFourierSeriesPath.txx.

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

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::DataObject::PropagateRequestedRegion ( void )

virtualinherited

Methods to update the pipeline. Called internally by the pipeline mechanism.

Definition at line 379 of file itkDataObject.cxx.

References itk::DataObjectError::SetDataObject(), itk::ExceptionObject::SetDescription(), and itk::ExceptionObject::SetLocation().

void itk::DataObject::PropagateResetPipeline ( )

protectedvirtualinherited

Propagate a call to ResetPipeline(). Called only from ProcessObject.

Definition at line 367 of file itkDataObject.cxx.

void itk::Object::Register ( ) const

virtualinherited

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

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

void itk::DataObject::ReleaseData ( )

inherited

Release data back to system to conserve memory resource. Used during pipeline execution. Releasing this data does not make down-stream data invalid, so it does not modify the MTime of this data object.

Definition at line 197 of file itkDataObject.cxx.

virtual void itk::DataObject::ReleaseDataFlagOff ( )

virtualinherited

virtual void itk::DataObject::ReleaseDataFlagOn ( )

virtualinherited

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::Object::RemoveObserver ( unsigned long tag )

inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

virtual bool itk::DataObject::RequestedRegionIsOutsideOfTheBufferedRegion ( )

inlinevirtualinherited

Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

Reimplemented in itk::ImageBase< VImageDimension >, itk::ImageBase< ::itk::GetImageDimension< TLabelObject >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< VectorImage< TPixelType, Dimension > >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >, itk::SpatialObject< TDimension >, itk::SpatialObject< 3 >, itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >, itk::QuadEdgeMesh< TPixel, VDimension, TTraits >, itk::PointSet< TPixelType, VDimension, TMeshTraits >, itk::PointSet< TPixel, VDimension, TTraits >, and itk::PointSet< TCoordType, VDimension, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >.

Definition at line 409 of file itkDataObject.h.

void itk::DataObject::ResetPipeline ( )

virtualinherited

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

Definition at line 360 of file itkDataObject.cxx.

void itk::Object::SetDebug ( bool debugFlag ) const

inherited

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

Definition at line 275 of file itkObject.cxx.

template<unsigned int VDimension>

virtual void itk::ParametricPath< VDimension >::SetDefaultInputStepSize ( InputType _arg )

virtualinherited

void itk::DataObject::SetGlobalReleaseDataFlag ( bool val )

staticinherited

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

Definition at line 177 of file itkDataObject.cxx.

void itk::Object::SetGlobalWarningDisplay ( bool val )

staticinherited

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

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

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

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

inherited

Returns:: Set the MetaDataDictionary

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

void itk::DataObject::SetPipelineMTime ( unsigned long time )

inlineinherited

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

Definition at line 370 of file itkDataObject.h.

Referenced by itk::ProcessObject::UpdateOutputInformation().

void itk::Object::SetReferenceCount ( int ref )

virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

void itk::DataObject::SetReleaseDataFlag ( bool flag )

inlineinherited

Turn on/off a flag to control whether this object's data is released after being used by a filter.

Definition at line 304 of file itkDataObject.h.

virtual void itk::DataObject::SetRequestedRegion ( DataObject * )

inlinevirtualinherited

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. For DataObject's that do not support Regions, this method does nothing. Subclasses of DataObject that do support Regions, provide an alternative implementation.

Definition at line 442 of file itkDataObject.h.

virtual void itk::DataObject::SetRequestedRegionToLargestPossibleRegion ( )

inlinevirtualinherited

Set the RequestedRegion to the LargestPossibleRegion. This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

Definition at line 398 of file itkDataObject.h.

bool itk::DataObject::ShouldIReleaseData ( ) const

inherited

Return flag indicating whether data should be released after use by a filter.

Definition at line 206 of file itkDataObject.cxx.

virtual InputType itk::Path< double , ContinuousIndex< double, VDimension > , VDimension >::StartOfInput ( ) const

inlinevirtualinherited

Where does the path begin? For most types of paths, the path will begin at zero. This value can be overridden in children, and is necessary for iterators to know how to go to the beginning of a path.

Reimplemented in itk::OrthogonallyCorrected2DParametricPath.

Definition at line 79 of file itkPath.h.

void itk::Object::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

void itk::DataObject::Update ( void )

virtualinherited

Provides opportunity for the data object to insure internal consistency before access. Also causes owning source/filter (if any) to update itself. The Update() method is composed of UpdateOutputInformation(), PropagateRequestedRegion(), and UpdateOutputData(). This method may call methods that throw an InvalidRequestedRegionError exception. This exception will leave the pipeline in an inconsistent state. You will need to call ResetPipeline() on the last ProcessObject in your pipeline in order to restore the pipeline to a state where you can call Update() again.

Definition at line 340 of file itkDataObject.cxx.

Referenced by itk::WatershedImageFilter< TInputImage >::GetBasicSegmentation().

void itk::DataObject::UpdateOutputData ( void )

virtualinherited

Definition at line 410 of file itkDataObject.cxx.

void itk::DataObject::UpdateOutputInformation ( void )

virtualinherited

Update the information for this DataObject so that it can be used as an output of a ProcessObject. This method is used in the pipeline mechanism to propagate information and initialize the meta data associated with a DataObject. Any implementation of this method in a derived class is assumed to call its source's ProcessObject::UpdateOutputInformation() which determines modified times, LargestPossibleRegions, and any extra meta data like spacing, origin, etc. Default implementation simply call's it's source's UpdateOutputInformation().

Definition at line 350 of file itkDataObject.cxx.

Referenced by otb::Wrapper::InputVectorDataListParameter::AddVectorData(), and itk::ProcessObject::UpdateOutputInformation().

virtual bool itk::DataObject::VerifyRequestedRegion ( )

inlinevirtualinherited

Verify that the RequestedRegion is within the LargestPossibleRegion.

If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possibly satisfy the request. This method returns true if the request can be satisfied (even if it will be necessary to process the entire LargestPossibleRegion) and returns false otherwise. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception if the requested region is not within the LargestPossibleRegion. Default implementation simply returns true in order to support DataObjects that do not need regions (for instance itk::EquivalencyTable).

Definition at line 424 of file itkDataObject.h.

Member Data Documentation

template<unsigned int VDimension>

CoefficientsPointer itk::FourierSeriesPath< VDimension >::m_CosCoefficients

private

Definition at line 127 of file itkFourierSeriesPath.h.

template<unsigned int VDimension>

InputType itk::ParametricPath< VDimension >::m_DefaultInputStepSize

protectedinherited

Default 1D input increment amount to trace along the path. Also, the value used by the defualt implementation of EvaluateDerivative() for numerically approximating the derivative with the change over a single default-sized step. (NOTE that the default implementation of EvaluateDerivative() should never be used in practice, but users or lazzy developers may nevertheless unwisely choose to do so anyway.) For integer- input-types, 1 is probably the correct value. For double-input-types, either 1 or 0.1 are probably good values. This value should be set in the constructor of all instantiable children. Values set in child constructors overwrite values set in parent constructors.

Definition at line 136 of file itkParametricPath.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

template<unsigned int VDimension>

CoefficientsPointer itk::FourierSeriesPath< VDimension >::m_SinCoefficients

private

Definition at line 128 of file itkFourierSeriesPath.h.

const unsigned int itk::Path< double , ContinuousIndex< double, VDimension > , VDimension >::PathDimension

staticinherited

Path dimension. The dimension of a path is fixed at construction.

Definition at line 59 of file itkPath.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

template<unsigned int VDimension> class itk::FourierSeriesPath< VDimension >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<unsigned int VDimension>
class itk::FourierSeriesPath< VDimension >