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

namespace itk
{

template< typename TDomainPartitioner, typename TAssociate >
class DomainThreader: public Object
{
public:
  typedef DomainThreader             Self;
  typedef Object                     Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  typedef TDomainPartitioner                         DomainPartitionerType;
  typedef typename DomainPartitionerType::DomainType DomainType;

  typedef TAssociate AssociateType;

  itkTypeMacro( DomainThreader, Object );

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

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

  itkGetConstMacro( NumberOfThreadsUsed, ThreadIdType );

  MultiThreader * GetMultiThreader() const;

  ThreadIdType GetMaximumNumberOfThreads() const;
  void SetMaximumNumberOfThreads( const ThreadIdType threads );

protected:
  DomainThreader();
  virtual ~DomainThreader();

  virtual void DetermineNumberOfThreadsUsed();

  virtual void BeforeThreadedExecution(){}

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

  virtual void AfterThreadedExecution(){}

  itkSetObjectMacro( MultiThreader, MultiThreader );

  static ITK_THREAD_RETURN_TYPE ThreaderCallback( void *arg );

  AssociateType * m_Associate;

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

  void StartThreadingSequence();

  struct ThreadStruct
    {
    DomainThreader     * domainThreader;
    };

  ThreadIdType                             m_NumberOfThreadsUsed;
  typename DomainPartitionerType::Pointer  m_DomainPartitioner;
  DomainType                               m_CompleteDomain;
  MultiThreader::Pointer                   m_MultiThreader;
};

}

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

#endif