itkObjectToObjectMultiMetricv4.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 itkObjectToObjectMultiMetricv4_h
#define itkObjectToObjectMultiMetricv4_h

#include "itkObjectToObjectMetric.h"
#include "itkArray.h"
#include <deque>

namespace itk
{
template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double >
class ObjectToObjectMultiMetricv4:
  public ObjectToObjectMetric<TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType>
{
public:
  typedef ObjectToObjectMultiMetricv4                                                                      Self;
  typedef ObjectToObjectMetric<TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType>  Superclass;
  typedef SmartPointer<Self>                                                                               Pointer;
  typedef SmartPointer<const Self>                                                                         ConstPointer;

  itkTypeMacro(ObjectToObjectMultiMetricv4, ObjectToObjectMetric);

  itkNewMacro( Self );

  typedef typename Superclass::MeasureType                  MeasureType;
  typedef typename Superclass::DerivativeType               DerivativeType;
  typedef typename Superclass::DerivativeValueType          DerivativeValueType;
  typedef typename Superclass::ParametersType               ParametersType;
  typedef typename Superclass::ParametersValueType          ParametersValueType;
  typedef typename Superclass::NumberOfParametersType       NumberOfParametersType;
  typedef typename Superclass::CoordinateRepresentationType CoordinateRepresentationType;
  typedef typename Superclass::MovingTransformType          MovingTransformType;
  typedef typename Superclass::FixedTransformType           FixedTransformType;

  typedef Superclass                               MetricType;
  typedef typename MetricType::Pointer             MetricBasePointer;
  typedef typename MetricType::ConstPointer        MetricBaseConstPointer;
  typedef std::deque<MetricBasePointer>            MetricQueueType;

  typedef typename Superclass::ObjectType          ObjectType;

  typedef typename DerivativeType::ValueType       WeightValueType;
  typedef Array<WeightValueType>                   WeightsArrayType;
  typedef Array<MeasureType>                       MetricValueArrayType;

  itkSetMacro(MetricWeights,WeightsArrayType);
  itkGetMacro(MetricWeights,WeightsArrayType);

  void AddMetric( MetricType* metric );

  void ClearMetricQueue();

  SizeValueType GetNumberOfMetrics() const;

  void Initialize(void) throw ( itk::ExceptionObject ) ITK_OVERRIDE;

  virtual void SetFixedObject( const ObjectType *itkNotUsed( object ) ) ITK_OVERRIDE
    {
    itkExceptionMacro( "A single object should not be specified for the multi metric.");
    }

  virtual void SetMovingObject( const ObjectType *itkNotUsed( object ) ) ITK_OVERRIDE
    {
    itkExceptionMacro( "A single object should not be specified for the multi metric.");
    }

  virtual void SetMovingTransform( MovingTransformType * ) ITK_OVERRIDE;

  virtual void SetFixedTransform( FixedTransformType * ) ITK_OVERRIDE;

  MeasureType GetValue() const ITK_OVERRIDE;

  virtual void GetDerivative( DerivativeType & ) const ITK_OVERRIDE;

  void GetValueAndDerivative(MeasureType & value, DerivativeType & derivative) const ITK_OVERRIDE;

  MetricValueArrayType GetValueArray() const;

  MeasureType GetWeightedValue() const;

  const MetricQueueType & GetMetricQueue() const;

  virtual bool SupportsArbitraryVirtualDomainSamples( void ) const ITK_OVERRIDE;

  typedef typename Superclass::MetricCategoryType   MetricCategoryType;

  virtual MetricCategoryType GetMetricCategory() const ITK_OVERRIDE
    {
    return Superclass::MULTI_METRIC;
    }

protected:

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

private:

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

  MetricQueueType               m_MetricQueue;
  WeightsArrayType              m_MetricWeights;
  mutable MetricValueArrayType  m_MetricValueArray;
};

} //end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkObjectToObjectMultiMetricv4.hxx"
#endif

#endif