Skip to content

ENH: Refactor itk::ImageRegistrationMethodv4 statements into methods #3876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jhlegarreta wants to merge 3 commits into from
+170 −30
Closed

ENH: Refactor itk::ImageRegistrationMethodv4 statements into methods #3876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4e119c6
ENH: Refactor `itk::ImageRegistrationMethodv4` domain clearing methods
jhlegarreta Jan 19, 2023
836c18c
ENH: Group setting `itk::ImageRegistrationMethodv4` random seeds
jhlegarreta Jan 19, 2023
0500c27
ENH: Refactor `itk::itkImageRegistrationMethodv4` dependent statements
jhlegarreta Jan 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions Modules/Registration/RegistrationMethodsv4/include/itkImageRegistrationMethodv4.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -593,6 +593,42 @@ class ITK_TEMPLATE_EXPORT ImageRegistrationMethodv4 : public ProcessObject
{
ptr = IdentityTransform<RealType, ImageDimension>::New().GetPointer();
}

/** Initialize members according to the required number of levels.
*
* Initialize the shrink factors, smoothing sigmas, and metric sampling percentage values. If
* decreasingConsecutiveShrinkFactors is true, the shrink factors will be initialized to decreasing integer values
* starting from the number of levels minus one (e.g. if the number of level is $3$, they will be initialized to the
* set ${2,1,0}$; if false, they will be initialized to all $1$'s. An equivalent logic applies to the smoothing sigma
* values.
*/
void
InitializeToLevels(const SizeValueType numberOfLevels,
const bool decreasingConsecutiveShrinkFactors,
const bool decreasingConsecutiveSmoothingSigmas);

/** Set the metric sampling random number generator seed to the specified value. */
void
SetMetricSamplingSeed(int seed);

/** Clear image masks. */
void
ClearImageMasks();

/** Clear registration entities.
*
* Clears smoothing images and point sets.
*/
void
ClearRegistrationEntities();

/** Clear smoothing images. */
void
ClearSmoothingImages();

/** Clear point sets. */
void
ClearPointSets();
};
} // end namespace itk

Expand Down
164 changes: 134 additions & 30 deletions Modules/Registration/RegistrationMethodsv4/include/itkImageRegistrationMethodv4.hxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,25 +102,10 @@ ImageRegistrationMethodv4<TFixedImage, TMovingImage, TTransform, TVirtualImage,
// Default to a 3-level image registration: force the initialization of the ivars that depend on the number of levels.
this->SetNumberOfLevels(3);

this->m_ShrinkFactorsPerLevel.resize(this->m_NumberOfLevels);
ShrinkFactorsPerDimensionContainerType shrinkFactors;
shrinkFactors.Fill(2);
this->m_ShrinkFactorsPerLevel[0] = shrinkFactors;
shrinkFactors.Fill(1);
this->m_ShrinkFactorsPerLevel[1] = shrinkFactors;
shrinkFactors.Fill(1);
this->m_ShrinkFactorsPerLevel[2] = shrinkFactors;

this->m_SmoothingSigmasPerLevel.SetSize(this->m_NumberOfLevels);
this->m_SmoothingSigmasPerLevel[0] = 2;
this->m_SmoothingSigmasPerLevel[1] = 1;
this->m_SmoothingSigmasPerLevel[2] = 0;

this->m_SmoothingSigmasAreSpecifiedInPhysicalUnits = true;

this->m_ReseedIterator = false;
this->m_RandomSeed = Statistics::MersenneTwisterRandomVariateGenerator::GetNextSeed();
this->m_CurrentRandomSeed = this->m_RandomSeed;
this->SetMetricSamplingSeed(Statistics::MersenneTwisterRandomVariateGenerator::GetNextSeed());

this->m_MetricSamplingStrategy = MetricSamplingStrategyEnum::NONE;
this->m_MetricSamplingPercentagePerLevel.SetSize(this->m_NumberOfLevels);
Expand Down Expand Up @@ -425,10 +410,7 @@ ImageRegistrationMethodv4<TFixedImage, TMovingImage, TTransform, TVirtualImage,
this->m_VirtualDomainImage->Allocate();
}

