elxFullSearchOptimizer.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 elxFullSearchOptimizer_h
#define elxFullSearchOptimizer_h
 
#include "elxIncludes.h" // include first to avoid MSVS warning
#include "itkFullSearchOptimizer.h"
#include <map>
 
#include "itkNDImageBase.h"
 
namespace elastix
{

 
template <typename TElastix>
class ITK_TEMPLATE_EXPORT FullSearch
  : public itk::FullSearchOptimizer
  , public OptimizerBase<TElastix>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(FullSearch);

  using Self = FullSearch;
  using Superclass1 = itk::FullSearchOptimizer;
  using Superclass2 = OptimizerBase<TElastix>;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(FullSearch);

  elxClassNameMacro("FullSearch");

  using Superclass1::CostFunctionType;
  using Superclass1::CostFunctionPointer;
  using Superclass1::ParametersType;
  using Superclass1::MeasureType;
  using Superclass1::ParameterValueType;
  using Superclass1::RangeValueType;
  using Superclass1::RangeType;
  using Superclass1::SearchSpaceType;
  using Superclass1::SearchSpacePointer;
  using Superclass1::SearchSpaceIteratorType;
  using Superclass1::SearchSpacePointType;
  using Superclass1::SearchSpaceIndexType;
  using Superclass1::SearchSpaceSizeType;

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

  using NDImageType = itk::NDImageBase<float>;
  using NDImagePointer = typename NDImageType::Pointer;

  using DimensionNameMapType = std::map<unsigned int, std::string>;
  using NameIteratorType = typename DimensionNameMapType::const_iterator;

  void
  BeforeRegistration() override;
 
  void
  BeforeEachResolution() override;
 
  void
  AfterEachResolution() override;
 
  void
  AfterEachIteration() override;
 
  void
  AfterRegistration() override;


  itkGetModifiableObjectMacro(OptimizationSurface, NDImageType);
 
protected:
  FullSearch();
  ~FullSearch() override = default;
 
private:
  elxOverrideGetSelfMacro;
 
  NDImagePointer m_OptimizationSurface;
 
  DimensionNameMapType m_SearchSpaceDimensionNames;

  // int CheckSearchSpaceRangeDefinition(const std::string & fullFieldName,
  //  int errorcode, unsigned int entry_nr);
  bool
  CheckSearchSpaceRangeDefinition(const std::string & fullFieldName, const unsigned int entry_nr) const;
};
 
} // end namespace elastix
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "elxFullSearchOptimizer.hxx"
#endif
 
#endif // end #ifndef elxFullSearchOptimizer_h