update to readme
This commit is contained in:
parent
78acc8f8cc
commit
4a47e3f21d
80
README.md
80
README.md
@ -1,68 +1,38 @@
|
||||
!!! Important !!!
|
||||
See Example: start the App in Matlab the correct folder (see picture), otherwise it will throw an error
|
||||
!
|
||||
See Example: start the App in Matlab the correct folder (see picture), otherwise it will give out an error
|
||||

|
||||
|
||||
Updated app is out. Check out app2 (everything except laps, grayed out buttons and presets works, presets might work in old app)
|
||||
app2 is basically feature complete.
|
||||
|
||||
KNOWN ERRORS / NOT WORKING / UNKNOWN
|
||||
- FT25-Presets -> instead use Load(fast) and Plot Subplot
|
||||
- new implementation of date selection might mess with lap selection
|
||||
- unknown status of Presets for FT23 and FT24 after the last few updates, might not work
|
||||
- should the imported data contain more than one day, preconfigured presets will might not work
|
||||
|
||||
FYI:
|
||||
- code is starting to get really clunky, going to rewrite the handling of loaded data some time in the future
|
||||
- search is case sensitive
|
||||
- you need to delete your search if you misspelled something
|
||||
- if something doesnt work try reset subplot and then press plot subplot again
|
||||
|
||||
Short tutorial:
|
||||
Part 1 - General Tab:
|
||||

|
||||
Part 2 - Preset Tab:
|
||||

|
||||
|
||||
Quick notes:
|
||||
There are two options to plot data
|
||||
- 1. Tab: General
|
||||
- Allows to make custom plots based on the data you have choosen
|
||||
- Allows to apply external functions saved in the folder "functions" to be applied to loaded dataset
|
||||
- Note: check "example.m" in the functions folder to learn how to make a custom function (there are some rules)
|
||||
- Timestamped data can only be created from app.data / Loaded Datasets
|
||||
- To timestamp the data you created with custom functions you need to append it first
|
||||
- 2. Tab: Presets
|
||||
- this tab allows you to plot and save preconfigured seasonal presets
|
||||
- presets exist for the seasons 23,24,25
|
||||
- check the Dropdown Box to see which plots are available
|
||||
|
||||
Quick tutorial:
|
||||
1. Browse the .mat file you want to open. (put it into /data folder)
|
||||
2. Choose either Load (fast) or Load (Presets)
|
||||
- Load(fast):
|
||||
- will load ONLY the name of all saved data in your .mat file
|
||||
- select data you want to plot in custom subplots -> select data (left side)
|
||||
- all features will work for this option
|
||||
- for customizing look under the next chapter
|
||||
|
||||
- Load (Presets)
|
||||
- will load a pre configured set of data in your .mat file (takes a bit of time)
|
||||
- choose a preset and a season, then press "Plot Presets"
|
||||
-> will plot pre configured graphs
|
||||
- all features in "Custom Subplots" do NOT work with this
|
||||
- the idea is that only sortdata.m and the plot_settings need to be configured each season
|
||||
- for customizing look under the next chapter (only features within Set Timestamps panel work)
|
||||
|
||||
Features:
|
||||
1. Set Timestamps:
|
||||
- works for both
|
||||
- entire stint (all data recorded) is the default option that will be plotted
|
||||
- otherwise you can select either the detected laps (will plot, but laps might be inaccurately recorded) or custom timestamps (remember to tick the Use box)
|
||||
2. Reset Panel and To Workspace Buttons:
|
||||
- work only for Presets
|
||||
- should something not work try pressing reset and plot preset again
|
||||
- to workspace throws the entire preset dataset into the matlab workspace (for further manipulation)
|
||||
- currently limited in capabilites
|
||||
3. Custom Subplots:
|
||||
- only works for the selected data (if you press load preset you can also use the displayed data, but somethings like cell voltages might not be avaible)
|
||||
- columns and rows to set the number of plots you want in one figure
|
||||
- press Plot Subplot to plot
|
||||
- how it works:
|
||||

|
||||

|
||||

|
||||
- press reset subplot to delete the selected graph
|
||||
|
||||
|
||||
Presets:
|
||||
Adapting a preset:
|
||||
- sortdata creates an struct pltData with all necessary data for plot_settings
|
||||
- easiest case: the data from the vectorlogger has the same fieldnames as last season -> probably no changes necessary, unless you want to plot different things
|
||||
- vectorlogger fieldnames changed: adapt the fieldname to the updated name
|
||||
- otherwise: add missing data with pltData.XXX =
|
||||
- plot_settings: uses the data given from pltData to plot, adapt as you see fit
|
||||
- plotData currently hands over all data that use the following strings:
|
||||
- "ABX*","Shunt*","AMS_Status*","INV*","XSens*
|
||||
- which can make problems (e.g. FT23 and FT25 use XSens, FT24 uses VN200)
|
||||
4 seperate datasets:
|
||||
app.data - main dataset for custom plots
|
||||
app.data_created - dataset created by custom functions/filter, can be appended to app.data via synchronize()
|
||||
app.data_tr = app.data(tr,:) - main dataset cut down with timestamp (timerange tr)
|
||||
app.pltData - main dataset for preset dataset
|
||||
|
BIN
app2.mlapp
BIN
app2.mlapp
Binary file not shown.
BIN
tutorial/1.png
BIN
tutorial/1.png
Binary file not shown.
Before Width: | Height: | Size: 96 KiB |
BIN
tutorial/2.png
BIN
tutorial/2.png
Binary file not shown.
Before Width: | Height: | Size: 102 KiB |
BIN
tutorial/3.png
BIN
tutorial/3.png
Binary file not shown.
Before Width: | Height: | Size: 118 KiB |
BIN
tutorial/app2 tutorial - presets.png
Normal file
BIN
tutorial/app2 tutorial - presets.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 50 KiB |
Loading…
x
Reference in New Issue
Block a user