Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
h2. Data Products

Here's the place to learn and talk about our data products - both current and future. Data products are primarily available through [Data Search|http://dmas.uvic.ca/home] ([Data Search help page|https://wiki.oceannetworks.ca/display/help/Data+Search+Help]). We are also developing new data product [API|https://wiki.oceannetworks.ca/display/help/API]s (web services) and a Data Preview utility that will also provide data products documented here. The aim of this documentation is to help our users understand and make use of our data products. A secondary purpose is to double as our data product specifications. This documentation is maintained as data products are improved and added. User input for new and improved data products is encouraged: comment below, press the (?) button in [Data Search|http://dmas.uvic.ca/home] Step 3, or [contact us|contact:Contact us].

h3. New Features and Highlights

* As part of the merge of VENUS and NEPTUNE data products, we have added or improved the following:
** [Kistler Accelerometer Data|DP:97] (to be made searchable mid August)
** [Sequoia LISST data products|DP:82]
** [Imagenex rotary data products|DP:100] and [81a files|DP:52]
** [CODAR data products|DP:46]
** Ferry plotting products: [time-distance-variable scalar plots|DP:90] and [spatial scalar plots|DP:91]
** Added support for ZAP echosounders to the [ASL echosounder data products|DP:24], which already support AZFP and AWCP echosounders, the data products for which were already standardized across both networks and data portals.
** Added [Nortek raw data products|DP:22] for all Nortek devices. These are the files that would be produced by the Nortek data acquisition software for the 6 types of Nortek sonars.
** Improvements to ADCP data processing: dynamic rotation of data to external, internal or fixed attitude values, improved documentation (in the wiki and within the MAT files), added linear and discrete bin-mapping to correct for tilt and several other quality of life changes.
** Improved integration of mobile positioning and attitude data into all scalar data products, including support of ferry data productsmany data products - see past release notes for details.
* Added [device-level scalar time series plots|DP:2] to support State of Environment plots and the new Data Preview feature (both are coming soon).
* Manufacturer format .RDI files are now corrected for heading/pitch/roll, including rotation of Earth co-ordinate data. Existing post-processed RDI files will need to be regenerated before RDI files will be made search-able.
* New data products for hydrophones: [spectral MAT files|DP:45] and [spectral probability density plots|DP:51].
* Complex data products are now available *live*. These products used to be available only after daily file archiving. Affected data products include: RDI ADCP, Nortek (all), all echosounders, all Satlantic products.
* Complex data products now produce a text file 'searchStatusUpdates.txt' available in the FTP folder for each search. This file contains all of the search status updates that are displayed to users, including important information that users often miss.
* Variables by location (primary sensor) search is now available.
* See the latest release notes [here|help:New Features Release Notes].
* Coming soon: variableimprovements byto locationspectrograms search,and State of Environment plots, improved spectrogramshydrophone products.
 
{section}{column:width=35%}

h3. Current Data Products

