itkParametricImageSource.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkParametricImageSource_h
#define itkParametricImageSource_h
 
#include "itkGenerateImageSource.h"
 
#include "itkArray.h"
 
namespace itk
{

template <typename TOutputImage>
class ITK_TEMPLATE_EXPORT ParametricImageSource : public GenerateImageSource<TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ParametricImageSource);

  using Self = ParametricImageSource;
  using Superclass = GenerateImageSource<TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using DataObjectPointer = DataObject::Pointer;

  using OutputImageType = TOutputImage;
  using OutputImagePointer = typename OutputImageType::Pointer;
  using OutputImagePixelType = typename OutputImageType::PixelType;
 
  using ParametersValueType = double;
  using ParametersType = Array<ParametersValueType>;

  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;

  itkOverrideGetNameOfClassMacro(ParametricImageSource);

  virtual void
  SetParameters(const ParametersType & parameters) = 0;

  virtual ParametersType
  GetParameters() const = 0;

  virtual unsigned int
  GetNumberOfParameters() const = 0;
 
protected:
  ParametricImageSource() = default;
  ~ParametricImageSource() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
};
} // end namespace itk
 
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkParametricImageSource.hxx"
#endif
 
#endif