MagneticCalibrationSpreadsheet.h

Go to the documentation of this file.

#pragma once
#include "DLLInfo.h"
#include "Base/Headers/Vertex.hpp"
#include "Base/Headers/Vector.hpp"
#include "Base/Headers/Angle.h"
#include "Base/Headers/TimeSpan.h"
#include "Base/Headers/File.h"
#include "Base/Headers/AngleFunctions.h"
#include "Base/Headers/Buffer.hpp"
#include "Base/Headers/Time.h"
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief The structure used for storing data to write to a MagneticCalibrationSpreadsheet
    **/
    struct XLSXMagneticAngleReading
    {
        Ray<3, fltp08> magnet;
        Ray<3, fltp08> acceleration;
        Ray<3, fltp08> gyro;
        Ray<3, fltp08> computed_acc;
        Ray<3, fltp08> computed_hdg;
        Ray<3, fltp08> raw;
        fltp08 temperature;
        fltp08 voltage;
        Time time;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief The structure used by the library for storing key points of data used to write to a 
        MagneticCalibrationSpreadsheet
    **/
    struct XLSXKeyPointMagneticAngleReading
    {
        Angle<fltp08> magnetic_angle = Constant<Angle<fltp08>>::Invalid;
        Angle<fltp08> raw_angle = Constant<Angle<fltp08>>::Invalid;
        XLSXMagneticAngleReading reference_reading;
        TimeSpan time_offset;
        uint04 count = 0;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief The structure used by the library for storing averaged points of data used to write to a
        MagneticCalibrationSpreadsheet
    **/
    struct XLSXMagneticAngleAverageReading
    {
        Angle<fltp08> reference_angle = Angle<fltp08>(0);
        Buffer<XLSXKeyPointMagneticAngleReading> points;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief IOFactory interface for reading and writing data from magnetometer calibration checks to excel files.
    \ingroup Hardware Magnetometer Widget
    **/
    class OPENXLSX_INTERFACE_API MagneticCalibrationSpreadsheet
    {
    public:
        void setCalibrationMatrix(const Matrix<fltp08>& calibration_matrix);
        File writeToFile(const File& template_file, const String& file_prefix, const File& file, const Buffer<XLSXMagneticAngleReading>& readings);
        Buffer<XLSXMagneticAngleAverageReading> computeData(const Buffer<XLSXMagneticAngleReading>& readings);
        XLSXMagneticAngleAverageReading computeAngle(const Buffer<XLSXMagneticAngleReading>& readings, uint04 start, uint04 end);
        XLSXKeyPointMagneticAngleReading computeAngle(const XLSXMagneticAngleReading& reading, const Angle<fltp08>& reference_angle);
    protected:
        Matrix<fltp08> m_calibration_matrix = Constant<Matrix<fltp08>>::Invalid;
        fltp08 m_acceleration_tolerance = 0.005;
    };
}