MultiImuFile.cpp

Go to the documentation of this file.

// This file is part of INSTINCT, the INS Toolkit for Integrated
// Navigation Concepts and Training by the Institute of Navigation of
// the University of Stuttgart, Germany.
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
#include "MultiImuFile.hpp"
 
#include "util/Logger.hpp"
 
#include "Navigation/Transformations/CoordinateFrames.hpp"
#include "Navigation/Transformations/Units.hpp"
 
#include "internal/FlowManager.hpp"
#include "internal/gui/widgets/EnumCombo.hpp"
#include "internal/gui/widgets/HelpMarker.hpp"
#include "internal/gui/NodeEditorApplication.hpp"
 
NAV::MultiImuFile::MultiImuFile()
    : Node(typeStatic())
{
    LOG_TRACE("{}: called", name);
 
    _hasConfig = true;
    _guiConfigDefaultWindowSize = { 528, 379 };
 
    updateNumberOfOutputPins();
}
 
NAV::MultiImuFile::~MultiImuFile()
{
    LOG_TRACE("{}: called", nameId());
}
 
std::string NAV::MultiImuFile::typeStatic()
{
    return "MultiImuFile";
}
 
std::string NAV::MultiImuFile::type() const
{
    return typeStatic();
}
 
std::string NAV::MultiImuFile::category()
{
    return "Data Provider";
}
 
void NAV::MultiImuFile::guiConfig()
{
    float columnWidth = 130.0F * gui::NodeEditorApplication::windowFontRatio();
 
    if (FileReader::guiConfig(".txt", { ".txt" }, size_t(id), nameId()))
    {
        flow::ApplyChanges();
        doDeinitialize();
    }
 
    ImGui::SetNextItemWidth(columnWidth);
 
    if (gui::widgets::EnumCombo(fmt::format("NMEA message type##{}", size_t(id)).c_str(), _nmeaType))
    {
        LOG_DEBUG("{}: nmeaType changed to {}", nameId(), fmt::underlying(_nmeaType));
 
        flow::ApplyChanges();
        doDeinitialize();
    }
    ImGui::SameLine();
    gui::widgets::HelpMarker("Until June 2023, NMEA messages in the Multi-IMU file's header were of the 'GPGGA' type. Since this type does not provide an absolute time reference, it was changed to 'GPZDA'.\n\n");
 
    if (_nmeaType == NmeaType::GPGGA)
    {
        if (gui::widgets::TimeEdit(fmt::format("{}", size_t(id)).c_str(), _startTime, _startTimeEditFormat))
        {
            LOG_DEBUG("{}: startTime changed to {}", nameId(), _startTime);
            flow::ApplyChanges();
        }
    }
 
    ImGui::Separator();
    // Set Imu Position and Rotation (from 'Imu::guiConfig();')
    bool showRotation = true;
    for (size_t i = 0; i < _nSensors; ++i)
    {
        ImGui::SetNextItemOpen(showRotation, ImGuiCond_FirstUseEver);
        if (i == 0) { showRotation = false; }
        if (ImGui::TreeNode(fmt::format("Imu #{} Position & Rotation##{}", i + 1, size_t(id)).c_str()))
        {
            ImGui::BeginDisabled(); // FIXME Not properly simulated and accounted for in the algorithms
            std::array<float, 3> imuPos = { static_cast<float>(_imuPosAll[i].b_positionIMU_p().x()), static_cast<float>(_imuPosAll[i].b_positionIMU_p().y()), static_cast<float>(_imuPosAll[i].b_positionIMU_p().z()) };
            if (ImGui::InputFloat3(fmt::format("Position [m]##{}", size_t(id)).c_str(), imuPos.data()))
            {
                flow::ApplyChanges();
                _imuPosAll[i]._b_positionIMU_p = Eigen::Vector3d(imuPos.at(0), imuPos.at(1), imuPos.at(2));
            }
            ImGui::EndDisabled();
            ImGui::SameLine();
            gui::widgets::HelpMarker("Position of the IMU sensor relative to the vehicle center of mass in the body coordinate frame.");
 
            Eigen::Vector3d eulerAnglesIMU = rad2deg(trafo::quat2eulerZYX(_imuPosAll[i].p_quat_b()));
            std::array<float, 3> imuRot = { static_cast<float>(eulerAnglesIMU.x()), static_cast<float>(eulerAnglesIMU.y()), static_cast<float>(eulerAnglesIMU.z()) };
            if (ImGui::InputFloat3(fmt::format("Rotation [deg]##{}", size_t(id)).c_str(), imuRot.data()))
            {
                // (-180:180] x (-90:90] x (-180:180]
                imuRot.at(0) = std::max(imuRot.at(0), -179.9999F);
                imuRot.at(0) = std::min(imuRot.at(0), 180.0F);
                imuRot.at(1) = std::max(imuRot.at(1), -89.9999F);
                imuRot.at(1) = std::min(imuRot.at(1), 90.0F);
                imuRot.at(2) = std::max(imuRot.at(2), -179.9999F);
                imuRot.at(2) = std::min(imuRot.at(2), 180.0F);
 
                flow::ApplyChanges();
                _imuPosAll[i]._b_quat_p = trafo::b_Quat_p(deg2rad(imuRot.at(0)), deg2rad(imuRot.at(1)), deg2rad(imuRot.at(2)));
            }
 
            ImGui::TreePop();
        }
    }
}
 
