otbMaskedIteratorDecorator.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 otbMaskedIteratorDecorator_h
#define otbMaskedIteratorDecorator_h
 
#include "itkMacro.h"
 
namespace otb
{
 
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);
 
  MaskedIteratorDecorator(MaskType* mask, ImageType* image, const RegionType& region);
 
  IndexType GetIndex() const;
 
  void GoToBegin();
 
  void GoToEnd();
 
  bool IsAtBegin() const;
 
  bool IsAtEnd() const;
 
  Self& operator++();
 
  Self& operator--();
 
  // void Set(const PixelType& value) const;
 
  const PixelType& Value(void) const;
 
  // Can't wrap all methods because iterator interface is open ended
  // So provide access to inner iterators:
 
  TMaskIteratorType& GetMaskIterator();
 
  const TMaskIteratorType& GetMaskIterator() const;
 
  TIteratorType& GetImageIterator();
 
  const TIteratorType& GetImageIterator() const;
 
  const bool& HasMask() const;
 
private:
  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