[sysid] Add SysId (#5672)

The source is copied from this commit:
625ff04784.
This commit is contained in:
Tyler Veness
2023-10-01 15:09:09 -07:00
committed by GitHub
parent 8d2cbfce16
commit a331ed2374
67 changed files with 7568 additions and 0 deletions

View File

@@ -0,0 +1,851 @@
// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
#include "sysid/view/Analyzer.h"
#include <algorithm>
#include <exception>
#include <filesystem>
#include <numbers>
#include <thread>
#include <fmt/core.h>
#include <glass/Context.h>
#include <glass/Storage.h>
#include <imgui.h>
#include <imgui_internal.h>
#include <imgui_stdlib.h>
#include <wpi/json.h>
#include "sysid/Util.h"
#include "sysid/analysis/AnalysisManager.h"
#include "sysid/analysis/AnalysisType.h"
#include "sysid/analysis/FeedbackControllerPreset.h"
#include "sysid/analysis/FilteringUtils.h"
#include "sysid/view/UILayout.h"
using namespace sysid;
Analyzer::Analyzer(glass::Storage& storage, wpi::Logger& logger)
: m_location(""), m_logger(logger) {
// Fill the StringMap with preset values.
m_presets["Default"] = presets::kDefault;
m_presets["WPILib (2020-)"] = presets::kWPILibNew;
m_presets["WPILib (Pre-2020)"] = presets::kWPILibOld;
m_presets["CANCoder"] = presets::kCTRECANCoder;
m_presets["CTRE"] = presets::kCTREDefault;
m_presets["CTRE (Pro)"] = presets::kCTREProDefault;
m_presets["REV Brushless Encoder Port"] = presets::kREVNEOBuiltIn;
m_presets["REV Brushed Encoder Port"] = presets::kREVNonNEO;
m_presets["REV Data Port"] = presets::kREVNonNEO;
m_presets["Venom"] = presets::kVenom;
ResetData();
UpdateFeedbackGains();
}
void Analyzer::UpdateFeedforwardGains() {
WPI_INFO(m_logger, "{}", "Gain calc");
try {
const auto& [ff, trackWidth] = m_manager->CalculateFeedforward();
m_ff = std::get<0>(ff);
m_accelRSquared = std::get<1>(ff);
m_accelRMSE = std::get<2>(ff);
m_trackWidth = trackWidth;
m_settings.preset.measurementDelay =
m_settings.type == FeedbackControllerLoopType::kPosition
? m_manager->GetPositionDelay()
: m_manager->GetVelocityDelay();
m_conversionFactor = m_manager->GetFactor();
PrepareGraphs();
} catch (const sysid::InvalidDataError& e) {
m_state = AnalyzerState::kGeneralDataError;
HandleError(e.what());
} catch (const sysid::NoQuasistaticDataError& e) {
m_state = AnalyzerState::kMotionThresholdError;
HandleError(e.what());
} catch (const sysid::NoDynamicDataError& e) {
m_state = AnalyzerState::kTestDurationError;
HandleError(e.what());
} catch (const AnalysisManager::FileReadingError& e) {
m_state = AnalyzerState::kFileError;
HandleError(e.what());
} catch (const wpi::json::exception& e) {
m_state = AnalyzerState::kFileError;
HandleError(e.what());
} catch (const std::exception& e) {
m_state = AnalyzerState::kFileError;
HandleError(e.what());
}
}
void Analyzer::UpdateFeedbackGains() {
if (m_ff[1] > 0 && m_ff[2] > 0) {
const auto& fb = m_manager->CalculateFeedback(m_ff);
m_timescale = units::second_t{m_ff[2] / m_ff[1]};
m_Kp = fb.Kp;
m_Kd = fb.Kd;
}
}
bool Analyzer::DisplayGain(const char* text, double* data,
bool readOnly = true) {
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 5);
if (readOnly) {
return ImGui::InputDouble(text, data, 0.0, 0.0, "%.5G",
ImGuiInputTextFlags_ReadOnly);
} else {
return ImGui::InputDouble(text, data, 0.0, 0.0, "%.5G");
}
}
static void SetPosition(double beginX, double beginY, double xShift,
double yShift) {
ImGui::SetCursorPos(ImVec2(beginX + xShift * 10 * ImGui::GetFontSize(),
beginY + yShift * 1.75 * ImGui::GetFontSize()));
}
bool Analyzer::IsErrorState() {
return m_state == AnalyzerState::kMotionThresholdError ||
m_state == AnalyzerState::kTestDurationError ||
m_state == AnalyzerState::kGeneralDataError ||
m_state == AnalyzerState::kFileError;
}
bool Analyzer::IsDataErrorState() {
return m_state == AnalyzerState::kMotionThresholdError ||
m_state == AnalyzerState::kTestDurationError ||
m_state == AnalyzerState::kGeneralDataError;
}
void Analyzer::DisplayFileSelector() {
// Get the current width of the window. This will be used to scale
// our UI elements.
float width = ImGui::GetContentRegionAvail().x;
// Show the file location along with an option to choose.
if (ImGui::Button("Select")) {
m_selector = std::make_unique<pfd::open_file>(
"Select Data", "",
std::vector<std::string>{"JSON File", SYSID_PFD_JSON_EXT});
}
ImGui::SameLine();
ImGui::SetNextItemWidth(width - ImGui::CalcTextSize("Select").x -
ImGui::GetFontSize() * 5);
ImGui::InputText("##location", &m_location, ImGuiInputTextFlags_ReadOnly);
}
void Analyzer::ResetData() {
m_plot.ResetData();
m_manager = std::make_unique<AnalysisManager>(m_settings, m_logger);
m_location = "";
m_ff = std::vector<double>{1, 1, 1};
UpdateFeedbackGains();
}
bool Analyzer::DisplayResetAndUnitOverride() {
auto type = m_manager->GetAnalysisType();
auto unit = m_manager->GetUnit();
float width = ImGui::GetContentRegionAvail().x;
ImGui::SameLine(width - ImGui::CalcTextSize("Reset").x);
if (ImGui::Button("Reset")) {
ResetData();
m_state = AnalyzerState::kWaitingForJSON;
return true;
}
if (type == analysis::kDrivetrain) {
ImGui::SetNextItemWidth(ImGui::GetFontSize() * kTextBoxWidthMultiple);
if (ImGui::Combo("Dataset", &m_dataset, kDatasets, 3)) {
m_settings.dataset =
static_cast<AnalysisManager::Settings::DrivetrainDataset>(m_dataset);
PrepareData();
}
ImGui::SameLine();
} else {
m_settings.dataset =
AnalysisManager::Settings::DrivetrainDataset::kCombined;
}
ImGui::Spacing();
ImGui::Text(
"Units: %s\n"
"Units Per Rotation: %.4f\n"
"Type: %s",
std::string(unit).c_str(), m_conversionFactor, type.name);
if (type == analysis::kDrivetrainAngular) {
ImGui::SameLine();
sysid::CreateTooltip(
"Here, the units and units per rotation represent what the wheel "
"positions and velocities were captured in. The track width value "
"will reflect the unit selected here. However, the Kv and Ka will "
"always be in Vs/rad and Vs^2 / rad respectively.");
}
if (ImGui::Button("Override Units")) {
ImGui::OpenPopup("Override Units");
}
auto size = ImGui::GetIO().DisplaySize;
ImGui::SetNextWindowSize(ImVec2(size.x / 4, size.y * 0.2));
if (ImGui::BeginPopupModal("Override Units")) {
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 7);
ImGui::Combo("Units", &m_selectedOverrideUnit, kUnits,
IM_ARRAYSIZE(kUnits));
unit = kUnits[m_selectedOverrideUnit];
if (unit == "Degrees") {
m_conversionFactor = 360.0;
} else if (unit == "Radians") {
m_conversionFactor = 2 * std::numbers::pi;
} else if (unit == "Rotations") {
m_conversionFactor = 1.0;
}
bool isRotational = m_selectedOverrideUnit > 2;
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 7);
ImGui::InputDouble(
"Units Per Rotation", &m_conversionFactor, 0.0, 0.0, "%.4f",
isRotational ? ImGuiInputTextFlags_ReadOnly : ImGuiInputTextFlags_None);
if (ImGui::Button("Close")) {
ImGui::CloseCurrentPopup();
m_manager->OverrideUnits(unit, m_conversionFactor);
PrepareData();
}
ImGui::EndPopup();
}
ImGui::SameLine();
if (ImGui::Button("Reset Units from JSON")) {
m_manager->ResetUnitsFromJSON();
PrepareData();
}
return false;
}
void Analyzer::ConfigParamsOnFileSelect() {
WPI_INFO(m_logger, "{}", "Configuring Params");
m_stepTestDuration = m_settings.stepTestDuration.to<float>();
// Estimate qp as 1/8 * units-per-rot
m_settings.lqr.qp = 0.125 * m_manager->GetFactor();
// Estimate qv as 1/4 * max velocity = 1/4 * (12V - kS) / kV
m_settings.lqr.qv = 0.25 * (12.0 - m_ff[0]) / m_ff[1];
}
void Analyzer::Display() {
DisplayFileSelector();
DisplayGraphs();
switch (m_state) {
case AnalyzerState::kWaitingForJSON: {
ImGui::Text(
"SysId is currently in theoretical analysis mode.\n"
"To analyze recorded test data, select a "
"data JSON.");
sysid::CreateTooltip(
"Theoretical feedback gains can be calculated from a "
"physical model of the mechanism being controlled. "
"Theoretical gains for several common mechanisms can "
"be obtained from ReCalc (https://reca.lc).");
ImGui::Spacing();
ImGui::Spacing();
ImGui::SetNextItemOpen(true, ImGuiCond_Once);
if (ImGui::CollapsingHeader("Feedforward Gains (Theoretical)")) {
float beginX = ImGui::GetCursorPosX();
float beginY = ImGui::GetCursorPosY();
CollectFeedforwardGains(beginX, beginY);
}
ImGui::SetNextItemOpen(true, ImGuiCond_Once);
if (ImGui::CollapsingHeader("Feedback Analysis")) {
DisplayFeedbackGains();
}
break;
}
case AnalyzerState::kNominalDisplay: { // Allow the user to select which
// data set they want analyzed and
// add a
// reset button. Also show the units and the units per rotation.
if (DisplayResetAndUnitOverride()) {
return;
}
ImGui::Spacing();
ImGui::Spacing();
ImGui::SetNextItemOpen(true, ImGuiCond_Once);
if (ImGui::CollapsingHeader("Feedforward Analysis")) {
float beginX = ImGui::GetCursorPosX();
float beginY = ImGui::GetCursorPosY();
DisplayFeedforwardGains(beginX, beginY);
}
ImGui::SetNextItemOpen(true, ImGuiCond_Once);
if (ImGui::CollapsingHeader("Feedback Analysis")) {
DisplayFeedbackGains();
}
break;
}
case AnalyzerState::kFileError: {
CreateErrorPopup(m_errorPopup, m_exception);
if (!m_errorPopup) {
m_state = AnalyzerState::kWaitingForJSON;
return;
}
break;
}
case AnalyzerState::kGeneralDataError:
case AnalyzerState::kTestDurationError:
case AnalyzerState::kMotionThresholdError: {
CreateErrorPopup(m_errorPopup, m_exception);
if (DisplayResetAndUnitOverride()) {
return;
}
float beginX = ImGui::GetCursorPosX();
float beginY = ImGui::GetCursorPosY();
DisplayFeedforwardParameters(beginX, beginY);
break;
}
}
// Periodic functions
try {
SelectFile();
} catch (const AnalysisManager::FileReadingError& e) {
m_state = AnalyzerState::kFileError;
HandleError(e.what());
} catch (const wpi::json::exception& e) {
m_state = AnalyzerState::kFileError;
HandleError(e.what());
}
}
void Analyzer::PrepareData() {
try {
m_manager->PrepareData();
UpdateFeedforwardGains();
UpdateFeedbackGains();
} catch (const sysid::InvalidDataError& e) {
m_state = AnalyzerState::kGeneralDataError;
HandleError(e.what());
} catch (const sysid::NoQuasistaticDataError& e) {
m_state = AnalyzerState::kMotionThresholdError;
HandleError(e.what());
} catch (const sysid::NoDynamicDataError& e) {
m_state = AnalyzerState::kTestDurationError;
HandleError(e.what());
} catch (const AnalysisManager::FileReadingError& e) {
m_state = AnalyzerState::kFileError;
HandleError(e.what());
} catch (const wpi::json::exception& e) {
m_state = AnalyzerState::kFileError;
HandleError(e.what());
} catch (const std::exception& e) {
m_state = AnalyzerState::kFileError;
HandleError(e.what());
}
}
void Analyzer::PrepareRawGraphs() {
if (m_manager->HasData()) {
AbortDataPrep();
m_dataThread = std::thread([&] {
m_plot.SetRawData(m_manager->GetOriginalData(), m_manager->GetUnit(),
m_abortDataPrep);
});
}
}
void Analyzer::PrepareGraphs() {
if (m_manager->HasData()) {
WPI_INFO(m_logger, "{}", "Graph state");
AbortDataPrep();
m_dataThread = std::thread([&] {
m_plot.SetData(m_manager->GetRawData(), m_manager->GetFilteredData(),
m_manager->GetUnit(), m_ff, m_manager->GetStartTimes(),
m_manager->GetAnalysisType(), m_abortDataPrep);
});
UpdateFeedbackGains();
m_state = AnalyzerState::kNominalDisplay;
}
}
void Analyzer::HandleError(std::string_view msg) {
m_exception = msg;
m_errorPopup = true;
if (m_state == AnalyzerState::kFileError) {
m_location = "";
}
PrepareRawGraphs();
}
void Analyzer::DisplayGraphs() {
ImGui::SetNextWindowPos(ImVec2{kDiagnosticPlotWindowPos},
ImGuiCond_FirstUseEver);
ImGui::SetNextWindowSize(ImVec2{kDiagnosticPlotWindowSize},
ImGuiCond_FirstUseEver);
ImGui::Begin("Diagnostic Plots");
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 6);
if (ImGui::SliderFloat("Point Size", &m_plot.m_pointSize, 1, 2, "%.2f")) {
if (!IsErrorState()) {
PrepareGraphs();
} else {
PrepareRawGraphs();
}
}
ImGui::SameLine();
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 6);
const char* items[] = {"Forward", "Backward"};
if (ImGui::Combo("Direction", &m_plot.m_direction, items, 2)) {
if (!IsErrorState()) {
PrepareGraphs();
} else {
PrepareRawGraphs();
}
}
// If the plots were already loaded, store the scroll position. Else go to
// the last recorded scroll position if they have just been initialized
bool plotsLoaded = m_plot.DisplayPlots();
if (plotsLoaded) {
if (m_prevPlotsLoaded) {
m_graphScroll = ImGui::GetScrollY();
} else {
ImGui::SetScrollY(m_graphScroll);
}
// If a JSON is selected
if (m_state == AnalyzerState::kNominalDisplay) {
DisplayGain("Acceleration R²", &m_accelRSquared);
CreateTooltip(
"The coefficient of determination of the OLS fit of acceleration "
"versus velocity and voltage. Acceleration is extremely noisy, "
"so this is generally quite small.");
ImGui::SameLine();
DisplayGain("Acceleration RMSE", &m_accelRMSE);
CreateTooltip(
"The standard deviation of the residuals from the predicted "
"acceleration."
"This can be interpreted loosely as the mean measured disturbance "
"from the \"ideal\" system equation.");
DisplayGain("Sim velocity R²", m_plot.GetSimRSquared());
CreateTooltip(
"The coefficient of determination the simulated velocity. "
"Velocity is much less-noisy than acceleration, so this "
"is pretty close to 1 for a decent fit.");
ImGui::SameLine();
DisplayGain("Sim velocity RMSE", m_plot.GetSimRMSE());
CreateTooltip(
"The standard deviation of the residuals from the simulated velocity "
"predictions - essentially the size of the mean error of the "
"simulated model "
"in the recorded velocity units.");
}
}
m_prevPlotsLoaded = plotsLoaded;
ImGui::End();
}
void Analyzer::SelectFile() {
// If the selector exists and is ready with a result, we can store it.
if (m_selector && m_selector->ready() && !m_selector->result().empty()) {
// Store the location of the file and reset the selector.
WPI_INFO(m_logger, "Opening File: {}", m_selector->result()[0]);
m_location = m_selector->result()[0];
m_selector.reset();
WPI_INFO(m_logger, "{}", "Opened File");
m_manager =
std::make_unique<AnalysisManager>(m_location, m_settings, m_logger);
PrepareData();
m_dataset = 0;
m_settings.dataset =
AnalysisManager::Settings::DrivetrainDataset::kCombined;
ConfigParamsOnFileSelect();
UpdateFeedbackGains();
}
}
void Analyzer::AbortDataPrep() {
if (m_dataThread.joinable()) {
m_abortDataPrep = true;
m_dataThread.join();
m_abortDataPrep = false;
}
}
void Analyzer::DisplayFeedforwardParameters(float beginX, float beginY) {
// Increase spacing to not run into trackwidth in the normal analyzer view
constexpr double kHorizontalOffset = 0.9;
SetPosition(beginX, beginY, kHorizontalOffset, 0);
bool displayAll =
!IsErrorState() || m_state == AnalyzerState::kGeneralDataError;
if (displayAll) {
// Wait for enter before refresh so double digit entries like "15" don't
// prematurely refresh with "1". That can cause display stuttering.
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 4);
int window = m_settings.medianWindow;
if (ImGui::InputInt("Window Size", &window, 0, 0,
ImGuiInputTextFlags_EnterReturnsTrue)) {
m_settings.medianWindow = std::clamp(window, 1, 15);
PrepareData();
}
CreateTooltip(
"The number of samples in the velocity median "
"filter's sliding window.");
}
if (displayAll || m_state == AnalyzerState::kMotionThresholdError) {
// Wait for enter before refresh so decimal inputs like "0.2" don't
// prematurely refresh with a velocity threshold of "0".
SetPosition(beginX, beginY, kHorizontalOffset, 1);
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 4);
double threshold = m_settings.motionThreshold;
if (ImGui::InputDouble("Velocity Threshold", &threshold, 0.0, 0.0, "%.3f",
ImGuiInputTextFlags_EnterReturnsTrue)) {
m_settings.motionThreshold = std::max(0.0, threshold);
PrepareData();
}
CreateTooltip("Velocity data below this threshold will be ignored.");
}
if (displayAll || m_state == AnalyzerState::kTestDurationError) {
SetPosition(beginX, beginY, kHorizontalOffset, 2);
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 4);
if (ImGui::SliderFloat("Test Duration", &m_stepTestDuration,
m_manager->GetMinStepTime().value(),
m_manager->GetMaxStepTime().value(), "%.2f")) {
m_settings.stepTestDuration = units::second_t{m_stepTestDuration};
PrepareData();
}
}
}
void Analyzer::CollectFeedforwardGains(float beginX, float beginY) {
SetPosition(beginX, beginY, 0, 0);
if (DisplayGain("Kv", &m_ff[1], false)) {
UpdateFeedbackGains();
}
SetPosition(beginX, beginY, 0, 1);
if (DisplayGain("Ka", &m_ff[2], false)) {
UpdateFeedbackGains();
}
SetPosition(beginX, beginY, 0, 2);
// Show Timescale
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 4);
DisplayGain("Response Timescale (ms)",
reinterpret_cast<double*>(&m_timescale));
CreateTooltip(
"The characteristic timescale of the system response in milliseconds. "
"Both the control loop period and total signal delay should be "
"at least 3-5 times shorter than this to optimally control the "
"system.");
}
void Analyzer::DisplayFeedforwardGains(float beginX, float beginY) {
SetPosition(beginX, beginY, 0, 0);
DisplayGain("Ks", &m_ff[0]);
SetPosition(beginX, beginY, 0, 1);
DisplayGain("Kv", &m_ff[1]);
SetPosition(beginX, beginY, 0, 2);
DisplayGain("Ka", &m_ff[2]);
SetPosition(beginX, beginY, 0, 3);
// Show Timescale
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 4);
DisplayGain("Response Timescale (ms)",
reinterpret_cast<double*>(&m_timescale));
CreateTooltip(
"The characteristic timescale of the system response in milliseconds. "
"Both the control loop period and total signal delay should be "
"at least 3-5 times shorter than this to optimally control the "
"system.");
SetPosition(beginX, beginY, 0, 4);
auto positionDelay = m_manager->GetPositionDelay();
DisplayGain("Position Measurement Delay (ms)",
reinterpret_cast<double*>(&positionDelay));
CreateTooltip(
"The average elapsed time between the first application of "
"voltage and the first detected change in mechanism position "
"in the step-voltage tests. This includes CAN delays, and "
"may overestimate the true delay for on-motor-controller "
"feedback loops by up to 20ms.");
SetPosition(beginX, beginY, 0, 5);
auto velocityDelay = m_manager->GetVelocityDelay();
DisplayGain("Velocity Measurement Delay (ms)",
reinterpret_cast<double*>(&velocityDelay));
CreateTooltip(
"The average elapsed time between the first application of "
"voltage and the maximum calculated mechanism acceleration "
"in the step-voltage tests. This includes CAN delays, and "
"may overestimate the true delay for on-motor-controller "
"feedback loops by up to 20ms.");
SetPosition(beginX, beginY, 0, 6);
if (m_manager->GetAnalysisType() == analysis::kElevator) {
DisplayGain("Kg", &m_ff[3]);
} else if (m_manager->GetAnalysisType() == analysis::kArm) {
DisplayGain("Kg", &m_ff[3]);
double offset;
auto unit = m_manager->GetUnit();
if (unit == "Radians") {
offset = m_ff[4];
} else if (unit == "Degrees") {
offset = m_ff[4] / std::numbers::pi * 180.0;
} else if (unit == "Rotations") {
offset = m_ff[4] / (2 * std::numbers::pi);
}
DisplayGain(
fmt::format("Angle offset to horizontal ({})", GetAbbreviation(unit))
.c_str(),
&offset);
CreateTooltip(
"This is the angle offset which, when added to the angle measurement, "
"zeroes it out when the arm is horizontal. This is needed for the arm "
"feedforward to work.");
} else if (m_trackWidth) {
DisplayGain("Track Width", &*m_trackWidth);
}
double endY = ImGui::GetCursorPosY();
DisplayFeedforwardParameters(beginX, beginY);
ImGui::SetCursorPosY(endY);
}
void Analyzer::DisplayFeedbackGains() {
// Allow the user to select a feedback controller preset.
ImGui::Spacing();
ImGui::SetNextItemWidth(ImGui::GetFontSize() * kTextBoxWidthMultiple);
if (ImGui::Combo("Gain Preset", &m_selectedPreset, kPresetNames,
IM_ARRAYSIZE(kPresetNames))) {
m_settings.preset = m_presets[kPresetNames[m_selectedPreset]];
m_settings.type = FeedbackControllerLoopType::kVelocity;
m_selectedLoopType =
static_cast<int>(FeedbackControllerLoopType::kVelocity);
m_settings.convertGainsToEncTicks = m_selectedPreset > 2;
UpdateFeedbackGains();
}
ImGui::SameLine();
sysid::CreateTooltip(
"Gain presets represent how feedback gains are calculated for your "
"specific feedback controller:\n\n"
"Default, WPILib (2020-): For use with the new WPILib PIDController "
"class.\n"
"WPILib (Pre-2020): For use with the old WPILib PIDController class.\n"
"CTRE: For use with CTRE units. These are the default units that ship "
"with CTRE motor controllers.\n"
"REV (Brushless): For use with NEO and NEO 550 motors on a SPARK MAX.\n"
"REV (Brushed): For use with brushed motors connected to a SPARK MAX.");
if (m_settings.preset != m_presets[kPresetNames[m_selectedPreset]]) {
ImGui::SameLine();
ImGui::TextDisabled("(modified)");
}
// Show our feedback controller preset values.
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 4);
double value = m_settings.preset.outputConversionFactor * 12;
if (ImGui::InputDouble("Max Controller Output", &value, 0.0, 0.0, "%.1f") &&
value > 0) {
m_settings.preset.outputConversionFactor = value / 12.0;
UpdateFeedbackGains();
}
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 4);
value = m_settings.preset.outputVelocityTimeFactor;
if (ImGui::InputDouble("Velocity Denominator Units (s)", &value, 0.0, 0.0,
"%.1f") &&
value > 0) {
m_settings.preset.outputVelocityTimeFactor = value;
UpdateFeedbackGains();
}
sysid::CreateTooltip(
"This represents the denominator of the velocity unit used by the "
"feedback controller. For example, CTRE uses 100 ms = 0.1 s.");
auto ShowPresetValue = [](const char* text, double* data,
float cursorX = 0.0f) {
if (cursorX > 0) {
ImGui::SetCursorPosX(cursorX);
}
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 4);
return ImGui::InputDouble(text, data, 0.0, 0.0, "%.5G");
};
// Show controller period.
if (ShowPresetValue("Controller Period (ms)",
reinterpret_cast<double*>(&m_settings.preset.period))) {
if (m_settings.preset.period > 0_s &&
m_settings.preset.measurementDelay >= 0_s) {
UpdateFeedbackGains();
}
}
// Show whether the controller gains are time-normalized.
if (ImGui::Checkbox("Time-Normalized?", &m_settings.preset.normalized)) {
UpdateFeedbackGains();
}
// Show position/velocity measurement delay.
if (ShowPresetValue(
"Measurement Delay (ms)",
reinterpret_cast<double*>(&m_settings.preset.measurementDelay))) {
if (m_settings.preset.period > 0_s &&
m_settings.preset.measurementDelay >= 0_s) {
UpdateFeedbackGains();
}
}
sysid::CreateTooltip(
"The average measurement delay of the process variable in milliseconds. "
"This may depend on your encoder settings and choice of motor "
"controller. Default velocity filtering windows are quite long "
"on many motor controllers, so be careful that this value is "
"accurate if the characteristic timescale of the mechanism "
"is small.");
// Add CPR and Gearing for converting Feedback Gains
ImGui::Separator();
ImGui::Spacing();
if (ImGui::Checkbox("Convert Gains to Encoder Counts",
&m_settings.convertGainsToEncTicks)) {
UpdateFeedbackGains();
}
sysid::CreateTooltip(
"Whether the feedback gains should be in terms of encoder counts or "
"output units. Because smart motor controllers usually don't have "
"direct access to the output units (i.e. m/s for a drivetrain), they "
"perform feedback on the encoder counts directly. If you are using a "
"PID Controller on the RoboRIO, you are probably performing feedback "
"on the output units directly.\n\nNote that if you have properly set "
"up position and velocity conversion factors with the SPARK MAX, you "
"can leave this box unchecked. The motor controller will perform "
"feedback on the output directly.");
if (m_settings.convertGainsToEncTicks) {
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 5);
if (ImGui::InputDouble("##Numerator", &m_gearingNumerator, 0.0, 0.0, "%.4f",
ImGuiInputTextFlags_EnterReturnsTrue) &&
m_gearingNumerator > 0) {
m_settings.gearing = m_gearingNumerator / m_gearingDenominator;
UpdateFeedbackGains();
}
ImGui::SameLine();
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 5);
if (ImGui::InputDouble("##Denominator", &m_gearingDenominator, 0.0, 0.0,
"%.4f", ImGuiInputTextFlags_EnterReturnsTrue) &&
m_gearingDenominator > 0) {
m_settings.gearing = m_gearingNumerator / m_gearingDenominator;
UpdateFeedbackGains();
}
sysid::CreateTooltip(
"The gearing between the encoder and the motor shaft (# of encoder "
"turns / # of motor shaft turns).");
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 5);
if (ImGui::InputInt("CPR", &m_settings.cpr, 0, 0,
ImGuiInputTextFlags_EnterReturnsTrue) &&
m_settings.cpr > 0) {
UpdateFeedbackGains();
}
sysid::CreateTooltip(
"The counts per rotation of your encoder. This is the number of counts "
"reported in user code when the encoder is rotated exactly once. Some "
"common values for various motors/encoders are:\n\n"
"Falcon 500: 2048\nNEO: 1\nCTRE Mag Encoder / CANCoder: 4096\nREV "
"Through Bore Encoder: 8192\n");
}
ImGui::Separator();
ImGui::Spacing();
// Allow the user to select a loop type.
ImGui::SetNextItemWidth(ImGui::GetFontSize() * kTextBoxWidthMultiple);
if (ImGui::Combo("Loop Type", &m_selectedLoopType, kLoopTypes,
IM_ARRAYSIZE(kLoopTypes))) {
m_settings.type =
static_cast<FeedbackControllerLoopType>(m_selectedLoopType);
if (m_state == AnalyzerState::kWaitingForJSON) {
m_settings.preset.measurementDelay = 0_ms;
} else {
if (m_settings.type == FeedbackControllerLoopType::kPosition) {
m_settings.preset.measurementDelay = m_manager->GetPositionDelay();
} else {
m_settings.preset.measurementDelay = m_manager->GetVelocityDelay();
}
}
UpdateFeedbackGains();
}
ImGui::Spacing();
// Show Kp and Kd.
float beginY = ImGui::GetCursorPosY();
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 4);
DisplayGain("Kp", &m_Kp);
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 4);
DisplayGain("Kd", &m_Kd);
// Come back to the starting y pos.
ImGui::SetCursorPosY(beginY);
if (m_selectedLoopType == 0) {
std::string unit;
if (m_state != AnalyzerState::kWaitingForJSON) {
unit = fmt::format(" ({})", GetAbbreviation(m_manager->GetUnit()));
}
ImGui::SetCursorPosX(ImGui::GetFontSize() * 9);
if (DisplayGain(fmt::format("Max Position Error{}", unit).c_str(),
&m_settings.lqr.qp, false)) {
if (m_settings.lqr.qp > 0) {
UpdateFeedbackGains();
}
}
}
std::string unit;
if (m_state != AnalyzerState::kWaitingForJSON) {
unit = fmt::format(" ({}/s)", GetAbbreviation(m_manager->GetUnit()));
}
ImGui::SetCursorPosX(ImGui::GetFontSize() * 9);
if (DisplayGain(fmt::format("Max Velocity Error{}", unit).c_str(),
&m_settings.lqr.qv, false)) {
if (m_settings.lqr.qv > 0) {
UpdateFeedbackGains();
}
}
ImGui::SetCursorPosX(ImGui::GetFontSize() * 9);
if (DisplayGain("Max Control Effort (V)", &m_settings.lqr.r, false)) {
if (m_settings.lqr.r > 0) {
UpdateFeedbackGains();
}
}
}

