[5d12a0]: / src / antsImageToImageMetric.h

Download this file

421 lines (356 with data), 18.5 kB

  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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
#include <nanobind/nanobind.h>
#include <nanobind/stl/vector.h>
#include <nanobind/stl/string.h>
#include <nanobind/stl/tuple.h>
#include <nanobind/stl/list.h>
#include <nanobind/ndarray.h>
#include <nanobind/stl/shared_ptr.h>
#include <algorithm>
#include <vector>
#include <string>
#include "antscore/antsUtilities.h"
#include "itkDisplacementFieldTransform.h"
#include "itkImageToImageMetricv4.h"
#include "itkMeanSquaresImageToImageMetricv4.h"
#include "itkCorrelationImageToImageMetricv4.h"
#include "itkMattesMutualInformationImageToImageMetricv4.h"
#include "itkANTSNeighborhoodCorrelationImageToImageMetricv4.h"
#include "itkDemonsImageToImageMetricv4.h"
#include "itkJointHistogramMutualInformationImageToImageMetricv4.h"
#include "itkImageMaskSpatialObject.h"
#include "itkMersenneTwisterRandomVariateGenerator.h"
#include "itkImageRandomConstIteratorWithIndex.h"
#include "antsImage.h"
namespace nb = nanobind;
using namespace nb::literals;
template <typename MetricType>
class ANTsImageToImageMetric {
public:
typedef MetricType itkMetricType;
std::string precision;
unsigned int dimension;
std::string metrictype;
unsigned int isVector;
nb::capsule pointer;
template <typename MyImageType>
void setFixedImage( AntsImage<MyImageType> &, bool);
template <typename MyImageType>
void setMovingImage( AntsImage<MyImageType> &, bool);
void setSampling(std::string, float);
void initialize();
float getValue();
};
template <typename MetricType>
void capsuleDestructor(void* ptr) noexcept {
auto* metricPtr = static_cast<typename MetricType::Pointer*>(ptr);
delete metricPtr;
}
template <typename MetricType>
ANTsImageToImageMetric<MetricType> wrap_metric( const typename MetricType::Pointer & itkMetric )
{
typedef typename MetricType::Pointer MetricPointerType;
MetricPointerType* ptr = new MetricPointerType( itkMetric );
ANTsImageToImageMetric<MetricType> antsMetric;
antsMetric.precision = "float";
antsMetric.dimension = MetricType::FixedImageDimension;
antsMetric.metrictype = itkMetric->GetNameOfClass();
antsMetric.isVector = 0;
antsMetric.pointer = nb::capsule(ptr, capsuleDestructor<MetricType>);
return antsMetric;
}
template <typename MetricType>
typename MetricType::Pointer as_metric( ANTsImageToImageMetric<MetricType> & metric )
{
void *ptr = metric.pointer.data();
typename MetricType::Pointer * real = reinterpret_cast<typename MetricType::Pointer *>(ptr); // static_cast or reinterpret_cast ??
return *real;
}
template <typename MetricType>
template <typename MyImageType>
void ANTsImageToImageMetric< MetricType >::setFixedImage( AntsImage<MyImageType> & antsImage,
bool isMask )
{
typedef typename MetricType::FixedImageType ImageType;
typedef typename ImageType::Pointer ImagePointerType;
typedef typename MetricType::Pointer MetricPointerType;
typedef itk::ImageMaskSpatialObject<ImageType::ImageDimension> ImageMaskSpatialObjectType;
typedef typename ImageMaskSpatialObjectType::ImageType MaskImageType;
MetricPointerType metric = as_metric< MetricType >( *this );
ImagePointerType image = antsImage.ptr;
if ( isMask ) {
typename ImageMaskSpatialObjectType::Pointer mask = ImageMaskSpatialObjectType::New();
typedef itk::CastImageFilter<ImageType,MaskImageType> CastFilterType;
typename CastFilterType::Pointer cast = CastFilterType::New();
cast->SetInput( image );
cast->Update();
mask->SetImage( cast->GetOutput() );
metric->SetMovingImageMask(mask);
}
else {
metric->SetFixedImage(image);
}
}
template <typename MetricType>
template <typename MyImageType>
void ANTsImageToImageMetric< MetricType >::setMovingImage( AntsImage<MyImageType> & antsImage,
bool isMask )
{
typedef typename MetricType::MovingImageType ImageType;
typedef typename ImageType::Pointer ImagePointerType;
typedef typename MetricType::Pointer MetricPointerType;
typedef itk::ImageMaskSpatialObject<ImageType::ImageDimension> ImageMaskSpatialObjectType;
typedef typename ImageMaskSpatialObjectType::ImageType MaskImageType;
MetricPointerType metric = as_metric< MetricType >( *this );
ImagePointerType image = antsImage.ptr;
if ( isMask ) {
typename ImageMaskSpatialObjectType::Pointer mask = ImageMaskSpatialObjectType::New();
typedef itk::CastImageFilter<ImageType,MaskImageType> CastFilterType;
typename CastFilterType::Pointer cast = CastFilterType::New();
cast->SetInput( image );
cast->Update();
mask->SetImage( cast->GetOutput() );
metric->SetMovingImageMask(mask);
}
else {
metric->SetMovingImage(image);
}
}
template< class MetricType >
float ANTsImageToImageMetric< MetricType >::getValue()
{
//Rcpp::Rcout << "antsrImageToImageMetric_GetValue<MetricType>()" << std::endl;
typedef typename MetricType::Pointer MetricPointerType;
MetricPointerType metric = as_metric< MetricType >( *this );
return metric->GetValue();
}
template< class MetricType >
void ANTsImageToImageMetric< MetricType >::setSampling( std::string strategy, float percentage )
{
typedef typename MetricType::MovingImageType ImageType;
typedef typename MetricType::Pointer MetricPointerType;
typedef typename MetricType::FixedSampledPointSetType MetricSamplePointSetType;
typedef typename MetricSamplePointSetType::PointType SamplePointType;
typename MetricSamplePointSetType::Pointer samplePointSet = MetricSamplePointSetType::New();
samplePointSet->Initialize();
MetricPointerType metric = as_metric< MetricType >( *this );
typedef typename itk::Statistics::MersenneTwisterRandomVariateGenerator RandomizerType;
typename RandomizerType::Pointer randomizer = RandomizerType::New();
randomizer->SetSeed( 1234 );
const typename ImageType::SpacingType oneThirdVirtualSpacing = metric->GetFixedImage()->GetSpacing() / 3.0;
unsigned long index = 0;
if ( strategy == "regular" )
{
const unsigned long sampleCount = static_cast<unsigned long>( std::ceil( 1.0 / percentage ) );
unsigned long count = sampleCount; //Start at sampleCount to keep behavior backwards identical, using first element.
itk::ImageRegionConstIteratorWithIndex<ImageType> It( metric->GetFixedImage(), metric->GetFixedImage()->GetRequestedRegion() );
for( It.GoToBegin(); !It.IsAtEnd(); ++It )
{
if( count == sampleCount )
{
count = 0; //Reset counter
SamplePointType point;
metric->GetFixedImage()->TransformIndexToPhysicalPoint( It.GetIndex(), point );
// randomly perturb the point within a voxel (approximately)
for( unsigned int d = 0; d < ImageType::ImageDimension; d++ )
{
point[d] += randomizer->GetNormalVariate() * oneThirdVirtualSpacing[d];
}
if( !metric->GetFixedImageMask() || metric->GetFixedImageMask()->IsInsideInWorldSpace( point ) )
{
samplePointSet->SetPoint( index, point );
++index;
}
}
++count;
}
metric->SetFixedSampledPointSet( samplePointSet );
metric->SetUseSampledPointSet( true );
}
else if (strategy == "random")
{
const unsigned long totalVirtualDomainVoxels = metric->GetFixedImage()->GetRequestedRegion().GetNumberOfPixels();
const unsigned long sampleCount = static_cast<unsigned long>( static_cast<float>( totalVirtualDomainVoxels ) * percentage );
itk::ImageRandomConstIteratorWithIndex<ImageType> ItR( metric->GetFixedImage(), metric->GetFixedImage()->GetRequestedRegion() );
ItR.SetNumberOfSamples( sampleCount );
for( ItR.GoToBegin(); !ItR.IsAtEnd(); ++ItR )
{
SamplePointType point;
metric->GetFixedImage()->TransformIndexToPhysicalPoint( ItR.GetIndex(), point );
// randomly perturb the point within a voxel (approximately)
for ( unsigned int d = 0; d < ImageType::ImageDimension; d++ )
{
point[d] += randomizer->GetNormalVariate() * oneThirdVirtualSpacing[d];
}
if( !metric->GetFixedImageMask() || metric->GetFixedImageMask()->IsInsideInWorldSpace( point ) )
{
samplePointSet->SetPoint( index, point );
++index;
}
}
metric->SetFixedSampledPointSet( samplePointSet );
metric->SetUseSampledPointSet( true );
}
}
template< class MetricType >
void ANTsImageToImageMetric< MetricType >::initialize()
{
typedef typename MetricType::Pointer MetricPointerType;
MetricPointerType metric = as_metric< MetricType >( *this );
metric->Initialize();
}
template <typename MetricType, unsigned int Dimension>
ANTsImageToImageMetric<MetricType> new_ants_metric( std::string precision, unsigned int dimension, std::string metrictype )
{
if ( metrictype == "MeanSquares" )
{
typedef itk::Image<float, Dimension> ImageType;
typedef itk::MeanSquaresImageToImageMetricv4<ImageType, ImageType> SpecificMetricType;
typename SpecificMetricType::Pointer metricPointer = SpecificMetricType::New();
typedef itk::ImageToImageMetricv4<itk::Image<float, Dimension>,itk::Image<float,Dimension>> MetricBaseType;
typedef typename MetricBaseType::Pointer MetricBasePointerType;
MetricBasePointerType basePointer = dynamic_cast<MetricBaseType *>( metricPointer.GetPointer() );
return wrap_metric< MetricType >( basePointer );
}
else if ( metrictype == "Correlation" )
{
typedef itk::Image<float, Dimension> ImageType;
typedef itk::CorrelationImageToImageMetricv4<ImageType,ImageType> SpecificMetricType;
typename SpecificMetricType::Pointer metricPointer = SpecificMetricType::New();
typedef itk::ImageToImageMetricv4<itk::Image<float, Dimension>,itk::Image<float,Dimension>> MetricBaseType;
typedef typename MetricBaseType::Pointer MetricBasePointerType;
MetricBasePointerType basePointer = dynamic_cast<MetricBaseType *>( metricPointer.GetPointer() );
return wrap_metric< MetricType >( basePointer );
}
else if ( metrictype == "ANTSNeighborhoodCorrelation" )
{
typedef itk::Image<float, Dimension> ImageType;
typedef itk::ANTSNeighborhoodCorrelationImageToImageMetricv4<ImageType,ImageType> SpecificMetricType;
typename SpecificMetricType::Pointer metricPointer = SpecificMetricType::New();
typedef itk::ImageToImageMetricv4<itk::Image<float, Dimension>,itk::Image<float,Dimension>> MetricBaseType;
typedef typename MetricBaseType::Pointer MetricBasePointerType;
MetricBasePointerType basePointer = dynamic_cast<MetricBaseType *>( metricPointer.GetPointer() );
return wrap_metric< MetricType >( basePointer );
}
else if ( metrictype == "Demons" )
{
typedef itk::Image<float, Dimension> ImageType;
typedef itk::DemonsImageToImageMetricv4<ImageType,ImageType> SpecificMetricType;
typename SpecificMetricType::Pointer metricPointer = SpecificMetricType::New();
typedef itk::ImageToImageMetricv4<itk::Image<float, Dimension>,itk::Image<float,Dimension>> MetricBaseType;
typedef typename MetricBaseType::Pointer MetricBasePointerType;
MetricBasePointerType basePointer = dynamic_cast<MetricBaseType *>( metricPointer.GetPointer() );
return wrap_metric< MetricType >( basePointer );
}
else if ( metrictype == "JointHistogramMutualInformation" )
{
typedef itk::Image<float, Dimension> ImageType;
typedef itk::JointHistogramMutualInformationImageToImageMetricv4<ImageType,ImageType> SpecificMetricType;
typename SpecificMetricType::Pointer metricPointer = SpecificMetricType::New();
typedef itk::ImageToImageMetricv4<itk::Image<float, Dimension>,itk::Image<float,Dimension>> MetricBaseType;
typedef typename MetricBaseType::Pointer MetricBasePointerType;
MetricBasePointerType basePointer = dynamic_cast<MetricBaseType *>( metricPointer.GetPointer() );
return wrap_metric< MetricType >( basePointer );
}
else if ( metrictype == "MattesMutualInformation" )
{
typedef itk::Image<float, Dimension> ImageType;
typedef itk::MattesMutualInformationImageToImageMetricv4<ImageType,ImageType> SpecificMetricType;
typename SpecificMetricType::Pointer metricPointer = SpecificMetricType::New();
typedef itk::ImageToImageMetricv4<itk::Image<float, Dimension>,itk::Image<float,Dimension>> MetricBaseType;
typedef typename MetricBaseType::Pointer MetricBasePointerType;
MetricBasePointerType basePointer = dynamic_cast<MetricBaseType *>( metricPointer.GetPointer() );
return wrap_metric< MetricType >( basePointer );
}
// should never reach this
typedef itk::Image<float, Dimension> ImageType;
typedef itk::MeanSquaresImageToImageMetricv4<itk::Image<float, Dimension>,itk::Image<float,Dimension>> SpecificMetricType;
typename SpecificMetricType::Pointer metricPointer = SpecificMetricType::New();
typedef itk::ImageToImageMetricv4<itk::Image<float, Dimension>,itk::Image<float,Dimension>> MetricBaseType;
typedef typename MetricBaseType::Pointer MetricBasePointerType;
MetricBasePointerType basePointer = dynamic_cast<MetricBaseType *>( metricPointer.GetPointer() );
return wrap_metric< MetricType >( basePointer );
}
template< typename MetricBaseType, unsigned int Dimension >
ANTsImageToImageMetric< MetricBaseType > create_ants_metric(std::string pixeltype,
unsigned int dimension,
std::string metrictype,
unsigned int isVector,
AntsImage<itk::Image<float, Dimension>> & fixed_img,
AntsImage<itk::Image<float, Dimension>> & moving_img )
{
typedef itk::Image<float, Dimension> ImageType;
typedef typename ImageType::Pointer ImagePointerType;
ImagePointerType fixed = fixed_img.ptr;
ImagePointerType moving = moving_img.ptr;
typedef typename MetricBaseType::Pointer MetricBasePointerType;
if ( metrictype == "MeanSquares" ) {
typedef itk::MeanSquaresImageToImageMetricv4<ImageType,ImageType> MetricType;
typename MetricType::Pointer metric = MetricType::New();
metric->SetFixedImage( fixed );
metric->SetMovingImage( moving );
MetricBasePointerType baseMetric = dynamic_cast<MetricBaseType *>( metric.GetPointer() );
return( wrap_metric< MetricBaseType >( baseMetric ) );
}
else if ( metrictype == "Correlation" ) {
typedef itk::CorrelationImageToImageMetricv4<ImageType,ImageType> MetricType;
typename MetricType::Pointer metric = MetricType::New();
metric->SetFixedImage( fixed );
metric->SetMovingImage( moving );
MetricBasePointerType baseMetric = dynamic_cast<MetricBaseType *>( metric.GetPointer() );
return( wrap_metric< MetricBaseType >( baseMetric ) );
}
else if ( metrictype == "ANTSNeighborhoodCorrelation" ) {
typedef itk::ANTSNeighborhoodCorrelationImageToImageMetricv4<ImageType,ImageType> MetricType;
typename MetricType::Pointer metric = MetricType::New();
metric->SetFixedImage( fixed );
metric->SetMovingImage( moving );
MetricBasePointerType baseMetric = dynamic_cast<MetricBaseType *>( metric.GetPointer() );
return( wrap_metric< MetricBaseType >( baseMetric ) );
}
else if ( metrictype == "Demons" ) {
typedef itk::DemonsImageToImageMetricv4<ImageType,ImageType> MetricType;
typename MetricType::Pointer metric = MetricType::New();
metric->SetFixedImage( fixed );
metric->SetMovingImage( moving );
/* This block needed to prevent exception on call to Initialize() */
typedef itk::DisplacementFieldTransform<typename MetricType::InternalComputationValueType,
ImageType::ImageDimension> TransformType;
typedef typename TransformType::DisplacementFieldType DisplacementFieldType;
typename DisplacementFieldType::Pointer itkField = DisplacementFieldType::New();
itkField->SetRegions( moving->GetLargestPossibleRegion() );
itkField->SetSpacing( moving->GetSpacing() );
itkField->SetOrigin( moving->GetOrigin() );
itkField->SetDirection( moving->GetDirection() );
itkField->AllocateInitialized();
typename TransformType::Pointer idTransform = TransformType::New();
idTransform->SetDisplacementField( itkField );
metric->SetMovingTransform( idTransform );
MetricBasePointerType baseMetric = dynamic_cast<MetricBaseType *>( metric.GetPointer() );
return( wrap_metric< MetricBaseType >( baseMetric ) );
}
else if ( metrictype == "MattesMutualInformation" ) {
typedef itk::MattesMutualInformationImageToImageMetricv4<ImageType,ImageType> MetricType;
typename MetricType::Pointer metric = MetricType::New();
metric->SetFixedImage( fixed );
metric->SetMovingImage( moving );
MetricBasePointerType baseMetric = dynamic_cast<MetricBaseType *>( metric.GetPointer() );
return( wrap_metric< MetricBaseType >( baseMetric ) );
}
else if ( metrictype == "JointHistogramMutualInformation" ) {
typedef itk::JointHistogramMutualInformationImageToImageMetricv4<ImageType,ImageType> MetricType;
typename MetricType::Pointer metric = MetricType::New();
metric->SetFixedImage( fixed );
metric->SetMovingImage( moving );
MetricBasePointerType baseMetric = dynamic_cast<MetricBaseType *>( metric.GetPointer() );
return( wrap_metric< MetricBaseType >( baseMetric ) );
}
// python code should prevent us getting here by checking for known metric types
std::cerr << "Unsupported metric type requested: " << metrictype << std::endl;
std::cerr << "Returning JointHistogramMutualInformation metric" << std::endl;
typedef itk::JointHistogramMutualInformationImageToImageMetricv4<ImageType,ImageType> MetricType;
typename MetricType::Pointer metric = MetricType::New();
metric->SetFixedImage( fixed );
metric->SetMovingImage( moving );
MetricBasePointerType baseMetric = dynamic_cast<MetricBaseType *>( metric.GetPointer() );
return( wrap_metric< MetricBaseType >( baseMetric ) );
}