ITK: itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager Class Reference

ITK 5.4.0

Insight Toolkit

#include <itkMattesMutualInformationImageToImageMetricv4.h>

Detailed Description

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>
class itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager

Definition at line 289 of file itkMattesMutualInformationImageToImageMetricv4.h.

Collaboration diagram for itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager:

Public Member Functions
void	BlockAndReduce ()

void	CheckAndReduceIfNecessary ()

	DerivativeBufferManager ()

void	DoubleBufferSize ()

vcl_size_t	GetCachedNumberOfLocalParameters () const

PDFValueType *	GetNextElementAndAddOffset (const OffsetValueType &offset)

void	Initialize (vcl_size_t maxBufferLength, const vcl_size_t cachedNumberOfLocalParameters, std::mutex *parentDerivativeMutexPtr, typename JointPDFDerivativesType::Pointer parentJointPDFDerivatives)

void	ReduceBuffer ()

	~DerivativeBufferManager ()=default

Private Types
using	Self = DerivativeBufferManager

Private Attributes
std::vector< OffsetValueType >	m_BufferOffsetContainer

std::vector< PDFValueType * >	m_BufferPDFValuesContainer

vcl_size_t	m_CachedNumberOfLocalParameters

vcl_size_t	m_CurrentFillSize { 0 }

vcl_size_t	m_MaxBufferSize

std::vector< PDFValueType >	m_MemoryBlock

vcl_size_t	m_MemoryBlockSize

JointPDFDerivativesType::Pointer	m_ParentJointPDFDerivatives

std::mutex *	m_ParentJointPDFDerivativesMutexPtr

Member Typedef Documentation

◆ Self

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::Self = DerivativeBufferManager

private

Definition at line 291 of file itkMattesMutualInformationImageToImageMetricv4.h.

Constructor & Destructor Documentation

◆ DerivativeBufferManager()

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::DerivativeBufferManager ( )

inline

Definition at line 305 of file itkMattesMutualInformationImageToImageMetricv4.h.

◆ ~DerivativeBufferManager()

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::~DerivativeBufferManager ( )

default

Member Function Documentation

◆ BlockAndReduce()

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

void itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::BlockAndReduce ( )

Force the buffer to dump by blocking.

◆ CheckAndReduceIfNecessary()

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

void itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::CheckAndReduceIfNecessary ( )

Attempt to dump the buffer if it is full. If the attempt to acquire the lock fails, double the buffer size and try again.

◆ DoubleBufferSize()

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

void itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::DoubleBufferSize ( )

◆ GetCachedNumberOfLocalParameters()

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

vcl_size_t itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::GetCachedNumberOfLocalParameters ( ) const

inline

Definition at line 312 of file itkMattesMutualInformationImageToImageMetricv4.h.

◆ GetNextElementAndAddOffset()

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

PDFValueType* itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::GetNextElementAndAddOffset ( const OffsetValueType & offset )

inline

Definition at line 332 of file itkMattesMutualInformationImageToImageMetricv4.h.

◆ Initialize()

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

void itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::Initialize	(	vcl_size_t	maxBufferLength,
		const vcl_size_t	cachedNumberOfLocalParameters,
		std::mutex *	parentDerivativeMutexPtr,
		typename JointPDFDerivativesType::Pointer	parentJointPDFDerivatives
	)

◆ ReduceBuffer()

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

void itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::ReduceBuffer ( )

Apply the operations stored in the buffer. This method is not thread safe and requires a lock while threading.

Member Data Documentation

◆ m_BufferOffsetContainer

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

std::vector<OffsetValueType> itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::m_BufferOffsetContainer

private

Definition at line 355 of file itkMattesMutualInformationImageToImageMetricv4.h.

◆ m_BufferPDFValuesContainer

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

std::vector<PDFValueType *> itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::m_BufferPDFValuesContainer

private

Definition at line 354 of file itkMattesMutualInformationImageToImageMetricv4.h.

◆ m_CachedNumberOfLocalParameters

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

vcl_size_t itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::m_CachedNumberOfLocalParameters

private

Definition at line 356 of file itkMattesMutualInformationImageToImageMetricv4.h.

◆ m_CurrentFillSize

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

vcl_size_t itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::m_CurrentFillSize { 0 }

private

Definition at line 349 of file itkMattesMutualInformationImageToImageMetricv4.h.

◆ m_MaxBufferSize

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

vcl_size_t itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::m_MaxBufferSize

private

Definition at line 357 of file itkMattesMutualInformationImageToImageMetricv4.h.

◆ m_MemoryBlock

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

std::vector<PDFValueType> itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::m_MemoryBlock

private

Definition at line 351 of file itkMattesMutualInformationImageToImageMetricv4.h.

◆ m_MemoryBlockSize

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

vcl_size_t itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::m_MemoryBlockSize

private

Definition at line 353 of file itkMattesMutualInformationImageToImageMetricv4.h.

◆ m_ParentJointPDFDerivatives

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

JointPDFDerivativesType::Pointer itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::m_ParentJointPDFDerivatives

private

Definition at line 361 of file itkMattesMutualInformationImageToImageMetricv4.h.

◆ m_ParentJointPDFDerivativesMutexPtr

template<typename TFixedImage , typename TMovingImage , typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

std::mutex* itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeBufferManager::m_ParentJointPDFDerivativesMutexPtr

private

Definition at line 359 of file itkMattesMutualInformationImageToImageMetricv4.h.

The documentation for this class was generated from the following file:

itkMattesMutualInformationImageToImageMetricv4.h