ITK  5.2.0
Insight Toolkit
itkPathSource.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 itkPathSource_h
19 #define itkPathSource_h
20 
21 #include "itkProcessObject.h"
22 #include "itkPath.h"
23 
24 namespace itk
25 {
41 template <typename TOutputPath>
42 class ITK_TEMPLATE_EXPORT PathSource : public ProcessObject
43 {
44 public:
45  ITK_DISALLOW_COPY_AND_ASSIGN(PathSource);
46 
48  using Self = PathSource;
52 
55 
57  itkNewMacro(Self);
58 
60  itkTypeMacro(PathSource, ProcessObject);
61 
63  using OutputPathType = TOutputPath;
64  using OutputPathPointer = typename OutputPathType::Pointer;
65  using OutputPathInputType = typename OutputPathType::InputType;
66  using OutputPathOutputType = typename OutputPathType::OutputType;
68  using OutputPathOffsetType = typename OutputPathType::OffsetType;
69 
111  GetOutput();
113 
115  GetOutput(unsigned int idx);
116 
151  // just calls GraftNthOutput()
152  virtual void
153  GraftOutput(OutputPathType * output);
154 
161  virtual void
162  GraftNthOutput(unsigned int idx, OutputPathType * output);
163 
178  using Superclass::MakeOutput;
180  MakeOutput(DataObjectPointerArraySizeType idx) override;
182 
183 protected:
184  PathSource();
185  ~PathSource() override = default;
186  void
187  PrintSelf(std::ostream & os, Indent indent) const override;
188 
189  // Inherit the empty ProcessObject::GenerateData()
190 
191  // Inherit ProcessObject::PrepareOutputs(), which calls Initialize()
192  // (Image replaces w/ empty function)
193 };
194 } // end namespace itk
195 
196 #ifndef ITK_MANUAL_INSTANTIATION
197 # include "itkPathSource.hxx"
198 #endif
199 
200 #endif
itk::PathSource
Base class for all process objects that output path data.
Definition: itkPathSource.h:42
itk::PathSource< TOutputFourierSeriesPath >::OutputPathPointer
typename OutputPathType::Pointer OutputPathPointer
Definition: itkPathSource.h:64
itk::PathSource< TOutputFourierSeriesPath >::OutputPathOutputType
typename OutputPathType::OutputType OutputPathOutputType
Definition: itkPathSource.h:66
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::ProcessObject::DataObjectPointerArraySizeType
DataObjectPointerArray::size_type DataObjectPointerArraySizeType
Definition: itkProcessObject.h:193
itk::PathSource< TOutputFourierSeriesPath >::OutputPathIndexType
typename OutputPathType::IndexType OutputPathIndexType
Definition: itkPathSource.h:67
itk::GTest::TypedefsAndConstructors::Dimension2::IndexType
ImageBaseType::IndexType IndexType
Definition: itkGTestTypedefsAndConstructors.h:50
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itkProcessObject.h
itkPath.h
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:138
itk::ProcessObject
class ITK_FORWARD_EXPORT ProcessObject
Definition: itkDataObject.h:41
itk::PathSource< TOutputFourierSeriesPath >::OutputPathInputType
typename OutputPathType::InputType OutputPathInputType
Definition: itkPathSource.h:65
itk::DataObject::Pointer
SmartPointer< Self > Pointer
Definition: itkDataObject.h:301
itk::PathSource< TOutputFourierSeriesPath >::OutputPathOffsetType
typename OutputPathType::OffsetType OutputPathOffsetType
Definition: itkPathSource.h:68
itk::PathSource< TOutputFourierSeriesPath >::OutputPathType
TOutputFourierSeriesPath OutputPathType
Definition: itkPathSource.h:63