itkExpNegativeImageFilter.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 itkExpNegativeImageFilter_h
#define itkExpNegativeImageFilter_h
 
#include "itkUnaryFunctorImageFilter.h"
#include "itkMath.h"
 
namespace itk
{
namespace Functor
{
template <typename TInput, typename TOutput>
class ExpNegative
{
public:
  ExpNegative() = default;
  ~ExpNegative() = default;
 
  bool
  operator==(const ExpNegative & other) const
  {
    return Math::ExactlyEquals(m_Factor, other.m_Factor);
  }
 
  ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(ExpNegative);
 
  inline TOutput
  operator()(const TInput & A) const
  {
    return static_cast<TOutput>(std::exp(-m_Factor * static_cast<double>(A)));
  }

  void
  SetFactor(double factor)
  {
    m_Factor = factor;
  }
 
  [[nodiscard]] double
  GetFactor() const
  {
    return m_Factor;
  }
 
private:
  double m_Factor{ 1.0 };
};
} // namespace Functor

template <typename TInputImage, typename TOutputImage>
class ExpNegativeImageFilter
  : public UnaryFunctorImageFilter<
      TInputImage,
      TOutputImage,
      Functor::ExpNegative<typename TInputImage::PixelType, typename TOutputImage::PixelType>>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ExpNegativeImageFilter);

  using Self = ExpNegativeImageFilter;
  using Superclass =
    UnaryFunctorImageFilter<TInputImage,
                            TOutputImage,
                            Functor::ExpNegative<typename TInputImage::PixelType, typename TOutputImage::PixelType>>;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ExpNegativeImageFilter);
 
  void
  SetFactor(double factor)
  {
    if (factor == this->GetFunctor().GetFactor())
    {
      return;
    }
    this->GetFunctor().SetFactor(factor);
    this->Modified();
  }
  [[nodiscard]] double
  GetFactor() const
  {
    return this->GetFunctor().GetFactor();
  }
 
  itkConceptMacro(InputConvertibleToDoubleCheck, (Concept::Convertible<typename TInputImage::PixelType, double>));
  itkConceptMacro(DoubleConvertibleToOutputCheck, (Concept::Convertible<double, typename TOutputImage::PixelType>));
 
protected:
  ExpNegativeImageFilter() = default;
  ~ExpNegativeImageFilter() override = default;
};
} // end namespace itk
 
#endif