itkFullSearchOptimizer.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 __itkFullSearchOptimizer_h
#define __itkFullSearchOptimizer_h
 
#include "itkSingleValuedNonLinearOptimizer.h"
#include "itkMapContainer.h"
#include "itkImage.h"
#include "itkArray.h"
#include "itkFixedArray.h"
 
namespace itk
{
 
class FullSearchOptimizer : public SingleValuedNonLinearOptimizer
{
public:
 
  typedef FullSearchOptimizer            Self;
  typedef SingleValuedNonLinearOptimizer Superclass;
  typedef SmartPointer< Self >           Pointer;
  typedef SmartPointer< const Self >     ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( FullSearchOptimizer, SingleValuedNonLinearOptimizer );
 
  typedef enum {
    FullRangeSearched,
    MetricError
  } StopConditionType;
 
  /* Typedefs inherited from superclass */
  typedef Superclass::ParametersType      ParametersType;
  typedef Superclass::CostFunctionType    CostFunctionType;
  typedef Superclass::CostFunctionPointer CostFunctionPointer;
  typedef Superclass::MeasureType         MeasureType;
 
  typedef ParametersType::ValueType               ParameterValueType;     // = double
  typedef ParameterValueType                      RangeValueType;
  typedef FixedArray< RangeValueType, 3 >         RangeType;
  typedef MapContainer< unsigned int, RangeType > SearchSpaceType;
  typedef SearchSpaceType::Pointer                SearchSpacePointer;
  typedef SearchSpaceType::ConstIterator          SearchSpaceIteratorType;
 
  typedef Array< ParameterValueType > SearchSpacePointType;
 
  typedef Array< IndexValueType > SearchSpaceIndexType;
 
  typedef Array< SizeValueType > SearchSpaceSizeType;
 
  itkGetConstMacro( Maximize, bool );
  itkSetMacro( Maximize, bool );
  itkBooleanMacro( Maximize );
  bool GetMinimize() const
  { return !m_Maximize; }
  void SetMinimize( bool v )
  { this->SetMaximize( !v ); }
  void MinimizeOn()
  { this->MaximizeOff(); }
  void MinimizeOff()
  { this->MaximizeOn(); }
 
  virtual void UpdateCurrentPosition( void );
 
  void StartOptimization( void ) override;
 
  virtual void ResumeOptimization( void );
 
  virtual void StopOptimization( void );
 
  itkSetObjectMacro( SearchSpace, SearchSpaceType );
  itkGetModifiableObjectMacro( SearchSpace, SearchSpaceType );
 
  virtual void AddSearchDimension( unsigned int param_nr,
    RangeValueType minimum, RangeValueType maximum, RangeValueType step );
 
  virtual void RemoveSearchDimension( unsigned int param_nr );
 
  virtual unsigned long GetNumberOfIterations( void );
 
  virtual unsigned int GetNumberOfSearchSpaceDimensions( void );
 
  virtual const SearchSpaceSizeType & GetSearchSpaceSize( void );
 
  virtual ParametersType PointToPosition( const SearchSpacePointType & point );
 
  virtual ParametersType IndexToPosition( const SearchSpaceIndexType & index );
 
  virtual SearchSpacePointType IndexToPoint( const SearchSpaceIndexType & index );
 
  itkGetConstMacro( CurrentIteration, unsigned long );
 
  itkGetConstReferenceMacro( CurrentPointInSearchSpace, SearchSpacePointType );
  itkGetConstReferenceMacro( CurrentIndexInSearchSpace, SearchSpaceIndexType );
 
  itkGetConstReferenceMacro( BestPointInSearchSpace, SearchSpacePointType );
  itkGetConstReferenceMacro( BestIndexInSearchSpace, SearchSpaceIndexType );
 
  itkGetConstMacro( Value, double );
 
  itkGetConstMacro( BestValue, double );
 
  itkGetConstMacro( StopCondition, StopConditionType );
 
protected:
 
  FullSearchOptimizer();
  ~FullSearchOptimizer() override {}
 
  //void PrintSelf(std::ostream& os, Indent indent) const;
 
  bool              m_Maximize;
  bool              m_Stop;
  double            m_Value;
  double            m_BestValue;
  StopConditionType m_StopCondition;
 
  SearchSpacePointer   m_SearchSpace;
  SearchSpacePointType m_CurrentPointInSearchSpace;
  SearchSpaceIndexType m_CurrentIndexInSearchSpace;
  SearchSpacePointType m_BestPointInSearchSpace;
  SearchSpaceIndexType m_BestIndexInSearchSpace;
  SearchSpaceSizeType  m_SearchSpaceSize;
  unsigned int         m_NumberOfSearchSpaceDimensions;
 
  unsigned long m_LastSearchSpaceChanges;
  virtual void ProcessSearchSpaceChanges( void );
 
private:
 
  FullSearchOptimizer( const Self & ); // purposely not implemented
  void operator=( const Self & );      // purposely not implemented
 
  unsigned long m_CurrentIteration;
 
};
 
} // end namespace itk
 
#endif