otbChangeNoDataValueFilter.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 otbChangeNoDataValueFilter_h
#define otbChangeNoDataValueFilter_h
 
#include "itkUnaryFunctorImageFilter.h"
#include "itkMetaDataObject.h"
#include "otbMetaDataKey.h"
#include "otbNoDataHelper.h"
 
namespace otb
{
namespace Functor
{
template <typename TInputPixel, typename TOutputPixel>
class ChangeNoDataFunctor
{
public:
  ChangeNoDataFunctor() : m_Flags(), m_Values(), m_NewValues(), m_NaNIsNoData(false)
  {
  }
 
  virtual ~ChangeNoDataFunctor() = default;
 
  inline TOutputPixel operator()(const TInputPixel& in) const
  {
    return otb::ChangeNoData(in, m_Flags, m_Values, m_NewValues, m_NaNIsNoData);
  }
 
  std::vector<bool>   m_Flags;
  std::vector<double> m_Values;
  std::vector<double> m_NewValues;
  bool                m_NaNIsNoData;
};
 
} // End namespace Functor
 
template <typename TInputImage, typename TOutputImage>
class ChangeNoDataValueFilter
    : public itk::UnaryFunctorImageFilter<TInputImage, TOutputImage,
                                          Functor::ChangeNoDataFunctor<typename TInputImage::PixelType, typename TOutputImage::PixelType>>
{
public:
  typedef Functor::ChangeNoDataFunctor<typename TInputImage::PixelType, typename TOutputImage::PixelType> FunctorType;
 
  typedef ChangeNoDataValueFilter Self;
  typedef itk::UnaryFunctorImageFilter<TInputImage, TOutputImage, FunctorType> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(ChangeNoDataValueFilter, itk::ImageToImageFilter);
 
  void SetNewNoDataValues(std::vector<double>& newValues)
  {
    this->GetFunctor().m_NewValues = newValues;
  }
 
  void SetNaNIsNoData(bool nanIsNoData)
  {
    this->GetFunctor().m_NaNIsNoData = nanIsNoData;
  }
 
protected:
  ChangeNoDataValueFilter() = default;
 
  ~ChangeNoDataValueFilter() override = default;
 
  void GenerateOutputInformation() override
  {
    Superclass::GenerateOutputInformation();
 
    std::vector<bool>   noDataValueAvailable;
    std::vector<double> noDataValues;
 
    bool ret = ReadNoDataFlags(this->GetInput()->GetImageMetadata(), noDataValueAvailable, noDataValues);
 
    if (!ret)
    {
      noDataValueAvailable.resize(this->GetInput()->GetNumberOfComponentsPerPixel(), false);
      noDataValues.resize(this->GetInput()->GetNumberOfComponentsPerPixel(), 0);
    }
 
    this->GetFunctor().m_Flags  = noDataValueAvailable;
    this->GetFunctor().m_Values = noDataValues;
 
    std::vector<bool> flags = noDataValueAvailable;
 
    if ((this->GetFunctor().m_NaNIsNoData) || (!ret))
    {
      flags = std::vector<bool>(flags.size(), true);
    }
 
    WriteNoDataFlags(flags, this->GetFunctor().m_NewValues, this->GetOutput()->GetImageMetadata());
  }
 
private:
  ChangeNoDataValueFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
};
 
} // End namespace otb
 
 
#endif