otbImageToNoDataMaskFilter.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 otbImageToNoDataMaskFilter_h
#define otbImageToNoDataMaskFilter_h
 
#include "itkUnaryFunctorImageFilter.h"
#include "itkMetaDataObject.h"
#include "otbMetaDataKey.h"
#include "otbNoDataHelper.h"
 
namespace otb
{
namespace Functor
{
template <typename TInputPixel, typename TOutputPixel>
class NoDataFunctor
{
public:
  NoDataFunctor() : m_Flags(), m_Values(), m_OutsideValue(0), m_InsideValue(1), m_NaNIsNoData(false)
  {
  }
 
  virtual ~NoDataFunctor() = default;
 
  inline TOutputPixel operator()(const TInputPixel& in) const
  {
    return otb::IsNoData(in, m_Flags, m_Values, m_NaNIsNoData) ? m_OutsideValue : m_InsideValue;
  }
 
  std::vector<bool>   m_Flags;
  std::vector<double> m_Values;
  TOutputPixel        m_OutsideValue;
  TOutputPixel        m_InsideValue;
  bool                m_NaNIsNoData;
};
 
} // End namespace Functor
 
 
template <typename TInputImage, typename TOutputImage>
class ImageToNoDataMaskFilter
    : public itk::UnaryFunctorImageFilter<TInputImage, TOutputImage, Functor::NoDataFunctor<typename TInputImage::PixelType, typename TOutputImage::PixelType>>
{
public:
  typedef Functor::NoDataFunctor<typename TInputImage::PixelType, typename TOutputImage::PixelType> FunctorType;
 
  typedef ImageToNoDataMaskFilter Self;
  typedef itk::UnaryFunctorImageFilter<TInputImage, TOutputImage, FunctorType> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(SpectralAngleDistanceImageFilter, itk::ImageToImageFilter);
 
  void SetInsideValue(const typename TOutputImage::PixelType& value)
  {
    this->GetFunctor().m_InsideValue = value;
  }
 
  void SetOutsideValue(const typename TOutputImage::PixelType& value)
  {
    this->GetFunctor().m_OutsideValue = value;
  }
 
  void SetNaNIsNoData(bool nanIsNoData)
  {
    this->GetFunctor().m_NaNIsNoData = nanIsNoData;
  }
 
protected:
  ImageToNoDataMaskFilter() = default;
 
  ~ImageToNoDataMaskFilter() = default;
 
  void BeforeThreadedGenerateData() override
  {
    std::vector<bool>   noDataValueAvailable;
    std::vector<double> noDataValues;
 
    ReadNoDataFlags(this->GetInput()->GetImageMetadata(), noDataValueAvailable, noDataValues);
 
    // don't pass empty containers to the functor
    if (noDataValueAvailable.empty() || noDataValues.empty())
    {
      const TInputImage* input = this->GetInput();
      noDataValueAvailable.assign(input->GetNumberOfComponentsPerPixel(), false);
      noDataValues.assign(input->GetNumberOfComponentsPerPixel(), 0.0);
    }
 
    this->GetFunctor().m_Flags  = noDataValueAvailable;
    this->GetFunctor().m_Values = noDataValues;
  }
 
private:
  ImageToNoDataMaskFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
};
 
} // End namespace otb
 
 
#endif