ITK  5.3.0
Insight Toolkit
itkPolyLineParametricPath.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef itkPolyLineParametricPath_h
19 #define itkPolyLineParametricPath_h
20 
21 #include "itkParametricPath.h"
22 #include "itkVectorContainer.h"
23 #include "itkIndex.h"
24 
25 namespace itk
26 {
56 template <unsigned int VDimension>
57 class ITK_TEMPLATE_EXPORT PolyLineParametricPath : public ParametricPath<VDimension>
58 {
59 public:
60  ITK_DISALLOW_COPY_AND_MOVE(PolyLineParametricPath);
61 
67 
70 
72  using typename Superclass::InputType;
73 
75  using typename Superclass::OutputType;
76 
78  using typename Superclass::ContinuousIndexType;
86 
89  Evaluate(const InputType & input) const override;
90 
93  // virtual VectorType EvaluateDerivative(const InputType & input) const;
94 
99  inline void
101  {
102  m_VertexList->InsertElement(m_VertexList->Size(), vertex);
103  this->Modified();
104  }
106 
110  InputType
111  EndOfInput() const override
112  {
113  return m_VertexList->Size() - 1;
114  }
115 
117  itkNewMacro(Self);
118 
120  void
121  Initialize() override
122  {
123  m_VertexList->Initialize();
124  }
125 
127  itkGetModifiableObjectMacro(VertexList, VertexListType);
128 
133  OffsetType
134  IncrementInput(InputType & input) const override;
135 
139  VectorType
140  EvaluateDerivative(const InputType & input) const override;
141 
142 protected:
144  ~PolyLineParametricPath() override = default;
145  void
146  PrintSelf(std::ostream & os, Indent indent) const override;
147 
148 private:
150 };
151 } // end namespace itk
152 
153 #ifndef ITK_MANUAL_INSTANTIATION
154 # include "itkPolyLineParametricPath.hxx"
155 #endif
156 
157 #endif
itk::Index
Represent a n-dimensional index in a n-dimensional image.
Definition: itkIndex.h:67
itk::ParametricPath
Represent a parametric path through ND Space.
Definition: itkParametricPath.h:62
itk::GTest::TypedefsAndConstructors::Dimension2::VectorType
ImageBaseType::SpacingType VectorType
Definition: itkGTestTypedefsAndConstructors.h:53
itk::Vector< double, VDimension >
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::PolyLineParametricPath::Initialize
void Initialize() override
Definition: itkPolyLineParametricPath.h:121
itk::PolyLineParametricPath
Represent a path of line segments through ND Space.
Definition: itkPolyLineParametricPath.h:57
itk::PolyLineParametricPath::EndOfInput
InputType EndOfInput() const override
Definition: itkPolyLineParametricPath.h:111
itk::PolyLineParametricPath::AddVertex
void AddVertex(const ContinuousIndexType &vertex)
Definition: itkPolyLineParametricPath.h:100
itk::PolyLineParametricPath::VertexListPointer
typename VertexListType::Pointer VertexListPointer
Definition: itkPolyLineParametricPath.h:85
itkIndex.h
itk::PolyLineParametricPath::m_VertexList
VertexListPointer m_VertexList
Definition: itkPolyLineParametricPath.h:149
itk::Offset
Represent a n-dimensional offset between two n-dimensional indexes of n-dimensional image.
Definition: itkOffset.h:67
itkVectorContainer.h
itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >::InputType
double InputType
Definition: itkPath.h:72
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ContinuousIndex
A templated class holding a point in n-Dimensional image space.
Definition: itkContinuousIndex.h:46
itk::Object
Base class for most ITK classes.
Definition: itkObject.h:62
itkParametricPath.h
itk::Point
A templated class holding a geometric point in n-Dimensional space.
Definition: itkPoint.h:53
itk::VectorContainer
Define a front-end to the STL "vector" container that conforms to the IndexedContainerInterface.
Definition: itkVectorContainer.h:48
itk::DataObject
Base class for all data objects in ITK.
Definition: itkDataObject.h:293