[[nodiscard]] json NAV::MultiImuFile::save() const
{
    LOG_TRACE("{}: called", nameId());
 
    json j;
 
    j["FileReader"] = FileReader::save();
    j["imuPos"] = _imuPosAll;
    j["nmeaType"] = _nmeaType;
    j["startTime"] = _startTime;
    j["delim"] = _delim;
 
    return j;
}
 
void NAV::MultiImuFile::restore(json const& j)
{
    LOG_TRACE("{}: called", nameId());
 
    if (j.contains("FileReader"))
    {
        FileReader::restore(j.at("FileReader"));
    }
    if (j.contains("imuPos"))
    {
        j.at("imuPos").get_to(_imuPosAll);
    }
    if (j.contains("nmeaType"))
    {
        j.at("nmeaType").get_to(_nmeaType);
    }
    if (j.contains("startTime"))
    {
        j.at("startTime").get_to(_startTime);
    }
    if (j.contains("delim"))
    {
        j.at("delim").get_to(_delim);
    }
}
 
bool NAV::MultiImuFile::initialize()
{
    LOG_TRACE("{}: called", nameId());
 
    return FileReader::initialize();
}
 
void NAV::MultiImuFile::deinitialize()
{
    LOG_TRACE("{}: called", nameId());
 
    FileReader::deinitialize();
}
 
bool NAV::MultiImuFile::resetNode()
{
    _lastFiltObs.reset();
    _lineCounter = 0;
 
    FileReader::resetReader();
 
    for (auto& sensor : _messages)
    {
        sensor.clear();
    }
    for (auto& cnt : _messageCnt)
    {
        cnt = 0;
    }
 
    return true;
}
 
void NAV::MultiImuFile::updateNumberOfOutputPins()
{
    while (outputPins.size() < _nSensors)
    {
        CreateOutputPin(fmt::format("ImuObs {}", outputPins.size() + 1).c_str(), Pin::Type::Flow, { NAV::ImuObs::type() }, &MultiImuFile::pollData);
        _imuPosAll.resize(_nSensors);
 
        _messages.resize(_nSensors);
        _messageCnt.resize(_nSensors);
    }
}
 
NAV::FileReader::FileType NAV::MultiImuFile::determineFileType()
{
    LOG_TRACE("called");
 
    if (good())
    {
        return FileType::ASCII;
    }
 
    LOG_ERROR("Could not open file {}", getFilepath().string());
    return FileType::NONE;
}
 
