itkImageRegionSplitterBase.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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.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:
  typedef ImageRegionSplitterBase    Self;
  typedef Object                     Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkTypeMacro(ImageRegionSplitterBase, Object);

  template <unsigned int VImageDimension>
    unsigned int GetNumberOfSplits(const ImageRegion<VImageDimension> & region,
                                   unsigned int requestedNumber) const
  {
    return this->GetNumberOfSplitsInternal( VImageDimension,
                                            region.GetIndex().m_Index,
                                            region.GetSize().m_Size,
                                            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_Index,
                                   region.GetModifiableSize().m_Size );
  }
  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;

  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;

private:
  ImageRegionSplitterBase(const ImageRegionSplitterBase &) ITK_DELETE_FUNCTION;
  void operator=(const ImageRegionSplitterBase &) ITK_DELETE_FUNCTION;
};
} // end namespace itk

#endif