 |
ITK
5.0.0
Insight Segmentation and Registration Toolkit
|
|
ITK
5.0.0
Insight Segmentation and Registration Toolkit
|
#include <itkPath.h>
Inheritance diagram for itk::Path< TInput, TOutput, VDimension >: Collaboration diagram for itk::Path< TInput, TOutput, VDimension >:Represent a path through ND Space.
This base class is intended to represent a path through an image. As a path, it maps a 1D parameter (such as time or arc length, etc) to an index (or possibly an offset or a point) in ND space. This mapping is done via the abstract Evaluate() method, which must be overridden in all instantiable subclasses. The only geometric requirement for a gerneral path is that it be continuous. A path may be open or closed, and may cross itself several times. A classic application of this class is the representation of contours in 2D images using chaincodes or freeman codes. Another use of a path is to guide the movement of an iterator through an image.
| TInput | Type of the 1D parameter of the path, e.g. unsigned int or double. |
| TOutput | Type of the path location at the given input, e.g. itk::Offset< VDimension > or itk::ContinuousIndex< VDimension > |
| VDimension | Dimension of the path. |
Public Types | |
| using | ConstPointer = SmartPointer< const Self > |
| using | IndexType = Index< VDimension > |
| using | InputType = TInput |
| using | OffsetType = Offset< VDimension > |
| using | OutputType = TOutput |
| 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 | |
| virtual InputType | EndOfInput () const |
| virtual OutputType | Evaluate (const InputType &input) const =0 |
| virtual IndexType | EvaluateToIndex (const InputType &input) const =0 |
| virtual const char * | GetNameOfClass () const |
| virtual OffsetType | IncrementInput (InputType &input) const =0 |
| virtual InputType | StartOfInput () const |
| 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 | Initialize () |
| virtual void | PrepareForNewData () |
| virtual void | PropagateRequestedRegion () |
| void | ReleaseData () |
| virtual void | ReleaseDataFlagOff () |
| 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 () |
| 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 *) |
| unsigned long | AddObserver (const EventObject &event, Command *) 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) |
| void | SetDebug (bool debugFlag) const |
| void | SetReferenceCount (int) override |
| void | UnRegister () const noexceptoverride |
| 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 Attributes | |
| static constexpr unsigned int | PathDimension = VDimension |
Protected Member Functions | |
| 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 &time) |
| ~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 | |
| IndexType | m_ZeroIndex |
| OffsetType | m_ZeroOffset |
Additional Inherited Members | |
| Static Public Member Functions inherited from itk::DataObject | |
| static bool | GetGlobalReleaseDataFlag () |
| static void | GlobalReleaseDataFlagOff () |
| static void | GlobalReleaseDataFlagOn () |
| 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 flag) |
| Static Public Member Functions inherited from itk::LightObject | |
| static void | BreakOnError () |
| static Pointer | New () |
| Protected Attributes inherited from itk::LightObject | |
| std::atomic< int > | m_ReferenceCount |
| using itk::Path< TInput, TOutput, VDimension >::ConstPointer = SmartPointer< const Self > |
| using itk::Path< TInput, TOutput, VDimension >::OffsetType = Offset< VDimension > |
| using itk::Path< TInput, TOutput, VDimension >::OutputType = TOutput |
| using itk::Path< TInput, TOutput, VDimension >::Pointer = SmartPointer< Self > |
| using itk::Path< TInput, TOutput, VDimension >::Superclass = DataObject |
|
protected |
|
overrideprotecteddefault |
|
inlinevirtual |
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, itk::PolyLineParametricPath< VDimension >, itk::HilbertPath< TIndexValue, VDimension >, itk::ChainCodePath< VDimension >, and itk::ChainCodePath< 2 >.
|
pure virtual |
Evaluate the path at specified location along the path. Return data is the path's "natural" format.
|
pure virtual |
Like Evaluate(), except always returns an index
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::DataObject.
Reimplemented in itk::ParametricPath< VDimension >, itk::ParametricPath< 2 >, itk::FourierSeriesPath< VDimension >, itk::PolyLineParametricPath< VDimension >, itk::ChainCodePath2D, itk::ChainCodePath< VDimension >, itk::HilbertPath< TIndexValue, VDimension >, itk::ChainCodePath< 2 >, and itk::OrthogonallyCorrected2DParametricPath.
|
protectedvirtual |
|
protectedvirtual |
|
pure virtual |
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.
|
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.
|
inlinevirtual |
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.
|
private |
|
static |
1.8.5
