Skip to content

STYLE: Remove the letter 's' from ParametersMap #935

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

Merged
N-Dekker merged 1 commit into from
Jul 12, 2023
Merged

STYLE: Remove the letter 's' from ParametersMap #935

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 12 additions & 12 deletions Common/GTesting/elxResampleInterpolatorGTest.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ struct WithDimension
using InterpolatorType = TInterpolatorTemplate<ElastixType<NDimension>>;

static void
Test_CreateTransformParametersMap_for_default_interpolator(const ParameterMapType & expectedDerivedParameterMap)
Test_CreateTransformParameterMap_for_default_interpolator(const ParameterMapType & expectedDerivedParameterMap)
{
SCOPED_TRACE(std::string("Function = ")
.append(__func__)
Expand All @@ -76,7 +76,7 @@ struct WithDimension
const elx::ResampleInterpolatorBase<ElastixType<NDimension>> & interpolator = *newInterpolator;

ParameterMapType actualParameterMap;
interpolator.CreateTransformParametersMap(actualParameterMap);
interpolator.CreateTransformParameterMap(actualParameterMap);

const ParameterMapType expectedBaseParameterMap = { { "ResampleInterpolator",
{ interpolator.elxGetClassName() } } };
Expand All @@ -88,41 +88,41 @@ struct WithDimension


static void
Test_CreateTransformParametersMap_for_default_interpolator()
Test_CreateTransformParameterMap_for_default_interpolator()
{
using namespace elx;

const std::string expectedFinalBSplineInterpolationOrderKey = "FinalBSplineInterpolationOrder";
const std::string expectedZero = "0";

WithInterpolator<BSplineResampleInterpolator>::Test_CreateTransformParametersMap_for_default_interpolator(
WithInterpolator<BSplineResampleInterpolator>::Test_CreateTransformParameterMap_for_default_interpolator(
{ { expectedFinalBSplineInterpolationOrderKey, { "3" } } });
WithInterpolator<BSplineResampleInterpolatorFloat>::Test_CreateTransformParametersMap_for_default_interpolator(
WithInterpolator<BSplineResampleInterpolatorFloat>::Test_CreateTransformParameterMap_for_default_interpolator(
{ { expectedFinalBSplineInterpolationOrderKey, { "3" } } });
WithInterpolator<LinearResampleInterpolator>::Test_CreateTransformParametersMap_for_default_interpolator({});
WithInterpolator<NearestNeighborResampleInterpolator>::Test_CreateTransformParametersMap_for_default_interpolator(
WithInterpolator<LinearResampleInterpolator>::Test_CreateTransformParameterMap_for_default_interpolator({});
WithInterpolator<NearestNeighborResampleInterpolator>::Test_CreateTransformParameterMap_for_default_interpolator(
{});

const auto skippedTest = [expectedZero] {
// Note: The following crashes when trying to retrieve "PreParameters" by `m_PreTransform->GetParameters()`.
WithInterpolator<RayCastResampleInterpolator>::Test_CreateTransformParametersMap_for_default_interpolator(
WithInterpolator<RayCastResampleInterpolator>::Test_CreateTransformParameterMap_for_default_interpolator(
{ { "FocalPoint", ParameterValuesType(NDimension, expectedZero) },
{ "PreParameters", { expectedZero } },
{ "Threshold", { expectedZero } } });
};
(void)skippedTest;

WithInterpolator<ReducedDimensionBSplineResampleInterpolator>::
Test_CreateTransformParametersMap_for_default_interpolator(
Test_CreateTransformParameterMap_for_default_interpolator(
{ { expectedFinalBSplineInterpolationOrderKey, { "1" } } });
}
};

} // namespace


GTEST_TEST(ResampleInterpolator, CreateTransformParametersMapForDefaultInterpolator)
GTEST_TEST(ResampleInterpolator, CreateTransformParameterMapForDefaultInterpolator)
{
WithDimension<2>::Test_CreateTransformParametersMap_for_default_interpolator();
WithDimension<3>::Test_CreateTransformParametersMap_for_default_interpolator();
WithDimension<2>::Test_CreateTransformParameterMap_for_default_interpolator();
WithDimension<3>::Test_CreateTransformParameterMap_for_default_interpolator();
}
16 changes: 8 additions & 8 deletions Common/GTesting/elxResamplerGTest.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ struct WithDimension
using ResamplerType = TResamplerTemplate<ElastixType<NDimension>>;

static void
Test_CreateTransformParametersMap_for_default_resampler(const ParameterMapType & expectedDerivedParameterMap)
Test_CreateTransformParameterMap_for_default_resampler(const ParameterMapType & expectedDerivedParameterMap)
{
SCOPED_TRACE(std::string("Function = ")
.append(__func__)
Expand All @@ -80,7 +80,7 @@ struct WithDimension
resampler.SetElastix(elastixObject);

ParameterMapType actualParameterMap;
resampler.CreateTransformParametersMap(actualParameterMap);
resampler.CreateTransformParameterMap(actualParameterMap);

const ParameterMapType expectedBaseParameterMap = { { "Resampler", { resampler.elxGetClassName() } },
{ "DefaultPixelValue", { "0" } },
Expand All @@ -95,11 +95,11 @@ struct WithDimension


static void
Test_CreateTransformParametersMap_for_default_resampler()
Test_CreateTransformParameterMap_for_default_resampler()
{
WithResampler<elx::DefaultResampler>::Test_CreateTransformParametersMap_for_default_resampler({});
WithResampler<elx::DefaultResampler>::Test_CreateTransformParameterMap_for_default_resampler({});
#ifdef ELASTIX_USE_OPENCL
WithResampler<elx::OpenCLResampler>::Test_CreateTransformParametersMap_for_default_resampler(
WithResampler<elx::OpenCLResampler>::Test_CreateTransformParameterMap_for_default_resampler(
{ { "OpenCLResamplerUseOpenCL", { "true" } } });
#endif
}
Expand All @@ -108,8 +108,8 @@ struct WithDimension
} // namespace


GTEST_TEST(Resampler, CreateTransformParametersMapForDefaultResampler)
GTEST_TEST(Resampler, CreateTransformParameterMapForDefaultResampler)
{
WithDimension<2>::Test_CreateTransformParametersMap_for_default_resampler();
WithDimension<3>::Test_CreateTransformParametersMap_for_default_resampler();
WithDimension<2>::Test_CreateTransformParameterMap_for_default_resampler();
WithDimension<3>::Test_CreateTransformParameterMap_for_default_resampler();
}
66 changes: 33 additions & 33 deletions Common/GTesting/elxTransformIOGTest.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ struct WithDimension


static void
Test_CreateTransformParametersMap_for_default_transform(const ParameterMapType & expectedDerivedParameterMap)
Test_CreateTransformParameterMap_for_default_transform(const ParameterMapType & expectedDerivedParameterMap)
{
SCOPED_TRACE(std::string("Function = ")
.append(__func__)
Expand All @@ -258,7 +258,7 @@ struct WithDimension
elxTransform->SetReadWriteTransformParameters(true);

ParameterMapType actualParameterMap;
elxTransform->CreateTransformParametersMap(itk::OptimizerParameters<double>{}, actualParameterMap);
elxTransform->CreateTransformParameterMap(itk::OptimizerParameters<double>{}, actualParameterMap);

const std::string expectedImageDimension{ char{ '0' + NDimension } };
const std::string expectedInternalImagePixelType = "float";
Expand Down Expand Up @@ -288,7 +288,7 @@ struct WithDimension
}

static void
Test_CreateTransformParametersMap_double_precision()
Test_CreateTransformParameterMap_double_precision()
{
// Use 0.3333333333333333... as test value.
constexpr auto testValue = 1.0 / 3.0;
Expand All @@ -315,7 +315,7 @@ struct WithDimension

ParameterMapType parameterMap;

elxTransform->CreateTransformParametersMap(itk::OptimizerParameters<double>(2U, testValue), parameterMap);
elxTransform->CreateTransformParameterMap(itk::OptimizerParameters<double>(2U, testValue), parameterMap);

for (const auto key : { "TransformParameters", "Origin", "Spacing" })
{
Expand All @@ -329,7 +329,7 @@ struct WithDimension
}

static void
Test_CreateTransformParametersMap_SetUseAddition()
Test_CreateTransformParameterMap_SetUseAddition()
{
const auto elxTransform = CheckNew<ElastixTransformType>();

Expand All @@ -342,7 +342,7 @@ struct WithDimension

const auto expectHowToCombineTransforms = [&elxTransform](const char * const expectedParameterValue) {
ParameterMapType parameterMap;
elxTransform->CreateTransformParametersMap({}, parameterMap);
elxTransform->CreateTransformParameterMap({}, parameterMap);

const auto found = parameterMap.find("HowToCombineTransforms");
ASSERT_NE(found, end(parameterMap));
Expand Down Expand Up @@ -382,7 +382,7 @@ struct WithDimension
}

static void
Test_CreateTransformParametersMap_for_default_transform()
Test_CreateTransformParameterMap_for_default_transform()
{
// Converts the specified string to an std::vector<std::string>. Each vector element contains a character of the
// specified string.
Expand Down Expand Up @@ -418,91 +418,91 @@ struct WithDimension

using namespace elx;

WithElastixTransform<AdvancedAffineTransformElastix>::Test_CreateTransformParametersMap_for_default_transform(
WithElastixTransform<AdvancedAffineTransformElastix>::Test_CreateTransformParameterMap_for_default_transform(
{ { "CenterOfRotationPoint", expectedZeros } });
WithElastixTransform<AdvancedBSplineTransform>::Test_CreateTransformParametersMap_for_default_transform(
WithElastixTransform<AdvancedBSplineTransform>::Test_CreateTransformParameterMap_for_default_transform(
{ { "BSplineTransformSplineOrder", { "3" } },
{ "GridDirection", expectedGridDirection },
{ "GridIndex", expectedZeros },
{ "GridOrigin", expectedZeros },
{ "GridSize", expectedZeros },
{ "GridSpacing", expectedOnes },
{ "UseCyclicTransform", { "false" } } });
WithElastixTransform<AffineDTITransformElastix>::Test_CreateTransformParametersMap_for_default_transform(
WithElastixTransform<AffineDTITransformElastix>::Test_CreateTransformParameterMap_for_default_transform(
{ { "CenterOfRotationPoint", expectedZeros }, { "MatrixTranslation", expectedMatrixTranslation } });
WithElastixTransform<AffineLogStackTransform>::Test_CreateTransformParametersMap_for_default_transform(
WithElastixTransform<AffineLogStackTransform>::Test_CreateTransformParameterMap_for_default_transform(
{ { "CenterOfRotationPoint", ParameterValuesType(NDimension - 1, expectedZero) },
{ "NumberOfSubTransforms", { expectedZero } },
{ "StackOrigin", { expectedZero } },
{ "StackSpacing", { expectedOne } } });
WithElastixTransform<AffineLogTransformElastix>::Test_CreateTransformParametersMap_for_default_transform(
WithElastixTransform<AffineLogTransformElastix>::Test_CreateTransformParameterMap_for_default_transform(
{ { "CenterOfRotationPoint", expectedZeros }, { "MatrixTranslation", expectedMatrixTranslation } });

const auto skippedTest = [] {
// Appears to crash when internally calling GetSubTransform(0) while m_SubTransformContainer is still empty.
WithElastixTransform<BSplineStackTransform>::Test_CreateTransformParametersMap_for_default_transform({});
WithElastixTransform<BSplineStackTransform>::Test_CreateTransformParameterMap_for_default_transform({});
};
(void)skippedTest;

WithElastixTransform<BSplineTransformWithDiffusion>::Test_CreateTransformParametersMap_for_default_transform(
WithElastixTransform<BSplineTransformWithDiffusion>::Test_CreateTransformParameterMap_for_default_transform(
{ { "DeformationFieldFileName", { expectedDeformationFieldFileName } },
{ "GridIndex", expectedZeros },
{ "GridOrigin", expectedZeros },
{ "GridSize", expectedZeros },
{ "GridSpacing", expectedOnes } });
WithElastixTransform<DeformationFieldTransform>::Test_CreateTransformParametersMap_for_default_transform(
WithElastixTransform<DeformationFieldTransform>::Test_CreateTransformParameterMap_for_default_transform(
{ { "DeformationFieldFileName", { expectedDeformationFieldFileName } },
{ "DeformationFieldInterpolationOrder", { expectedZero } } });
WithElastixTransform<EulerStackTransform>::Test_CreateTransformParametersMap_for_default_transform(
WithElastixTransform<EulerStackTransform>::Test_CreateTransformParameterMap_for_default_transform(
{ { "CenterOfRotationPoint", ParameterValuesType(NDimension - 1, expectedZero) },
{ "NumberOfSubTransforms", { expectedZero } },
{ "StackOrigin", { expectedZero } },
{ "StackSpacing", { expectedOne } } });

WithElastixTransform<EulerTransformElastix>::Test_CreateTransformParametersMap_for_default_transform(
WithElastixTransform<EulerTransformElastix>::Test_CreateTransformParameterMap_for_default_transform(
(NDimension == 3)
? ParameterMapType{ { "CenterOfRotationPoint", expectedZeros }, { "ComputeZYX", { expectedFalse } } }
: ParameterMapType{ { "CenterOfRotationPoint", expectedZeros } });

try
{
WithElastixTransform<MultiBSplineTransformWithNormal>::Test_CreateTransformParametersMap_for_default_transform(
WithElastixTransform<MultiBSplineTransformWithNormal>::Test_CreateTransformParameterMap_for_default_transform(
{ { "GridIndex", expectedZeros },
{ "GridOrigin", expectedZeros },
{ "GridSize", expectedZeros },
{ "GridSpacing", expectedOnes },
{ "BSplineTransformSplineOrder", { "3" } },
{ "GridDirection", expectedGridDirection },
{ "MultiBSplineTransformWithNormalLabels", { itksys::SystemTools::GetCurrentWorkingDirectory() } } });
EXPECT_FALSE("MultiBSplineTransformWithNormal::CreateTransformParametersMap is expected to throw an exception!");
EXPECT_FALSE("MultiBSplineTransformWithNormal::CreateTransformParameterMap is expected to throw an exception!");
}
catch (const itk::ExceptionObject & exceptionObject)
{
// TODO Avoid this exception!
EXPECT_NE(std::strstr(exceptionObject.GetDescription(), "ERROR: Missing -labels argument!"), nullptr);
}

WithElastixTransform<RecursiveBSplineTransform>::Test_CreateTransformParametersMap_for_default_transform(
WithElastixTransform<RecursiveBSplineTransform>::Test_CreateTransformParameterMap_for_default_transform(
{ { "BSplineTransformSplineOrder", { "3" } },
{ "GridDirection", expectedGridDirection },
{ "GridIndex", expectedZeros },
{ "GridOrigin", expectedZeros },
{ "GridSize", expectedZeros },
{ "GridSpacing", expectedOnes },
{ "UseCyclicTransform", { expectedFalse } } });
WithElastixTransform<SimilarityTransformElastix>::Test_CreateTransformParametersMap_for_default_transform(
WithElastixTransform<SimilarityTransformElastix>::Test_CreateTransformParameterMap_for_default_transform(
{ { "CenterOfRotationPoint", expectedZeros } });
WithElastixTransform<SplineKernelTransform>::Test_CreateTransformParametersMap_for_default_transform(
WithElastixTransform<SplineKernelTransform>::Test_CreateTransformParameterMap_for_default_transform(
{ { "FixedImageLandmarks", {} },
{ "SplineKernelType", { "unknown" } },
{ "SplinePoissonRatio", { "0.3" } },
{ "SplineRelaxationFactor", { expectedZero } } });
WithElastixTransform<TranslationStackTransform>::Test_CreateTransformParametersMap_for_default_transform(
WithElastixTransform<TranslationStackTransform>::Test_CreateTransformParameterMap_for_default_transform(
{ { "NumberOfSubTransforms", { expectedZero } },
{ "StackOrigin", { expectedZero } },
{ "StackSpacing", { expectedOne } } });
WithElastixTransform<TranslationTransformElastix>::Test_CreateTransformParametersMap_for_default_transform({});
WithElastixTransform<WeightedCombinationTransformElastix>::Test_CreateTransformParametersMap_for_default_transform(
WithElastixTransform<TranslationTransformElastix>::Test_CreateTransformParameterMap_for_default_transform({});
WithElastixTransform<WeightedCombinationTransformElastix>::Test_CreateTransformParameterMap_for_default_transform(
{ { "NormalizeCombinationWeights", { expectedFalse } }, { "SubTransforms", {} } });
}
};
Expand Down Expand Up @@ -830,30 +830,30 @@ GTEST_TEST(TransformIO, CopyParametersToCorrespondingItkTransform)
}


GTEST_TEST(Transform, CreateTransformParametersMapForDefaultTransform)
GTEST_TEST(Transform, CreateTransformParameterMapForDefaultTransform)
{
WithDimension<2>::Test_CreateTransformParametersMap_for_default_transform();
WithDimension<3>::Test_CreateTransformParametersMap_for_default_transform();
WithDimension<2>::Test_CreateTransformParameterMap_for_default_transform();
WithDimension<3>::Test_CreateTransformParameterMap_for_default_transform();
}


GTEST_TEST(Transform, CreateTransformParametersMapDoublePrecision)
GTEST_TEST(Transform, CreateTransformParameterMapDoublePrecision)
{
// Checks two different transform types, just to be sure.
WithDimension<2>::WithElastixTransform<
elx::AdvancedAffineTransformElastix>::Test_CreateTransformParametersMap_double_precision();
elx::AdvancedAffineTransformElastix>::Test_CreateTransformParameterMap_double_precision();
WithDimension<3>::WithElastixTransform<
elx::TranslationTransformElastix>::Test_CreateTransformParametersMap_double_precision();
elx::TranslationTransformElastix>::Test_CreateTransformParameterMap_double_precision();
}


GTEST_TEST(Transform, CreateTransformParametersSetUseAddition)
{
// Checks two different transform types, just to be sure.
WithDimension<2>::WithElastixTransform<
elx::AdvancedAffineTransformElastix>::Test_CreateTransformParametersMap_SetUseAddition();
elx::AdvancedAffineTransformElastix>::Test_CreateTransformParameterMap_SetUseAddition();
WithDimension<3>::WithElastixTransform<
elx::TranslationTransformElastix>::Test_CreateTransformParametersMap_SetUseAddition();
elx::TranslationTransformElastix>::Test_CreateTransformParameterMap_SetUseAddition();
}


Expand Down
2 changes: 1 addition & 1 deletion ...onents/ResampleInterpolators/BSplineResampleInterpolator/elxBSplineResampleInterpolator.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ class ITK_TEMPLATE_EXPORT BSplineResampleInterpolator

/** Creates a map of the parameters specific for this (derived) interpolator type. */
ParameterMapType
CreateDerivedTransformParametersMap() const override;
CreateDerivedTransformParameterMap() const override;
};

} // end namespace elastix
Expand Down
6 changes: 3 additions & 3 deletions ...ents/ResampleInterpolators/BSplineResampleInterpolator/elxBSplineResampleInterpolator.hxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,16 +71,16 @@ BSplineResampleInterpolator<TElastix>::ReadFromFile()


/**
* ******************* CreateDerivedTransformParametersMap ******************************
* ******************* CreateDerivedTransformParameterMap ******************************
*/

template <class TElastix>
auto
BSplineResampleInterpolator<TElastix>::CreateDerivedTransformParametersMap() const -> ParameterMapType
BSplineResampleInterpolator<TElastix>::CreateDerivedTransformParameterMap() const -> ParameterMapType
{
return { { "FinalBSplineInterpolationOrder", { Conversion::ToString(this->GetSplineOrder()) } } };

} // end CreateDerivedTransformParametersMap()
} // end CreateDerivedTransformParameterMap()


} // end namespace elastix
Expand Down
2 changes: 1 addition & 1 deletion ...ampleInterpolators/BSplineResampleInterpolatorFloat/elxBSplineResampleInterpolatorFloat.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ class ITK_TEMPLATE_EXPORT BSplineResampleInterpolatorFloat

/** Creates a map of the parameters specific for this (derived) interpolator type. */
ParameterMapType
CreateDerivedTransformParametersMap() const override;
CreateDerivedTransformParameterMap() const override;
};

} // end namespace elastix
Expand Down
6 changes: 3 additions & 3 deletions ...pleInterpolators/BSplineResampleInterpolatorFloat/elxBSplineResampleInterpolatorFloat.hxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,16 +72,16 @@ BSplineResampleInterpolatorFloat<TElastix>::ReadFromFile()


/**
* ******************* CreateDerivedTransformParametersMap ******************************
* ******************* CreateDerivedTransformParameterMap ******************************
*/

template <class TElastix>
auto
BSplineResampleInterpolatorFloat<TElastix>::CreateDerivedTransformParametersMap() const -> ParameterMapType
BSplineResampleInterpolatorFloat<TElastix>::CreateDerivedTransformParameterMap() const -> ParameterMapType
{
return { { "FinalBSplineInterpolationOrder", { Conversion::ToString(this->GetSplineOrder()) } } };

} // end CreateDerivedTransformParametersMap()
} // end CreateDerivedTransformParameterMap()


} // end namespace elastix
Expand Down
2 changes: 1 addition & 1 deletion ...ts/ResampleInterpolators/RDBSplineResampleInterpolator/elxRDBSplineResampleInterpolator.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ class ITK_TEMPLATE_EXPORT ReducedDimensionBSplineResampleInterpolator

/** Creates a map of the parameters specific for this (derived) interpolator type. */
ParameterMapType
CreateDerivedTransformParametersMap() const override;
CreateDerivedTransformParameterMap() const override;
};

} // end namespace elastix
Expand Down
Loading