void NAV::MultiImuFile::readHeader()
{
    LOG_TRACE("called");
 
    _gpzdaFound = false;
    _gpggaFound = false;
    const char* gpzda = "GPZDA";
    const char* gpgga = "GPGGA";
 
    std::string line;
    auto len = tellg();
 
    // Find first line of data
    while (getline(line))
    {
        _lineCounter++;
 
        // Remove any trailing non text characters
        line.erase(std::ranges::find_if(line, [](int ch) { return std::iscntrl(ch); }), line.end());
 
        if ((line.find(gpzda)) != std::string::npos)
        {
            _gpzdaFound = true;
 
            int32_t year{};
            int32_t month{};
            int32_t day{};
            int32_t hour{};
            int32_t min{};
            long double sec{};
 
            // Convert line into stream
            std::stringstream lineStream(line);
            std::string cell;
 
            // Split line at comma
            for (const auto& col : _headerColumns)
            {
                if (std::getline(lineStream, cell, ','))
                {
                    // Remove any trailing non text characters
                    cell.erase(std::ranges::find_if(cell, [](int ch) { return std::iscntrl(ch); }), cell.end());
                    while (cell.empty())
                    {
                        std::getline(lineStream, cell, ',');
                    }
 
                    if (col == "nmeaMsgType")
                    {
                        LOG_DEBUG("{}: nmeaMsgType read.", nameId());
                        continue;
                    }
                    if (col == "UTC_HMS")
                    {
                        hour = std::stoi(cell.substr(0, 2));
                        min = std::stoi(cell.substr(2, 2));
                        sec = std::stold(cell.substr(4, 5));
                        continue;
                    }
                    if (col == "day")
                    {
                        day = std::stoi(cell);
                        continue;
                    }
                    if (col == "month")
                    {
                        month = std::stoi(cell);
                        continue;
                    }
                    if (col == "year")
                    {
                        year = std::stoi(cell);
                    }
 
                    _startTime = InsTime(year, month, day, hour, min, sec + 1. / _gpsRate, UTC); // GPS has a rate of 1 Hz, actual starttime is one message after the last GPZDA msg in the header
 
                    len = tellg();
                    continue;
                }
            }
        }
        if (line.find(gpgga) != std::string::npos)
        {
            _gpggaFound = true;
        }
        else if ((std::find_if(line.begin(), line.begin() + 1, [](int ch) { return std::isdigit(ch); }) != (std::begin(line) + 1)) && (_gpggaFound || _gpzdaFound))
        {
            LOG_DEBUG("{}: Found first line of data: {}", nameId(), line);
            seekg(len, std::ios_base::beg); // Reset the read cursor, otherwise we skip the first message
            break;
        }
        len = tellg();
    }
    if (_gpggaFound && _nmeaType == NmeaType::GPZDA && !_gpzdaFound)
    {
        LOG_WARN("{}: NMEA message type was set to 'GPZDA', but the file contains only 'GPGGA'. Make sure that the absolute time reference is set correctly.", nameId());
        _nmeaType = NmeaType::GPGGA;
    }
    if (_gpzdaFound && _nmeaType == NmeaType::GPGGA)
    {
        LOG_WARN("{}: NMEA message type was set to 'GPGGA', but the file contains 'GPZDA'. The absolute time reference was read from the header, not the GUI input.", nameId());
        _nmeaType = NmeaType::GPZDA;
    }
    _delim = _gpzdaFound ? ',' : ' ';
}
 