View File

@@ -0,0 +1,531 @@
// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
#include "sysid/view/AnalyzerPlot.h"
#include <algorithm>
#include <cmath>
#include <mutex>
#include <fmt/format.h>
#include <units/math.h>
#include "sysid/Util.h"
#include "sysid/analysis/AnalysisManager.h"
#include "sysid/analysis/ArmSim.h"
#include "sysid/analysis/ElevatorSim.h"
#include "sysid/analysis/FilteringUtils.h"
#include "sysid/analysis/SimpleMotorSim.h"
using namespace sysid;
static ImPlotPoint Getter(int idx, void* data) {
return static_cast<ImPlotPoint*>(data)[idx];
}
template <typename Model>
static std::vector<std::vector<ImPlotPoint>> PopulateTimeDomainSim(
const std::vector<PreparedData>& data,
const std::array<units::second_t, 4>& startTimes, size_t step, Model model,
double* simSquaredErrorSum, double* squaredVariationSum,
int* timeSeriesPoints) {
// Create the vector of ImPlotPoints that will contain our simulated data.
std::vector<std::vector<ImPlotPoint>> pts;
std::vector<ImPlotPoint> tmp;
auto startTime = data[0].timestamp;
tmp.emplace_back(startTime.value(), data[0].velocity);
model.Reset(data[0].position, data[0].velocity);
units::second_t t = 0_s;
for (size_t i = 1; i < data.size(); ++i) {
const auto& now = data[i];
const auto& pre = data[i - 1];
t += now.timestamp - pre.timestamp;
// If the current time stamp and previous time stamp are across a test's
// start timestamp, it is the start of a new test and the model needs to be
// reset.
if (std::find(startTimes.begin(), startTimes.end(), now.timestamp) !=
startTimes.end()) {
pts.emplace_back(std::move(tmp));
model.Reset(now.position, now.velocity);
continue;
}
model.Update(units::volt_t{pre.voltage}, now.timestamp - pre.timestamp);
tmp.emplace_back((startTime + t).value(), model.GetVelocity());
*simSquaredErrorSum += std::pow(now.velocity - model.GetVelocity(), 2);
*squaredVariationSum += std::pow(now.velocity, 2);
++(*timeSeriesPoints);
}
pts.emplace_back(std::move(tmp));
return pts;
}
AnalyzerPlot::AnalyzerPlot(wpi::Logger& logger) : m_logger(logger) {}
void AnalyzerPlot::SetRawTimeData(const std::vector<PreparedData>& rawSlow,
const std::vector<PreparedData>& rawFast,
std::atomic<bool>& abort) {
auto rawSlowStep = std::ceil(rawSlow.size() * 1.0 / kMaxSize * 4);
auto rawFastStep = std::ceil(rawFast.size() * 1.0 / kMaxSize * 4);
// Populate Raw Slow Time Series Data
for (size_t i = 0; i < rawSlow.size(); i += rawSlowStep) {
if (abort) {
return;
}
m_quasistaticData.rawData.emplace_back((rawSlow[i].timestamp).value(),
rawSlow[i].velocity);
}
// Populate Raw fast Time Series Data
for (size_t i = 0; i < rawFast.size(); i += rawFastStep) {
if (abort) {
return;
}
m_dynamicData.rawData.emplace_back((rawFast[i].timestamp).value(),
rawFast[i].velocity);
}
}
void AnalyzerPlot::ResetData() {
m_quasistaticData.Clear();
m_dynamicData.Clear();
m_regressionData.Clear();
m_timestepData.Clear();
FitPlots();
}
void AnalyzerPlot::SetGraphLabels(std::string_view unit) {
std::string_view abbreviation = GetAbbreviation(unit);
m_velocityLabel = fmt::format("Velocity ({}/s)", abbreviation);
m_accelerationLabel = fmt::format("Acceleration ({}/s²)", abbreviation);
m_velPortionAccelLabel =
fmt::format("Velocity-Portion Accel ({}/s²)", abbreviation);
}
void AnalyzerPlot::SetRawData(const Storage& data, std::string_view unit,
std::atomic<bool>& abort) {
const auto& [slowForward, slowBackward, fastForward, fastBackward] = data;
const auto& slow = m_direction == 0 ? slowForward : slowBackward;
const auto& fast = m_direction == 0 ? fastForward : fastBackward;
SetGraphLabels(unit);
std::scoped_lock lock(m_mutex);
ResetData();
SetRawTimeData(slow, fast, abort);
}
void AnalyzerPlot::SetData(const Storage& rawData, const Storage& filteredData,
std::string_view unit,
const std::vector<double>& ffGains,
const std::array<units::second_t, 4>& startTimes,
AnalysisType type, std::atomic<bool>& abort) {
double simSquaredErrorSum = 0;
double squaredVariationSum = 0;
int timeSeriesPoints = 0;
const auto& Ks = ffGains[0];
const auto& Kv = ffGains[1];
const auto& Ka = ffGains[2];
auto& [slowForward, slowBackward, fastForward, fastBackward] = filteredData;
auto& [rawSlowForward, rawSlowBackward, rawFastForward, rawFastBackward] =
rawData;
const auto slow = AnalysisManager::DataConcat(slowForward, slowBackward);
const auto fast = AnalysisManager::DataConcat(fastForward, fastBackward);
const auto rawSlow =
AnalysisManager::DataConcat(rawSlowForward, rawSlowBackward);
const auto rawFast =
AnalysisManager::DataConcat(rawFastForward, rawFastBackward);
SetGraphLabels(unit);
std::scoped_lock lock(m_mutex);
ResetData();
// Calculate step sizes to ensure that we only use the memory that we
// allocated.
auto slowStep = std::ceil(slow.size() * 1.0 / kMaxSize * 4);
auto fastStep = std::ceil(fast.size() * 1.0 / kMaxSize * 4);
units::second_t dtMean = GetMeanTimeDelta(filteredData);
// Velocity-vs-time plots
{
const auto& slow = m_direction == 0 ? slowForward : slowBackward;
const auto& fast = m_direction == 0 ? fastForward : fastBackward;
const auto& rawSlow = m_direction == 0 ? rawSlowForward : rawSlowBackward;
const auto& rawFast = m_direction == 0 ? rawFastForward : rawFastBackward;
// Populate quasistatic time-domain graphs
for (size_t i = 0; i < slow.size(); i += slowStep) {
if (abort) {
return;
}
m_quasistaticData.filteredData.emplace_back((slow[i].timestamp).value(),
slow[i].velocity);
if (i > 0) {
// If the current timestamp is not in the startTimes array, it is the
// during a test and should be included. If it is in the startTimes
// array, it is the beginning of a new test and the dt will be inflated.
// Therefore we skip those to exclude that dt and effectively reset dt
// calculations.
if (slow[i].dt > 0_s &&
std::find(startTimes.begin(), startTimes.end(),
slow[i].timestamp) == startTimes.end()) {
m_timestepData.data.emplace_back(
(slow[i].timestamp).value(),
units::millisecond_t{slow[i].dt}.value());
}
}
}
// Populate dynamic time-domain graphs
for (size_t i = 0; i < fast.size(); i += fastStep) {
if (abort) {
return;
}
m_dynamicData.filteredData.emplace_back((fast[i].timestamp).value(),
fast[i].velocity);
if (i > 0) {
// If the current timestamp is not in the startTimes array, it is the
// during a test and should be included. If it is in the startTimes
// array, it is the beginning of a new test and the dt will be inflated.
// Therefore we skip those to exclude that dt and effectively reset dt
// calculations.
if (fast[i].dt > 0_s &&
std::find(startTimes.begin(), startTimes.end(),
fast[i].timestamp) == startTimes.end()) {
m_timestepData.data.emplace_back(
(fast[i].timestamp).value(),
units::millisecond_t{fast[i].dt}.value());
}
}
}
SetRawTimeData(rawSlow, rawFast, abort);
// Populate simulated time domain data
if (type == analysis::kElevator) {
const auto& Kg = ffGains[3];
m_quasistaticData.simData = PopulateTimeDomainSim(
rawSlow, startTimes, fastStep, sysid::ElevatorSim{Ks, Kv, Ka, Kg},
&simSquaredErrorSum, &squaredVariationSum, &timeSeriesPoints);
m_dynamicData.simData = PopulateTimeDomainSim(
rawFast, startTimes, fastStep, sysid::ElevatorSim{Ks, Kv, Ka, Kg},
&simSquaredErrorSum, &squaredVariationSum, &timeSeriesPoints);
} else if (type == analysis::kArm) {
const auto& Kg = ffGains[3];
const auto& offset = ffGains[4];
m_quasistaticData.simData = PopulateTimeDomainSim(
rawSlow, startTimes, fastStep, sysid::ArmSim{Ks, Kv, Ka, Kg, offset},
&simSquaredErrorSum, &squaredVariationSum, &timeSeriesPoints);
m_dynamicData.simData = PopulateTimeDomainSim(
rawFast, startTimes, fastStep, sysid::ArmSim{Ks, Kv, Ka, Kg, offset},
&simSquaredErrorSum, &squaredVariationSum, &timeSeriesPoints);
} else {
m_quasistaticData.simData = PopulateTimeDomainSim(
rawSlow, startTimes, fastStep, sysid::SimpleMotorSim{Ks, Kv, Ka},
&simSquaredErrorSum, &squaredVariationSum, &timeSeriesPoints);
m_dynamicData.simData = PopulateTimeDomainSim(
rawFast, startTimes, fastStep, sysid::SimpleMotorSim{Ks, Kv, Ka},
&simSquaredErrorSum, &squaredVariationSum, &timeSeriesPoints);
}
}
// Acceleration-vs-velocity plot
// Find minimum velocity of slow and fast datasets, then find point for line
// of best fit
auto slowMinVel =
std::min_element(slow.cbegin(), slow.cend(), [](auto& a, auto& b) {
return a.velocity < b.velocity;
})->velocity;
auto fastMinVel =
std::min_element(fast.cbegin(), fast.cend(), [](auto& a, auto& b) {
return a.velocity < b.velocity;
})->velocity;
auto minVel = std::min(slowMinVel, fastMinVel);
m_regressionData.fitLine[0] = ImPlotPoint{minVel, -Kv / Ka * minVel};
// Find maximum velocity of slow and fast datasets, then find point for line
// of best fit
auto slowMaxVel =
std::max_element(slow.cbegin(), slow.cend(), [](auto& a, auto& b) {
return a.velocity < b.velocity;
})->velocity;
auto fastMaxVel =
std::max_element(fast.cbegin(), fast.cend(), [](auto& a, auto& b) {
return a.velocity < b.velocity;
})->velocity;
auto maxVel = std::max(slowMaxVel, fastMaxVel);
m_regressionData.fitLine[1] = ImPlotPoint{maxVel, -Kv / Ka * maxVel};
// Populate acceleration vs velocity graph
for (size_t i = 0; i < slow.size(); i += slowStep) {
if (abort) {
return;
}
// Calculate portion of acceleration caused by back-EMF
double accelPortion = slow[i].acceleration - 1.0 / Ka * slow[i].voltage +
std::copysign(Ks / Ka, slow[i].velocity);
if (type == analysis::kElevator) {
const auto& Kg = ffGains[3];
accelPortion -= Kg / Ka;
} else if (type == analysis::kArm) {
const auto& Kg = ffGains[3];
accelPortion -= Kg / Ka * slow[i].cos;
}
m_regressionData.data.emplace_back(slow[i].velocity, accelPortion);
}
for (size_t i = 0; i < fast.size(); i += fastStep) {
if (abort) {
return;
}
// Calculate portion of voltage that corresponds to change in acceleration.
double accelPortion = fast[i].acceleration - 1.0 / Ka * fast[i].voltage +
std::copysign(Ks / Ka, fast[i].velocity);
if (type == analysis::kElevator) {
const auto& Kg = ffGains[3];
accelPortion -= Kg / Ka;
} else if (type == analysis::kArm) {
const auto& Kg = ffGains[3];
accelPortion -= Kg / Ka * fast[i].cos;
}
m_regressionData.data.emplace_back(fast[i].velocity, accelPortion);
}
// Timestep-vs-time plot
for (size_t i = 0; i < slow.size(); i += slowStep) {
if (i > 0) {
// If the current timestamp is not in the startTimes array, it is the
// during a test and should be included. If it is in the startTimes
// array, it is the beginning of a new test and the dt will be inflated.
// Therefore we skip those to exclude that dt and effectively reset dt
// calculations.
if (slow[i].dt > 0_s &&
std::find(startTimes.begin(), startTimes.end(), slow[i].timestamp) ==
startTimes.end()) {
m_timestepData.data.emplace_back(
(slow[i].timestamp).value(),
units::millisecond_t{slow[i].dt}.value());
}
}
}
for (size_t i = 0; i < fast.size(); i += fastStep) {
if (i > 0) {
// If the current timestamp is not in the startTimes array, it is the
// during a test and should be included. If it is in the startTimes
// array, it is the beginning of a new test and the dt will be inflated.
// Therefore we skip those to exclude that dt and effectively reset dt
// calculations.
if (fast[i].dt > 0_s &&
std::find(startTimes.begin(), startTimes.end(), fast[i].timestamp) ==
startTimes.end()) {
m_timestepData.data.emplace_back(
(fast[i].timestamp).value(),
units::millisecond_t{fast[i].dt}.value());
}
}
}
auto minTime =
units::math::min(slow.front().timestamp, fast.front().timestamp);
m_timestepData.fitLine[0] =
ImPlotPoint{minTime.value(), units::millisecond_t{dtMean}.value()};
auto maxTime = units::math::max(slow.back().timestamp, fast.back().timestamp);
m_timestepData.fitLine[1] =
ImPlotPoint{maxTime.value(), units::millisecond_t{dtMean}.value()};
// RMSE = std::sqrt(sum((x_i - x^_i)^2) / N) where sum represents the sum of
// all time series points, x_i represents the velocity at a timestep, x^_i
// represents the prediction at the timestep, and N represents the number of
// points
m_RMSE = std::sqrt(simSquaredErrorSum / timeSeriesPoints);
m_accelRSquared =
1 - m_RMSE / std::sqrt(squaredVariationSum / timeSeriesPoints);
FitPlots();
}
void AnalyzerPlot::FitPlots() {
// Set the "fit" flag to true.
m_quasistaticData.fitNextPlot = true;
m_dynamicData.fitNextPlot = true;
m_regressionData.fitNextPlot = true;
m_timestepData.fitNextPlot = true;
}
double* AnalyzerPlot::GetSimRMSE() {
return &m_RMSE;
}
double* AnalyzerPlot::GetSimRSquared() {
return &m_accelRSquared;
}
static void PlotSimData(std::vector<std::vector<ImPlotPoint>>& data) {
for (auto&& pts : data) {
ImPlot::SetNextLineStyle(IMPLOT_AUTO_COL, 1.5);
ImPlot::PlotLineG("Simulation", Getter, pts.data(), pts.size());
}
}
bool AnalyzerPlot::DisplayPlots() {
std::unique_lock lock(m_mutex, std::defer_lock);
if (!lock.try_lock()) {
ImGui::Text("Loading %c",
"|/-\\"[static_cast<int>(ImGui::GetTime() / 0.05f) & 3]);
return false;
}
ImVec2 plotSize = ImGui::GetContentRegionAvail();
// Fit two plots horizontally
plotSize.x = (plotSize.x - ImGui::GetStyle().ItemSpacing.x) / 2.f;
// Fit two plots vertically while leaving room for three text boxes
const float textBoxHeight = ImGui::GetFontSize() * 1.75;
plotSize.y =
(plotSize.y - textBoxHeight * 3 - ImGui::GetStyle().ItemSpacing.y) / 2.f;
m_quasistaticData.Plot("Quasistatic Velocity vs. Time", plotSize,
m_velocityLabel.c_str(), m_pointSize);
ImGui::SameLine();
m_dynamicData.Plot("Dynamic Velocity vs. Time", plotSize,
m_velocityLabel.c_str(), m_pointSize);
m_regressionData.Plot("Acceleration vs. Velocity", plotSize,
m_velocityLabel.c_str(), m_velPortionAccelLabel.c_str(),
true, true, m_pointSize);
ImGui::SameLine();
m_timestepData.Plot("Timesteps vs. Time", plotSize, "Time (s)",
"Timestep duration (ms)", true, false, m_pointSize,
[] { ImPlot::SetupAxisLimits(ImAxis_Y1, 0, 50); });
return true;
}
AnalyzerPlot::FilteredDataVsTimePlot::FilteredDataVsTimePlot() {
rawData.reserve(kMaxSize);
filteredData.reserve(kMaxSize);
simData.reserve(kMaxSize);
}
void AnalyzerPlot::FilteredDataVsTimePlot::Plot(const char* title,
const ImVec2& size,
const char* yLabel,
float pointSize) {
// Generate Sim vs Filtered Plot
if (fitNextPlot) {
ImPlot::SetNextAxesToFit();
}
if (ImPlot::BeginPlot(title, size)) {
ImPlot::SetupAxis(ImAxis_X1, "Time (s)", ImPlotAxisFlags_NoGridLines);
ImPlot::SetupAxis(ImAxis_Y1, yLabel, ImPlotAxisFlags_NoGridLines);
ImPlot::SetupLegend(ImPlotLocation_NorthEast);
// Plot Raw Data
ImPlot::SetNextMarkerStyle(IMPLOT_AUTO, 1, IMPLOT_AUTO_COL, 0);
ImPlot::SetNextMarkerStyle(ImPlotStyleVar_MarkerSize, pointSize);
ImPlot::PlotScatterG("Raw Data", Getter, rawData.data(), rawData.size());
// Plot Filtered Data after Raw data
ImPlot::SetNextMarkerStyle(IMPLOT_AUTO, 1, IMPLOT_AUTO_COL, 0);
ImPlot::SetNextMarkerStyle(ImPlotStyleVar_MarkerSize, pointSize);
ImPlot::PlotScatterG("Filtered Data", Getter, filteredData.data(),
filteredData.size());
// Plot Simulation Data for Velocity Data
PlotSimData(simData);
// Disable constant resizing
if (fitNextPlot) {
fitNextPlot = false;
}
ImPlot::EndPlot();
}
}
void AnalyzerPlot::FilteredDataVsTimePlot::Clear() {
rawData.clear();
filteredData.clear();
simData.clear();
}
AnalyzerPlot::DataWithFitLinePlot::DataWithFitLinePlot() {
data.reserve(kMaxSize);
}
void AnalyzerPlot::DataWithFitLinePlot::Plot(const char* title,
const ImVec2& size,
const char* xLabel,
const char* yLabel, bool fitX,
bool fitY, float pointSize,
std::function<void()> setup) {
if (fitNextPlot) {
if (fitX && fitY) {
ImPlot::SetNextAxesToFit();
} else if (fitX && !fitY) {
ImPlot::SetNextAxisToFit(ImAxis_X1);
} else if (!fitX && fitY) {
ImPlot::SetNextAxisToFit(ImAxis_Y1);
}
}
if (ImPlot::BeginPlot(title, size)) {
setup();
ImPlot::SetupAxis(ImAxis_X1, xLabel, ImPlotAxisFlags_NoGridLines);
ImPlot::SetupAxis(ImAxis_Y1, yLabel, ImPlotAxisFlags_NoGridLines);
ImPlot::SetupLegend(ImPlotLocation_NorthEast);
// Get a reference to the data that we are plotting.
ImPlot::SetNextMarkerStyle(IMPLOT_AUTO, 1, IMPLOT_AUTO_COL, 0);
ImPlot::SetNextMarkerStyle(ImPlotStyleVar_MarkerSize, pointSize);
ImPlot::PlotScatterG("Filtered Data", Getter, data.data(), data.size());
ImPlot::SetNextLineStyle(IMPLOT_AUTO_COL, 1.5);
ImPlot::PlotLineG("Fit", Getter, fitLine.data(), fitLine.size());
ImPlot::EndPlot();
if (fitNextPlot) {
fitNextPlot = false;
}
}
}
void AnalyzerPlot::DataWithFitLinePlot::Clear() {
data.clear();
// Reset line of best fit
fitLine[0] = ImPlotPoint{0, 0};
fitLine[1] = ImPlotPoint{0, 0};
}

