aodn / acoustic-data-viewer

Web application for visualisation and download of acoustic data
GNU General Public License v3.0
1 stars 0 forks source link

Add more information to help text #3

Closed pblain closed 11 years ago

pblain commented 11 years ago

Need to add a bit more detail, e.g what's shown in the spectrogram and how to interact with it, what you get in the download, describe new features as they're added.

History

1 Updated by Marton Hidas 3 months ago

I'll work out the wording for this with Rob & Sasha's help.

2 Updated by Marton Hidas about 2 hours ago

Suggestion from Sasha for help text:

   1. Choose a Site/Deployment from the pop-up menu above;
   2. You will be presented a long-term average spectrogram compiled from the power spectrum density of sea noise calculated for each individual recording;
   3. Scroll the spectrogram horizontally to find the time period of interest;
   4. Click on the spectrogram to see the waveform and spectrogram of the sea noise recording corresponding to the selected time;
   5. If this recording is of interest, you can download the raw (binary) data file using the download button;
   6. To read the binary data file in Matlab, download the Matlab routine using the Matlab Reader button.
   7. To convert data into acoustic pressure, use the calibration file, which can be downloaded by pressing the Calibration File button, and the hydrophone sensitivity and calibration noise level displayed. The noise recorder electronics was calibrated using white noise of known level input in series with the hydrophone.

Note: the time periods shown in dark blue in the long-term spectrogram do not contain data for technical reasons.
mhidas commented 11 years ago

If enhancement #4 is implemented, the last three items in the help text will be replaced by:

   5. Click the Download button to download a zip file containing:
      * the selected recording (in raw binary format),
      * the waveform and spectrogram preview images,
      * a script to read the raw data into Matlab, and 
      * the calibration file required to convert the raw data into acoustic pressure.
Notes:
   * The noise recorder electronics was calibrated using white noise of known level input in series with the hydrophone.
   * The time periods shown in dark blue in the long-term spectrogram do not contain data for technical reasons.
pmbohm commented 11 years ago

1/2 hour

pmbohm commented 11 years ago

5 is combined into this issue

pmbohm commented 11 years ago

The solution is to add a link to the help page in portal help page http://portalhelp.aodn.org.au/Portal2_help/?q=node/160 This page is also retrieved and the body contents are loaded into the splash page of the app. Should the page go missing the default content in the index.gsp page is shown