itkThreadedImageRegionPartitioner.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 itkThreadedImageRegionPartitioner_h
#define itkThreadedImageRegionPartitioner_h
 
#include "itkThreadedDomainPartitioner.h"
#include "itkImageRegion.h"
#include "itkImageRegionSplitterSlowDimension.h"
 
namespace itk
{
 
template <unsigned int VDimension>
class ITK_TEMPLATE_EXPORT ThreadedImageRegionPartitioner : public ThreadedDomainPartitioner<ImageRegion<VDimension>>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ThreadedImageRegionPartitioner);
 
  using Self = ThreadedImageRegionPartitioner;
  using Superclass = ThreadedDomainPartitioner<ImageRegion<VDimension>>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkOverrideGetNameOfClassMacro(ThreadedImageRegionPartitioner);
 
  using typename Superclass::DomainType;
 
  static constexpr unsigned int ImageDimension = VDimension;
  using ImageRegionType = typename Self::DomainType;
  using SizeType = typename ImageRegionType::SizeType;
  using IndexType = typename ImageRegionType::IndexType;
 
  ThreadIdType
  PartitionDomain(const ThreadIdType threadId,
                  const ThreadIdType requestedTotal,
                  const DomainType & completeRegion,
                  DomainType &       subRegion) const override;
 
protected:
  ThreadedImageRegionPartitioner() = default;
  ~ThreadedImageRegionPartitioner() override = default;
 
  using ImageRegionSplitterType = ImageRegionSplitterSlowDimension;
 
private:
  ImageRegionSplitterType::Pointer m_ImageRegionSplitter{ ImageRegionSplitterType::New() };
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkThreadedImageRegionPartitioner.hxx"
#endif
 
#endif