View File

@@ -0,0 +1,64 @@
// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
#include "sysid/analysis/JSONConverter.h"
#include "sysid/view/JSONConverter.h"
#include <exception>
#include <imgui.h>
#include <portable-file-dialogs.h>
#include <wpi/timestamp.h>
#include "sysid/Util.h"
using namespace sysid;
void JSONConverter::DisplayConverter(
const char* tooltip,
std::function<std::string(std::string_view, wpi::Logger&)> converter) {
if (ImGui::Button(tooltip)) {
m_opener = std::make_unique<pfd::open_file>(
tooltip, "", std::vector<std::string>{"JSON File", SYSID_PFD_JSON_EXT});
}
if (m_opener && m_opener->ready()) {
if (!m_opener->result().empty()) {
m_location = m_opener->result()[0];
try {
converter(m_location, m_logger);
m_timestamp = wpi::Now() * 1E-6;
} catch (const std::exception& e) {
ImGui::OpenPopup("Exception Caught!");
m_exception = e.what();
}
}
m_opener.reset();
}
if (wpi::Now() * 1E-6 - m_timestamp < 5) {
ImGui::SameLine();
ImGui::Text("Saved!");
}
// Handle exceptions.
ImGui::SetNextWindowSize(ImVec2(480.f, 0.0f));
if (ImGui::BeginPopupModal("Exception Caught!")) {
ImGui::PushTextWrapPos(0.0f);
ImGui::Text(
"An error occurred when parsing the JSON. This most likely means that "
"the JSON data is incorrectly formatted.");
ImGui::TextColored(ImVec4(1.0f, 0.4f, 0.4f, 1.0f), "%s",
m_exception.c_str());
ImGui::PopTextWrapPos();
if (ImGui::Button("Close")) {
ImGui::CloseCurrentPopup();
}
ImGui::EndPopup();
}
}
void JSONConverter::DisplayCSVConvert() {
DisplayConverter("Select SysId JSON", sysid::ToCSV);
}

