elxImpactMetric.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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 elxImpactMetric_h
#define elxImpactMetric_h
 
#include "elxIncludes.h" // include first to avoid MSVS warning
#include "elxConfiguration.h"
#include "itkImpactImageToImageMetric.h"
#include "itkVector.h"
 
namespace elastix
{

 
template <typename TElastix>
class ITK_TEMPLATE_EXPORT ImpactMetric
  : public itk::ImpactImageToImageMetric<typename MetricBase<TElastix>::FixedImageType,
                                         typename MetricBase<TElastix>::MovingImageType>
  , public MetricBase<TElastix>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ImpactMetric);

  using Self = ImpactMetric;
  using Superclass1 = itk::ImpactImageToImageMetric<typename MetricBase<TElastix>::FixedImageType,
                                                    typename MetricBase<TElastix>::MovingImageType>;
  using Superclass2 = MetricBase<TElastix>;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ImpactMetric);

  elxClassNameMacro("Impact");

  using typename Superclass1::CoordinateRepresentationType;
  using typename Superclass1::MovingImageType;
  using typename Superclass1::MovingImagePixelType;
  using typename Superclass1::MovingImageConstPointer;
  using typename Superclass1::FixedImageType;
  using typename Superclass1::FixedImageConstPointer;
  using typename Superclass1::FixedImageRegionType;
  using typename Superclass1::TransformType;
  using typename Superclass1::TransformPointer;
  using typename Superclass1::InputPointType;
  using typename Superclass1::OutputPointType;
  using typename Superclass1::TransformJacobianType;
  using typename Superclass1::InterpolatorType;
  using typename Superclass1::InterpolatorPointer;
  using typename Superclass1::RealType;
  using typename Superclass1::GradientPixelType;
  using typename Superclass1::GradientImageType;
  using typename Superclass1::GradientImagePointer;
  using typename Superclass1::FixedImageMaskType;
  using typename Superclass1::FixedImageMaskPointer;
  using typename Superclass1::MovingImageMaskType;
  using typename Superclass1::MovingImageMaskPointer;
  using typename Superclass1::MeasureType;
  using typename Superclass1::DerivativeType;
  using typename Superclass1::ParametersType;
  using typename Superclass1::FixedImagePixelType;
  using typename Superclass1::MovingImageRegionType;
  using typename Superclass1::ImageSamplerType;
  using typename Superclass1::ImageSamplerPointer;
  using typename Superclass1::ImageSampleContainerType;
  using typename Superclass1::ImageSampleContainerPointer;
  using typename Superclass1::FixedImageLimiterType;
  using typename Superclass1::MovingImageLimiterType;
  using typename Superclass1::FixedImageLimiterOutputType;
  using typename Superclass1::MovingImageLimiterOutputType;
  using typename Superclass1::MovingImageDerivativeScalesType;

  itkStaticConstMacro(FixedImageDimension, unsigned int, FixedImageType::ImageDimension);

  itkStaticConstMacro(MovingImageDimension, unsigned int, MovingImageType::ImageDimension);

  using typename Superclass2::ElastixType;
  using typename Superclass2::RegistrationType;
  using ITKBaseType = typename Superclass2::ITKBaseType;
 

  void
  Initialize() override;

  void
  AfterEachIteration() override;

  void
  BeforeEachResolution() override;

  void
  BeforeRegistration() override;
 
protected:
  ImpactMetric() = default;
  ~ImpactMetric() override = default;
 
  unsigned long m_CurrentIteration;
 
private:
  elxOverrideGetSelfMacro;
 
  std::vector<itk::ImpactModelConfiguration>
  GenerateModelsConfiguration(unsigned int level,
                              std::string  type,
                              std::string  mode,
                              unsigned int imageDimension,
                              bool         useMixedPrecision);
};

inline std::vector<bool>
GetBooleanVectorFromString(std::string valueStr, bool defaultValue)
{
  std::vector<bool> values(defaultValue, valueStr.size());
  for (char c : valueStr)
  {
    std::stringstream tokenStream(std::string(1, c));
    std::string       subToken;
    if (tokenStream >> subToken)
    {
      bool value = subToken == "1";
      values.push_back(value);
    }
  }
  if (values.empty())
  {
    values.push_back(defaultValue);
  }
  return values;
} // end GetVectorFromString

template <typename T>
std::vector<std::vector<T>>
GroupByDimensions(const std::vector<T> & values, const std::vector<unsigned int> & dimensions)
{
  std::vector<std::vector<T>> grouped;
  size_t                      currentIndex = 0;
  size_t                      n = values.size();
 
  for (unsigned int dim : dimensions)
  {
    std::vector<T> group;
    for (unsigned int i = 0; i < dim; ++i)
    {
      if (currentIndex < n)
      {
        group.push_back(values[currentIndex++]);
      }
      else if (!values.empty())
      {
        group.push_back(values.back()); // repeats last value if overflow
      }
    }
    grouped.push_back(std::move(group));
  }
 
  return grouped;
}
 
} // end namespace elastix
 
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "elxImpactMetric.hxx"
#endif
 
#endif // end #ifndef elxImpactMetric_h