std::shared_ptr<const NAV::NodeData> NAV::MultiImuFile::pollData(size_t pinIdx, bool peek)
{
    std::shared_ptr<ImuObs> obs = nullptr;
 
    if (!_messages.at(pinIdx).empty()) // Another pin was reading a message for this pin
    {
        obs = _messages.at(pinIdx).begin()->second;
        if (!peek) // When peeking, we leave the message in the buffer, so we can remove it when polling
        {
            _messages.at(pinIdx).erase(_messages.at(pinIdx).begin());
        }
    }
    else
    {
        // Read line
        std::string line;
        while (getline(line))
        {
            _lineCounter++;
 
            // Remove any starting non text characters
            line.erase(line.begin(), std::ranges::find_if(line, [](int ch) { return std::isgraph(ch); }));
 
            if (line.empty())
            {
                continue;
            }
 
            // Convert line into stream
            std::stringstream lineStream(line);
            std::string cell;
 
            size_t sensorId{};
            double gpsSecond{};
            double timeNumerator{};
            double timeDenominator{};
            std::optional<double> accelX;
            std::optional<double> accelY;
            std::optional<double> accelZ;
            std::optional<double> gyroX;
            std::optional<double> gyroY;
            std::optional<double> gyroZ;
 
            // Split line at comma
            for (const auto& col : _columns)
            {
                if (std::getline(lineStream, cell, _delim))
                {
                    // Remove any trailing non text characters
                    cell.erase(std::ranges::find_if(cell, [](int ch) { return std::iscntrl(ch); }), cell.end());
                    while (cell.empty())
                    {
                        std::getline(lineStream, cell, ' ');
                    }
 
                    if (col == "sensorId")
                    {
                        sensorId = std::stoul(cell); // NOLINT(clang-diagnostic-implicit-int-conversion)
                    }
                    else if (col == "gpsSecond")
                    {
                        gpsSecond = std::stod(cell); // [s]
                        if (_startupGpsSecond == 0)
                        {
                            _startupGpsSecond = gpsSecond;
                        }
                    }
                    else if (col == "timeNumerator")
                    {
                        timeNumerator = std::stod(cell);
                    }
                    else if (col == "timeDenominator")
                    {
                        timeDenominator = std::stod(cell);
                    }
                    else if (col == "accelX")
                    {
                        accelX = 0.001 * std::stod(cell); // [m/s²]
                    }
                    else if (col == "accelY")
                    {
                        accelY = 0.001 * std::stod(cell); // [m/s²]
                    }
                    else if (col == "accelZ")
                    {
                        accelZ = 0.001 * std::stod(cell); // [m/s²]
                    }
                    else if (col == "gyroX")
                    {
                        gyroX = deg2rad(std::stod(cell) / 131); // [deg/s]
                    }
                    else if (col == "gyroY")
                    {
                        gyroY = deg2rad(std::stod(cell)) / 131; // [deg/s]
                    }
                    else if (col == "gyroZ")
                    {
                        gyroZ = deg2rad(std::stod(cell)) / 131; // [deg/s]
                    }
                }
            }
 
            auto timeStamp = gpsSecond + timeNumerator / timeDenominator - _startupGpsSecond;
            if (!peek)
            {
                LOG_DEBUG("line: {}", line);
                LOG_DEBUG("timeStamp: {}", timeStamp);
            }
 
            obs = std::make_shared<ImuObs>(_imuPosAll[sensorId - 1]);
 
            obs->insTime = _startTime + std::chrono::duration<double>(timeStamp);
 
            if (!accelX || !accelY || !accelZ)
            {
                LOG_ERROR("{}: Fields 'accelX', 'accelY', 'accelZ' are needed.", nameId());
                return nullptr;
            }
            if (!gyroX || !gyroY || !gyroZ)
            {
                LOG_ERROR("{}: Fields 'gyroX', 'gyroY', 'gyroZ' are needed.", nameId());
                return nullptr;
            }
 
            obs->p_acceleration = { accelX.value(), accelY.value(), accelZ.value() };
            obs->p_angularRate = { gyroX.value(), gyroY.value(), gyroZ.value() };
 
            if (sensorId - 1 != pinIdx)
            {
                // Write message into buffer to process later on correct pin
                _messages.at(sensorId - 1).insert(std::make_pair(obs->insTime, obs));
 
                continue; // Read next line in file and search for correct sensor
            }
            if (peek)
            {
                // Write message into buffer to process later in poll step
                _messages.at(pinIdx).insert(std::make_pair(obs->insTime, obs));
            }
            break;
        }
    }
 
    // Calls all the callbacks
    if (obs && !peek)
    {
        _messageCnt.at(pinIdx)++;
 
        // Detect jumps back in time
        if (obs->insTime < _lastFiltObs)
        {
            LOG_ERROR("{}: Jumped back in time on line {} (at {}), by {} s", nameId(), _lineCounter, obs->insTime.toYMDHMS(), static_cast<double>((obs->insTime - _lastFiltObs).count()));
            return obs;
        }
        _lastFiltObs = obs->insTime;
 
        invokeCallbacks(pinIdx, obs);
    }
    if (obs == nullptr)
    {
        LOG_DEBUG("{}: Finished reading on pinIdx {}. Read a total of {} messages.", nameId(), pinIdx, _messageCnt.at(pinIdx));
    }
    return obs;
}