View File

@@ -0,0 +1,222 @@
// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
#include "sysid/view/Logger.h"
#include <exception>
#include <numbers>
#include <glass/Context.h>
#include <glass/Storage.h>
#include <imgui.h>
#include <imgui_internal.h>
#include <imgui_stdlib.h>
#include <networktables/NetworkTable.h>
#include <units/angle.h>
#include <wpigui.h>
#include "sysid/Util.h"
#include "sysid/analysis/AnalysisType.h"
#include "sysid/view/UILayout.h"
using namespace sysid;
Logger::Logger(glass::Storage& storage, wpi::Logger& logger)
: m_logger{logger}, m_ntSettings{"sysid", storage} {
wpi::gui::AddEarlyExecute([&] { m_ntSettings.Update(); });
m_ntSettings.EnableServerOption(false);
}
void Logger::Display() {
// Get the current width of the window. This will be used to scale
// our UI elements.
float width = ImGui::GetContentRegionAvail().x;
// Add team number input and apply button for NT connection.
m_ntSettings.Display();
// Reset and clear the internal manager state.
ImGui::SameLine();
if (ImGui::Button("Reset Telemetry")) {
m_settings = TelemetryManager::Settings{};
m_manager = std::make_unique<TelemetryManager>(m_settings, m_logger);
m_settings.mechanism = analysis::FromName(kTypes[m_selectedType]);
}
// Add NT connection indicator.
static ImVec4 kColorDisconnected{1.0f, 0.4f, 0.4f, 1.0f};
static ImVec4 kColorConnected{0.2f, 1.0f, 0.2f, 1.0f};
ImGui::SameLine();
bool ntConnected = nt::NetworkTableInstance::GetDefault().IsConnected();
ImGui::TextColored(ntConnected ? kColorConnected : kColorDisconnected,
ntConnected ? "NT Connected" : "NT Disconnected");
// Create a Section for project configuration
ImGui::Separator();
ImGui::Spacing();
ImGui::Text("Project Parameters");
// Add a dropdown for mechanism type.
ImGui::SetNextItemWidth(ImGui::GetFontSize() * kTextBoxWidthMultiple);
if (ImGui::Combo("Mechanism", &m_selectedType, kTypes,
IM_ARRAYSIZE(kTypes))) {
m_settings.mechanism = analysis::FromName(kTypes[m_selectedType]);
}
// Add Dropdown for Units
ImGui::SetNextItemWidth(ImGui::GetFontSize() * kTextBoxWidthMultiple);
if (ImGui::Combo("Unit Type", &m_selectedUnit, kUnits,
IM_ARRAYSIZE(kUnits))) {
m_settings.units = kUnits[m_selectedUnit];
}
sysid::CreateTooltip(
"This is the type of units that your gains will be in. For example, if "
"you want your flywheel gains in terms of radians, then use the radians "
"unit. On the other hand, if your drivetrain will use gains in meters, "
"choose meters.");
// Rotational units have fixed Units per rotations
m_isRotationalUnits =
(m_settings.units == "Rotations" || m_settings.units == "Degrees" ||
m_settings.units == "Radians");
if (m_settings.units == "Degrees") {
m_settings.unitsPerRotation = 360.0;
} else if (m_settings.units == "Radians") {
m_settings.unitsPerRotation = 2 * std::numbers::pi;
} else if (m_settings.units == "Rotations") {
m_settings.unitsPerRotation = 1.0;
}
// Units Per Rotations entry
ImGui::SetNextItemWidth(ImGui::GetFontSize() * kTextBoxWidthMultiple);
ImGui::InputDouble("Units Per Rotation", &m_settings.unitsPerRotation, 0.0f,
0.0f, "%.4f",
m_isRotationalUnits ? ImGuiInputTextFlags_ReadOnly
: ImGuiInputTextFlags_None);
sysid::CreateTooltip(
"The logger assumes that the code will be sending recorded motor shaft "
"rotations over NetworkTables. This value will then be multiplied by the "
"units per rotation to get the measurement in the units you "
"specified.\n\nFor non-rotational units (e.g. meters), this value is "
"usually the wheel diameter times pi (should not include gearing).");
// Create a section for voltage parameters.
ImGui::Separator();
ImGui::Spacing();
ImGui::Text("Voltage Parameters");
auto CreateVoltageParameters = [this](const char* text, double* data,
float min, float max) {
ImGui::SetNextItemWidth(ImGui::GetFontSize() * 6);
ImGui::PushItemFlag(ImGuiItemFlags_Disabled,
m_manager && m_manager->IsActive());
float value = static_cast<float>(*data);
if (ImGui::SliderFloat(text, &value, min, max, "%.2f")) {
*data = value;
}
ImGui::PopItemFlag();
};
CreateVoltageParameters("Quasistatic Ramp Rate (V/s)",
&m_settings.quasistaticRampRate, 0.10f, 0.60f);
sysid::CreateTooltip(
"This is the rate at which the voltage will increase during the "
"quasistatic test.");
CreateVoltageParameters("Dynamic Step Voltage (V)", &m_settings.stepVoltage,
0.0f, 10.0f);
sysid::CreateTooltip(
"This is the voltage that will be applied for the "
"dynamic voltage (acceleration) tests.");
// Create a section for tests.
ImGui::Separator();
ImGui::Spacing();
ImGui::Text("Tests");
auto CreateTest = [this, width](const char* text, const char* itext) {
// Display buttons if we have an NT connection.
if (nt::NetworkTableInstance::GetDefault().IsConnected()) {
// Create button to run tests.
if (ImGui::Button(text)) {
// Open the warning message.
ImGui::OpenPopup("Warning");
m_manager->BeginTest(itext);
m_opened = text;
}
if (m_opened == text && ImGui::BeginPopupModal("Warning")) {
ImGui::TextWrapped("%s", m_popupText.c_str());
if (ImGui::Button(m_manager->IsActive() ? "End Test" : "Close")) {
m_manager->EndTest();
ImGui::CloseCurrentPopup();
m_opened = "";
}
ImGui::EndPopup();
}
} else {
// Show disabled text when there is no connection.
ImGui::TextDisabled("%s", text);
}
// Show whether the tests were run or not.
bool run = m_manager->HasRunTest(itext);
ImGui::SameLine(width * 0.7);
ImGui::Text(run ? "Run" : "Not Run");
};
CreateTest("Quasistatic Forward", "slow-forward");
CreateTest("Quasistatic Backward", "slow-backward");
CreateTest("Dynamic Forward", "fast-forward");
CreateTest("Dynamic Backward", "fast-backward");
m_manager->RegisterDisplayCallback(
[this](const auto& str) { m_popupText = str; });
// Display the path to where the JSON will be saved and a button to select the
// location.
ImGui::Separator();
ImGui::Spacing();
ImGui::Text("Save Location");
if (ImGui::Button("Choose")) {
m_selector = std::make_unique<pfd::select_folder>("Select Folder");
}
ImGui::SameLine();
ImGui::InputText("##savelocation", &m_jsonLocation,
ImGuiInputTextFlags_ReadOnly);
// Add button to save.
ImGui::SameLine(width * 0.9);
if (ImGui::Button("Save")) {
try {
m_manager->SaveJSON(m_jsonLocation);
} catch (const std::exception& e) {
ImGui::OpenPopup("Exception Caught!");
m_exception = e.what();
}
}
// Handle exceptions.
if (ImGui::BeginPopupModal("Exception Caught!")) {
ImGui::Text("%s", m_exception.c_str());
if (ImGui::Button("Close")) {
ImGui::CloseCurrentPopup();
}
ImGui::EndPopup();
}
// Run periodic methods.
SelectDataFolder();
m_ntSettings.Update();
m_manager->Update();
}
void Logger::SelectDataFolder() {
// If the selector exists and is ready with a result, we can store it.
if (m_selector && m_selector->ready()) {
m_jsonLocation = m_selector->result();
m_selector.reset();
}
}