itkShiftScaleImageFilter.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 itkShiftScaleImageFilter_h
#define itkShiftScaleImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "itkArray.h"
#include <mutex>
 
namespace itk
{
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT ShiftScaleImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ShiftScaleImageFilter);

  using Self = ShiftScaleImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  using InputImageRegionType = typename TInputImage::RegionType;
  using OutputImageRegionType = typename TOutputImage::RegionType;

  using InputImagePointer = typename TInputImage::Pointer;
  using OutputImagePointer = typename TOutputImage::Pointer;

  using InputImagePixelType = typename TInputImage::PixelType;
  using OutputImagePixelType = typename TOutputImage::PixelType;

  using InputImageIndexType = typename TInputImage::IndexType;
  using InputImageSizeType = typename TInputImage::SizeType;
  using InputImageOffsetType = typename TInputImage::OffsetType;
  using OutputImageIndexType = typename TOutputImage::IndexType;
  using OutputImageSizeType = typename TOutputImage::SizeType;
  using OutputImageOffsetType = typename TOutputImage::OffsetType;

  using RealType = typename NumericTraits<OutputImagePixelType>::RealType;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  itkOverrideGetNameOfClassMacro(ShiftScaleImageFilter);

  itkSetMacro(Shift, RealType);
  itkGetConstMacro(Shift, RealType);

  itkSetMacro(Scale, RealType);
  itkGetConstMacro(Scale, RealType);

  itkGetConstMacro(UnderflowCount, SizeValueType);
  itkGetConstMacro(OverflowCount, SizeValueType);
 
  itkConceptMacro(OutputHasNumericTraitsCheck, (Concept::HasNumericTraits<OutputImagePixelType>));
  itkConceptMacro(InputPlusRealTypeCheck, (Concept::AdditiveOperators<InputImagePixelType, RealType, RealType>));
  itkConceptMacro(RealTypeMultiplyOperatorCheck, (Concept::MultiplyOperator<RealType>));
 
protected:
  ShiftScaleImageFilter() = default;
  ~ShiftScaleImageFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  BeforeThreadedGenerateData() override;
 
  void
  DynamicThreadedGenerateData(const OutputImageRegionType &) override;
 
private:
  RealType m_Shift{};
  RealType m_Scale{ NumericTraits<RealType>::OneValue() };
 
  SizeValueType m_UnderflowCount{ 0 };
  SizeValueType m_OverflowCount{ 0 };
 
  std::mutex m_Mutex{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkShiftScaleImageFilter.hxx"
#endif
 
#endif