otbClampImageFilter.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2022 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_hxx
#define otbClampImageFilter_hxx
 
#include "otbClampImageFilter.h"
#include "itkImageScanlineIterator.h"
#include "itkImageScanlineConstIterator.h"
#include "itkImageRegionIterator.h"
#include "itkNumericTraits.h"
#include "itkObjectFactory.h"
#include "itkProgressReporter.h"
#include <limits>
 
namespace otb
{
 
template <class TInputImage, class TOutputImage>
ClampImageFilter<TInputImage, TOutputImage>::ClampImageFilter()
  :
  m_Lower(std::numeric_limits<OutputPixelValueType>::lowest()),
  m_Upper(std::numeric_limits<OutputPixelValueType>::max())
{}
 
template <class TInputImage, class TOutputImage>
void ClampImageFilter<TInputImage, TOutputImage>::SetThresholds(OutputPixelValueType lowerVal, OutputPixelValueType upperVal)
{
  assert( lowerVal <= upperVal );
  if ((m_Lower != lowerVal) || (m_Upper != upperVal))
  {
    m_Lower = lowerVal;
    m_Upper = upperVal;
    this->GetFunctor().SetThresholds(m_Lower, m_Upper);
    this->Modified();
  }
}
 
template <class TInputImage, class TOutputImage>
void ClampImageFilter<TInputImage, TOutputImage>::PrintSelf(std::ostream& os, itk::Indent indent) const
{
  Superclass::PrintSelf(os, indent);
 
  os << indent << "Lower: " << static_cast<typename itk::NumericTraits<OutputImagePixelType>::PrintType>(m_Lower) << std::endl;
  os << indent << "Upper: " << static_cast<typename itk::NumericTraits<OutputImagePixelType>::PrintType>(m_Upper) << std::endl;
}
 
template <class TInputImage, class TOutputImage>
void ClampImageFilter<TInputImage, TOutputImage>::ClampAbove(const OutputPixelValueType& thresh)
{
  if (m_Upper != thresh || m_Lower > std::numeric_limits<OutputPixelValueType>::lowest())
  {
    m_Lower = std::numeric_limits<OutputPixelValueType>::lowest();
    m_Upper = thresh;
    this->GetFunctor().SetThresholds(m_Lower, m_Upper);
    this->Modified();
  }
}
 
template <class TInputImage, class TOutputImage>
void ClampImageFilter<TInputImage, TOutputImage>::ClampBelow(const OutputPixelValueType& thresh)
{
  if (m_Lower != thresh || m_Upper < std::numeric_limits<OutputPixelValueType>::max())
  {
    m_Upper = std::numeric_limits<OutputPixelValueType>::max();
    m_Lower = thresh;
    this->GetFunctor().SetThresholds(m_Lower, m_Upper);
    this->Modified();
  }
}
 
 
template <class TInputImage, class TOutputImage>
void ClampImageFilter<TInputImage, TOutputImage>::ClampOutside(const OutputPixelValueType& lower, const OutputPixelValueType& upper)
{
  if (lower > upper)
  {
    itkExceptionMacro(<< "Lower threshold cannot be greater than upper threshold.");
    return;
  }
 
  if (m_Lower != lower || m_Upper != upper)
  {
    m_Lower = lower;
    m_Upper = upper;
    this->GetFunctor().SetThresholds(m_Lower, m_Upper);
    this->Modified();
  }
}
 
template <class TInputImage, class TOutputImage>
void
ClampImageFilter<TInputImage, TOutputImage>
::ThreadedGenerateData(const OutputImageRegionType& outputRegionForThread, itk::ThreadIdType threadId)
{
  const auto& regionSize = outputRegionForThread.GetSize();
 
  if (regionSize[0] == 0)
  {
    return;
  }
  const auto            numberOfLinesToProcess = outputRegionForThread.GetNumberOfPixels() / regionSize[0];
  itk::ProgressReporter p(this, threadId, numberOfLinesToProcess);
 
  // Build output iterator
  itk::ImageScanlineConstIterator<InputImageType>  inIt(this->GetInput(), outputRegionForThread);
  itk::ImageScanlineIterator<OutputImageType>      outIt(this->GetOutput(), outputRegionForThread);
 
  // Build a default value
  typename OutputImageType::PixelType outputValueHolder;
  // Luc: I'm not sure this will be the correct size given the convoluted
  // size computations done in the ConvertTypeFunctor
  itk::NumericTraits<typename OutputImageType::PixelType>::SetLength(outputValueHolder, this->GetOutput()->GetNumberOfComponentsPerPixel());
 
  while (!outIt.IsAtEnd())
  {
    // MoveIterartors will ++ all iterators in the tuple
    for (; !outIt.IsAtEndOfLine(); ++outIt, ++inIt)
    {
      // This will call the operator with inputIterators Get() results
      // and fill outputValueHolder with the result.
      m_Functor(outputValueHolder, inIt.Get());
      outIt.Set(outputValueHolder);
    }
    outIt.NextLine();
    inIt.NextLine();
    p.CompletedPixel(); // may throw
  }
}
 
} // end namespace otb
 
#endif