itkImageRegionSplitterBase.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  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 itkImageRegionSplitterBase_h
#define itkImageRegionSplitterBase_h
 
#include "itkImageRegion.h"
#include "itkObjectFactory.h"
#include "itkImageIORegion.h"
 
namespace itk
{
 
class ITKCommon_EXPORT ImageRegionSplitterBase : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ImageRegionSplitterBase);
 
  using Self = ImageRegionSplitterBase;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkOverrideGetNameOfClassMacro(ImageRegionSplitterBase);
 
  template <unsigned int VImageDimension>
  unsigned int
  GetNumberOfSplits(const ImageRegion<VImageDimension> & region, unsigned int requestedNumber) const
  {
    return this->GetNumberOfSplitsInternal(
      VImageDimension, region.GetIndex().m_InternalArray, region.GetSize().m_InternalArray, requestedNumber);
  }
  inline unsigned int
  GetNumberOfSplits(const ImageIORegion & region, unsigned int requestedNumber) const
  {
    return this->GetNumberOfSplitsInternal(
      region.GetImageDimension(), &region.GetIndex()[0], &region.GetSize()[0], requestedNumber);
  }
  template <unsigned int VImageDimension>
  unsigned int
  GetSplit(unsigned int i, unsigned int numberOfPieces, ImageRegion<VImageDimension> & region) const
  {
    return this->GetSplitInternal(VImageDimension,
                                  i,
                                  numberOfPieces,
                                  region.GetModifiableIndex().m_InternalArray,
                                  region.GetModifiableSize().m_InternalArray);
  }
  unsigned int
  GetSplit(unsigned int i, unsigned int numberOfPieces, ImageIORegion & region) const
  {
    return this->GetSplitInternal(
      region.GetImageDimension(), i, numberOfPieces, &region.GetModifiableIndex()[0], &region.GetModifiableSize()[0]);
  }
 
protected:
  ImageRegionSplitterBase();
 
  virtual unsigned int
  GetNumberOfSplitsInternal(unsigned int         dim,
                            const IndexValueType regionIndex[],
                            const SizeValueType  regionSize[],
                            unsigned int         requestedNumber) const = 0;
 
  virtual unsigned int
  GetSplitInternal(unsigned int   dim,
                   unsigned int   i,
                   unsigned int   numberOfPieces,
                   IndexValueType regionIndex[],
                   SizeValueType  regionSize[]) const = 0;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
};
} // end namespace itk
 
#endif