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 "itkObjectFactory.h"

namespace itk
{
template< unsigned int VImageDimension >
class ITK_EXPORT ImageRegionSplitter:public Object
{
public:
  typedef ImageRegionSplitter        Self;
  typedef Object                     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() {}
  void PrintSelf(std::ostream & os, Indent indent) const;

private:
  ImageRegionSplitter(const ImageRegionSplitter &); //purposely not implemented
  void operator=(const ImageRegionSplitter &);      //purposely not implemented
};
} // end namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_ImageRegionSplitter(_, EXPORT, TypeX, TypeY)                   \
  namespace itk                                                                     \
  {                                                                                 \
  _( 1 ( class EXPORT ImageRegionSplitter< ITK_TEMPLATE_1 TypeX > ) )               \
  namespace Templates                                                               \
  {                                                                                 \
  typedef ImageRegionSplitter< ITK_TEMPLATE_1 TypeX > ImageRegionSplitter##TypeY; \
  }                                                                                 \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkImageRegionSplitter+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkImageRegionSplitter.hxx"
#endif

#endif