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:
  ITK_DISALLOW_COPY_AND_MOVE(ScaledSingleValuedCostFunction);
 
  using Self = ScaledSingleValuedCostFunction;
  using Superclass = SingleValuedCostFunction;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkTypeMacro(ScaledSingleValuedCostFunction, SingleValuedCostFunction);
 
  using Superclass::MeasureType;
  using Superclass::DerivativeType;
  using Superclass::ParametersType;
  // temporary, untill it is fixed in the ITK4
  // typedef IdentifierType NumberOfParametersType; // temp, copied from itk::TransformBase
  using NumberOfParametersType = unsigned int; // temp, copied from itk::CostFunction
  using SingleValuedCostFunctionPointer = Superclass::Pointer;
 
  using ScalesType = Array<double>;
 
  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() 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 = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  ScalesType                      m_Scales{};
  ScalesType                      m_SquaredScales{};
  SingleValuedCostFunctionPointer m_UnscaledCostFunction{ nullptr };
  bool                            m_UseScales{ false };
  bool                            m_NegateCostFunction{ false };
};
 
} // end namespace itk
 
#endif // #ifndef itkScaledSingleValuedCostFunction_h