diff --git a/documentation/01 _ Table of Contents.help.md b/documentation/01 _ Table of Contents.help.md index e424e111b900ff9b759eba4c15e06be118a72734..7758351d0002c2db569afd01468023217d5d6182 100644 --- a/documentation/01 _ Table of Contents.help.md +++ b/documentation/01 _ Table of Contents.help.md @@ -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) -+ [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) @@ -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) -+ [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) + [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) diff --git a/documentation/05 _ Read Data.help.md b/documentation/05 _ Read Data.help.md new file mode 100644 index 0000000000000000000000000000000000000000..907783b054572fda98d93a42eba6a53a1de73093 --- /dev/null +++ b/documentation/05 _ Read Data.help.md @@ -0,0 +1,62 @@ +# 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 diff --git a/documentation/05 _ Read from Memory Card.help.md b/documentation/05 _ Read from Memory Card.help.md deleted file mode 100644 index 458af3d6409f50cd1677b8df9e670e0b76964d4c..0000000000000000000000000000000000000000 --- a/documentation/05 _ Read from Memory Card.help.md +++ /dev/null @@ -1,37 +0,0 @@ -## 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 diff --git a/documentation/12 _ Display Data Point Info.help.md b/documentation/12 _ Display Data Point Info.help.md new file mode 100644 index 0000000000000000000000000000000000000000..0c8e907c9465a79b27f9e3156e01d5a582fc80ca --- /dev/null +++ b/documentation/12 _ Display Data Point Info.help.md @@ -0,0 +1,40 @@ +# 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 /> diff --git a/documentation/11 _ Save Plots.help.md b/documentation/12 _ Save Plots.help.md similarity index 100% rename from documentation/11 _ Save Plots.help.md rename to documentation/12 _ Save Plots.help.md diff --git a/documentation/12 _ Plot Different Key.help.md b/documentation/13 _ Plot Different Key.help.md similarity index 100% rename from documentation/12 _ Plot Different Key.help.md rename to documentation/13 _ Plot Different Key.help.md diff --git a/documentation/13 _ Ruler and Zooming.help.md b/documentation/13 _ Ruler and Zooming.help.md new file mode 100644 index 0000000000000000000000000000000000000000..daf89a5281dadad3e9c7cf685a1ff5df18ff65a0 --- /dev/null +++ b/documentation/13 _ Ruler and Zooming.help.md @@ -0,0 +1,33 @@ +# 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 /> diff --git a/documentation/20 _ Search SOH n LOG.help.md b/documentation/20 _ Search SOH n LOG.help.md index cabd892945b33431aed47418c691a1983a0b240d..70c31d102f03bbe8df0dcea150316e36cc537212 100644 --- a/documentation/20 _ Search SOH n LOG.help.md +++ b/documentation/20 _ Search SOH n LOG.help.md @@ -1,9 +1,13 @@ # 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. 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 <br /> --------------------------- -## User interface +# User interface <br /> -### Search box +## Search box The box to enter search text is placed at the top of the dialog. <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. @@ -32,27 +36,51 @@ The box to enter search text is placed at the top of the dialog. <br /> -### Tabs +## Tabs + **Search SOH Lines** tab: to list all lines that includes searched text with its channel -+ **Processing Logs** tab: to list all processing logs with its log type and -color of each line depends on its log type. -+ Each of the following tab is for one of SOH LOG channels +<br /> +<br /> +<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'. + + **RT130**: All the SOH messages +of the selected set will be displayed under tab 'SOH'. <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 /> --------------------------- -## How to search +# How to search <br /> -### Search for a text +## Search for a text 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. @@ -61,15 +89,16 @@ search text using **Search Previous** or **Search Next** button. <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 searched text. <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 will be focused and the line corresponding to the data point will be brought up to view. +<br /> <br /> \ No newline at end of file diff --git a/documentation/31 _ View-Edit Database Tables.help.md b/documentation/31 _ View-Edit Database Tables.md similarity index 100% rename from documentation/31 _ View-Edit Database Tables.help.md rename to documentation/31 _ View-Edit Database Tables.md diff --git a/documentation/40 _ Firmware Notice.help.md b/documentation/40 _ Firmware Notice.help.md index 796d2cfd6ab8b91228aacf57f5ef3494222470ba..c7a398f87e0a8e9bb15e9b07c10b042782cd9bc5 100644 --- a/documentation/40 _ Firmware Notice.help.md +++ b/documentation/40 _ Firmware Notice.help.md @@ -2,4 +2,4 @@ Pegasus firmware was updated to record VEI in millivolts. Previous versions of the firmware recorded VEI in microvolts. 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. \ No newline at end of file +If user observe values higher than expected values for Pegasus, the data is of the older version. \ No newline at end of file diff --git a/documentation/images/display_data_point_info/mseed_soh_data.png b/documentation/images/display_data_point_info/mseed_soh_data.png new file mode 100644 index 0000000000000000000000000000000000000000..3e7804eafbf5393dd9da0318ba6a56932d5e198d Binary files /dev/null and b/documentation/images/display_data_point_info/mseed_soh_data.png differ diff --git a/documentation/images/display_data_point_info/rt130_soh_data.png b/documentation/images/display_data_point_info/rt130_soh_data.png new file mode 100644 index 0000000000000000000000000000000000000000..c49c21a6d0238692e4700d1b2b42e82ad92c3151 Binary files /dev/null and b/documentation/images/display_data_point_info/rt130_soh_data.png differ diff --git a/documentation/images/display_data_point_info/tps_data.png b/documentation/images/display_data_point_info/tps_data.png new file mode 100644 index 0000000000000000000000000000000000000000..f18e74f9adc69cf29bfe446848fe7087b40bc0eb Binary files /dev/null and b/documentation/images/display_data_point_info/tps_data.png differ diff --git a/documentation/images/display_data_point_info/waveform_data.png b/documentation/images/display_data_point_info/waveform_data.png new file mode 100644 index 0000000000000000000000000000000000000000..5e55c190e1ea47025674d4ea1ebeb618ddcc6db5 Binary files /dev/null and b/documentation/images/display_data_point_info/waveform_data.png differ diff --git a/documentation/images/memory_card/from_memory_card_checkbox.png b/documentation/images/memory_card/from_memory_card_checkbox.png deleted file mode 100644 index 08e04aee981584a9389a514dbabbda018c663114..0000000000000000000000000000000000000000 Binary files a/documentation/images/memory_card/from_memory_card_checkbox.png and /dev/null differ diff --git a/documentation/images/memory_card/das_in_cf_card.png b/documentation/images/read_data/das_in_cf_card.png similarity index 100% rename from documentation/images/memory_card/das_in_cf_card.png rename to documentation/images/read_data/das_in_cf_card.png diff --git a/documentation/images/memory_card/data_sdata_radio_buttons.png b/documentation/images/read_data/data_sdata_radio_buttons.png similarity index 100% rename from documentation/images/memory_card/data_sdata_radio_buttons.png rename to documentation/images/read_data/data_sdata_radio_buttons.png diff --git a/documentation/images/read_data/from_memory_card_checkbox.png b/documentation/images/read_data/from_memory_card_checkbox.png new file mode 100644 index 0000000000000000000000000000000000000000..6e8334b750c179baf2e5b32e75ccb98034ab08ee Binary files /dev/null and b/documentation/images/read_data/from_memory_card_checkbox.png differ diff --git a/documentation/images/read_data/read_files_button.png b/documentation/images/read_data/read_files_button.png new file mode 100644 index 0000000000000000000000000000000000000000..16c1b66a7b8ab8fdab32fa7e376c31fe7c7e7e24 Binary files /dev/null and b/documentation/images/read_data/read_files_button.png differ diff --git a/documentation/images/read_data/select_main_data_directory.png b/documentation/images/read_data/select_main_data_directory.png new file mode 100644 index 0000000000000000000000000000000000000000..c9846a2ad2bbfd310b101c1b3d5cbf407d3698f1 Binary files /dev/null and b/documentation/images/read_data/select_main_data_directory.png differ diff --git a/documentation/images/ruler_and_zooming/ruler.png b/documentation/images/ruler_and_zooming/ruler.png new file mode 100644 index 0000000000000000000000000000000000000000..9b6a6de6a2597072f56780f54ce69f041a1cdfa3 Binary files /dev/null and b/documentation/images/ruler_and_zooming/ruler.png differ diff --git a/documentation/images/ruler_and_zooming/tps_zooming.png b/documentation/images/ruler_and_zooming/tps_zooming.png new file mode 100644 index 0000000000000000000000000000000000000000..fa7677b02be2f767d2865328b585d47e42df34db Binary files /dev/null and b/documentation/images/ruler_and_zooming/tps_zooming.png differ diff --git a/documentation/images/search_messages/search_dialog.png b/documentation/images/search_messages/search_dialog.png new file mode 100644 index 0000000000000000000000000000000000000000..44bfc4e1b4170d0d8608c05bee82b0c7473e4be5 Binary files /dev/null and b/documentation/images/search_messages/search_dialog.png differ diff --git a/documentation/images/search_messages/search_soh_lines.png b/documentation/images/search_messages/search_soh_lines.png index e1dcd0275f64215dbe189fc25b22b5d0ab10a3ca..5683cf2e069af92e2ca572e74b47505da3476d68 100644 Binary files a/documentation/images/search_messages/search_soh_lines.png and b/documentation/images/search_messages/search_soh_lines.png differ diff --git a/documentation/images/search_messages/soh_log_channel.png b/documentation/images/search_messages/soh_log_channel.png new file mode 100644 index 0000000000000000000000000000000000000000..c96bbd4350cdefc558968b05e0470a6898ae3f41 Binary files /dev/null and b/documentation/images/search_messages/soh_log_channel.png differ