ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::OrthogonallyCorrected2DParametricPath Class Reference
Data Representation Objects » Path Representation ObjectsGroup Filtering » | Module ITKPath

#include <itkOrthogonallyCorrected2DParametricPath.h>

Detailed Description

Represent an orthogonally corrected 2D parametric path.

Description

See also
EllipseParametricPath
PolyLineParametricPath
ParametricPath
Path
ContinuousIndex
Index
Offset
Vector

Definition at line 45 of file itkOrthogonallyCorrected2DParametricPath.h.

+ Inheritance diagram for itk::OrthogonallyCorrected2DParametricPath:
+ Collaboration diagram for itk::OrthogonallyCorrected2DParametricPath:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< double, 2 >
 
using IndexType = Index< 2 >
 
using InputType = Superclass::InputType
 
using OffsetType = Offset< 2 >
 
using OriginalPathConstPointer = OriginalPathType::ConstPointer
 
using OriginalPathType = ParametricPath< 2 >
 
using OrthogonalCorrectionTablePointer = OrthogonalCorrectionTableType::Pointer
 
using OrthogonalCorrectionTableSizeType = OrthogonalCorrectionTableType::ElementIdentifier
 
using OrthogonalCorrectionTableType = VectorContainer< unsigned int, double >
 
using OutputType = Superclass::OutputType
 
using Pointer = SmartPointer< Self >
 
using Self = OrthogonallyCorrected2DParametricPath
 
using Superclass = ParametricPath< 2 >
 
using VectorType = Superclass::VectorType
 
- Public Types inherited from itk::ParametricPath< 2 >
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< SpacePrecisionType, VDimension >
 
using IndexType = Index< VDimension >
 
using OffsetType = Offset< VDimension >
 
using Pointer = SmartPointer< Self >
 
using Self = ParametricPath
 
using Superclass = Path< double, ContinuousIndexType, VDimension >
 
using VectorType = Vector< double, VDimension >
 
- Public Types inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
using ConstPointer = SmartPointer< const Self >
 
using IndexType = Index< VDimension >
 
using InputType = double
 
using OffsetType = Offset< VDimension >
 
using OutputType = ContinuousIndex< SpacePrecisionType, VDimension >
 
using Pointer = SmartPointer< Self >
 
using Self = Path
 
using Superclass = DataObject
 
- Public Types inherited from itk::DataObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = std::string
 
using DataObjectPointerArraySizeType = std::vector< Pointer >::size_type
 
using Pointer = SmartPointer< Self >
 
using Self = DataObject
 
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

InputType EndOfInput () const override
 
OutputType Evaluate (const InputType &inputValue) const override
 
const char * GetNameOfClass () const override
 
void Initialize () override
 
void SetOriginalPath (const OriginalPathType *originalPath)
 
virtual void SetOrthogonalCorrectionTable (OrthogonalCorrectionTableType *_arg)
 
InputType StartOfInput () const override
 
- Public Member Functions inherited from itk::ParametricPath< 2 >
virtual VectorType EvaluateDerivative (const InputType &input) const
 
IndexType EvaluateToIndex (const InputType &input) const override
 
virtual const InputType & GetDefaultInputStepSize () const
 
const char * GetNameOfClass () const override
 
OffsetType IncrementInput (InputType &input) const override
 
virtual void SetDefaultInputStepSize (InputType _arg)
 
- Public Member Functions inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
virtual OutputType Evaluate (const InputType &input) const=0
 
const char * GetNameOfClass () const override
 
- Public Member Functions inherited from itk::DataObject
virtual void CopyInformation (const DataObject *)
 
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointer< ProcessObject > GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierType & GetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void Graft (const DataObject *)
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOn ()
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
virtual void SetRequestedRegion (const DataObject *)
 
virtual void SetRequestedRegionToLargestPossibleRegion ()
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
void UpdateSource () const
 
virtual bool VerifyRequestedRegion ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual const ModifiedTimeType & GetPipelineMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStamp & GetRealTimeStamp () 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
 
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 void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static Pointer New ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- 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

 OrthogonallyCorrected2DParametricPath ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~OrthogonallyCorrected2DParametricPath () override=default
 
- Protected Member Functions inherited from itk::ParametricPath< 2 >
 ParametricPath ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ParametricPath () override=default
 
- Protected Member Functions inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
virtual IndexType GetZeroIndex () const
 
virtual OffsetType GetZeroOffset () const
 
 Path ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~Path () override=default
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
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 PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

OriginalPathConstPointer m_OriginalPath {}
 
OrthogonalCorrectionTablePointer m_OrthogonalCorrectionTable {}
 

Additional Inherited Members

- Static Public Attributes inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
static constexpr unsigned int PathDimension
 
- Protected Attributes inherited from itk::ParametricPath< 2 >
InputType m_DefaultInputStepSize
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

using itk::OrthogonallyCorrected2DParametricPath::ConstPointer = SmartPointer<const Self>

Definition at line 54 of file itkOrthogonallyCorrected2DParametricPath.h.

◆ ContinuousIndexType

using itk::OrthogonallyCorrected2DParametricPath::ContinuousIndexType = ContinuousIndex<double, 2>

Basic data-structure types used

Definition at line 66 of file itkOrthogonallyCorrected2DParametricPath.h.

◆ IndexType

using itk::OrthogonallyCorrected2DParametricPath::IndexType = Index<2>

Definition at line 67 of file itkOrthogonallyCorrected2DParametricPath.h.

◆ InputType

using itk::OrthogonallyCorrected2DParametricPath::InputType = Superclass::InputType

