FitParameter.cpp

Go to the documentation of this file.

// Copyright (c) 2017 The ComPWA Team.
// This file is part of the ComPWA framework, check
// https://github.com/ComPWA/ComPWA/license.txt for details.

#include <iomanip>

#include "Core/Utils.hpp"

#include "FitParameter.hpp"

namespace ComPWA {
namespace FunctionTree {

FitParameter::FitParameter(std::string inName)
    : Parameter(inName, ParType::DOUBLE), HasBounds(false), IsFixed(true),
      Value(0), Bounds(std::pair<double, double>(0, 0)),
      ErrType(ErrorType::NOTDEF), Error(std::pair<double, double>(0, 0)) {}

FitParameter::FitParameter(const boost::property_tree::ptree &pt)
    : Parameter("", ParType::DOUBLE), HasBounds(false), IsFixed(true), Value(0),
      Bounds(std::pair<double, double>(0, 0)), ErrType(ErrorType::NOTDEF),
      Error(std::pair<double, double>(0, 0)) {
  load(pt);
}

FitParameter::FitParameter(std::string inName, const double value)
    : Parameter(inName, ParType::DOUBLE), HasBounds(false), IsFixed(true),
      Value(value), Bounds(std::pair<double, double>(0, 0)),
      ErrType(ErrorType::NOTDEF), Error(std::pair<double, double>(0, 0)) {}

FitParameter::FitParameter(std::string inName, const double value,
                           const double error)
    : Parameter(inName, ParType::DOUBLE), HasBounds(false), IsFixed(true),
      Value(value), Bounds(std::pair<double, double>(0, 0)),
      ErrType(ErrorType::SYM), Error(std::pair<double, double>(error, error)) {}

FitParameter::FitParameter(std::string inName, const double value,
                           const double min, const double max)
    : Parameter(inName, ParType::DOUBLE), HasBounds(false), IsFixed(false),
      Value(value), Bounds(std::pair<double, double>(0, 0)),
      ErrType(ErrorType::NOTDEF), Error(std::pair<double, double>(0, 0)) {
  setBounds(min, max);
}

FitParameter::FitParameter(std::string inName, const double value,
                           const double min, const double max,
                           const double error)
    : Parameter(inName, ParType::DOUBLE), HasBounds(false), IsFixed(false),
      Value(value), Bounds(std::pair<double, double>(0, 0)),
      ErrType(ErrorType::NOTDEF), Error(std::pair<double, double>(0, 0)) {
  setError(error);
  setBounds(min, max);
}

FitParameter::FitParameter(ComPWA::FitParameter<double> par)
    : Parameter(par.Name, ParType::DOUBLE), Value(par.Value) {

  if (par.HasBounds)
    setBounds(par.Bounds);
  setError(par.Error);
  HasBounds = par.HasBounds;
  IsFixed = par.IsFixed;
};

void FitParameter::updateParameter(std::shared_ptr<FitParameter> newPar) {

  // Copy bounds
  if (newPar->hasBounds()) {
    HasBounds = true;
    setBounds(newPar->bounds());
  } else
    HasBounds = false;

  bool isFix = newPar->isFixed();
  fixParameter(0); // we ignore here if parameter is fixed

  // Copy value
  setValue(newPar->value());

  // Copy uncertainty
  if (newPar->errorType() == ErrorType::SYM)
    setError(newPar->error().first);
  else if (newPar->errorType() == ErrorType::ASYM)
    setError(newPar->error());
  else
    ErrType = ErrorType::NOTDEF;

  // Copy fix parameter
  fixParameter(isFix);
  return;
}

void FitParameter::setValue(const double inVal) {
  if (IsFixed)
    throw ParameterFixed("FunctionTree::FitParameter::setValue() | Parameter " +
                         name() + " is fixed!");
  // Call notify only if value has changed! Otherwise tree is
  // recalculated also in case where current parameter is not changed
  if (Value == inVal)
    return;

  if (HasBounds && (inVal < bounds().first || inVal > bounds().second))
    throw ParameterOutOfBound(
        "FitParameter::setValue() | Parameter " + name() +
        " not within bounds: val=" + std::to_string(inVal) + " [" +
        std::to_string(bounds().first) + ";" + std::to_string(bounds().second) +
        "]");

  Value = inVal;
  notify();
}

std::pair<double, double> FitParameter::bounds() const { return Bounds; }

void FitParameter::setBounds(const double min, const double max) {
  if (!check_bounds(std::pair<double, double>(min, max)))
    throw BadParameter("FitParameter::setBounds() | Bounds not valid: [" +
                       std::to_string(min) + ", " + std::to_string(max) + "]");
  Bounds.first = min;
  Bounds.second = max;
  HasBounds = true;
}

void FitParameter::setBounds(const std::pair<double, double> r) {
  if (!check_bounds(r))
    throw BadParameter("FitParameter::setBounds() | Bounds not valid: [" +
                       std::to_string(r.first) + ", " +
                       std::to_string(r.second) + "]");
  Bounds = r;
  HasBounds = true;
}

bool FitParameter::hasError() const {
  if (ErrType != ErrorType::NOTDEF)
    return true;
  return false;
}

std::pair<double, double> FitParameter::error() const {
  if (!hasError())
    throw std::runtime_error("FitParameter::error() | "
                             "Parameter " +
                             Name + " has no errors defined!");
  return Error;
}

void FitParameter::setError(double errLow, double errHigh) {
  Error.first = errLow;
  Error.second = errHigh;
  if (Error.first == 0.0 && Error.second == 0.0)
    SetErrorType(ErrorType::NOTDEF);
  else
    SetErrorType(ErrorType::ASYM);
}

void FitParameter::setError(std::pair<double, double> err) {
  Error = err;
  if (Error.first == 0.0 && Error.second == 0.0)
    SetErrorType(ErrorType::NOTDEF);
  else
    SetErrorType(ErrorType::ASYM);
}

void FitParameter::setError(double err) {
  Error.first = err;
  Error.second = err;
  if (Error.first == 0.0 && Error.second == 0.0)
    SetErrorType(ErrorType::NOTDEF);
  else
    SetErrorType(ErrorType::SYM);
}

bool FitParameter::operator==(const FitParameter otherPar) const {
  if (this->type() != otherPar.type())
    return false;
  if (this->name() != otherPar.name())
    return false;
  if (this->value() != otherPar.value())
    return false;

  // We assume that if name and value are the same both parameters match. In
  // case that other properties of the parameterts differ we throw an
  // exception since we assume that this is a user mistake.
  if (HasBounds != otherPar.HasBounds || this->bounds() != otherPar.bounds())
    throw std::runtime_error("FitParameter::operator==() | Parameters "
                             "match by name (" +
                             name() + ") and value (" +
                             std::to_string(value()) +
                             ") but differs in "
                             "parameter bounds. We assume that there is a "
                             "mistake. Check your input files!");

  if (IsFixed != otherPar.IsFixed)
    throw std::runtime_error(
        "FitParameter::operator==() | Parameters "
        "match by name (" +
        name() + ") and value (" + std::to_string(value()) +
        ") but one is fixed the other not. "
        "We assume that there is a mistake. Check your input files!");

  if (ErrType != otherPar.ErrType || Error != otherPar.Error)
    throw std::runtime_error("FitParameter::operator==() | Parameters "
                             "match by name (" +
                             name() + ") and value (" +
                             std::to_string(value()) +
                             ") but differs in "
                             "parameter error. We assume that there is a "
                             "mistake. Check your input files!");

  return true;
}

bool FitParameter::check_bounds(const std::pair<double, double> bounds) const {
  if ((bounds.second > bounds.first) && (bounds.second >= Value) &&
      (bounds.first <= Value))
    return true;
  return false;
}

std::string FitParameter::to_str() const {
  std::stringstream oss;
  oss << std::setw(20) << Name;
  oss << "\t Value = " << std::left << Value;
  if (ErrType == ErrorType::SYM) {
    oss << " (+-" << Error.first << ")";
  } else if (ErrType == ErrorType::ASYM) {
    oss << " (+" << Error.second << " -" << Error.first << ")";
  }

  if (HasBounds)
    oss << " [" << Bounds.first << " ; " << Bounds.second << "]";
  if (IsFixed)
    oss << " fixed ";
  return oss.str();
}

std::string FitParameter::val_to_str() const {
  std::stringstream ovs;
  ovs << Value;
  return ovs.str();
}

void FitParameter::load(const boost::property_tree::ptree &pt) {

  // Class attribute is not required. But if it is specified we expect 'Double'
  // here.
  auto c = pt.get_optional<std::string>("<xmlattr>.Class");
  if (c && c.get() != "Double")
    throw BadConfig("CoherentIntensity::Factory() | Property tree seems to "
                    "not containt a configuration for an CoherentIntensity!");

  // Require that name and value are provided
  Name = pt.get<std::string>("<xmlattr>.Name");
  Value = pt.get<double>("Value");

  // Optional settings
  if (pt.get_optional<double>("Error")) {
    this->setError(pt.get<double>("Error"));
  }
  if (pt.get_optional<double>("ErrorLow")) {
    if (pt.get_optional<double>("ErrorHigh"))
      this->setError(std::pair<double, double>(pt.get<double>("ErrorLow"),
                                               pt.get<double>("ErrorHigh")));
    else
      throw std::runtime_error("FitParameterFactory() | Parameter asymmetic "
                               "error not properly set!");
  } else if (pt.get_optional<double>("ErrorHigh")) {
    throw std::runtime_error("FitParameterFactory() | Parameter asymmetic "
                             "error not properly set!");
  } else { // Do not set a asymmetric errors
  }

  auto fix = pt.get_optional<bool>("Fix");
  if (fix)
    this->fixParameter(fix.get());
  else
    this->fixParameter(true);

  auto min = pt.get_optional<double>("Min");
  auto max = pt.get_optional<double>("Max");
  if (min && max) {
    this->setBounds(min.get(), max.get());
  } else if (min || max) { // Bounds not completely specified
    throw std::runtime_error(
        "FitParameterFactory() | Parameter bounds not properly set!");
  } else { // No bounds specified
  }
}

boost::property_tree::ptree FitParameter::save() const {
  boost::property_tree::ptree pt;

  // Require that name and value are provided
  pt.put("<xmlattr>.Class", "Double");
  pt.put("<xmlattr>.Name", name());
  pt.put("Value", value());
  pt.put("Fix", isFixed());
  if (hasBounds()) {
    pt.put("Min", bounds().first);
    pt.put("Max", bounds().second);
  }
  if (ErrType == ErrorType::SYM) {
    pt.put("Error", error().first);
  } else if (ErrType == ErrorType::ASYM) {
    pt.put("ErrorLow", error().first);
    pt.put("ErrorHigh", error().second);
  }
  return pt;
}

} // namespace FunctionTree
} // namespace ComPWA