/usr/include/ITK-4.5/itkImageToImageMetricv4GetValueAndDerivativeThreaderBase.h is in libinsighttoolkit4-dev 4.5.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 | /*=========================================================================
*
* 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 __itkImageToImageMetricv4GetValueAndDerivativeThreaderBase_h
#define __itkImageToImageMetricv4GetValueAndDerivativeThreaderBase_h
#include "itkDomainThreader.h"
#include "itkCompensatedSummation.h"
namespace itk
{
/** \class ImageToImageMetricv4GetValueAndDerivativeThreaderBase
* \brief Provides threading for ImageToImageMetricv4::GetValueAndDerivative.
*
* \tparam TDomainPartitioner type of the Domain,
* ThreadedImageRegionPartitioner or ThreadedIndexedContainerPartitioner
* \tparam TImageToImageMetricv4 type of the ImageToImageMetricv4
*
* This class provides a \c BeforeThreadedExecution, and \c
* AfterThreadedExecution.
*
* The \c ThreadedExecution in
* ImageToImageMetricv4GetValueAndDerivativeThreader calls \c
* ProcessVirtualPoint on every point in the virtual image domain. \c
* ProcessVirtualPoint calls \c ProcessPoint on each point.
*
* \ingroup ITKMetricsv4 */
template < typename TDomainPartitioner, typename TImageToImageMetricv4 >
class ImageToImageMetricv4GetValueAndDerivativeThreaderBase
: public DomainThreader< TDomainPartitioner, TImageToImageMetricv4 >
{
public:
/** Standard class typedefs. */
typedef ImageToImageMetricv4GetValueAndDerivativeThreaderBase Self;
typedef DomainThreader< TDomainPartitioner, TImageToImageMetricv4 > Superclass;
typedef SmartPointer< Self > Pointer;
typedef SmartPointer< const Self > ConstPointer;
itkTypeMacro( ImageToImageMetricv4GetValueAndDerivativeThreaderBase, DomainThreader );
/** Superclass types. */
typedef typename Superclass::DomainType DomainType;
typedef typename Superclass::AssociateType AssociateType;
/** Types of the target class. */
typedef TImageToImageMetricv4 ImageToImageMetricv4Type;
typedef typename ImageToImageMetricv4Type::VirtualImageType VirtualImageType;
typedef typename ImageToImageMetricv4Type::VirtualIndexType VirtualIndexType;
typedef typename ImageToImageMetricv4Type::VirtualPointType VirtualPointType;
typedef typename ImageToImageMetricv4Type::FixedImagePointType FixedImagePointType;
typedef typename ImageToImageMetricv4Type::FixedImagePixelType FixedImagePixelType;
typedef typename ImageToImageMetricv4Type::FixedImageIndexType FixedImageIndexType;
typedef typename ImageToImageMetricv4Type::FixedImageGradientType FixedImageGradientType;
typedef typename ImageToImageMetricv4Type::MovingImagePointType MovingImagePointType;
typedef typename ImageToImageMetricv4Type::MovingImagePixelType MovingImagePixelType;
typedef typename ImageToImageMetricv4Type::MovingImageGradientType MovingImageGradientType;
typedef typename ImageToImageMetricv4Type::FixedTransformType FixedTransformType;
typedef typename FixedTransformType::OutputPointType FixedOutputPointType;
typedef typename ImageToImageMetricv4Type::MovingTransformType MovingTransformType;
typedef typename MovingTransformType::OutputPointType MovingOutputPointType;
typedef typename ImageToImageMetricv4Type::MeasureType MeasureType;
typedef typename ImageToImageMetricv4Type::DerivativeType DerivativeType;
typedef typename ImageToImageMetricv4Type::DerivativeValueType DerivativeValueType;
typedef typename ImageToImageMetricv4Type::JacobianType JacobianType;
typedef typename ImageToImageMetricv4Type::ImageDimensionType ImageDimensionType;
typedef typename ImageToImageMetricv4Type::InternalComputationValueType InternalComputationValueType;
typedef typename ImageToImageMetricv4Type::NumberOfParametersType NumberOfParametersType;
typedef CompensatedSummation<DerivativeValueType> CompensatedDerivativeValueType;
typedef std::vector<CompensatedDerivativeValueType> CompensatedDerivativeType;
/** Access the GetValueAndDerivative() accesor in image metric base. */
virtual bool GetComputeDerivative() const;
protected:
ImageToImageMetricv4GetValueAndDerivativeThreaderBase();
virtual ~ImageToImageMetricv4GetValueAndDerivativeThreaderBase();
/** Resize and initialize per thread objects. */
virtual void BeforeThreadedExecution();
/** Collects the results from each thread and sums them. Results are stored
* in the enclosing class \c m_Value and \c m_DerivativeResult. Behavior
* depends on m_AverageValueAndDerivativeByNumberOfValuePoints,
* m_NumberOfValidPoints, to average the value sum, and to average
* derivative sums for global transforms only (i.e. transforms without local
* support). */
virtual void AfterThreadedExecution();
/** Method called by the threaders to process the given virtual point. This
* in turn calls \c TransformAndEvaluateFixedPoint, \c
* TransformAndEvaluateMovingPoint, and \c ProcessPoint.
* And adds entries to m_MeasurePerThread and m_LocalDerivativesPerThread,
* m_NumberOfValidPointsPerThread. */
virtual bool ProcessVirtualPoint( const VirtualIndexType & virtualIndex,
const VirtualPointType & virtualPoint,
const ThreadIdType threadId );
/** Method to calculate the metric value and derivative
* given a point, value and image derivative for both fixed and moving
* spaces. The provided values have been calculated from \c virtualPoint,
* which is provided in case it's needed.
* \param virtualIndex
* \param virtualPoint is the point within the virtual domain from which
* the passed parameters have been calculated.
* \param mappedFixedPoint is a valid point within the moving image space
* that has passed bounds checking, and lies within any mask that may
* be assigned.
* \param mappedFixedPixelValue holds the pixel value at the mapped fixed
* point.
* \param mappedFixedImageGradient holds the image gradient at the fixed point,
* but only when \c m_GradientSource is set to calculate fixed image gradients
* (either when it's set to calculate only fixed gradients, or both fixed and
* moving). Otherwise, the value is meaningless and should be ignored.
* \param mappedMovingPoint
* \param mappedMovingPixelValue
* \param mappedMovingImageGradient
* These three parameters hold the point, pixel value and image gradient for
* the moving image space, as described above for the fixed image space.
* Results must be returned by derived classes in:
* \param metricValueReturn
* \param localDerivativeReturn
* \param threadID may be used as needed, for example to access any per-thread
* data cached during pre-processing by the derived class.
* \warning This is called from the threader, and thus must be thread-safe.
*/
virtual bool ProcessPoint(
const VirtualIndexType & virtualIndex,
const VirtualPointType & virtualPoint,
const FixedImagePointType & mappedFixedPoint,
const FixedImagePixelType & mappedFixedPixelValue,
const FixedImageGradientType & mappedFixedImageGradient,
const MovingImagePointType & mappedMovingPoint,
const MovingImagePixelType & mappedMovingPixelValue,
const MovingImageGradientType & mappedMovingImageGradient,
MeasureType & metricValueReturn,
DerivativeType & localDerivativeReturn,
const ThreadIdType threadID ) const = 0;
/** Store derivative result from a single point calculation.
* \warning If this method is overridden or otherwise not used
* in a derived class, be sure to *accumulate* results. */
virtual void StorePointDerivativeResult( const VirtualIndexType & virtualIndex,
const ThreadIdType threadID );
struct GetValueAndDerivativePerThreadStruct
{
/** Intermediary threaded metric value storage. */
InternalComputationValueType Measure;
/** Intermediary threaded metric value storage. */
DerivativeType Derivatives;
/** Intermediary threaded metric value storage. This is used only with global transforms. */
CompensatedDerivativeType CompensatedDerivatives;
/** Intermediary threaded metric value storage. */
DerivativeType LocalDerivatives;
/** Intermediary threaded metric value storage. */
SizeValueType NumberOfValidPoints;
/** Pre-allocated transform jacobian objects, for use as needed by dervied
* classes for efficiency. */
JacobianType MovingTransformJacobian;
};
itkPadStruct( ITK_CACHE_LINE_ALIGNMENT, GetValueAndDerivativePerThreadStruct,
PaddedGetValueAndDerivativePerThreadStruct);
itkAlignedTypedef( ITK_CACHE_LINE_ALIGNMENT, PaddedGetValueAndDerivativePerThreadStruct,
AlignedGetValueAndDerivativePerThreadStruct );
mutable AlignedGetValueAndDerivativePerThreadStruct * m_GetValueAndDerivativePerThreadVariables;
/** Cached values to avoid call overhead.
* These will only be set once threading has been started. */
mutable NumberOfParametersType m_CachedNumberOfParameters;
mutable NumberOfParametersType m_CachedNumberOfLocalParameters;
private:
ImageToImageMetricv4GetValueAndDerivativeThreaderBase( const Self & ); // purposely not implemented
void operator=( const Self & ); // purposely not implemented
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkImageToImageMetricv4GetValueAndDerivativeThreaderBase.hxx"
#endif
#endif
|