itkImageRegionSplitterMultidimensional.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 __itkImageRegionSplitterMultidimensional_h
#define __itkImageRegionSplitterMultidimensional_h

#include "itkRegion.h"
#include "itkIndex.h"
#include "itkImageRegionSplitterBase.h"

namespace itk
{
class ITKCommon_EXPORT ImageRegionSplitterMultidimensional
  : public ImageRegionSplitterBase
{
public:
  typedef ImageRegionSplitterMultidimensional Self;
  typedef ImageRegionSplitterBase             Superclass;
  typedef SmartPointer< Self >                Pointer;
  typedef SmartPointer< const Self >          ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(ImageRegionSplitterMultidimensional, ImageRegionSplitterBase);

protected:
  ImageRegionSplitterMultidimensional();


  virtual unsigned int GetNumberOfSplitsInternal(unsigned int dim,
                                                 const IndexValueType regionIndex[],
                                                 const SizeValueType regionSize[],
                                                 unsigned int requestedNumber) const;

  virtual unsigned int GetSplitInternal(unsigned int dim,
                                        unsigned int i,
                                        unsigned int numberOfPieces,
                                        IndexValueType regionIndex[],
                                        SizeValueType regionSize[]) const;

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

private:
  ImageRegionSplitterMultidimensional(const Self &); //purposely not implemented
  void operator=(const Self &);                      //purposely not
                                                     //implemented

  static unsigned int ComputeSplits(unsigned int dim,
                                    unsigned int requestedNumber,
                                    const IndexValueType regionIndex[],
                                    const SizeValueType regionSize[],
                                    unsigned int splits[]);

};
} // end namespace itk

#endif