ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath > Class Template Reference

#include <itkChainCodeToFourierSeriesPathFilter.h>

+ Inheritance diagram for itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >:
+ Collaboration diagram for itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using IndexType = typename InputPathType::IndexType
 
using InputPathInputType = typename InputPathType::InputType
 
using InputPathPointer = typename InputPathType::Pointer
 
using InputPathType = TInputChainCodePath
 
using OffsetType = typename InputPathType::OffsetType
 
using OutputPathInputType = typename OutputPathType::InputType
 
using OutputPathPointer = typename OutputPathType::Pointer
 
using OutputPathType = TOutputFourierSeriesPath
 
using Pointer = SmartPointer< Self >
 
using Self = ChainCodeToFourierSeriesPathFilter
 
using Superclass = PathToPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >
 
using VectorType = typename OutputPathType::VectorType
 
- Public Types inherited from itk::PathToPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >
using ConstPointer = SmartPointer< const Self >
 
using InputPathConstPointer = typename InputPathType::ConstPointer
 
using InputPathPointer = typename InputPathType::Pointer
 
using InputPathType = TInputChainCodePath
 
using Pointer = SmartPointer< Self >
 
using Self = PathToPathFilter
 
using Superclass = PathSource< TOutputFourierSeriesPath >
 
- Public Types inherited from itk::PathSource< TOutputFourierSeriesPath >
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 = TOutputFourierSeriesPath
 
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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
virtual void SetNumberOfHarmonics (unsigned int _arg)
 
- Public Member Functions inherited from itk::PathToPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
const InputPathTypeGetInput ()
 
const InputPathTypeGetInput (unsigned int idx)
 
virtual void SetInput (const InputPathType *path)
 
virtual void SetInput (unsigned int, const TInputChainCodePath *path)
 
- Public Member Functions inherited from itk::PathSource< TOutputFourierSeriesPath >
OutputPathTypeGetOutput ()
 
OutputPathTypeGetOutput (unsigned int idx)
 
virtual void GraftOutput (OutputPathType *output)
 
virtual void GraftNthOutput (unsigned int idx, OutputPathType *output)
 
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 ()
 
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 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)
 
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 SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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)
 
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
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::PathToPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::PathSource< TOutputFourierSeriesPath >
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

 ChainCodeToFourierSeriesPathFilter ()
 
void GenerateData () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ChainCodeToFourierSeriesPathFilter () override=default
 
- Protected Member Functions inherited from itk::PathToPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >
 PathToPathFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~PathToPathFilter () override=default
 
void GenerateInputRequestedRegion () override
 
- Protected Member Functions inherited from itk::PathSource< TOutputFourierSeriesPath >
 PathSource ()
 
 ~PathSource () override=default
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void GenerateOutputInformation ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 Attributes

unsigned int m_NumberOfHarmonics
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TInputChainCodePath, typename TOutputFourierSeriesPath>
class itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >

Filter that produces a Fourier series version of a chain code path.

ChainCodeToFourierSeriesPathFilter produces a Fourier series representation of a chain code path. By default, the first 8 harmonics (frequency coefficients, which include the "DC" term) are computed. SetNumberOfHarmonics() can be used to override this value. Because the requested number of harmonics may not be able to be computed, it is advisable to check the number of harmonics in the actual output.

Definition at line 42 of file itkChainCodeToFourierSeriesPathFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
using itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::ConstPointer = SmartPointer<const Self>

Definition at line 53 of file itkChainCodeToFourierSeriesPathFilter.h.

◆ IndexType

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
using itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::IndexType = typename InputPathType::IndexType

Definition at line 68 of file itkChainCodeToFourierSeriesPathFilter.h.

◆ InputPathInputType

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
using itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::InputPathInputType = typename InputPathType::InputType

Definition at line 64 of file itkChainCodeToFourierSeriesPathFilter.h.

◆ InputPathPointer

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
using itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::InputPathPointer = typename InputPathType::Pointer

Definition at line 63 of file itkChainCodeToFourierSeriesPathFilter.h.

◆ InputPathType

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
using itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::InputPathType = TInputChainCodePath

Some convenient type alias.

Definition at line 62 of file itkChainCodeToFourierSeriesPathFilter.h.

◆ OffsetType

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
using itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::OffsetType = typename InputPathType::OffsetType

Definition at line 69 of file itkChainCodeToFourierSeriesPathFilter.h.

◆ OutputPathInputType

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
using itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::OutputPathInputType = typename OutputPathType::InputType

Definition at line 67 of file itkChainCodeToFourierSeriesPathFilter.h.

◆ OutputPathPointer

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
using itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::OutputPathPointer = typename OutputPathType::Pointer

Definition at line 66 of file itkChainCodeToFourierSeriesPathFilter.h.

◆ OutputPathType

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
using itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::OutputPathType = TOutputFourierSeriesPath

Definition at line 65 of file itkChainCodeToFourierSeriesPathFilter.h.

◆ Pointer

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
using itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::Pointer = SmartPointer<Self>

Definition at line 52 of file itkChainCodeToFourierSeriesPathFilter.h.

◆ Self

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
using itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::Self = ChainCodeToFourierSeriesPathFilter

Standard class type aliases.

Definition at line 49 of file itkChainCodeToFourierSeriesPathFilter.h.

◆ Superclass

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
using itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::Superclass = PathToPathFilter<TInputChainCodePath, TOutputFourierSeriesPath>

Definition at line 50 of file itkChainCodeToFourierSeriesPathFilter.h.

◆ VectorType

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
using itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::VectorType = typename OutputPathType::VectorType

Definition at line 70 of file itkChainCodeToFourierSeriesPathFilter.h.

Constructor & Destructor Documentation

◆ ChainCodeToFourierSeriesPathFilter()

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::ChainCodeToFourierSeriesPathFilter ( )
protected

◆ ~ChainCodeToFourierSeriesPathFilter()

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::~ChainCodeToFourierSeriesPathFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
virtual::itk::LightObject::Pointer itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::CreateAnother ( ) 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.

◆ GenerateData()

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
void itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::GenerateData ( )
overrideprotectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

◆ GetNameOfClass()

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
virtual const char* itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::PathToPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >.

◆ New()

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
static Pointer itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
void itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

STL map to store the named inputs and outputs

Reimplemented from itk::ProcessObject.

◆ SetNumberOfHarmonics()

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
virtual void itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::SetNumberOfHarmonics ( unsigned int  _arg)
virtual

Set the number of harmonics to try to compute. By default, the first 8 harmonics (frequency coefficients, which include the "DC" term) are computed. SetNumberOfHarmonics() can be used to override this value. If the chain code has too few steps to calculate the desired number of harmonics (due to the Nyquist criterion), then as many harmonics as are possible (input->NumberOfSteps()/2) will be calculated, but at least 2 harmonics will always be calculated.

Member Data Documentation

◆ m_NumberOfHarmonics

template<typename TInputChainCodePath , typename TOutputFourierSeriesPath >
unsigned int itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >::m_NumberOfHarmonics
private

Definition at line 90 of file itkChainCodeToFourierSeriesPathFilter.h.


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