this->m_FixedImageMasks.clear();
this->m_FixedImageMasks.resize(this->m_NumberOfMetrics);
this->m_MovingImageMasks.clear();
this->m_MovingImageMasks.resize(this->m_NumberOfMetrics);
this->ClearImageMasks();

for (SizeValueType n = 0; n < this->m_NumberOfMetrics; ++n)
{
Expand Down Expand Up @@ -595,14 +577,7 @@ ImageRegistrationMethodv4<TFixedImage, TMovingImage, TTransform, TVirtualImage,
// Although this isn't necessary, we want to leave the option for
// changing the point sets per level.

this->m_FixedSmoothImages.clear();
this->m_FixedSmoothImages.resize(this->m_NumberOfMetrics);
this->m_MovingSmoothImages.clear();
this->m_MovingSmoothImages.resize(this->m_NumberOfMetrics);
this->m_FixedPointSets.clear();
this->m_FixedPointSets.resize(this->m_NumberOfMetrics);
this->m_MovingPointSets.clear();
this->m_MovingPointSets.resize(this->m_NumberOfMetrics);
this->ClearRegistrationEntities();

for (SizeValueType n = 0; n < this->m_NumberOfMetrics; ++n)
{
Expand Down Expand Up @@ -746,6 +721,43 @@ ImageRegistrationMethodv4<TFixedImage, TMovingImage, TTransform, TVirtualImage,
}
}

template <typename TFixedImage, typename TMovingImage, typename TTransform, typename TVirtualImage, typename TPointSet>
void
ImageRegistrationMethodv4<TFixedImage, TMovingImage, TTransform, TVirtualImage, TPointSet>::ClearImageMasks()
{
this->m_FixedImageMasks.clear();
this->m_FixedImageMasks.resize(this->m_NumberOfMetrics);
this->m_MovingImageMasks.clear();
this->m_MovingImageMasks.resize(this->m_NumberOfMetrics);
}

template <typename TFixedImage, typename TMovingImage, typename TTransform, typename TVirtualImage, typename TPointSet>
void
ImageRegistrationMethodv4<TFixedImage, TMovingImage, TTransform, TVirtualImage, TPointSet>::ClearRegistrationEntities()
{
this->ClearPointSets();
this->ClearSmoothingImages();
}

template <typename TFixedImage, typename TMovingImage, typename TTransform, typename TVirtualImage, typename TPointSet>
void
ImageRegistrationMethodv4<TFixedImage, TMovingImage, TTransform, TVirtualImage, TPointSet>::ClearSmoothingImages()
{
this->m_FixedSmoothImages.clear();
this->m_FixedSmoothImages.resize(this->m_NumberOfMetrics);
this->m_MovingSmoothImages.clear();
this->m_MovingSmoothImages.resize(this->m_NumberOfMetrics);
}

template <typename TFixedImage, typename TMovingImage, typename TTransform, typename TVirtualImage, typename TPointSet>
void
ImageRegistrationMethodv4<TFixedImage, TMovingImage, TTransform, TVirtualImage, TPointSet>::ClearPointSets()
{
this->m_FixedPointSets.clear();
this->m_FixedPointSets.resize(this->m_NumberOfMetrics);
this->m_MovingPointSets.clear();
this->m_MovingPointSets.resize(this->m_NumberOfMetrics);
}

template <typename TFixedImage, typename TMovingImage, typename TTransform, typename TVirtualImage, typename TPointSet>
void
Expand Down Expand Up @@ -907,6 +919,91 @@ ImageRegistrationMethodv4<TFixedImage, TMovingImage, TTransform, TVirtualImage,

this->Modified();
}

this->InitializeToLevels(m_NumberOfLevels, false, false);
this->InitializeToLevels(m_NumberOfLevels, true, true);
}

template <typename TFixedImage, typename TMovingImage, typename TTransform, typename TVirtualImage, typename TPointSet>
void
ImageRegistrationMethodv4<TFixedImage, TMovingImage, TTransform, TVirtualImage, TPointSet>::InitializeToLevels(
const SizeValueType numberOfLevels,
const bool decreasingConsecutiveShrinkFactors,
const bool decreasingConsecutiveSmoothingSigmas)
{
this->m_NumberOfLevels = numberOfLevels;

// Set default transform adaptors which don't do anything to the input transform
// Similarly, fill in some default values for the shrink factors, smoothing sigmas,
// and learning rates.


// Check why this is not initialized in the constructor
this->m_TransformParametersAdaptorsPerLevel.clear();
for (SizeValueType level = 0; level < this->m_NumberOfLevels; ++level)
{
this->m_TransformParametersAdaptorsPerLevel.push_back(nullptr);
}

this->m_ShrinkFactorsPerLevel.resize(this->m_NumberOfLevels);
if (!decreasingConsecutiveShrinkFactors)
{
auto shrinkFactors = ShrinkFactorsArrayType(this->m_NumberOfLevels);
shrinkFactors.Fill(1);
this->SetShrinkFactorsPerLevel(shrinkFactors);

// Check against the below
for (SizeValueType level = 0; level < this->m_NumberOfLevels; ++level)
{
ShrinkFactorsPerDimensionContainerType shrinkFactors1;
shrinkFactors1.Fill(1);
this->SetShrinkFactorsPerDimension(level, shrinkFactors1);
}
}
else
{
ShrinkFactorsPerDimensionContainerType shrinkFactors;
shrinkFactors.Fill(m_NumberOfLevels - 1);
this->SetShrinkFactorsPerDimension(0, shrinkFactors);

auto shrinkFactors2 = ShrinkFactorsArrayType(this->m_NumberOfLevels);
for (SizeValueType level = 1; level < this->m_NumberOfLevels; ++level)
{
shrinkFactors.Fill(1);
this->SetShrinkFactorsPerDimension(level, shrinkFactors);
}

// Check against the below
ShrinkFactorsPerDimensionContainerType shrinkFactors1;
shrinkFactors1.Fill(2);
this->m_ShrinkFactorsPerLevel[0] = shrinkFactors1;
shrinkFactors1.Fill(1);
this->m_ShrinkFactorsPerLevel[1] = shrinkFactors1;
shrinkFactors1.Fill(1);
this->m_ShrinkFactorsPerLevel[2] = shrinkFactors1;
}


this->m_SmoothingSigmasPerLevel.SetSize(this->m_NumberOfLevels);
if (!decreasingConsecutiveSmoothingSigmas)
{
this->m_SmoothingSigmasPerLevel.Fill(1.0);
}
else
{
for (SizeValueType level = 0; level < this->m_NumberOfLevels; ++level)
{
this->m_SmoothingSigmasPerLevel[level] = m_NumberOfLevels - level - 1;
}

// Check against the below
// this->m_SmoothingSigmasPerLevel[0] = 2;
// this->m_SmoothingSigmasPerLevel[1] = 1;
// this->m_SmoothingSigmasPerLevel[2] = 0;
}

this->m_MetricSamplingPercentagePerLevel.SetSize(this->m_NumberOfLevels);
this->m_MetricSamplingPercentagePerLevel.Fill(1.0);
}

/**
Expand Down Expand Up @@ -1288,12 +1385,19 @@ ImageRegistrationMethodv4<TFixedImage, TMovingImage, TTransform, TVirtualImage,
if (m_ReseedIterator || m_RandomSeed != seed)
{
m_ReseedIterator = false;
m_RandomSeed = seed;
m_CurrentRandomSeed = seed;
this->SetMetricSamplingSeed(seed);
this->Modified();
}
}

template <typename TFixedImage, typename TMovingImage, typename TTransform, typename TVirtualImage, typename TPointSet>
void
ImageRegistrationMethodv4<TFixedImage, TMovingImage, TTransform, TVirtualImage, TPointSet>::SetMetricSamplingSeed(
int seed)
{
m_RandomSeed = seed;
m_CurrentRandomSeed = seed;
}

template <typename TFixedImage, typename TMovingImage, typename TTransform, typename TVirtualImage, typename TPointSet>
void
Expand Down