itkScaledSingleValuedCostFunction.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 __itkScaledSingleValuedCostFunction_h
#define __itkScaledSingleValuedCostFunction_h
 
#include "itkSingleValuedCostFunction.h"
#include "itkIntTypes.h" //temp, needed for IdentifierType
 
namespace itk
{
class ScaledSingleValuedCostFunction : public SingleValuedCostFunction
{
public:
 
  typedef ScaledSingleValuedCostFunction Self;
  typedef SingleValuedCostFunction       Superclass;
  typedef SmartPointer< Self >           Pointer;
  typedef SmartPointer< const Self >     ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( ScaledSingleValuedCostFunction, SingleValuedCostFunction );
 
  typedef Superclass::MeasureType    MeasureType;
  typedef Superclass::DerivativeType DerivativeType;
  typedef Superclass::ParametersType ParametersType;
  // temporary, untill it is fixed in the ITK4
  //typedef IdentifierType NumberOfParametersType; // temp, copied from itk::TransformBase
  typedef unsigned int        NumberOfParametersType; // temp, copied from itk::CostFunction
  typedef Superclass::Pointer SingleValuedCostFunctionPointer;
 
  typedef Array< double > ScalesType;
 
  MeasureType GetValue( const ParametersType & parameters ) const override;
 
  void GetDerivative(
    const ParametersType & parameters,
    DerivativeType & derivative ) const override;
 
  void GetValueAndDerivative(
    const ParametersType & parameters,
    MeasureType & value,
    DerivativeType & derivative ) const override;
 
  NumberOfParametersType GetNumberOfParameters( void ) const override;
 
  itkSetObjectMacro( UnscaledCostFunction, Superclass );
  itkGetModifiableObjectMacro( UnscaledCostFunction, Superclass );
 
  virtual void SetScales( const ScalesType & scales );
 
  itkGetConstReferenceMacro( Scales, ScalesType );
 
  virtual void SetSquaredScales( const ScalesType & squaredScales );
 
  itkGetConstReferenceMacro( SquaredScales, ScalesType );
 
  itkSetMacro( UseScales, bool );
 
  itkGetConstMacro( UseScales, bool );
 
  itkBooleanMacro( NegateCostFunction );
 
  itkSetMacro( NegateCostFunction, bool );
  itkGetConstMacro( NegateCostFunction, bool );
 
  virtual void ConvertScaledToUnscaledParameters( ParametersType & parameters ) const;
 
  virtual void ConvertUnscaledToScaledParameters( ParametersType & parameters ) const;
 
protected:
 
  ScaledSingleValuedCostFunction();
  ~ScaledSingleValuedCostFunction() override {}
 
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
private:
 
  ScaledSingleValuedCostFunction( const Self & );   // purposely not implemented
  void operator=( const Self & );                   // purposely not implemented
 
  ScalesType                      m_Scales;
  ScalesType                      m_SquaredScales;
  SingleValuedCostFunctionPointer m_UnscaledCostFunction;
  bool                            m_UseScales;
  bool                            m_NegateCostFunction;
 
};
 
} //end namespace itk
 
#endif // #ifndef __itkScaledSingleValuedCostFunction_h