Skip to content
Snippets Groups Projects
Commit c4d89395 authored by Lan Dam's avatar Lan Dam
Browse files

Update documentation for db config

parent 5170b9cc
No related branches found
No related tags found
1 merge request!308Update documentation for db config
Showing
with 551 additions and 3 deletions
......@@ -34,13 +34,25 @@ The home button can be used to return to this page at any time.
+ [Ruler and Zooming](13%20_%20Ruler%20and%20Zooming.help.md)
+ [Save Plots](14%20_%20Save%20Plots.help.md)
+ [Hide, show, reorder channels](14%20_%20Hide,%20show,%20reorder%20channels.help.md)
+ [Plot Different Data Set ID](15%20_%20Plot%20Different%20Data%20Set%20ID.help.md)
+ [Setting Data Type for a Data Set](15%20_%20Setting%20Data%20Type%20for%20a%20Data%20Set.help.md)
+ [Search SOH n LOG](20%20_%20Search%20SOH%20n%20LOG.help.md)
+ [Add or Edit a Single Channel](16%20_%20Add%20or%20Edit%20a%20Single%20Channel.help.md)
+ [Edit a Single Parameter](17%20_%20Edit%20a%20Single%20Parameter.help.md)
+ [Edit valueColor for a Parameter](18%20_%20Edit%20valueColor%20for%20a%20Parameter.help.md)
+ [Plot Different Data Set ID](19%20_%20Plot%20Different%20Data%20Set%20ID.help.md)
+ [Save Plots](20%20_%20Save%20Plots.help.md)
+ [Search SOH n LOG](21%20_%20Search%20SOH%20n%20LOG.help.md)
+ [GPS Dialog](30%20_%20GPS%20Dialog.help.md)
+ [View-Edit Database Tables](31%20_%20View-Edit%20Database%20Tables.help.md)
+ [Firmware Notice](40%20_%20Firmware%20Notice.help.md)
......@@ -49,3 +49,6 @@ dialog saves a table in a file with extension .log, which means that the saved
log file will be recognized in SOHStationViewer by default. For information
about saving a table in the Search Messages dialog, refer to the "Search SOH n
Log" section.
Refer to the "Options Menu" section for information to add mass position to
RT130 SOH messages.
## Hide, show, reorder channels
To Select an ordered list of SOH channels to plot before reading the data set, refer
to "Select SOH" section.
Once all channels are plotted, user can reorder, hide or show SOH channels or
waveform channel by right-clicking anywhere on a channel and select "Select Channels
to show" from context menu.
<br />
<img alt="Select Channel to show from Context Menu" src="images/hide_show_reorder_channels/select_context_menu.jpg" width="250" />
<br />
A "Show/Hide and Reorder Channels" dialog will pop up.
As stated in the dialog, user can show channels by checking the checkboxes in front of
the channels and hide channels by unchecking the checkboxes. In the picture, HH2 and VM2
are unchecked and will be hidden when APPLY is clicked.
<br />
<img alt="Check to show, uncheck to hide channels" src="images/hide_show_reorder_channels/check_to_show_uncheck_to_hide.jpg" height="300" />
<br />
User can also drag and drop to reorder the channels. In the picture, HHZ has been moved to
the top of the list and it will show on top of other channels in the figure when APPLY is clicked.
<br />
<img alt="Reordered channels" src="images/hide_show_reorder_channels/reorder_channels.jpg" height="300" />
<br />
Note that mass position channels are plotted in order already and won't be reorderable.
The following is the result of hide/show, reorder tasks.
<br />
<img alt="Reordered channels" src="images/hide_show_reorder_channels/hide_show_reorder_result.jpg" width="600" />
<br />
## Manually giving data type for data set that SOHView cannot identify its datatype
When a data set has no signature channels, SOHView can't decide its
data type. In the file info box, 'Unknown' will be set as data type for
the dataset. User can't be able to add any channels of this data set to
database.
<br />
<img alt="Unknown Data Type in File Info Box" src="images/setting_data_type/unknown_data_type_in_file_info_box.jpg" width="250" />
<br />
To set a data type for this data set, right-click on a channel in the figure to
see the context menu. Click on "Set up Data Type for Data Set"
<br />
<img alt="Select Setup Data Type Context Menu" src="images/setting_data_type/select_setup_data_type_context_menu.jpg" width="300" />
<br />
The Setup Data Type dialog will pop up allowing user to choose one data type from
existing data type in database or create new data type to apply to this data set.
<br />
<img alt="Setup Data Type Box" src="images/setting_data_type/setup_data_type_box.jpg" width="250" />
<br />
To select from existing data type in database, check the radio button "Use existing data type".
Then select one data type from the data type combo box under that.
<br />
<img alt="Select From Existing Data Type" src="images/setting_data_type/select_from_existing_data_type.jpg" width="250" />
<br />
If the data type user want to use isn't exist, check the radio button "Create new data type".
Then type the new data type to the text box under that. The new data type entered will be added into
database when SUBMIT button is clicked.
<br />
<img alt="Create New Data Type" src="images/setting_data_type/create_new_data_type.jpg" width="250" />
<br />
To close box without doing anything, click CANCEL.
To apply changes, user will click on SUBMIT button.
If new data type has been entered, a confirmation dialog will pop up for user to confirm it.
<br />
<img alt="Confirm adding New Data Type" src="images/setting_data_type/confirm_adding_new_data_type.jpg" width="350" />
<br />
If user select from existing data type, a confirmation box wil pop up for user to confirm setting the data type.
<br />
<img alt="Confirm setting Data Type for Data Set" src="images/setting_data_type/confirm_setting_data_type_for_data_set.jpg" width="350" />
<br />
New data type will be updated in file info box.
<br />
<img alt="New Data Type updated in File Info Box" src="images/setting_data_type/new_data_type_updated_in_file_info_box.jpg" width="300" />
<br />
User can also see the new data type in Database - Add/Edit Data Types table.
<br />
<img alt="New Data Type Added" src="images/setting_data_type/new_data_type_added.jpg" width="650" />
<br />
Now the action allowing user to add channel shows up in the context menu.
<br />
<img alt="Add New Channel Context Menu" src="images/setting_data_type/add_new_channel_context_menu.jpg" width="300" />
<br />
## Add a new Channel
A new channel can be added directly to database
(Look at View - Edit Database Table)
When plotting, if a channel can't be found in database, its label text will be changed
to orange color and DEFAULT will prefix it to show that the channel will be plotted
with default plot type which is green line.
<br />
<img alt="Add New Channel Context Menu" src="images/add_edit_single_channel/default_channel.jpg" width="300" />
<br />
To add the channel to database, right click on the channel to see the context menu
and click "Add NEW Channel xxx" in which xxx is the channel name
<br />
<img alt="Add New Channel Context Menu" src="images/add_edit_single_channel/add_new_channel_menu.jpg" width="300" />
<br />
A dialog will pop up for user to add info for the channel. EDIT PARAMETER and
SAVE CHANNEL button will only be enable if a parameter differ from Default is
selected.
<br />
<img alt="Add New Channel Dialog" src="images/add_edit_single_channel/add_new_channel_dialog.jpg" width="500" />
<br />
Normally user shouldn't edit parameter because it will affect how to plot other channels
that use the same parameter. But in special case, they can edit the parameter or just simply
want to review how the parameter is plotted by clicking on EDIT PARAMETER. Please
refer to Edit Single Parameter section for the instruction.
When done with all the info of the channel, user can click on SAVE CHANNEL to add
the channel to database and replot the channel. If the channel showing nothing,
look at the parameter editor to see how it is plotted to figure out the problem.
## Edit a single channel
A channel that has database information will have label text in green.
If user want to edit how a channel is displayed, again, right click for context
menu and select
<br />
<img alt="Add New Channel Dialog" src="images/add_edit_single_channel/edit_channel_menu.jpg" width="300" />
<br />
A dialog will pop up for user to edit info for the channel. Default parameter won't be
allowed to select.
<br />
<img alt="Add New Channel Dialog" src="images/add_edit_single_channel/edit_channel_dialog.jpg" width="500" />
<br />
When done with all the info of the channel, user can click on SAVE CHANNEL to add
the changes to the channel to database and replot the channel. If the channel
showing nothing, look at the parameter editor to see how it is plotted to figure out
the problem.
To be easy to edit select a parameter for the channel, user should open Database -
Add/Edit Parameter dialog for view of all parameters exist in SOHViewer.
\ No newline at end of file
## Edit a Single Parameter
It is recommended to edit parameters in Database - Add/Edit Parameters dialog.
However if user click on EDIT PARAMETER in Add/Edit a Single Channel dialog,
they can view or edit parameter from there.
A dialog will pop up for user to edit info for the parameter. Default parameter won't be
allowed to select.
<br />
<br />
<img alt="Edit Single Parameter Dialog" src="images/edit_single_parameter/edit_parameter_dialog.jpg" width="400" />
<br />
<br />
Notice that if the height is different to the current channel's height, to apply the
new height, user need to RePlot all the channels.
## ValueColor Widget
ValueColor Widget is a widget to edit colors for plotting channels.
It can be found in Database - Parameter table or Edit Parameter dialog.
<br />
<br />
<img alt="Edit/Add/Delete Parameters Dialog" src="images/edit_value_color_edit/edit_add_delete_parameters.jpg" width="670" />
<br />
<br />
<img alt="Edit Single Parameter Dialog" src="images/edit_value_color_edit/edit_parameter_dialog.jpg" width="400" />
<br />
When selecting a new plot type for the parameter,
+ If the current value color string isn't compatible with the plot type,
the default value color string will show up in ValueColor Widget.
+ If there's no value color string show up in ValueColor Widget,
colors aren't editable for the selected plot type.
<br />
<br />
## Edit ValueColor
To edit ValueColor, click on pencil icon on the right of the widget. Then
a dialog corresponding to the selected plot type will pop up to edit the value
color string.
The general buttons in the dialog to edit value color string:
+ Select Color: To edit Color. The color selected will be displayed in the box on
its left.
+ SAVE COLORS: Create new value color string according to the setting, close the
dialog and display the new string in the ValueColor widget.
+ CANCEL: Discard changes and close the dialog
<br />
<br />
### Dialog to edit linesDots plot type's value color string
<br />
<br />
<img alt="Dialog to edit linesDots plot type's value color string" src="images/edit_value_color_edit/line_dots_value_color.jpg" width="350" />
<br />
Three items are defined for this plot type.
+ Line color is required. The channel will be plotted as a line through all
data points of the channel. Line color defines the color of the channel's line.
The label on the right will display the total of all data points in the selected view.
+ Dot color is optional. Selected by setting checked on the checkbox Included
in front of Dot. If included, a dot will be displayed at each data points.
+ Zero color is optional. Selected by setting checked on the checkbox Included
in front of Zero. If included, the zero value data point won't be included in the
line/dot but display as a dot separately with the defined color. There will be
three labels on the right of the channel. The top one displays the total of data
points with value greater than 0. The middle one displays the total of data points
with value 0. The top one displays the total of data oints with value less than 0.
<br />
<br />
### Dialog to edit upDownDots plot type's value color string
<br />
<br />
<img alt="Dialog to edit upDownDots plot type's value color string" src="images/edit_value_color_edit/up_down_value_color.jpg" width="350" />
<br />
Two items are defined for this plot type to plot the channel with two values: 1 and 0
+ Up color is required. All data points with value 1 will be plotted as dots above the
center line with the defined color for Up.
+ Down color is required. All data points with value 0 will be plotted as dots under the
center line with the defined color for Down.
<br />
<br />
### Dialog to edit triColorLines plot type's value color string
<br />
<br />
<img alt="Dialog to edit triColorLines plot type's value color string" src="images/edit_value_color_edit/tri_color_lines_value_color.jpg" width="350" />
<br />
Three base lines will be plotted to display this plot type.
Three items are defined for this plot type to plot the channel with three values: 1, 0 and -1
+ 1 color is required. All data points with value 1 will be plotted as dots on the
first line with the defined color for '1'.
+ 0 color is required. All data points with value 0 will be plotted as dots on the
second line with the defined color for '0'.
+ -1 color is required. All data points with value -1 will be plotted as dots on the
third line with the defined color for '-1'.
<br />
<br />
### Dialog to edit multiColorDotsEqualOnUpperBound plot type's value color string
<br />
<br />
<img alt="Dialog to edit multiColorDotsEqualOnUpperBound plot type's value color string"
src="images/edit_value_color_edit/multi_color_dots_equal_on_upper_bound_value_color.jpg" width="350"
/>
<br />
User can define up to 7 colors corresponding to 7 ranges of values in this plot type.
All data points are plotted in the center line with colors represents its values.
+ If the Include checkbox in the first row is checked, the range less than or equal
to the defined value will be plotted with the defined color. If it is unchecked,
the color in the range won't be plotted, and the 'Select Color' button of the row
will be disabled.
+ Any of the middle rows define the color for the range defined on that row. It
is required to add value in the increasing order and not skipping rows. Warning
will be given if the rules are broken.
+ The greatest value will be added automatically to the last row to define the
color greater than the greatest value. However it is optional to include it or not.
<br />
<br />
### Dialog to edit multiColorDotsEqualOnLowerBound plot type's value color string
<br />
<br />
<img alt="Dialog to edit multiColorDotsEqualOnLowerBound plot type's value color string"
src="images/edit_value_color_edit/multi_color_dots_equal_on_lower_bound_value_color.jpg" width="350"
/>
<br />
User can define up to 7 colors corresponding to 7 ranges of values in this plot type.
All data points are plotted in the center line with colors represents its values.
+ If the Include checkbox in the first row is checked, the range less than
the defined value will be plotted with the defined color. If it is unchecked,
the color in the range won't be plotted, and the 'Select Color' button of the row
will be disabled.
+ Any of the middle rows define the color for the range defined on that row. It
is required to add value in the increasing order and not skipping rows. Warning
will be given if the rules are broken.
+ The greatest value will be added automatically to the last row to define the
color equal to the greatest value. However it is optional to include it or not.
<br />
<br />
## Reset Database to Default State
If users have a need to reset database back to the default state when SOH View
is released. They can do that from menu Commands - Reset Database to Default.
After confirm their will, database will be reset back to its default state.
<br />
<br />
<img alt="Reset Database Menu" src="images/reset_database/reset_database_menu.jpg" width="300" />
<br />
\ No newline at end of file
## Options Menu
<br />
<br />
<img alt="Reset Database Menu" src="images/options_menu/options_menu.jpg" width="500" />
<br />
<br />
### Warn big file size
User can set checked or unchecked the option "Warn big file size" to select the
option before doing the task Read Files.
Once "Warn Big file size" is checked, the size of the data set will be checked
to see if the data needed to be processed is big and it will take a long time to
process it. In that case, a warning will pop up for user to continue with the
selection or can change the selected channels to be plotted. Taking off reading
waveform channels for plotting TPS and RAW data is the effective way to speed
up the processing.
<br />
<br />
<img alt="Big Size Warning" src="images/options_menu/big_size_warning.jpg" width="280" />
<br />
<br />
### Mass Position Colors
User can select mass position color from two options: regular and trillium.
<br />
<br />
<img alt="Mass Position Colors" src="images/options_menu/mass_position_colors.jpg" width="600" />
<br />
<br />
+ Regular:
* Value <= 0.5: Cyan
* 0.5 < Value <= 2.0: Green
* 2.0 < Value <= 4.0: Yellow
* 4.0 < Value <= 7.0: Red
* Value > 7.0: Magenda
+ Trillium:
* Value <= 0.5: Cyan
* 0.5 < Value <= 1.8: Green
* 1.8 < Value <= 2.4: Yellow
* 2.4 < Value <= 3.5: Red
* Value > 3.5: Magenda
When processing the data, SOHViewer will use the selected mass position colors
to plot mass position channels.
User can select the other option then click on RePlot to apply the new choice
in plotting.
<br />
<br />
### Add Mass Positions to RT130 SOH Messages
This is the option to add mass positions' information to the RT130's SOH messages.
This option needs to be selected before data is read and the mass position can be
seen at the end of Search Messages dialog - SOH tab.
<br />
<br />
### Date Format
Allow user to select the format to be displayed for date on plotting figure and
From, To dates.
<br />
<br />
<img alt="Date Format" src="images/options_menu/date_format.jpg" width="600" />
<br />
There are three options to select from:
+ YYYY-MM-DD: Ex. 2023-03-01
+ YYYY-DOY: Ex. 2023-201
+ YYYYMMMDD: Ex. 2023MAR01
+
<br />
<br />
\ No newline at end of file
......@@ -13,7 +13,7 @@ To view/edit database a table, select the table in database menu.
List all types of plotting and description. This table is readonly.
<br />
<br />
<img alt="Plot Types Table" src="images/database_tables/plot_types.png" width="590" />
<img alt="Plot Types Table" src="images/database_tables/plot_types.jpg" width="650" />
<br />
+ Fields' meaning:
......@@ -21,68 +21,62 @@ List all types of plotting and description. This table is readonly.
+ Description: Describing how the channel will look like and the format
of the ValueColors if applicable.
<br />
<br />
## Data Types Table
List all data types available in which Default is the datatype for DEFAULT
channel to draw any channels that aren't defined in database.
<br />
<br />
<img alt="Data Types Table" src="images/database_tables/data_types.jpg" width="650" />
<br />
<br />
## Parameters Table
List all parameters available.
<br />
<br />
<img alt="Parameters Table" src="images/database_tables/parameters.png" width="590" />
<img alt="Parameters Table" src="images/database_tables/parameters.jpg" width="650" />
<br />
+ Depend on the PlotType entered, ValueColors will be applied for the
parameter or not. If ValueColors is available, there will be some hint for
values to entered in grey color.
+ To add a new row to the table, click on ADD ROW button.
+ To save any changes to database, click on SAVE CHANGES. If ValueColors isn't
applicable, the field will be cleared; otherwise it will be validated at this point.
+ To close the dialog, click on CLOSE. User will be asked to confirm closing
if there have been any changes made.
+ Fields' meaning:
+ No.: Line number, start with 0.
+ Param: Parameter's name.
+ Plot Type: Define how to plot the parameter. Description of Plot Type
* No.: Line number, start with 0.
* Param: Parameter's name.
* Plot Type: Define how to plot the parameter. Description of Plot Type
can be found in Plot Types Table.
+ ValueColors: mapping between values and colors or dot/line and color, or
simply color of dots in the plots
+ Height: Height of plot in compare with other plots.
* ValueColors: mapping between values/dot/line/up/down and color, or
simply color of dots in the plots. When Plot Type is changed, if the current valueColors in
database is in incorrect format, default valueColors will be used. To edit Value Color, click
on the pencil sign on the right of ValueColors widget.
* Height: Height of plot in compare with other plots.
* Reset to org. DB: Button to reset the changes in the current DB to backup (original) DB.
* Delete: button to delete a row from the
+ For each color mode available, a row in the database has a separate value for
ValueColors. In order to change between the color mode, use the selector at
the bottom right of the dialog. The color mode chosen when the Parameters table
is opened is the one chosen in the main window.
<br />
the bottom right of the dialog. The color mode chosen when the Parameters table
is opened is the one chosen in the main window. The ValueColor widget has the background
color matching with the selected background color so user can see the real effect of the
selected color on the background.
<br />
<img alt="Parameters Table" src="images/database_tables/parameters_change_color_mode.jpeg" width="590" />
<br />
## Data Types Table
<img alt="Parameters Table" src="images/database_tables/parameters_change_color_mode.jpeg" width="650" />
List all data types available in which Default is the datatype for DEFAULT
channel to draw any channels that aren't defined in database.
<br />
<br />
<img alt="Data Types Table" src="images/database_tables/data_types.png" width="590" />
<br />
+ To add a new row to the table, click on ADD ROW button.
+ To save any changes to database, click on SAVE CHANGES.
+ To close the dialog, click on CLOSE. User will be asked to confirm closing if there have been any changes made.
<br />
## Channels Table
List all channels available for the selected Data Type on the left-top corner.
<br />
<br />
<img alt="A Row of SOH List" src="images/database_tables/channels.png" width="590" />
<img alt="A Row of SOH List" src="images/database_tables/channels.jpg" width="650" />
<br />
+ To add a new row to the table, click on ADD ROW button.
+ To save any changes to database, click on SAVE CHANGES.
+ To close the dialog, click on CLOSE. User will be asked to confirm closing if there have been any changes made.
+ Fields' meaning:
+ No.: Line number, start with 0.
+ Channel: Channel's name.
......@@ -94,5 +88,32 @@ List all channels available for the selected Data Type on the left-top corner.
+ Channels that aren't defined in database will be draw with DEFAULT channel defined in Data Type Default.
<br />
<br />
<img alt="DEFAULT channel" src="images/database_tables/default_channel.png" width="590" />
<img alt="DEFAULT channel" src="images/database_tables/default_channel.png" width="650" />
<br />
## Common Widgets
+ ADD ROW: Button to add a new row to the table, click on ADD ROW button.
+ SAVE CHANGES: To save any changes to database. Each row will be validated before saved.
+ RESET: To reset changes during open time.
<br />
<br />
<img alt="ADD, SAVE, RESET buttons" src="images/database_tables/add-save-reset.jpg" width="550" />
<br />
+ Reset to org. DB: To reset the changes in the current DB to backup (original) DB on a row.
This button is only enabled if the row has a backup row and the backup row is different from
the content of the row in current DB. Once Reset is performed, the button will turn to
Undo Reset button which allows user to change the row back to its current saved content in
the database. Changes made by this button is only saved to DB if SAVE CHANGES is clicked.
<br />
<br />
<img alt="Reset to org. DB buttons" src="images/database_tables/reset-undoreset.jpg" width="650" />
<br />
+ DELETE: To delete a row from database and remove it from GUI. The button will only be enabled
if the row have no constrain with other tables. Once Delete is performed, the button will turn
to Undo button which allows user to add the row back to the GUI. Changes made by this button is only
saved to DB if SAVE CHANGES is clicked.
<br />
<br />
<img alt="DEFAULT channel" src="images/database_tables/undo-delete.jpg" width="650" />
<br />
\ No newline at end of file
sohstationviewer/documentation/images/add_edit_single_channel/add_new_channel_dialog.jpg

45.2 KiB

sohstationviewer/documentation/images/add_edit_single_channel/add_new_channel_menu.jpg

12.8 KiB

sohstationviewer/documentation/images/add_edit_single_channel/default_channel.jpg

10.6 KiB

sohstationviewer/documentation/images/add_edit_single_channel/edit_channel_dialog.jpg

50.5 KiB

sohstationviewer/documentation/images/add_edit_single_channel/edit_channel_menu.jpg

9.88 KiB

sohstationviewer/documentation/images/database_tables/add-save-reset.jpg

7.23 KiB

sohstationviewer/documentation/images/database_tables/channels.jpg

41.2 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment