otbImageRegionAdaptativeSplitter.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 otbImageRegionAdaptativeSplitter_h
#define otbImageRegionAdaptativeSplitter_h
 
#include "itkRegion.h"
#include "itkImageRegionSplitter.h"
#include "itkIndex.h"
#include "itkSize.h"
#include <mutex>
 
namespace otb
{
 
template <unsigned int VImageDimension>
class ITK_EXPORT       ImageRegionAdaptativeSplitter : public itk::ImageRegionSplitter<VImageDimension>
{
public:
  typedef ImageRegionAdaptativeSplitter             Self;
  typedef itk::ImageRegionSplitter<VImageDimension> Superclass;
  typedef itk::SmartPointer<Self>                   Pointer;
  typedef itk::SmartPointer<const Self>             ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(ImageRegionAdaptativeSplitter, itk::Object);
 
  itkStaticConstMacro(ImageDimension, unsigned int, VImageDimension);
 
  static unsigned int GetImageDimension()
  {
    return VImageDimension;
  }
 
  typedef itk::Index<VImageDimension>        IndexType;
  typedef typename IndexType::IndexValueType IndexValueType;
 
  typedef itk::Size<VImageDimension>       SizeType;
  typedef typename SizeType::SizeValueType SizeValueType;
 
  typedef itk::ImageRegion<VImageDimension> RegionType;
 
  typedef std::vector<RegionType> StreamVectorType;
 
  itkSetMacro(TileHint, SizeType);
 
  itkGetConstReferenceMacro(TileHint, SizeType);
 
  itkSetMacro(ImageRegion, RegionType);
 
  itkGetConstReferenceMacro(ImageRegion, RegionType);
 
  itkSetMacro(RequestedNumberOfSplits, unsigned int);
 
  itkGetConstReferenceMacro(RequestedNumberOfSplits, unsigned int);
 
  unsigned int GetNumberOfSplits(const RegionType& region, unsigned int requestedNumber) override;
 
  RegionType GetSplit(unsigned int i, unsigned int numberOfPieces, const RegionType& region) override;
 
  void Modified() const override
  {
    // Call superclass implementation
    Superclass::Modified();
 
    // Invalidate up-to-date
    m_IsUpToDate = false;
  }
 
protected:
  ImageRegionAdaptativeSplitter() : m_TileHint(), m_ImageRegion(), m_RequestedNumberOfSplits(0), m_StreamVector(), m_IsUpToDate(false)
  {
  }
 
  ~ImageRegionAdaptativeSplitter() override
  {
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  void EstimateSplitMap();
 
  ImageRegionAdaptativeSplitter(const ImageRegionAdaptativeSplitter&) = delete;
  void operator=(const ImageRegionAdaptativeSplitter&) = delete;
 
  // This reflects the input image tiling
  SizeType m_TileHint{0,0};
 
  // This contains the ImageRegion that is currently being split
  RegionType m_ImageRegion;
 
  // This contains the requested number of splits
  unsigned int m_RequestedNumberOfSplits;
 
  // This is a vector of all regions which will be split
  StreamVectorType m_StreamVector;
 
  // Is the splitter up-to-date ?
  mutable bool m_IsUpToDate;
 
  // Lock to ensure thread-safety
  std::mutex m_Lock;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbImageRegionAdaptativeSplitter.hxx"
#endif
 
#endif