ITK  5.2.0
Insight Toolkit
itkPathToImageFilter.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 itkPathToImageFilter_h
19 #define itkPathToImageFilter_h
20 
21 #include "itkImageSource.h"
22 #include "itkConceptChecking.h"
23 
24 namespace itk
25 {
36 template <typename TInputPath, typename TOutputImage>
37 class ITK_TEMPLATE_EXPORT PathToImageFilter : public ImageSource<TOutputImage>
38 {
39 public:
40  ITK_DISALLOW_COPY_AND_MOVE(PathToImageFilter);
41 
47 
49  itkNewMacro(Self);
50 
52  itkTypeMacro(PathToImageFilter, ImageSource);
53 
55  using OutputImageRegionType = typename Superclass::OutputImageRegionType;
56  using InputPathType = TInputPath;
57  using InputPathPointer = typename InputPathType::Pointer;
58  using InputPathConstPointer = typename InputPathType::ConstPointer;
59  using OutputImageType = TOutputImage;
60  using OutputImagePointer = typename OutputImageType::Pointer;
62  using ValueType = typename OutputImageType::ValueType;
63 
65  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
66 
68  using Superclass::SetInput;
69  virtual void
70  SetInput(const InputPathType * path);
71 
72  virtual void
73  SetInput(unsigned int, const TInputPath * path);
74 
75  const InputPathType *
76  GetInput();
77 
78  const InputPathType *
79  GetInput(unsigned int idx);
80 
85  virtual void
86  SetSpacing(const double * spacing);
87 
88  virtual void
89  SetSpacing(const float * spacing);
90 
91  virtual const double *
92  GetSpacing() const;
93 
96  itkSetMacro(PathValue, ValueType);
97  itkGetConstMacro(PathValue, ValueType);
98  itkSetMacro(BackgroundValue, ValueType);
99  itkGetConstMacro(BackgroundValue, ValueType);
101 
106  virtual void
107  SetOrigin(const double * origin);
108 
109  virtual void
110  SetOrigin(const float * origin);
111 
112  virtual const double *
113  GetOrigin() const;
114 
116  itkSetMacro(Size, SizeType);
117  itkGetConstMacro(Size, SizeType);
119 
120 protected:
122  ~PathToImageFilter() override = default;
123 
124  void
126  {} // do nothing
127  void
128  GenerateData() override;
129 
131  double m_Spacing[OutputImageDimension];
132  double m_Origin[OutputImageDimension];
135 
136  void
137  PrintSelf(std::ostream & os, Indent indent) const override;
138 };
139 } // end namespace itk
140 
141 #ifndef ITK_MANUAL_INSTANTIATION
142 # include "itkPathToImageFilter.hxx"
143 #endif
144 
145 #endif
itk::ImageSource::OutputImagePointer
typename OutputImageType::Pointer OutputImagePointer
Definition: itkImageSource.h:91
itkImageSource.h
itk::PathToImageFilter::GenerateOutputInformation
void GenerateOutputInformation() override
Definition: itkPathToImageFilter.h:125
itk::Size
Represent a n-dimensional size (bounds) of a n-dimensional image.
Definition: itkSize.h:69
itk::PathToImageFilter::InputPathType
TInputPath InputPathType
Definition: itkPathToImageFilter.h:56
itkConceptChecking.h
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::PathToImageFilter::m_PathValue
ValueType m_PathValue
Definition: itkPathToImageFilter.h:133
itk::ImageSource
Base class for all process objects that output image data.
Definition: itkImageSource.h:67
itk::PathToImageFilter::InputPathPointer
typename InputPathType::Pointer InputPathPointer
Definition: itkPathToImageFilter.h:57
itk::PathToImageFilter::SizeType
typename OutputImageType::SizeType SizeType
Definition: itkPathToImageFilter.h:61
itk::ImageSource::OutputImageRegionType
typename OutputImageType::RegionType OutputImageRegionType
Definition: itkImageSource.h:92
itk::PathToImageFilter::InputPathConstPointer
typename InputPathType::ConstPointer InputPathConstPointer
Definition: itkPathToImageFilter.h:58
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::PathToImageFilter
Base class for filters that take a Path as input and produce an image as output. Base class for filte...
Definition: itkPathToImageFilter.h:37
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:138
itk::PathToImageFilter::m_Size
SizeType m_Size
Definition: itkPathToImageFilter.h:130
itk::PathToImageFilter::ValueType
typename OutputImageType::ValueType ValueType
Definition: itkPathToImageFilter.h:62
itk::ImageSource::OutputImageType
TOutputImage OutputImageType
Definition: itkImageSource.h:90
itk::PathToImageFilter::m_BackgroundValue
ValueType m_BackgroundValue
Definition: itkPathToImageFilter.h:134