otbClampVectorImageFilter.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 otbClampVectorImageFilter_h
#define otbClampVectorImageFilter_h
 
#include "itkImageToImageFilter.h"
 
namespace otb
{
 
template <class TInputImage, class TOutputImage = TInputImage>
class ITK_EXPORT ClampVectorImageFilter : public itk::ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  typedef ClampVectorImageFilter Self;
  typedef itk::ImageToImageFilter<TInputImage, TOutputImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(ClampVectorImageFilter, itk::ImageToImageFilter);
 
 
  typedef TInputImage                                InputImageType;
  typedef typename InputImageType::ConstPointer      InputImagePointer;
  typedef typename InputImageType::RegionType        InputImageRegionType;
  typedef typename InputImageType::PixelType         InputImagePixelType;
  typedef typename InputImageType::InternalPixelType InputImageInternalPixelType;
 
  typedef TOutputImage                                OutputImageType;
  typedef typename OutputImageType::Pointer           OutputImagePointer;
  typedef typename OutputImageType::RegionType        OutputImageRegionType;
  typedef typename OutputImageType::PixelType         OutputImagePixelType;
  typedef typename OutputImageType::InternalPixelType OutputImageInternalPixelType;
 
 
  void ClampAbove(const OutputImageInternalPixelType& thresh);
 
  void ClampBelow(const OutputImageInternalPixelType& thresh);
 
  void ClampOutside(const OutputImageInternalPixelType& lower, const OutputImageInternalPixelType& upper);
 
  void SetLower(OutputImageInternalPixelType val)
  {
    m_Lower  = val;
    m_DLower = static_cast<double>(val);
    this->Modified();
  }
  itkGetConstMacro(Lower, OutputImageInternalPixelType);
 
  void SetUpper(OutputImageInternalPixelType val)
  {
    m_Upper  = val;
    m_DUpper = static_cast<double>(val);
    this->Modified();
  }
  itkGetConstMacro(Upper, OutputImageInternalPixelType);
 
 
protected:
  ClampVectorImageFilter();
  ~ClampVectorImageFilter() override{};
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void DynamicThreadedGenerateData(const OutputImageRegionType& outputRegionForThread) override;
 
  void GenerateOutputInformation(void) override
  {
    Superclass::GenerateOutputInformation();
 
    this->GetOutput()->SetNumberOfComponentsPerPixel(this->GetInput()->GetNumberOfComponentsPerPixel());
  }
 
private:
  ClampVectorImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  double m_DLower;
  double m_DUpper;
 
  OutputImageInternalPixelType m_Lower;
  OutputImageInternalPixelType m_Upper;
};
 
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbClampVectorImageFilter.hxx"
#endif
 
#endif