Class BumpModel

Defined in File bump_model.hpp

Inheritance Relationships

Base Type

public otyca::Model< 1 > (Template Class Model)

Class Documentation

class BumpModel : public otyca::Model<1>

A model that applies bumps to an underlying core model.

Public Functions

inline BumpModel(const std::shared_ptr<Model<1>> &core)

Constructs a BumpModel with a core model.

Parameters:: core – The core model to which bumps will be applied.

std::vector<double> evaluate(const std::vector<std::array<double, 1>> &x) const override

double core_model_evaluate(double x) const

Evaluates the core model at a given point.

Parameters:: x – The input value.
Returns:: The evaluated result from the core model.

virtual void set_transformed_calibration_parameters(const std::vector<double> &transformed_parameters) override

set the transformed parameters for calibration.

Parameters:: transformed_calibration_parameters – the transformed calibration parameters

void add_bump(double t, double bump)

Adds a bump to the model.

Parameters:

t – The time at which the bump is applied.
bump – The magnitude of the bump.

void calibrate(const Model<1>::CalibrationInput &input, const CalibrationConfig &calibration_config) override

double bump(double t_min, double t_max)

Retrieves the sum of all bump values within a given time range.

Parameters:

t_min – The minimum time bound.
t_max – The maximum time bound.

Returns:

The sum of all bump values.

virtual std::vector<double> get_transformed_calibration_parameters() const override

get the transformed parameters for calibration.

Returns:: the transformed parameters for calibration

virtual std::vector<double> get_parameters() const override

Get the model’s raw parameters.

Returns:: A vector containing the model’s parameters.

virtual void set_parameters(const std::vector<double> &parameters) override

Set the model’s raw parameters.

Parameters:: parameters – A vector of new parameter values.

inline virtual std::string name() const override

Get the model’s name.

Returns:: A string representing the name of the model.

inline void set_core_model(const std::shared_ptr<Model<1>> &core)

Sets the core model.

Parameters:: core – The new core model.

inline std::shared_ptr<Model<1>> get_core_model()

Retrieves the core model.

Returns:: A shared pointer to the core model.

inline virtual std::ostream &print(std::ostream &out) const override

Print model parameters and names to an output stream.

Prints parameter names followed by values, comma-separated.

Parameters:: out – The output stream to write to.
Returns:: The modified output stream.

const Scatter<double> &get_bumps() const

Retrieves the bumps applied to the core model.

Returns:: A reference to the Scatter object containing bumps.