BiasNoiseModel.h

/******************************************************************************
* Copyright (c) ATTX LLC 2024. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX, LLC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX, LLC.
******************************************************************************/
/*
Bias and noise model header file
 
Author: Alex Reynolds
*/
 
#ifndef MODELS_SUPPORT_BIAS_NOISE_MODEL_H
#define MODELS_SUPPORT_BIAS_NOISE_MODEL_H
 
#include "core/macros.h"
#include "simulation/Model.h"
#include "simulation/NormalRandom.hpp"
 
namespace modelspace {
 
    /**
     * @brief   Bias and noise model
     * 
     * This model perturbs a single output according to a bias and noise value
     * configured at start time. Distribution is gaussian.
     * 
     * @author Alex Reynolds <alex.reynolds@attx.tech>
    */
    class BiasNoiseModel : public Model {
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            /** The bias in the object as a raw, constant error across all draws for the entire simulation */
            SIGNAL(bias,                    double,                 0.0)
            /** The standard deviation of noise in the object as a gaussian random noise */
            SIGNAL(noise_std,               double,                 0.0)
            /** Value to seed the internal RNG for this model. */
            SIGNAL(seed_value,              int,                    0)
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
            /** The input value to be perturbed by noise and bias */
            SIGNAL(input_val,               double,                 0.0)
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            /** The output value as perturbed by noise and bias */
            SIGNAL(output_val,              double,                 0.0)
        END_OUTPUTS
 
        // Model-specific implementations of startup and derivative
        BiasNoiseModel();
        BiasNoiseModel(Model &pnt, const std::string &m_name="bias_noise");
        BiasNoiseModel(SimulationExecutive &e, const std::string &m_name="bias_noise");
        BiasNoiseModel(Model &pnt, int schedule_slot, const std::string &m_name="bias_noise");
        BiasNoiseModel(SimulationExecutive &e, int schedule_slot, const std::string &m_name="bias_noise");
        ~BiasNoiseModel() {}
 
    protected:
        int start();
        int execute();
 
        /// @brief RNG to produce our distribution.
        NormalRandom<double> *_rng = nullptr;
    };
 
}
 
#endif