itkImageRegionSplitter.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 itkImageRegionSplitter_h
#define itkImageRegionSplitter_h

#include "itkImageRegion.h"
#include "itkImageRegionSplitterBase.h"

namespace itk
{
template< unsigned int VImageDimension >
class ITK_TEMPLATE_EXPORT ImageRegionSplitter:public ImageRegionSplitterBase
{
public:
  typedef ImageRegionSplitter        Self;
  typedef ImageRegionSplitterBase    Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(ImageRegionSplitter, Object);

  itkStaticConstMacro(ImageDimension, unsigned int, VImageDimension);

  static unsigned int GetImageDimension()
  { return VImageDimension; }

  typedef Index< VImageDimension >           IndexType;

  typedef Size< VImageDimension >          SizeType;
  typedef typename SizeType::SizeValueType SizeValueType;

  typedef ImageRegion< VImageDimension > RegionType;

  virtual unsigned int GetNumberOfSplits(const RegionType & region,
                                         unsigned int requestedNumber);


  virtual RegionType GetSplit(unsigned int i, unsigned int numberOfPieces,
                              const RegionType & region);

protected:
  ImageRegionSplitter() {}
  ~ImageRegionSplitter() {}

  virtual unsigned int GetNumberOfSplitsInternal(unsigned int,
                                         const IndexValueType regionIndex[],
                                         const SizeValueType regionSize[],
                                         unsigned int requestedNumber) const ITK_OVERRIDE
  {
    // this function adapts the legecy method, defined in this class
    // be used by the ImageRegionSplitterBase.
    IndexType idx;
    idx.SetIndex( regionIndex );
    SizeType sz;
    sz.SetSize( regionSize );
    RegionType region = RegionType(idx, sz);

    Self *nonconst_this = const_cast<Self*>(this);
    return nonconst_this->GetNumberOfSplits(region, requestedNumber);

  }

  virtual unsigned int GetSplitInternal(unsigned int dim,
                                unsigned int i,
                                unsigned int numberOfPieces,
                                IndexValueType regionIndex[],
                                SizeValueType regionSize[]) const ITK_OVERRIDE
  {
    // this function adapts the legecy method, defined in this class
    // be used by the ImageRegionSplitterBase.
    IndexType idx;
    idx.SetIndex( regionIndex );
    SizeType sz;
    sz.SetSize( regionSize );
    RegionType region = RegionType(idx, sz);

    Self *nonconst_this = const_cast<Self*>(this);
    region = nonconst_this->GetSplit(i, numberOfPieces, region);

    for (unsigned int d = 0; d < dim; ++d)
      {
      regionIndex[d] = region.GetIndex(d);
      regionSize[d] = region.GetSize(d);
      }
    return numberOfPieces;
  }

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

private:
  ITK_DISALLOW_COPY_AND_ASSIGN(ImageRegionSplitter);
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkImageRegionSplitter.hxx"
#endif

#endif