itkDomainThreader.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 itkDomainThreader_h
#define itkDomainThreader_h

#include "itkObject.h"
#include "itkMultiThreaderBase.h"

namespace itk
{

template< typename TDomainPartitioner, typename TAssociate >
class ITK_TEMPLATE_EXPORT DomainThreader: public Object
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(DomainThreader);

  using Self = DomainThreader;
  using Superclass = Object;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  using DomainPartitionerType = TDomainPartitioner;
  using DomainType = typename DomainPartitionerType::DomainType;

  using AssociateType = TAssociate;

  itkTypeMacro( DomainThreader, Object );

  void Execute( AssociateType * enclosingClass, const DomainType & domain );

  itkSetObjectMacro( DomainPartitioner, DomainPartitionerType );
  itkGetModifiableObjectMacro( DomainPartitioner, DomainPartitionerType );

  itkGetConstMacro( NumberOfWorkUnitsUsed, ThreadIdType );

  MultiThreaderBase * GetMultiThreader() const;

  itkSetClampMacro(NumberOfWorkUnits, ThreadIdType, 1, ITK_MAX_THREADS);
  itkGetConstMacro(NumberOfWorkUnits, ThreadIdType);

  ThreadIdType GetMaximumNumberOfThreads() const
  {
    return this->m_MultiThreader->GetMaximumNumberOfThreads();
  }
  void SetMaximumNumberOfThreads(const ThreadIdType threads);

protected:
  DomainThreader();
  ~DomainThreader() override = default;

  virtual void DetermineNumberOfWorkUnitsUsed();

  virtual void BeforeThreadedExecution(){}

  virtual void ThreadedExecution( const DomainType& subdomain,
                                  const ThreadIdType threadId ) = 0;

  virtual void AfterThreadedExecution(){}

  itkSetObjectMacro( MultiThreader, MultiThreaderBase );

  static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback( void *arg );

  AssociateType * m_Associate;

private:
  void StartThreadingSequence();

  struct ThreadStruct
    {
    DomainThreader     * domainThreader;
    };

  ThreadIdType                             m_NumberOfWorkUnitsUsed{0};
  ThreadIdType                             m_NumberOfWorkUnits;
  typename DomainPartitionerType::Pointer  m_DomainPartitioner;
  DomainType                               m_CompleteDomain;
  MultiThreaderBase::Pointer               m_MultiThreader;
};

}

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

#endif