otbClampImageFilter.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * 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
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 otbClampImageFilter_h
#define otbClampImageFilter_h
 
#include "otbConvertTypeFunctor.h"
#include "itkUnaryFunctorImageFilter.h"
 
namespace otb
{
 
template <class TInputImage, class TOutputImage = TInputImage>
class ITK_EXPORT ClampImageFilter
: public itk::ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  using Self         = ClampImageFilter;
  using Superclass   = itk::ImageToImageFilter<TInputImage, TOutputImage>;
  using FunctorType  = Functor::ConvertTypeFunctor<typename TInputImage::PixelType, typename TOutputImage::PixelType>;
  using Pointer      = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkTypeMacro(ClampImageFilter, OSEF);
 
 
  using InputImageType          = TInputImage;
  using InputImageRegionType    = typename InputImageType::RegionType;
  using InputImagePixelType     = typename InputImageType::PixelType;
 
  using OutputImageType         = TOutputImage;
  using OutputImageRegionType   = typename OutputImageType::RegionType;
  using OutputImagePixelType    = typename OutputImageType::PixelType;
  using OutputInternalPixelType = typename OutputImageType::InternalPixelType;
  using OutputPixelValueType    = typename itk::NumericTraits<OutputInternalPixelType>::ValueType;
 
  void ClampAbove(const OutputPixelValueType& thresh);
 
  void ClampBelow(const OutputPixelValueType& thresh);
 
  void ClampOutside(const OutputPixelValueType& lower, const OutputPixelValueType& upper);
 
  void SetThresholds(OutputPixelValueType lowerVal, OutputPixelValueType upperVal);
  itkGetConstMacro(Lower, OutputPixelValueType);
  itkGetConstMacro(Upper, OutputPixelValueType);
 
 
protected:
  ClampImageFilter();
  ~ClampImageFilter() override = default;
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void GenerateOutputInformation(void) override
  {
    Superclass::GenerateOutputInformation();
    unsigned int sizeIn = this->GetInput()->GetNumberOfComponentsPerPixel();
    this->GetFunctor().SetInputComponents(sizeIn);
    this->GetOutput()->SetNumberOfComponentsPerPixel(this->GetFunctor().GetOutputSize());
  }
 
  void DynamicThreadedGenerateData(const OutputImageRegionType& outputRegionForThread) override;
 
  FunctorType      & GetFunctor()       noexcept { return m_Functor; }
  FunctorType const& GetFunctor() const noexcept { return m_Functor; }
 
private:
  ClampImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  OutputPixelValueType m_Lower;
  OutputPixelValueType m_Upper;
  FunctorType          m_Functor;
};
 
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbClampImageFilter.hxx"
#endif
 
#endif