Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MagFit tools terminology and UI suggestions #120

Open
rmackay9 opened this issue Feb 1, 2024 · 2 comments
Open

MagFit tools terminology and UI suggestions #120

rmackay9 opened this issue Feb 1, 2024 · 2 comments

Comments

@rmackay9
Copy link

rmackay9 commented Feb 1, 2024

I was trying to use the Magfit tool and got a little confused perhaps due to terminology and layout.

In the first sentence is says, "predicted field from the World Magnetic Model"... but from then on in the web page it uses the synonym "Expected"... I guess this "Expected" is the same as "predicted"? Maybe we should change the first paragraph to also be "expected"?

The wording in the "Expected vs measured body frame magnetic field" section is a bit confusing. The "No motor comp" box surrounding the "Offsets", "Offsets and scale" and "Offset and iron" makes me think that checking these boxes will perhaps enable motor compensation? .. I don't think this is what it does though. Maybe "No motor comp" should be changed to, "Calculate Calibration with:"
image

I guess there's no way to not graph the Expected? It might be good to have a checked box for this as well in the renamed, "Graph" section above.

For some reason I was unable to check the "Offsets and scale" and "Offsets and iron" checkboxes but there's no explanation as to why I can't.

The "Offsets No motor comp" label beside some graphs is unclear whether we're talking about existing offsets or new calculated offsets. I'm pretty sure it's the new ones but let's not make users have to try and figure this out.
image

By the way, the tool tip above "Fit error" reuses the word "Fit" without any explanation of what it means in this context. Perhaps it should be changed from, "First plot is error of selected fit over time" to "First plot shows the error (e.g. difference) over time between the selected calibrations and the expected world magnetic model."

@IamPete1
Copy link
Member

IamPete1 commented Feb 4, 2024

I have done some fixes from this in #123

The wording in the "Expected vs measured body frame magnetic field" section is a bit confusing. The "No motor comp" box surrounding the "Offsets", "Offsets and scale" and "Offset and iron" makes me think that checking these boxes will perhaps enable motor compensation? .. I don't think this is what it does though. Maybe "No motor comp" should be changed to, "Calculate Calibration with:"

I agree its a little confusing if you have no motor compensation options. For example if there is battery current available you would get this:

image

Having the second set of options makes the grouping more clear I think. We only currently support two calibration options, but in the future we will probably add a a param to select which battery to use, then you will get a new set of calibrations for each battery. We could also add a "throttle" calibration set. So if we were to change the format it would have to take into account that there could be quite a lot more options in the future.

I also wanted the titles here ("No motor comp" and "Battery 1 current") to match the legend titles on the plots.

image

That means were limited to a short title so the legend doesn't squash the plot too much.

I'm open to better suggestions.

For some reason I was unable to check the "Offsets and scale" and "Offsets and iron" checkboxes but there's no explanation as to why I can't.

I have added a note in the tip:
image

In your case you have very bad coverage, a longer flight with more orientations will give it a better chance of fitting the higher order options where it uses more parameters.

I guess there's no way to not graph the Expected? It might be good to have a checked box for this as well in the renamed, "Graph" section above.

Right, you always get the expected. I'm not sure about renaming the sections. what your picking is really the calibrations. Yes we do graph them, but the last one selected is also the one that you will get when you save parameters. If we were to rename to "graph" we might then need to add another place where you select the calibration you want to save.

@prathamEndu
Copy link

Another suggestion:
Please add option to graph the raw magnetometer values as well (for comparison)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants