File: elxPCAMetric.hxx

package info (click to toggle)
elastix 5.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 42,480 kB
  • sloc: cpp: 68,403; lisp: 4,118; python: 1,013; xml: 182; sh: 177; makefile: 33
file content (157 lines) | stat: -rw-r--r-- 5,669 bytes parent folder | download
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
/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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 elxPCAMetric_hxx
#define elxPCAMetric_hxx

#include "elxPCAMetric.h"
#include "itkTimeProbe.h"
#include <itkDeref.h>

namespace elastix
{

/**
 * ******************* Initialize ***********************
 */

template <class TElastix>
void
PCAMetric<TElastix>::Initialize()
{
  itk::TimeProbe timer;
  timer.Start();
  this->Superclass1::Initialize();

  const Configuration & configuration = itk::Deref(Superclass2::GetConfiguration());

  if (configuration.HasParameter("SubtractMean"))
  {
    log::warn(std::string("WARNING: From elastix version 5.2, the ") + elxGetClassNameStatic() +
              " parameter `SubtractMean` (default \"false\") is "
              "replaced with `UseZeroAverageDisplacementConstraint` "
              "(default \"true\").");
  }

  timer.Stop();
  log::info(std::ostringstream{} << "Initialization of PCAMetric metric took: "
                                 << static_cast<long>(timer.GetMean() * 1000) << " ms.");

} // end Initialize()


/**
 * ***************** BeforeRegistration ***********************
 */

template <class TElastix>
void
PCAMetric<TElastix>::BeforeRegistration()
{
  /** Check if this elastix object has a transform. (If so, it must be a combination transform.) */
  if (CombinationTransformType * const combinationTransform{
        BaseComponent::AsITKBaseType(this->GetElastix()->GetElxTransformBase()) })
  {
    auto * const currentTransform = combinationTransform->GetModifiableCurrentTransform();

    /** Check for B-spline transform. */
    if (const auto bsplineTransform = dynamic_cast<BSplineTransformBaseType *>(currentTransform))
    {
      this->SetGridSize(bsplineTransform->GetGridRegion().GetSize());
    }
    else
    {
      /** Check for stack transform. */
      if (const auto stackTransform = dynamic_cast<StackTransformType *>(currentTransform))
      {
        /** Set itk member variable. */
        this->SetTransformIsStackTransform(true);

        // Return early, now that the current transform is a stack transform.
        return;
      }
    }
  }
  // If the current transform would have been a stack transform, the function would have returned earlier.
  this->SetTransformIsStackTransform(false);
}


/**
 * ***************** BeforeEachResolution ***********************
 */

template <class TElastix>
void
PCAMetric<TElastix>::BeforeEachResolution()
{
  const Configuration & configuration = itk::Deref(Superclass2::GetConfiguration());
  const std::string     componentLabel = BaseComponent::GetComponentLabel();

  /** Get the current resolution level. */
  unsigned int level = (this->m_Registration->GetAsITKBaseType())->GetCurrentLevel();

  unsigned int NumEigenValues = 6;
  configuration.ReadParameter(NumEigenValues, "NumEigenValues", componentLabel, level, 0);
  this->SetNumEigenValues(NumEigenValues);

  /** Get and set if we want to subtract the mean from the derivative. */
  bool useZeroAverageDisplacementConstraint = true;
  // The parameter name "SubtractMean" is obsolete, so just use it as initial value, for backward compatibility.
  configuration.ReadParameter(useZeroAverageDisplacementConstraint, "SubtractMean", componentLabel, 0, 0);
  configuration.ReadParameter(
    useZeroAverageDisplacementConstraint, "UseZeroAverageDisplacementConstraint", componentLabel, 0, 0);
  this->SetUseZeroAverageDisplacementConstraint(useZeroAverageDisplacementConstraint);

  /** Get and set the number of additional samples sampled at the fixed timepoint.  */
  //    unsigned int numAdditionalSamplesFixed = 0;
  //    configuration.ReadParameter( numAdditionalSamplesFixed,
  //      "NumAdditionalSamplesFixed", componentLabel, level, 0 );
  //    this->SetNumAdditionalSamplesFixed( numAdditionalSamplesFixed );

  /** Get and set the fixed timepoint number. */
  //    unsigned int reducedDimensionIndex = 0;
  //    configuration.ReadParameter(
  //        reducedDimensionIndex, "ReducedDimensionIndex",
  //        componentLabel, 0, 0 );
  //    this->SetReducedDimensionIndex( reducedDimensionIndex );

  /** Set moving image derivative scales. */
  this->SetUseMovingImageDerivativeScales(false);
  MovingImageDerivativeScalesType movingImageDerivativeScales;
  bool                            usescales = true;
  for (unsigned int i = 0; i < MovingImageDimension; ++i)
  {
    usescales =
      usescales && configuration.ReadParameter(
                     movingImageDerivativeScales[i], "MovingImageDerivativeScales", componentLabel, i, -1, true);
  }
  if (usescales)
  {
    this->SetUseMovingImageDerivativeScales(true);
    this->SetMovingImageDerivativeScales(movingImageDerivativeScales);
    log::info(std::ostringstream{} << "Multiplying moving image derivatives by: " << movingImageDerivativeScales);
  }

  log::info("end BeforeEachResolution");

} // end BeforeEachResolution()


} // end namespace elastix

#endif // end #ifndef elxPCAMetric_hxx