Input type

Definition at line 60 of file itkOrthogonallyCorrected2DParametricPath.h.

◆ OffsetType

using itk::OrthogonallyCorrected2DParametricPath::OffsetType = Offset<2>

Definition at line 68 of file itkOrthogonallyCorrected2DParametricPath.h.

◆ OriginalPathConstPointer

using itk::OrthogonallyCorrected2DParametricPath::OriginalPathConstPointer = OriginalPathType::ConstPointer

Definition at line 71 of file itkOrthogonallyCorrected2DParametricPath.h.

◆ OriginalPathType

using itk::OrthogonallyCorrected2DParametricPath::OriginalPathType = ParametricPath<2>

Definition at line 70 of file itkOrthogonallyCorrected2DParametricPath.h.

◆ OrthogonalCorrectionTablePointer

using itk::OrthogonallyCorrected2DParametricPath::OrthogonalCorrectionTablePointer = OrthogonalCorrectionTableType::Pointer

Definition at line 73 of file itkOrthogonallyCorrected2DParametricPath.h.

◆ OrthogonalCorrectionTableSizeType

using itk::OrthogonallyCorrected2DParametricPath::OrthogonalCorrectionTableSizeType = OrthogonalCorrectionTableType::ElementIdentifier

Definition at line 75 of file itkOrthogonallyCorrected2DParametricPath.h.

◆ OrthogonalCorrectionTableType

using itk::OrthogonallyCorrected2DParametricPath::OrthogonalCorrectionTableType = VectorContainer<unsigned int, double>

Definition at line 72 of file itkOrthogonallyCorrected2DParametricPath.h.

◆ OutputType

using itk::OrthogonallyCorrected2DParametricPath::OutputType = Superclass::OutputType

Output type

Definition at line 63 of file itkOrthogonallyCorrected2DParametricPath.h.

◆ Pointer

using itk::OrthogonallyCorrected2DParametricPath::Pointer = SmartPointer<Self>

Definition at line 53 of file itkOrthogonallyCorrected2DParametricPath.h.

◆ Self

using itk::OrthogonallyCorrected2DParametricPath::Self = OrthogonallyCorrected2DParametricPath

Standard class type aliases.

Definition at line 51 of file itkOrthogonallyCorrected2DParametricPath.h.

◆ Superclass

using itk::OrthogonallyCorrected2DParametricPath::Superclass = ParametricPath<2>

Definition at line 52 of file itkOrthogonallyCorrected2DParametricPath.h.

◆ VectorType

using itk::OrthogonallyCorrected2DParametricPath::VectorType = Superclass::VectorType

Definition at line 69 of file itkOrthogonallyCorrected2DParametricPath.h.

Constructor & Destructor Documentation

◆ OrthogonallyCorrected2DParametricPath()

itk::OrthogonallyCorrected2DParametricPath::OrthogonallyCorrected2DParametricPath ( )
protected

◆ ~OrthogonallyCorrected2DParametricPath()

itk::OrthogonallyCorrected2DParametricPath::~OrthogonallyCorrected2DParametricPath ( )
overrideprotecteddefault

Member Function Documentation

◆ EndOfInput()

InputType itk::OrthogonallyCorrected2DParametricPath::EndOfInput ( ) const
inlineoverridevirtual

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 from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >.

Definition at line 112 of file itkOrthogonallyCorrected2DParametricPath.h.

◆ Evaluate()

OutputType itk::OrthogonallyCorrected2DParametricPath::Evaluate ( const InputType &  inputValue) const
override

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

◆ GetNameOfClass()

const char* itk::OrthogonallyCorrected2DParametricPath::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::DataObject.

◆ Initialize()

void itk::OrthogonallyCorrected2DParametricPath::Initialize ( )
inlineoverridevirtual

Needed for Pipelining

Reimplemented from itk::DataObject.

Definition at line 98 of file itkOrthogonallyCorrected2DParametricPath.h.

◆ New()

static Pointer itk::OrthogonallyCorrected2DParametricPath::New ( )
static

New() method for dynamic construction

◆ PrintSelf()

void itk::OrthogonallyCorrected2DParametricPath::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::DataObject.

◆ SetOriginalPath()

void itk::OrthogonallyCorrected2DParametricPath::SetOriginalPath ( const OriginalPathType *  originalPath)

Set pointer to the original path. The path MUST be continuous in its first derivative to prevent discontinuities in the corrected path. The path should also be closed, since the first correction is applied to both the beginning and the end of the original path.

◆ SetOrthogonalCorrectionTable()

virtual void itk::OrthogonallyCorrected2DParametricPath::SetOrthogonalCorrectionTable ( OrthogonalCorrectionTableType *  _arg)
virtual

Set table of evenly-spaced orthogonal offsets for the original path.

◆ StartOfInput()

InputType itk::OrthogonallyCorrected2DParametricPath::StartOfInput ( ) const
inlineoverridevirtual

These are determined by the original path

Reimplemented from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >.

Definition at line 106 of file itkOrthogonallyCorrected2DParametricPath.h.

Member Data Documentation

◆ m_OriginalPath

OriginalPathConstPointer itk::OrthogonallyCorrected2DParametricPath::m_OriginalPath {}
private

Definition at line 124 of file itkOrthogonallyCorrected2DParametricPath.h.

◆ m_OrthogonalCorrectionTable

OrthogonalCorrectionTablePointer itk::OrthogonallyCorrected2DParametricPath::m_OrthogonalCorrectionTable {}
private

Definition at line 125 of file itkOrthogonallyCorrected2DParametricPath.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16