|| ID || Data Product ||
| 1 | [Time Series Scalar Data|1] (incl. stationary and mobile scalar devices) |
| 2 | [Time Series Scalar Plot|DP:2] (incl. stationary and mobile scalar devices) |
| 3 | [Borehole Temperature Time Series Plot|DP:3] |
| 4 | [Log File|DP:4] |
| 5 | [RDI ADCP Time Series|DP:5] |
| 7 | [Audio Data|DP:7] |
| 9 | [RDI ADCP Daily Current Plot|DP:9] |
| 10 | [RDI ADCP Daily Intensity Plot|DP:10] |
| 14 | [AVI Video|DP:14] |
| 18 | [AGO Time Series  Plot|DP:18] |
| 19 | [BioSonics Time Series|DP:19] |
| 20 | [Satlantic ISUS Time Series|DP:20] |
| 21 | [Time Series Staircase Plot|DP:21] |
| 22 | [Nortek Time Series|DP:22] (raw and processed formats) |
| 23 | [MP4 Video|DP:23] |
| 24 | [ASL Acoustic Profiler Time Series|DP:24] (AZFP, AWCP and ZAP echosounders) |
| 25 | [CSEM Receiver Time Series|DP:25] |
| 26 | [RDI Wave Time Series|DP:26] |
| 27 | [Satlantic Radiometer Time Series|DP:27] |
| 30 | [Imagenex Raw Data|DP:30] |
| 33 | [COVIS Plume Imaging Raw Files|DP:33] |
| 34 | [COVIS Diffuse Flow Raw Files|DP:33] |
| 35 | [COVIS Plume Doppler Raw Files|DP:35] |
| 38 | [Hydrophone Array Raw Data|DP:38] |
| 40 | [COVIS Plume Imaging Time Series|http://wiki.neptunecanada.ca/display/DP/40] |
| 41 | [COVIS Diffuse Flow Time Series|http://wiki.neptunecanada.ca/display/DP/41] |
| 42 | [MOV Video|DP:42] |
| 43 | [OGG Video|DP:43] |
| 44 | [MPG Video|DP:44] |
| 45 | [Hydrophone Spectral Data|DP:45] |
| 46 | [CODAR Data|DP:46] |
| 48 | [Kongsberg Mesotech Rotary Sonar Data Product - SWEEP|http://wiki.neptunecanada.ca/display/DP/48] |
| 49 | [Nortek Profiler Daily Currents Plot|DP:49] |
| 51 | [Hydrophone Spectral Probability Density |DP:51] |
| 52 | [Imagenex Manufacturer Formats|DP:52] |
| 56 | [Time Series Scalar VPS Cast Data Product|http://wiki.neptunecanada.ca/display/DP/56] |
| 57 | [Satlantic Radiometer VPS Cast Data Product|http://wiki.neptunecanada.ca/display/DP/57] |
| 58 | [Nortek Time Series VPS Cast Data Product|http://wiki.neptunecanada.ca/display/DP/58] |
| 59 | [Satlantic ISUS VPS Cast Data Product|http://wiki.neptunecanada.ca/display/DP/59] |
| 60 | [ASL AWCP VPS Cast Data Product|http://wiki.neptunecanada.ca/display/DP/60] |
| 61 | [Time Series Scalar Profile Plot|http://wiki.neptunecanada.ca/display/DP/61] |
| 63 | [Image Set raw.zip |http://wiki.neptunecanada.ca/display/DP/63] |
| 64 | [Image Set bmp.zip |http://wiki.neptunecanada.ca/display/DP/64] |
| 65 | [Kongsberg Mesotech Rotary Sonar Data Product - SCAN|DP:65] |
| 66 | [Kongsberg EM Series Raw ALL Data|DP:66] |
| 67 | [COVIS Plume Doppler Data|DP:67] |
| 68 | [EK60 Echosounder Data|DP:68] |
| 76 | [Kongsberg EA600 Raw Data|DP:76] |
| 82 | [Sequoia LISST Data|DP:82] |
| 90 | [Time Distance Variable Scalar Plot|DP:90] |
| 91 | [Spatial Scalar Plot|DP:91] |
| 97 | [Kistler Accelerometer Data|DP:97] |
| 98 | [Kistler Accelerometer Raw Files|DP:98] |
| 100 | [Imagenex Rotary Data Product |DP:100] |
{column}
{column:width=65%}

h3. Data Product Options

For all scalar data products and some complex data products, users will be presented with options to customize their data products. These options are described in the individual data product pages. A compilation of the options is presented in the [data product options page|DP:Data Product Options].

h3. Data Quality

Data quality information is supplied by way of [data quality flags|DP:Quality Assurance Quality Control] and comments in the data products, as well as annotations listed in the [metadata|DP:Metadata] reports. See the [DP:Quality Assurance Quality Control] page for more information.

h3. Metadata

[Metadata|http://wiki.neptunecanada.ca/display/DP/Metadata] reports available with nearly all different data products. These PDF reports are produced automatically when a data search is completed and are made available via a link adjacent to the data, see step 3 in [data search help|http://wiki.neptunecanada.ca/display/help/Data+Search+Help]. The reports contain extensive information about the data, including instrument location, deployment, calibration, data quality and data gaps.

h3. Mobile Data

See the [mobile device page|http://wiki.neptunecanada.ca/display/DP/Positioning+and+Attitude+for+Mobile+Devices] to see how data products handle data from mobile devices.
h3. Data Availability
 
Data availability is indicated in step 2. of [Data Search|https://wiki.oceannetworks.ca/display/help/Data+Search+Help]. The green data availability bar is based on archived data and may not show data for the last 24 hours (until it is archived). All data that goes through the shore-station drivers is archived in a raw format nightly: [log files|DP:4]. Some devices provide data through FTP or HTTP file transfers; the data availability graph will be accurate in that case and data products will be available in near real-time (usually delayed by a few minutes). Although the data availability bar doesn't show it, scalar data is available live: data is usually only a few seconds delayed as it comes up the wire and through the various parsing, conversion, calibrated and QAQC steps. Many complex data products (data that is multidimensional, such as acoustic backscatter or profile data) produce data from log files. These complex data products can, since October 2015, access the raw data prior to archiving, to produce near-live data, usually delayed by a few minutes. In all, users should be able to access near real-time data for all active devices, in addition to accessing historic data from as far back as 2002 (currently, we continue to acquire historic data).

h3. Conventions

*Time-stamps:* Time-stamps are always in UTC. For file-names and string dates, the format conforms to the  ISO8601 convention: yyyymmddTHHMMSS. In some cases, the millisecond  portion may be added: yyyymmddTHHMMSS.FFFZ. Numerical time-stamps within data product files may follow a different format as noted on the data product pages. For instances, numeric time-stamps within MAT files are in the [MATLAB serial date format|http://www.mathworks.com/help/matlab/matlab_prog/represent-date-and-times-in-MATLAB.html#bth57t1-1]. When [resampling|DP:Resampling], the time-stamps are generally taken from the the centre of the resample interval.

*File-names:* Note that the underscore character, "_", is used to separate the components of the names, while spaces, dots and other special characters are not included in file-names. File breaks are avoided as much as possible, but do occur for many reasons, including configuration or device changes, plus some data products have daily file breaks.

For an instrument by category search, files are named as DEVICECODE\_{color:#000000}SENSORNAME{color}\_yyyymmddTHHMMSS.FFFZ_yyyymmddTHHMMSS.FFFZ\-{color:#000000}MODE{color}.EXT where:

* DEVICECODE is a descriptive string unique to each instrument.
* SENSORNAME is the sensor name as it appears in data search, and is only included if a single-sensor data product was requested.
* The first yyyymmddTHHMMSS.FFFZ is the time-stamp (ISO8601 format) of the first data record in the file; the second yyyymmddTHHMMSS.FFFZ is the last time-stamp of data in the file (including data flagged and replaced with NaN). The date-to time stamp is not mandatory, as files which are streamed directly from the file archive will not get a data-to in their file-names. The time-stamp format optionally includes milliseconds: yyyymmddTHHMMSS.FFFZ, where 'FFF' are the milliseconds. The time span of the data within the file, and hence the file-name, may be considerably less than than the requested search time span. Except for many of the plotting products where the time axis is fixed to the search time range, so users can see the plot scaled as they requested. Instrument by category searches are limited to the selected instrument deployment: use the 'All Available' option when selecting the time range to search for all of the data for the selected instrument and deployment.
* MODE is optional text which allows files of the same extension to be differentiated. It is used for different operation modes (Kongsberg [scan|DP:65] or [sweep|DP:48] for instance) or different data product options or multiple formats of the same extension. For example, [scalar MAT files|DP:1] will get an 'ANCILLARY' when on ADCPs so they are not confused with [RDI MAT files|DP:5]. Data product option mode strings are used on scalar data products primarily, examples: '-NaN', '-clean', '-NaN_clean_avg15minute', '-MinMax1hour', see [here|DP:Data Product Options] for more details. Other data products supply file modes as described in their documentation.
* EXT is the file extension.

For instrument by location and variables by location search types, files are named as STATIONNAME\_{color:#000000}DEVICECATEGORY{color}\_SENSORNAME_yyyymmddTHHMMSS.FFFZ_yyyymmddTHHMMSS.FFFZ\-{color:#000000}MODE{color}.EXT where
* STATIONNAME is the station name, including node and station names separated by dashes, for example: _BarkleyCanyon-VPSUpperSlope._
* {color:#000000}DEVICECATEGORY{color} is the device category, such as 'CTD'. If there is more than one device in the category, the file will contain multiple devices combined together for a long record of data.
* SENSORNAME is the sensor name and is omitted for a device-level data product that contains multiple sensors.
* yyyymmddTHHMMSS.FFFZ, MODE and EXT are as above.

 
h3. Interoperability Partners
 
These data products are linked to from Data Search Step 1.
 
|| ID || Data Product ||
| 15 | [ISDM Data Product|DP:15] |
| 16 | [PANGAEA Data  Product|DP:16] |
| 17 | [POKM Data  Product|DP:17] |

h3. File formats

Additional resources for available file formats is available [here|DP:File Formats].
!data_products_mosaic.png|border=1,align=center!

{column}
{section}
If you have any data product related questions or would like to see additional data products, please [let us know|contact:Contact us].