#include <itkOrthogonalSwath2DPathFilter.h>

Inheritance diagram for itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >:

Collaboration diagram for itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >:

Detailed Description

template<typename TFourierSeriesPath, typename TSwathMeritImage>
class itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >

Filter that optimizes a 2D path relative to an image.

OrthogonalSwath2DPathFilter produces an OrthogonallyCorrected2DParametricPath representation of a path that is optimal with respect to an image and an original Fourier series path (sometimes referred to as an "initial contour"). Usage is a little complex. The input image must be preprocessed with ExtractOrthogonalSwath2DImageFilter (the user may want to smooth the image first). The user should then use the resulting swath image to produce a new "merit" swath image of the EXACT same size as the swath image produced in the preceding step. Each pixel value in the merit swath image indicates the local merit of having the path pass through that swath index (taking the absolute value of the vertical partial-derivative of the swath image is often a good way to do this). Both the merit swath image and the path used to extract the swath image should then be passed as inputs to this filter which will search through the merit swath image using dynamic programming to find the absolutely optimum (in terms of the swath image) path.

The file itkOrthogonalSwath2DPathFilterTest.cxx provides a good usage example of itk::OrthogonalSwath2DPathFilter

Definition at line 51 of file itkOrthogonalSwath2DPathFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef ImageType::ConstPointer	ImageConstPointer

typedef TSwathMeritImage	ImageType

typedef InputPathType::IndexType	IndexType

typedef InputPathType::InputType	InputPathInputType

typedef InputPathType::Pointer	InputPathPointer

typedef TFourierSeriesPath	InputPathType

typedef InputPathType::OffsetType	OffsetType

typedef OutputPathType::OrthogonalCorrectionTablePointer	OrthogonalCorrectionTablePointer

typedef OutputPathType::OrthogonalCorrectionTableType	OrthogonalCorrectionTableType

typedef OutputPathType::InputType	OutputPathInputType

typedef OutputPathType::Pointer	OutputPathPointer

typedef OrthogonallyCorrected2DParametricPath	OutputPathType

typedef SmartPointer< Self >	Pointer

typedef OrthogonalSwath2DPathFilter	Self

typedef ImageType::SizeType	SizeType

typedef PathAndImageToPathFilter < TFourierSeriesPath, TSwathMeritImage, OrthogonallyCorrected2DParametricPath >	Superclass

Public Types inherited from itk::PathAndImageToPathFilter< TFourierSeriesPath, TSwathMeritImage, OrthogonallyCorrected2DParametricPath >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::ConstPointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TSwathMeritImage	InputImageType

typedef InputPathType::ConstPointer	InputPathConstPointer

typedef InputPathType::IndexType	InputPathIndexType

typedef InputPathType::InputType	InputPathInputType

typedef InputPathType::OffsetType	InputPathOffsetType

typedef InputPathType::OutputType	InputPathOutputType

typedef InputPathType::Pointer	InputPathPointer

typedef TFourierSeriesPath	InputPathType

typedef OutputPathType::IndexType	OutputPathIndexType

typedef OutputPathType::InputType	OutputPathInputType

typedef OutputPathType::OffsetType	OutputPathOffsetType

typedef OutputPathType::OutputType	OutputPathOutputType

typedef OutputPathType::Pointer	OutputPathPointer

typedef OrthogonallyCorrected2DParametricPath	OutputPathType

typedef SmartPointer< Self >	Pointer

typedef PathAndImageToPathFilter	Self

typedef PathToPathFilter < TFourierSeriesPath, OrthogonallyCorrected2DParametricPath >	Superclass

Public Types inherited from itk::PathToPathFilter< TFourierSeriesPath, OrthogonallyCorrected2DParametricPath >
typedef SmartPointer< const Self >	ConstPointer

typedef InputPathType::ConstPointer	InputPathConstPointer

typedef InputPathType::Pointer	InputPathPointer

typedef TFourierSeriesPath	InputPathType

typedef SmartPointer< Self >	Pointer

typedef PathToPathFilter	Self

typedef PathSource < OrthogonallyCorrected2DParametricPath >	Superclass

Public Types inherited from itk::PathSource< OrthogonallyCorrected2DParametricPath >
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::Pointer	DataObjectPointer

typedef OutputPathType::IndexType	OutputPathIndexType

typedef OutputPathType::InputType	OutputPathInputType

typedef OutputPathType::OffsetType	OutputPathOffsetType

typedef OutputPathType::OutputType	OutputPathOutputType

typedef OutputPathType::Pointer	OutputPathPointer

typedef OrthogonallyCorrected2DParametricPath	OutputPathType

typedef SmartPointer< Self >	Pointer

typedef PathSource	Self

typedef ProcessObject	Superclass

typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef MultiThreader	MultiThreaderType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::PathAndImageToPathFilter< TFourierSeriesPath, TSwathMeritImage, OrthogonallyCorrected2DParametricPath >
virtual ::itk::LightObject::Pointer	CreateAnother () const

const InputImageType *	GetImageInput ()

const InputPathType *	GetPathInput ()

virtual void	SetImageInput (const TSwathMeritImage *image)

virtual void	SetPathInput (const TFourierSeriesPath *path)

Public Member Functions inherited from itk::PathToPathFilter< TFourierSeriesPath, OrthogonallyCorrected2DParametricPath >
virtual ::itk::LightObject::Pointer	CreateAnother () const

const InputPathType *	GetInput ()

const InputPathType *	GetInput (unsigned int idx)

virtual void	SetInput (const InputPathType *path)

virtual void	SetInput (unsigned int, const TFourierSeriesPath *path)

Public Member Functions inherited from itk::PathSource< OrthogonallyCorrected2DParametricPath >
OutputPathType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, OutputPathType *output)

OutputPathType *	GetOutput ()

virtual void	GraftOutput (OutputPathType *output)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual const float &	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

void	SetProgress (float progress)

virtual void	SetReleaseDataFlag (bool flag)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfThreads (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfThreads () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

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

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

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::PathAndImageToPathFilter< TFourierSeriesPath, TSwathMeritImage, OrthogonallyCorrected2DParametricPath >
static Pointer	New ()

Static Public Member Functions inherited from itk::PathToPathFilter< TFourierSeriesPath, OrthogonallyCorrected2DParametricPath >
static Pointer	New ()

Static Public Member Functions inherited from itk::PathSource< OrthogonallyCorrected2DParametricPath >
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
void	GenerateData (void) override

	OrthogonalSwath2DPathFilter ()

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

virtual	~OrthogonalSwath2DPathFilter () override

Protected Member Functions inherited from itk::PathAndImageToPathFilter< TFourierSeriesPath, TSwathMeritImage, OrthogonallyCorrected2DParametricPath >
virtual void	GenerateInputRequestedRegion () override

	PathAndImageToPathFilter ()

virtual	~PathAndImageToPathFilter () override

Protected Member Functions inherited from itk::PathToPathFilter< TFourierSeriesPath, OrthogonallyCorrected2DParametricPath >
	PathToPathFilter ()

	~PathToPathFilter () override

Protected Member Functions inherited from itk::PathSource< OrthogonallyCorrected2DParametricPath >
	PathSource ()

virtual	~PathSource () override

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))

	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))

	itkLegacyMacro (virtual void RemoveInput(DataObject *input))

	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)

virtual void	SetPrimaryInput (DataObject *input)

virtual void	SetPrimaryOutput (DataObject *output)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation ()

virtual void	VerifyPreconditions ()

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName (void) const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName (void) const

DataObject *	GetOutput (DataObjectPointerArraySizeType idx)

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

Protected Member Functions inherited from itk::Object
	Object ()

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

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object () override

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 Member Functions
unsigned int	FindAndStoreBestErrorStep (unsigned int x, unsigned int F, unsigned int L)

double &	MeritValue (int f, int l, int x)

int &	StepValue (int f, int l, int x)

Private Attributes
OrthogonalCorrectionTablePointer	m_FinalOffsetValues

double *	m_MeritValues

int *	m_OptimumStepsValues

int *	m_StepValues

SizeType	m_SwathSize

Additional Inherited Members
Static Public Attributes inherited from itk::PathAndImageToPathFilter< TFourierSeriesPath, TSwathMeritImage, OrthogonallyCorrected2DParametricPath >
static const unsigned int	InputImageDimension

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount