#include <itkOrthogonalSwath2DPathFilter.h>

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 54 of file itkOrthogonalSwath2DPathFilter.h.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	ImageConstPointer = typename ImageType::ConstPointer

using	ImageType = TSwathMeritImage

using	IndexType = typename InputPathType::IndexType

using	InputPathInputType = typename InputPathType::InputType

using	InputPathPointer = typename InputPathType::Pointer

using	InputPathType = TFourierSeriesPath

using	OffsetType = typename InputPathType::OffsetType

using	OrthogonalCorrectionTablePointer = typename OutputPathType::OrthogonalCorrectionTablePointer

using	OrthogonalCorrectionTableType = typename OutputPathType::OrthogonalCorrectionTableType

using	OutputPathInputType = typename OutputPathType::InputType

using	OutputPathPointer = typename OutputPathType::Pointer

using	OutputPathType = OrthogonallyCorrected2DParametricPath

using	Pointer = SmartPointer< Self >

using	Self = OrthogonalSwath2DPathFilter

using	SizeType = typename ImageType::SizeType

using	Superclass = PathAndImageToPathFilter< TFourierSeriesPath, TSwathMeritImage, OrthogonallyCorrected2DParametricPath >

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

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::ConstPointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TSwathMeritImage

using	InputPathConstPointer = typename InputPathType::ConstPointer

using	InputPathIndexType = typename InputPathType::IndexType

using	InputPathInputType = typename InputPathType::InputType

using	InputPathOffsetType = typename InputPathType::OffsetType

using	InputPathOutputType = typename InputPathType::OutputType

using	InputPathPointer = typename InputPathType::Pointer

using	InputPathType = TFourierSeriesPath

using	OutputPathIndexType = typename OutputPathType::IndexType

using	OutputPathInputType = typename OutputPathType::InputType

using	OutputPathOffsetType = typename OutputPathType::OffsetType

using	OutputPathOutputType = typename OutputPathType::OutputType

using	OutputPathPointer = typename OutputPathType::Pointer

using	OutputPathType = OrthogonallyCorrected2DParametricPath

using	Pointer = SmartPointer< Self >

using	Self = PathAndImageToPathFilter

using	Superclass = PathToPathFilter< TFourierSeriesPath, OrthogonallyCorrected2DParametricPath >

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

using	InputPathConstPointer = typename InputPathType::ConstPointer

using	InputPathPointer = typename InputPathType::Pointer

using	InputPathType = TFourierSeriesPath

using	Pointer = SmartPointer< Self >

using	Self = PathToPathFilter

using	Superclass = PathSource< OrthogonallyCorrected2DParametricPath >

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

using	DataObjectPointer = DataObject::Pointer

using	OutputPathIndexType = typename OutputPathType::IndexType

using	OutputPathInputType = typename OutputPathType::InputType

using	OutputPathOffsetType = typename OutputPathType::OffsetType

using	OutputPathOutputType = typename OutputPathType::OutputType

using	OutputPathPointer = typename OutputPathType::Pointer

using	OutputPathType = OrthogonallyCorrected2DParametricPath

using	Pointer = SmartPointer< Self >

using	Self = PathSource

using	Superclass = ProcessObject

using	DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

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

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::PathAndImageToPathFilter< TFourierSeriesPath, TSwathMeritImage, OrthogonallyCorrected2DParametricPath >
const InputImageType *	GetImageInput ()

const char *	GetNameOfClass () const override

const InputPathType *	GetPathInput ()

virtual void	SetImageInput (const TSwathMeritImage *image)

virtual void	SetPathInput (const TFourierSeriesPath *path)

Public Member Functions inherited from itk::PathToPathFilter< TFourierSeriesPath, OrthogonallyCorrected2DParametricPath >
const InputPathType *	GetInput ()

const InputPathType *	GetInput (unsigned int idx)

const char *	GetNameOfClass () const override

virtual void	SetInput (const InputPathType *path)

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

Public Member Functions inherited from itk::PathSource< OrthogonallyCorrected2DParametricPath >
const char *	GetNameOfClass () const override

OutputPathType *	GetOutput (unsigned int idx)

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

virtual void	GraftOutput (OutputPathType *graft)

OutputPathType *	GetOutput ()

DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx) override

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

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

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

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

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

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

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 val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
void	GenerateData () override

	OrthogonalSwath2DPathFilter ()=default

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

	~OrthogonalSwath2DPathFilter () override=default

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

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

	~PathAndImageToPathFilter () override=default

void	GenerateInputRequestedRegion () override

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

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

	~PathToPathFilter () override=default

void	GenerateInputRequestedRegion () override

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

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

	~PathSource () override=default

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	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

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

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 ()

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

	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 idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

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

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

	~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 () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~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	PrintSelf (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 { OrthogonalCorrectionTableType::New() }

std::unique_ptr< double[]>	m_MeritValues { nullptr }

std::unique_ptr< int[]>	m_OptimumStepsValues { nullptr }

std::unique_ptr< int[]>	m_StepValues { nullptr }

SizeType	m_SwathSize { { 0 } }

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

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}