/*
 * 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 otbMaskedIteratorDecorator_h
#define otbMaskedIteratorDecorator_h

#include "itkMacro.h"

namespace otb
{

/** \class MaskedIteratorDecorator
 * \brief Decorate an iterator to ignore masked pixels
 *
 * An iterator that dispatches its operations on both an image and a mask using
 * two iterators of the same type. It skips over pixels where the value of the
 * mask is zero. There is a limitation that the image and the mask must both be
 * of the same type.
 *
 * \ingroup OTBImageManipulation
 */
template <typename TIteratorType, typename TMaskIteratorType = TIteratorType>
class MaskedIteratorDecorator
{
public:
  typedef MaskedIteratorDecorator<TIteratorType, TMaskIteratorType> Self;
  typedef typename TMaskIteratorType::ImageType MaskType;
  typedef typename TIteratorType::ImageType     ImageType;
  typedef typename ImageType::IndexType         IndexType;
  typedef typename ImageType::RegionType        RegionType;
  typedef typename ImageType::PixelType         PixelType;
  typedef typename MaskType::PixelType          MaskPixelType;

  // Run-time type information
  itkTypeMacroNoParent(MaskedIteratorDecorator);

  /** Constructors forward arguments to both iterators
   * Beware that the iterator is in a undefinite state after construction
   * GoToBegin() or GoToEnd() should be called */
  MaskedIteratorDecorator(MaskType* mask, ImageType* image, const RegionType& region);

  /** Current iterator index. Wraps the underlying iterator GetIndex() */
  IndexType GetIndex() const;

  /** Move to the first valid iteration position. Note that this is different
   * from the underlying iterators GoToBegin because their first pixels might be
   * masked */
  void GoToBegin();

  /** Move one pixel past the last valid iteration index */
  void GoToEnd();

  /** True if the iterator is at the beginning */
  bool IsAtBegin() const;

  /** True if the iterator is at the end */
  bool IsAtEnd() const;

  /** Advance to the next valid iteration position. That is the next non masked
   * position of the image iterator */
  Self& operator++();

  /** Move to the previous valid iteration position. That is the previous non
   * masked position of the image iterator */
  Self& operator--();

  /** Set the image pixel value */
  // void Set(const PixelType& value) const;

  /** Get the image pixel value */
  const PixelType& Value(void) const;

  // Can't wrap all methods because iterator interface is open ended
  // So provide access to inner iterators:

  /** Underlying mask iterator accessor */
  TMaskIteratorType& GetMaskIterator();

  /** Underlying mask iterator const accessor */
  const TMaskIteratorType& GetMaskIterator() const;

  /** Underlying image iterator accessor */
  TIteratorType& GetImageIterator();

  /** Underlying image iterator const accessor */
  const TIteratorType& GetImageIterator() const;

  const bool& HasMask() const;

private:
  /** Private method to compute the begin iterator position taking into account
  the mask. Called by the constructor. */
  void ComputeMaskedBegin();

private:
  // Inner iterators on the image and mask
  TMaskIteratorType m_ItMask;
  TIteratorType     m_ItImage;

  // flag to check if mask is present
  bool m_UseMask;

  // Unmasked bounds
  TMaskIteratorType m_StartMask;
  TIteratorType     m_StartImage;
};
}

#ifndef OTB_MANUAL_INSTANTIATION
#include "otbMaskedIteratorDecorator.hxx"
#endif

#endif
