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

modify and add more help documents

parent 319108cc
No related branches found
No related tags found
1 merge request!203Revise and add documentations
Pipeline #3117 passed with stage
in 4 minutes and 13 seconds
Showing
with 188 additions and 59 deletions
...@@ -16,7 +16,7 @@ The home button can be used to return to this page at any time. ...@@ -16,7 +16,7 @@ The home button can be used to return to this page at any time.
+ [Search List of Directories](04%20_%20Search%20List%20of%20Directories.help.md) + [Search List of Directories](04%20_%20Search%20List%20of%20Directories.help.md)
+ [Read from Memory Card](05%20_%20Read%20from%20Data%20Card.help.md) + [Read Data](05%20_%20Read%20Data.help.md)
+ [Select SOH](06%20_%20Select%20SOH.help.md) + [Select SOH](06%20_%20Select%20SOH.help.md)
...@@ -26,17 +26,19 @@ The home button can be used to return to this page at any time. ...@@ -26,17 +26,19 @@ The home button can be used to return to this page at any time.
+ [Gap Display](09%20_%20Gap%20Display.help.md) + [Gap Display](09%20_%20Gap%20Display.help.md)
+ [Change TPS Color Range](10%20_%20Change%20TPS%20Color%20Range.help.md) + [TPS Dialog](10%20_%20TPS%20Dialog.help.md)
+ [Save Plots](11%20_%20Save%20Plots.help.md) + [Display Data Point Info](12%20_%20Display%20Data%20Point%20Info.help.md)
+ [Plot Different Key](12%20_%20Plot%20Different%20Key.help.md) + [Save Plots](12%20_%20Save%20Plots.help.md)
+ [Plot Different Key](13%20_%20Plot%20Different%20Key.help.md)
+ [Ruler and Zooming](13%20_%20Ruler%20and%20Zooming.help.md)
+ [Search SOH n LOG](20%20_%20Search%20SOH%20n%20LOG.help.md) + [Search SOH n LOG](20%20_%20Search%20SOH%20n%20LOG.help.md)
+ [GPS Dialog](30%20_%20GPS%20Dialog.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) + [Firmware Notice](40%20_%20Firmware%20Notice.help.md)
# Select Main Data Directory
* To change Main Data Directory to where folders for different data set are nested,
click button 'Main Data Directory' (1). A file dialog will pop up to select the main
main directory.
* The path of the main directory will be displayed in (2) box.
* All folders under the main directory will be displayed in the directory list (3).
*
<br />
<img alt="From Memory Card checkbox" src="images/read_data/select_main_data_directory.png" height="250" />
<br />
<br />
# Read data from selected folders:
After selecting the option needed, users have two ways to read data from selected folders:
* Double-click on one folder in the directory list box, the reading will be started
* Select one by left-click on a folder in the directory list box
or select more than one folder by ctrl + left-click on different folders in
the list box, then click button 'Read Files' to start reading
*
<br />
<img alt="From Memory Card checkbox" src="images/read_data/read_files_button.png" height="200" />
<br />
<br />
# Read data from external memory card:
To read data from a memory card, navigate to the desired drive by clicking on
'Main Data Directory' button and check the checkbox "From Memory Card".
Directory List box will display "Memory Card". Click 'Read Files' to read data
from the memory card. *selecting 'Memory Card' in the directory list box isn't
necessary *
There are different kinds of memory cards that can be used in SOHViewer, eg. SD
card, CF card or flash drive.
<br />
<br />
<img alt="From Memory Card checkbox" src="images/read_data/from_memory_card_checkbox.png" height="50" />
<br />
## Baler data: data/ or sdata/
Baler data has data/ folder for main data and sdata/ folder for backup
data. When Baler data is selected, the radio buttons for data/ and sdata/
are enable for user to select one of the folder to read from.
<br />
<br />
<img alt="data/sdata radio buttons" src="images/read_data/data_sdata_radio_buttons.png" height="80" />
<br />
## RT130
When an RT130 folder is selected as the Main Data Directory, the serial numbers of the
RT130 DASs will be listed for user to select for reading.
<br />
<br />
<img alt="DAS in CF Card" src="images/read_data/das_in_cf_card.png" height="100" />
<br />
Note: DASs list will be displayed in the File List box no matter the From Data
Card checkbox is checked or not.
<br />
<br />
\ No newline at end of file
## To read data from external memory card:
There are different kinds of memory cards that can be used in SOH
View, eg. SD card, CF card or flash drive.
To read data from a memory card, check the checkbox "From Memory Card".
Directory List box will display "Memory Card" and the data in the selected card can be
read without selecting "Memory Card" in the Directory List box.
<br />
<br />
<img alt="From Memory Card checkbox" src="images/memory_card/from_memory_card_checkbox.png" height="80" />
<br />
Note: This will work the same way as selecting the first level folder of a data set.
### Baler data
Baler data has data/ folder for main data and sdata/ folder for backup
data. When Baler data is selected, the radio buttons for data/ and sdata/
are enable for user to select one of the folder to read from.
<br />
<br />
<img alt="data/sdata radio buttons" src="images/memory_card/data_sdata_radio_buttons.png" height="80" />
<br />
### CF card
When CF card which contents RT130 data is selected, the serial numbers of the
DASs in the CF card will be listed for user to select for reading.
<br />
<br />
<img alt="DAS in CF Card" src="images/memory_card/das_in_cf_card.png" height="100" />
<br />
Note: DASs list will be displayed in the File List box no matter the From Data
Card checkbox is checked or not.
\ No newline at end of file
# Display info
Click on any data point to display the info of the data point in the info box
at the bottom of each plotting dialog
<br />
<br />
## Mseed SOH data
<br />
<br />
<img alt="MSeed SOH data info" src="images/display_data_point_info/mseed_soh_data.png" width="600" />
<br />
<br />
## Waveform data
<br />
<br />
<img alt="Waveform data info" src="images/display_data_point_info/waveform_data.png" width="600" />
<br />
<br />
## TPS data
Click on one tps channel will display info at the same position for all tps channels no matter
the tps channels are in the same tab or in different tabs.
<br />
<br />
<img alt="Waveform data info" src="images/display_data_point_info/tps_data.png" width="600" />
<br />
<br />
## RT130 SOH data
Click on one SOH data point will highlight the SOH message corresponding to that line.
<br />
<br />
<img alt="MSeed SOH data info" src="images/display_data_point_info/rt130_soh_data.png" width="600" />
<br />
<br />
# Ruler
Ctrl/Cmd + Click on a point in a plotting, a yellow ruler will show up with time on top.
Rulers will also show up on other plotting dialog at the corresponding position
On TPS plotting a yellow square box will show up to mark the corresponding data points on
all the TPS channels. Ctr/cmd + Click on TPS plot will work the same.
<br />
<br />
<img alt="Ruler" src="images/ruler_and_zooming/ruler.png" width="600" />
<br />
<br />
---------------------------
---------------------------
# Zooming
Shift + Click to mark the first zooming point, then Shift + click again to mark
the second zooming point to zoom the area between two zooming points.
The zooming task will be performed in the area corresponding to zooming triggering
dialog.
For TPS, zooming won't be performed but mark with 2 orange bars. Zooming can't
be triggered from TPS dialog.
<br />
<br />
<img alt="Ruler" src="images/ruler_and_zooming/tps_zooming.png" width="600" />
<br />
<br />
<br />
# Search Messages # Search Messages
<br />
<br />
<img alt="Search Dialog" src="images/search_messages/search_dialog.png" width="600" />
<br />
<br />
--------------------------- ---------------------------
--------------------------- ---------------------------
## How to open # How to open
Search Messages dialog will open by itself after a data set are done with reading and plotting. Search Messages dialog will open by itself after a data set are done with reading and plotting.
If it is closed by any reason, user can open it by go to Menu - Forms and click on "Search Messages" If it is closed by any reason, user can open it by go to Menu - Forms and click on "Search Messages"
...@@ -11,16 +15,16 @@ If it is closed by any reason, user can open it by go to Menu - Forms and click ...@@ -11,16 +15,16 @@ If it is closed by any reason, user can open it by go to Menu - Forms and click
<br /> <br />
--------------------------- ---------------------------
## User interface # User interface
<br /> <br />
### Search box ## Search box
The box to enter search text is placed at the top of the dialog. The box to enter search text is placed at the top of the dialog.
<br /> <br />
### Toolbar ## Toolbar
+ <img alt="To Selected" src="images/search_messages/to_selected.png" width="30" /> **To Selected**: The current table rolls back to the current selected line. + <img alt="To Selected" src="images/search_messages/to_selected.png" width="30" /> **To Selected**: The current table rolls back to the current selected line.
...@@ -32,27 +36,51 @@ The box to enter search text is placed at the top of the dialog. ...@@ -32,27 +36,51 @@ The box to enter search text is placed at the top of the dialog.
<br /> <br />
### Tabs ## Tabs
+ **Search SOH Lines** tab: to list all lines that includes searched text with + **Search SOH Lines** tab: to list all lines that includes searched text with
its channel its channel
+ **Processing Logs** tab: to list all processing logs with its log type and <br />
color of each line depends on its log type. <br />
+ Each of the following tab is for one of SOH LOG channels <img alt="Search SOH Lines" src="images/search_messages/search_soh_lines.png" width="600" />
<br />
<br />
+ **Processing Logs** tab: to list all logs of data and plotting processing
with its log type and color of each line depends on its log type.
<br />
<br />
<img alt="Processing Log" src="images/search_messages/processing_log.png" width="600" />
<br />
<br />
+ Each of the following tab is for an SOH log channels
<br />
<br />
<img alt="An SOH Log Channel" src="images/search_messages/soh_log_channel.png" width="600" />
<br />
<br />
**MSeed**: For a channel that are wrapped in MSeed format, the log messages of the channel will be
nested in tab of the channel name. For a text log file under the folder of a station name, the log will only
be displayed when the station is selected and the tab name will be 'TXT'. For a text log file that isn't
under any station name folder, the log will be display for any selected station and the tab name will be 'TEXT'.
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**RT130**: All the SOH messages
of the selected set will be displayed under tab 'SOH'.
<br /> <br />
### Info box
The box to display the info of the selected line. ## Info box
The box at the bottom to display the info of the selected line.
<br /> <br />
--------------------------- ---------------------------
## How to search # How to search
<br /> <br />
### Search for a text ## Search for a text
Type a searched text, the searched text will be highlighted through the table Type a searched text, the searched text will be highlighted through the table
and the current table scrolls to the first line that contains the searched text. and the current table scrolls to the first line that contains the searched text.
...@@ -61,15 +89,16 @@ search text using **Search Previous** or **Search Next** button. ...@@ -61,15 +89,16 @@ search text using **Search Previous** or **Search Next** button.
<br /> <br />
### Filter all lines with searched text ## Filter all lines with searched text
The first tab **Search SOH Lines** is for filtering all lines that contains The first tab **Search SOH Lines** is for filtering all lines that contains
the searched text. the searched text.
<br /> <br />
### Interaction with RT130 SOH channel's data point ## Interaction with RT130 SOH channel's data point
When user click on a clickable data point on a SOH channel of RT130, SOH tab When user click on a clickable data point on a SOH channel of RT130, SOH tab
will be focused and the line corresponding to the data point will be brought will be focused and the line corresponding to the data point will be brought
up to view. up to view.
<br />
<br /> <br />
\ No newline at end of file
...@@ -2,4 +2,4 @@ Pegasus firmware was updated to record VEI in millivolts. ...@@ -2,4 +2,4 @@ Pegasus firmware was updated to record VEI in millivolts.
Previous versions of the firmware recorded VEI in microvolts. Previous versions of the firmware recorded VEI in microvolts.
We decided to apply VEI's conversion factor in newer version of Pegasus. We decided to apply VEI's conversion factor in newer version of Pegasus.
If user may see higher than expected values in the older version of Pegasus. If user observe values higher than expected values for Pegasus, the data is of the older version.
\ No newline at end of file \ No newline at end of file
documentation/images/display_data_point_info/mseed_soh_data.png

73 KiB

documentation/images/display_data_point_info/rt130_soh_data.png

166 KiB

documentation/images/display_data_point_info/tps_data.png

59.8 KiB

documentation/images/display_data_point_info/waveform_data.png

56.1 KiB

documentation/images/memory_card/from_memory_card_checkbox.png

14.9 KiB

documentation/images/read_data/from_memory_card_checkbox.png

17.9 KiB

documentation/images/read_data/read_files_button.png

97 KiB

documentation/images/read_data/select_main_data_directory.png

104 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