itkObjectToObjectOptimizerBase.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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 __itkObjectToObjectOptimizerBase_h
#define __itkObjectToObjectOptimizerBase_h

#include "itkOptimizerParameters.h"
#include "itkObjectToObjectMetricBase.h"
#include "itkIntTypes.h"

namespace itk
{
class ITK_EXPORT ObjectToObjectOptimizerBase : public Object
{
public:
  typedef ObjectToObjectOptimizerBase                 Self;
  typedef Object                                      Superclass;
  typedef SmartPointer< Self >                        Pointer;
  typedef SmartPointer< const Self >                  ConstPointer;

  itkTypeMacro(ObjectToObjectOptimizerBase, Object);

  typedef OptimizerParameters< double >             ScalesType;

  typedef OptimizerParameters< double >             ParametersType;

  typedef ObjectToObjectMetricBase                  MetricType;
  typedef MetricType::Pointer                       MetricTypePointer;

  typedef MetricType::NumberOfParametersType        NumberOfParametersType;

  typedef MetricType::MeasureType                   MeasureType;

  typedef MetricType::InternalComputationValueType  InternalComputationValueType;

  itkSetObjectMacro( Metric, MetricType );
  itkGetModifiableObjectMacro(Metric, MetricType );

  itkGetConstReferenceMacro( CurrentMetricValue, MeasureType );

  const MeasureType & GetValue();

  itkSetMacro( Scales, ScalesType );

  itkGetConstReferenceMacro( Scales, ScalesType );

  itkGetConstReferenceMacro( ScalesAreIdentity, bool );

  itkSetMacro( Weights, ScalesType );

  itkGetConstReferenceMacro( Weights, ScalesType );

  itkGetConstReferenceMacro( WeightsAreIdentity, bool );

  virtual void SetNumberOfThreads( ThreadIdType number );

  itkGetConstReferenceMacro( NumberOfThreads, ThreadIdType );

  const ParametersType & GetCurrentPosition();

  virtual void StartOptimization( bool doOnlyInitialization = false );

protected:

  ObjectToObjectOptimizerBase();
  virtual ~ObjectToObjectOptimizerBase();

  MetricTypePointer             m_Metric;
  ThreadIdType                  m_NumberOfThreads;

  MeasureType                   m_CurrentMetricValue;

  ScalesType                    m_Scales;

  ScalesType                    m_Weights;

  bool                          m_ScalesAreIdentity;

  bool                          m_WeightsAreIdentity;

  virtual void PrintSelf(std::ostream & os, Indent indent) const;

private:

  //purposely not implemented
  ObjectToObjectOptimizerBase( const Self & );
  //purposely not implemented
  void operator=( const Self& );

};

} // end namespace itk

#endif