ITK  5.3.0
Insight Toolkit
itkParametricImageSource.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 itkParametricImageSource_h
19 #define itkParametricImageSource_h
20 
21 #include "itkGenerateImageSource.h"
22 
23 #include "itkArray.h"
24 
25 namespace itk
26 {
27 
44 template <typename TOutputImage>
45 class ITK_TEMPLATE_EXPORT ParametricImageSource : public GenerateImageSource<TOutputImage>
46 {
47 public:
48  ITK_DISALLOW_COPY_AND_MOVE(ParametricImageSource);
49 
55 
58 
60  using OutputImageType = TOutputImage;
61  using OutputImagePointer = typename OutputImageType::Pointer;
62  using OutputImagePixelType = typename OutputImageType::PixelType;
63 
64  using ParametersValueType = double;
66 
68  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
69 
72 
77  virtual void
78  SetParameters(const ParametersType & parameters) = 0;
80 
82  virtual ParametersType
83  GetParameters() const = 0;
84 
86  virtual unsigned int
87  GetNumberOfParameters() const = 0;
88 
89 protected:
90  ParametricImageSource() = default;
91  ~ParametricImageSource() override = default;
92  void
93  PrintSelf(std::ostream & os, Indent indent) const override;
94 };
95 } // end namespace itk
96 
97 
98 #ifndef ITK_MANUAL_INSTANTIATION
99 # include "itkParametricImageSource.hxx"
100 #endif
101 
102 #endif
itk::ImageSource::OutputImagePointer
typename OutputImageType::Pointer OutputImagePointer
Definition: itkImageSource.h:91
itk::GenerateImageSource
a Base class for image sources which need to have image size, and other meta-data set.
Definition: itkGenerateImageSource.h:41
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::ImageSource
Base class for all process objects that output image data.
Definition: itkImageSource.h:67
itk::ParametricImageSource
Base class for all parametric image sources.
Definition: itkParametricImageSource.h:45
itkArray.h
itkGenerateImageSource.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::ImageSource::OutputImagePixelType
typename OutputImageType::PixelType OutputImagePixelType
Definition: itkImageSource.h:93
itk::Array
Array class with size defined at construction time.
Definition: itkArray.h:47
itk::DataObject::Pointer
SmartPointer< Self > Pointer
Definition: itkDataObject.h:301
itk::ParametricImageSource::ParametersValueType
double ParametersValueType
Definition: itkParametricImageSource.h:64
itk::ImageSource::OutputImageType
TOutputImage OutputImageType
Definition: itkImageSource.h:90