Magnetometer.h

Go to the documentation of this file.

/******************************************************************************
* Copyright (c) ATTX INC 2025. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX, INC. 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, INC.
******************************************************************************/
/*
Magnetometer model header file
 
Author: James Tabony
*/
/*
Metadata for MS GUI:
imdata = {"displayname" : "Magnetometer",
          "exclude" : False,
          "category" : "Sensors"
}
aliases = {"bias_initial" : "Bias",
           "min_mag_field_strength" : "Minimum Mag. Strength",
           "max_mag_field_strength" : "Maximum Mag. Strength",
           "mount_frame" : "Spacecraft Body",
           "mount_position__mf" : "EXCLUDE",
           "mount_alignment_mf" : "EXCLUDE",
           "resolution" : "EXCLUDE",
           "rate_hz" : "Rate Hz",
           "seed_value" : "EXCLUDE",
           "mag_field_model_frame" : "Mag. Field Model Frame",
           "latency" : "EXCLUDE",
           "gaussian_noise" : "Noise",
           "walking_bias_std" : "EXCLUDE",
           "scale_factor_std" : "EXCLUDE",
           "truth_mag_field__model" : "Truth Mag. Field",
           "meas_mag_field__mag" : "Meas. Mag. Field",
           "truth_mag_field__mag" : "EXCLUDE",
           "is_valid" : "Meas. Validity Flag",
           "operational_power_draw" : "Operational Power Draw",
           "mass" : "Mass",
           "current_power_draw" : "Current Power Draw",
}
*/
 
#ifndef MODELS_SENSORS_MAGNETOMETER_H
#define MODELS_SENSORS_MAGNETOMETER_H
 
#include "simulation/Model.h"
#include "frames/Frame.h"
#include "models/support/MarkovUncertaintyModel.h"
#include "monitors/RateMonitor.h"
#include "utils/LatencyUtil.hpp"
 
namespace warptwin {


    struct _magnetometer_output_struct {
        CartesianVector3 meas_mag_field__mag;
        bool is_valid;
        // Default constuctor (should populate with model defualt outputs)
        _magnetometer_output_struct()
            : meas_mag_field__mag(CartesianVector3({0.0, 0.0, 0.0})),
              is_valid(false) {}
        // Custom constructor
        _magnetometer_output_struct(CartesianVector3 meas_mag_field__mag, bool is_valid)
            : meas_mag_field__mag(meas_mag_field__mag),
              is_valid(is_valid) {}
    };
 
    MODEL(Magnetometer)
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            SIGNAL(bias_initial,            CartesianVector3,       CartesianVector3({0.0, 0.0, 0.0}))
            SIGNAL(min_mag_field_strength,  double,                 -800000.0)
            SIGNAL(max_mag_field_strength,  double,                 800000.0)
            SIGNAL(mount_frame,             Frame*,                 nullptr)
            SIGNAL(mount_position__mf,      CartesianVector3,       CartesianVector3({0.0, 0.0, 0.0}))
            SIGNAL(mount_alignment_mf,      clockwerk::Quaternion,  clockwerk::Quaternion({1.0, 0.0, 0.0, 0.0}))
            SIGNAL(resolution,              double,                 0.0)
            SIGNAL(rate_hz,                 int,                    0)
            SIGNAL(seed_value,              int,                    0)
            SIGNAL(mag_field_model_frame,   Frame*,                 nullptr)
            SIGNAL(latency,                 int,                    0)
            SIGNAL(operational_power_draw,  double,                 0.0)
            SIGNAL(mass,                    double,                 0.0)
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
            SIGNAL(gaussian_noise,          CartesianVector3,       CartesianVector3({0.0, 0.0, 0.0}))
            SIGNAL(walking_bias_std,        CartesianVector3,       CartesianVector3({0.0, 0.0, 0.0}))
            SIGNAL(scale_factor_std,        CartesianVector3,       CartesianVector3({0.0, 0.0, 0.0}))
            SIGNAL(truth_mag_field__model,  CartesianVector3,       CartesianVector3({0.0, 0.0, 0.0}))
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            SIGNAL(output_time,             clockwerk::Time,        clockwerk::Time(0, 0))
            SIGNAL(meas_mag_field__mag,     CartesianVector3,       CartesianVector3({0.0, 0.0, 0.0}))
            SIGNAL(truth_mag_field__mag,    CartesianVector3,       CartesianVector3({0.0, 0.0, 0.0}))
            SIGNAL(is_valid,                bool,                   false)
            SIGNAL(current_power_draw,      double,                 0.0)
        END_OUTPUTS

        clockwerk::DataIO<Frame*> sensor_frame = clockwerk::DataIO<Frame*>(this, "sensor_frame", &_sensor_frame);

        warptwin::MarkovUncertaintyModel* biasNoiseModel() {return &_sensor_noise_model;}

        warptwin::RateMonitor* rateMonitor() {return &_rate_monitor;}
 
        int16 activate() override;
        int16 deactivate() override;
 
    protected:
        int16 start() override;
        int16 execute() override;

        void _configureInternal();

        Frame _sensor_frame;

        MarkovUncertaintyModel _sensor_noise_model;

        RateMonitor _rate_monitor;

        CartesianVector3 _previous_bias;

        CartesianVector3 _truth_mag_field__mag;

        CartesianVector3 _perturbed_mag;

        std::array<bool, 3> _in_deadzone;

        LatencyUtil<_magnetometer_output_struct> _latency_model;

        _magnetometer_output_struct _last_output, _latency_return;
    };
 
}
 
#endif