Level 3 data (velocity profilers): Difference between revisions

From Atomix
Change dll_calculation type to dll_method for consistency with Brian's data
 
(29 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{ReviewStage
{{ReviewStage
|toreview=Draft
|toreview=Ready for review
|authors=Cynthia
|authors=Cynthia
|instrument_type=Velocity profilers
|instrument_type=Velocity profilers
Line 6: Line 6:
[[File:SF atomix ADCP.png|300px|thumb|Schematic of ADCP processing nomenclature]]
[[File:SF atomix ADCP.png|300px|thumb|Schematic of ADCP processing nomenclature]]
The required dimensions and variables for the structure-function processing level within NetCDF ATOMIX format for velocity ADCP measurements are described below.  This NetCDF group contains the structure function (DLL) calculated as a function of the along-beam separation for the available/usable ADCP bins.  
The required dimensions and variables for the structure-function processing level within NetCDF ATOMIX format for velocity ADCP measurements are described below.  This NetCDF group contains the structure function (DLL) calculated as a function of the along-beam separation for the available/usable ADCP bins.  
Only a few attributes for each variable are listed since the page's purpose is to describe the information layout within each NetCDF file. Please refer to the {{FontColor|bg=#fca1fd|text= [[NetCDF_parameter|complete list]]}} for the additional attributes related to each variable (e.g., units, bounds, cell_methods).


__TOC__
__TOC__
Line 20: Line 22:
| time
| time
| TIME
| TIME
| Units in Days since 1950-01-01T00:00:00Z. Provide a bounds attribute to designate the variable containing the limits of each segment ([http://cfconventions.org/cf-conventions/v1.6.0/cf-conventions.html#methods-applied-to-a-timeseries-ex see CF-compliant example]).
| Segment midpoint time. Units in Days since reference time specified in variable attribute.
|-
|-
| R_DIST
| Z_DIST
| distance_from_sensor_along_beams
| distance_from_sensor_along_vertical
| R_DIST
| Z_DIST
| Along-beam bin centre distance (in meters) from the transducer  
| bin centre distance (in meters) from the transducer along the instrument's vertical axis
|-
| R_DEL
| along-beam_separation_distance_at_which_structure_function_is_evaluated
| R_DEL (variable?)
| Estimated from bin sizes and theta in [[Level_2_qaqc_velocities_(velocity_profilers)#Variables|Level 2 qaqc variables]]
|-
|-
| N_BEAM
| N_BEAM
| unique_identifier_for_each_beam
| unique_identifier_for_each_beam
| N_BEAM
| N_BEAM
| Array of 1 to number of beams (4 or 5 typically)
| Array of 1 to number of beams (3 to 5 typically)
|-
|-
| colspan="4" style="text-align:center; font-weight:bold; background-color:#f9eddd"|  Optional dimensions for 5-beam ADCP <math>\ddagger</math>
| N_DEL
|-
| along-beam_separation_distance_over_
| R_DIST5
which_DLL_is_evaluated_in_number_of_bins
| distance_from_sensor_along_beam_5
| N_DEL
| R_DIST5
| Number of bins separating two velocity measurements used to calculate DLL
| Along-beam bin centre distance (in meters) from the transducer for the 5th vertical beam
|}
|}
</div>
</div>
Line 57: Line 53:
|-
|-
| DLL
| DLL
| water_radial_velocity_of_scatterers_towards
| second_order_structure_function
_instrument_in_each_beam
| TIME, Z_DIST, N_BEAM, N_DEL
| TIME, R_DIST, R_DEL, N_BEAM
| Differences in velocities squared have been time-averaged (units of m2/s2).
|  
|-
|-
| DLL_FLAGS
| DLL_FLAGS
| status_flags
| second_order_structure_function_
| TIME, R_DIST, R_DEL, N_BEAM
status_flag
| {{FontColor|fg=white|bg=red|text=To be linked, when boolean flags defined}}
| TIME, Z_DIST, N_BEAM, N_DEL
| For details see [[Velocity Profiler data flags| Velocity profiler data flags]]
|-
| R_DEL
| along-beam_separation_distance_at_
which_structure_function_is_evaluated
| N_BEAM, N_DEL
| Estimated quantity (in meters) from N_DEL (Level 3), BIN_SIZE (Level 2) and THETA (Level 2).
|-
| R_DIST
| distance_from_sensor_along_beams
| Z_DIST, N_BEAM
| Along-beam bin centre distance (in meters) from the transducer
|-
| DLL_N
| second_order_structure_function_number_
of_observations
| TIME, Z_DIST, N_BEAM, N_DEL
| The number of available measurements in each segment i.e., data quality.
|-
|-
| N_SEGMENT
| N_SEGMENT
Line 72: Line 85:
| TIME
| TIME
| Enables backtracking to [[Level 2 segmented (velocity profilers)|previous processing level]]
| Enables backtracking to [[Level 2 segmented (velocity profilers)|previous processing level]]
|-
| BURST_NUMBER <math>\dagger\dagger</math>
| unique_identifier_for_each_burst
| TIME
| Only required when measuring in burst-mode. Integers of 1, 2, etc to designate which burst the velocities are associated with.
|-
| colspan="4" style="text-align:center; font-weight:bold; background-color:#f9eddd"|  Optional dimensions for 5-beam ADCP <math>\ddagger</math>
|-
| DLL5
| water_radial_velocity_of_scatterers_towards
_instrument_in_beam_5
| TiME, R_DEL5, R_DIST5
| Only necessary for 5-beam ADCP
|-
| DLL5_FLAGS
| status_flags
| TiME, R_DEL5, R_DIST5
| Same as DLL_FLAGS but for the 5th vertical beam when present.
|-
| colspan="4" |
<math>\dagger\dagger</math> Variable required only when measuring in bursts e.g., 18 min of continuous measurements every hour.
|}  
|}  
</div>
</div>
Line 111: Line 102:
| processing_level
| processing_level
| Boilerplate about the content of the NetCDF group.
| Boilerplate about the content of the NetCDF group.
| <blockquote>''This group includes the structure function Dll as a function of the separation distance.  Any ancillary information required for estimatng the dissipation of turbulent kinetic energy may also be stored here. ''</blockquote>
| <blockquote>''This group includes the structure function Dll as a function of the separation distance.  Any ancillary information required for estimating the dissipation of turbulent kinetic energy may also be stored here. ''</blockquote>
|-
|-
| dll_calculation_type
| dll_method
| Specify differencing technique used to estimate DLL
| Specify differencing technique used to estimate DLL
| Examples include
| Examples include:
<blockquote>Central-differencing</blockquote>
<blockquote>Central-differencing</blockquote>
     <blockquote>Forward-differencing</blockquote>
     <blockquote>Forward-differencing</blockquote>
Line 123: Line 114:
| stationarity_testing
| stationarity_testing
| Any testing done on the segment to verify stationarity?
| Any testing done on the segment to verify stationarity?
|  
| {{FontColor|fg=white|bg=red|text=To be revisited once testing begins}}. Tentatively refer to [https://bitbucket.org/efm_cb/netcdf/src/master/TestData/adcp_atomix_metada.yml demo yaml] file.
|-
|-
| noise_testing
| noise_testing
Line 136: Line 127:


----
----
Return to [[Level 2 data (velocity profilers)| Level 2 quality controlled and segmented velocities]]
Return to [[Level 2 data (velocity profilers)| Level 2 segmented velocities]]
 
Go to [[Level 4 data (velocity profilers)| Level 4 dissipation estimates]]
Go to [[Level 4 data (velocity profilers)| Level 4 dissipation estimates]]

Latest revision as of 13:53, 8 July 2022

Page status: Ready for review
Author(s): Cynthia
Reviewer(s):
Comment:
Schematic of ADCP processing nomenclature

The required dimensions and variables for the structure-function processing level within NetCDF ATOMIX format for velocity ADCP measurements are described below. This NetCDF group contains the structure function (DLL) calculated as a function of the along-beam separation for the available/usable ADCP bins.

Only a few attributes for each variable are listed since the page's purpose is to describe the information layout within each NetCDF file. Please refer to the complete list for the additional attributes related to each variable (e.g., units, bounds, cell_methods).

Dimensions

Short name Standard name Dimensions Comments
TIME time TIME Segment midpoint time. Units in Days since reference time specified in variable attribute.
Z_DIST distance_from_sensor_along_vertical Z_DIST bin centre distance (in meters) from the transducer along the instrument's vertical axis
N_BEAM unique_identifier_for_each_beam N_BEAM Array of 1 to number of beams (3 to 5 typically)
N_DEL along-beam_separation_distance_over_

which_DLL_is_evaluated_in_number_of_bins

N_DEL Number of bins separating two velocity measurements used to calculate DLL

Variables


Short name Standard name Dimensions Comment
DLL second_order_structure_function TIME, Z_DIST, N_BEAM, N_DEL Differences in velocities squared have been time-averaged (units of m2/s2).
DLL_FLAGS second_order_structure_function_

status_flag

TIME, Z_DIST, N_BEAM, N_DEL For details see Velocity profiler data flags
R_DEL along-beam_separation_distance_at_

which_structure_function_is_evaluated

N_BEAM, N_DEL Estimated quantity (in meters) from N_DEL (Level 3), BIN_SIZE (Level 2) and THETA (Level 2).
R_DIST distance_from_sensor_along_beams Z_DIST, N_BEAM Along-beam bin centre distance (in meters) from the transducer
DLL_N second_order_structure_function_number_

of_observations

TIME, Z_DIST, N_BEAM, N_DEL The number of available measurements in each segment i.e., data quality.
N_SEGMENT unique_identifier_for_each_segment_

in_the_entire_available_timeseries

TIME Enables backtracking to previous processing level

Group attributes (metadata)

This section describes attributes that may provide additional information about how the data was processed and manipulated at this stage.


Attribute name Purpose Suggested content
processing_level Boilerplate about the content of the NetCDF group.

This group includes the structure function Dll as a function of the separation distance. Any ancillary information required for estimating the dissipation of turbulent kinetic energy may also be stored here.

dll_method Specify differencing technique used to estimate DLL Examples include:

Central-differencing

Forward-differencing

Optional group attributes [math]\displaystyle{ \ddagger }[/math]
stationarity_testing Any testing done on the segment to verify stationarity? To be revisited once testing begins. Tentatively refer to demo yaml file.
noise_testing Details of testing the noise levels, or if the signal comprises mostly of noise?
comment (optional) Any additional information pertinent to other users who test their algorithms against the file.

Return to Level 2 segmented velocities

Go to Level 4 dissipation estimates