Commit 3e33f07e authored by PONCELET's avatar PONCELET

Adapt model and asciidoctor generation to SonarNetcdf site

https://github.com/ices-eg/wg_WGFAST/
parent cfad9ff1
This diff is collapsed.
|==============================================================================================================================================================================================================
|Description |Obligation |Comment
|Group attributes | |
|Variables | |
|==============================================================================================================================================================================================================
|==============================================================================================================================================================================================================
|Description |Obligation |Comment
|Group attributes | |
|:string |O |System description
|Dimensions | |
|time:time | |can be fixed or unlimited length, as appropriate
|Variables | |
|float pitch(time) |M |platform pitch in VCS coordinate system
|:crs = "VCS" | |
|:standard_name = "platform_pitch_angle" | |
|:units = "degree" | |
|:long_name = "pitch angle" | |
| | |
|float pitch_rate(time) |O |platform pitch in VCS coordinate system
|:crs = "VCS" | |
|:standard_name = "platform_pitch_rate" | |
|:units = "degree/s" | |
|:long_name = "pitch rate" | |
| | |
|float roll(time) |M |platform roll in VCS coordinate system
|:crs = "VCS" | |
|:standard_name = "platform_roll_angle" | |
|:units = "degree" | |
|:long_name = "roll angle" | |
| | |
|float roll_rate(time) |O |platform roll in VCS coordinate system
|:crs = "VCS" | |
|:standard_name = "platform_roll_rate" | |
|:units = "degree/s" | |
|:long_name = "roll rate" | |
| | |
|ulong time(time) |M |Timestamps for attitude captor
|:calendar = "gregorian" | |
|:standard_name = "time" | |
|:units = "nanoseconds since 1970-01-01 00:00:00Z" | |
|:axis = "T" | |
|:long_name = "Timestamps for attitude captor" | |
| | |
|float vertical_offset(time) |M |Distance from the nominal water level to the actual water level measured along the z-axis of the platform coordinate system (positive values are when the actual water level is below the nominal water level). For ships and similar, this is called heave, but the concept applies equally well to underwater vehicle depth
|:units = "m" | |
|:long_name = "Platform vertical offset from nominal" | |
| | |
|float yaw(time) |M |platform yaw in VCS coordinate system
|:crs = "VCS" | |
|:standard_name = "platform_yaw_angle" | |
|:units = "degree" | |
|:long_name = "yaw angle" | |
| | |
|float yaw_rate(time) |O |platform yaw in VCS coordinate system
|:crs = "VCS" | |
|:standard_name = "platform_yaw_rate" | |
|:units = "degree/s" | |
|:long_name = "yaw rate" | |
|==============================================================================================================================================================================================================
|==============================================================================================================================================================================================================
|Description |Obligation |Comment
|Group attributes | |
|Variables | |
|==============================================================================================================================================================================================================
|==============================================================================================================================================================================================================
|Description |Obligation |Comment
|Group attributes | |
|:beam_mode |M |Mode of the beam in this subgroup, taken from the defined vocabulary of: “vertical” (a set of beams that form a vertical slice through the water), ”horizontal” (a set of beams that form a nominally horizontal plane through the water), and ”inspection” (a set of beams with arbitrary pointing directions).
|conversion_equation_t :conversion_equation_type |M |Type of equation used to convert backscatter measurements into volume backscattering strength and target strength.
|beam_stabilisation_t :beam_stabilisation |M |Indicate if beam are stabilized from ship motion or not
|Dimensions | |
|detection:detection | |The maximum number of main soundings detection in this group per swath.
|swath:swath | |Can be of fixed or unlimited length, as appropriate.
|sector:sector | |The maximum number of sectors
|beam:beam | |wc rx beams
|backscatter_sample:backscatter_sample | |the total number of sample in water column data for all ping
|Variables | |
|ushort backscatter_count(swath, beam) |M |Number of WC sample for water column backscatter data
|:long_name = "wc backscatter sample count" | |
| | |
|long backscatter_offset(swath, beam) |M |starting offset WC sample in the sample list
|:long_name = "wc backscatter offset" | |
| | |
|byte backscatter_r(backscatter_sample) |M |Real part or amplitude or power of backscatter measurements in water column
|:linked_count = "/root/sonar/beam/Beam_group1/backscatter_count" | |
|:units = "as appropriate" | |
|:long_name = "Real part or amplitude or power of backscatter measurements in water column" | |
|:linked_offset = "/root/sonar/beam/Beam_group1/backscatter_offset" | |
|float:scale_factor = 0.5 | |
| | |
|float beam_direction_x(swath, beam) |M |The x-axis coordinate of a unit vector in the beam direction for each beam and ping in the FACS coordinate system (ie relative to the vertical)
|:crs = "FACS" | |
|float :valid_range = -1.0f, 1.0f | |
|:long_name = "x-component of the vector that gives the pointing direction of the beam, in sonar beam coordinate system" | |
| | |
|float beam_direction_y(swath, beam) |M |The y-axis coordinate of a unit vector in the beam direction for each beam and ping, in the FACS coordinate system (ie relative to the vertical)
|float :valid_range = -1.0f, 1.0f | |
|:crs = "FACS" | |
|:long_name = "y-component of the vector that gives the pointing direction of the beam, in the FACS coordinate system (ie relative to the vertical)" | |
| | |
|float beam_direction_z(swath, beam) |M |The z-axis coordinate of a unit vector in the beam direction for each beam and ping, in the FACS coordinate system (ie relative to the vertical)
|float :valid_range = -1.0f, 1.0f | |
|:crs = "FACS" | |
|:long_name = "z-component of the vector that gives the pointing direction of the beam, in the FACS coordinate system (ie relative to the vertical)" | |
| | |
|float beamwidth_receive_major(swath, beam) |M |One-way beam width at half power down in the horizontal direction of the receive beam. Horizontal direction matched across ship direction in MBES case
|float :valid_range = 0.0f, 360.0f | |
|:units = "arc_degree" | |
|:long_name = "Half power one-way receive beam width along major (horizontal) axis of beam, Horizontal direction matched across ship direction in MBES case" | |
| | |
|float beamwidth_receive_minor(swath, beam) |O |One-way beam width at half power down in the vertical direction of the receive beam. Vertical direction matched along ship direction in MBES case
|float :valid_range = 0.0f, 360.0f | |
|:units = "arc_degree" | |
|:long_name = "Half power one-way receive beam width along minor (vertical) axis of beam, Vertical direction matched along ship direction in MBES case " | |
| | |
|float beamwidth_transmit_major(swath, sector) |O |One-way beam width at half power down in the horizontal direction of the transmit beam. Horizontal direction matched across ship direction in MBES case
|float :valid_range = 0.0f, 360.0f | |
|:units = "arc_degree" | |
|:long_name = "Half power one-way transmit beam width along major (horizontal) axis of beam, horizontal direction matched across ship direction in MBES case " | |
| | |
|float beamwidth_transmit_minor(swath, sector) |M |One-way beam width at half power down in the vertical direction of the transmit beam. Vertical direction matched along ship direction in MBES case
|float :valid_range = 0.0f, 360.0f | |
|:units = "arc_degree" | |
|:long_name = "One-way beam width at half power down in the vertical direction of the transmit beam. Vertical direction matched along ship direction in MBES case" | |
| | |
|float detection_beam_pointing_angle(swath, detection) |O |In high density mode, beam width is synthetically sharpen in order to make several independant sounding detection per beam. This variable matches the beam pointing angle of the sharpen synthetic beam. Angle relative to the RX transducer array if beam are not stabilized, If stabilized (ME70 for example) angles are relative to the horizontal plane. If mode is not High density, the synthetic pointing angle should match the beam pointing angle
|:crs = "ACS" | |
|:long_name = "detection synthetic beam pointing angle relative to Rx reference plane" | |
|:units = "arc_degree" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|float detection_backscatter_calibration(swath, detection) |O |Backscatter (BScorr) calibration offset applied (default 0 dB).
|:units = "dB" | |
|:long_name = " detection backscatter calibration" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|float detection_constructor_quality_factor(swath, detection) |O |quality factor as given by constructor
|:long_name = "constructor quality factor" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|float detection_ifremer_quality_factor(swath, detection) |O |Estimated standard deviation as % of the detected depth. Quality Factor (QF) is calculated from IFREMER Quality Factor (IFQ):QF=Est(dz)/z=100*10^-IQF
|:long_name = "Estimated standard deviation as % of the detected depth. Quality Factor (QF) is calculated from IFREMER Quality Factor (IFQ):QF=Est(dz)/z=100*10^-IQ" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|double detection_latitude(swath, detection) |O |Latitude of the detection in WGS-84 reference system
|float:valid_min = -90 | |
|float:valid_max = 90 | |
|:standard_name = "latitude" | |
|:units = "degrees_north" | |
|:long_name = "Latitude of the detection" | |
|double:_FillValue = Double.NaN | |
| | |
|double detection_longitude(swath, detection) |O |Longitude of the detection in WGS-84 reference system
|float:valid_min = -90 | |
|float:valid_max = 90 | |
|:standard_name = "longitude" | |
|:units = "degrees_east" | |
|:long_name = "Longitude of the detection" | |
|double:_FillValue = Double.NaN | |
| | |
|float detection_mean_absorption_coefficient(swath, detection) |O |parameter used in equation type_3
|:units = "dB/km" | |
|:long_name = "mean absorption coefficient" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|float detection_receiver_sensitivity_applied(swath, detection) |O |Receiver sensitivity (M), in dB, compensated for RX beampattern at actual transmit frequency at current vessel attitude.
|:long_name = "detection receiver sensitivity applied" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|float detection_backscatter(swath, detection) |O |Beam intensity at detection point (kmall type_3 for reflectivity2 data, type_4 for km data
|:equation_type = "conversion_equation_t" | |
|:long_name = "detection seafloor backscatter" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|ushort detection_rx_transducer_index(swath, detection) |M |associated rx transducer index, as recorded in the Platform description. As a swath can be made of several transmit sectors and rx fans, those data are recorded per swath and per detection
|:long_name = "detection associated Rx transducer index" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|float detection_source_level_applied(swath, detection) |O |Source level (SL) applied (dB):
|:units = "dB" | |
|:long_name = "detection source level applied" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|float detection_time_varying_gain(swath, detection) |O |Time Varying Gain (TVG) used when correcting reflectivity.
|:units = "dB" | |
|:long_name = "detection Time Varying Gain (TVG) used when correcting reflectivity." | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|float detection_two_way_travel_time(swath, detection) |O |Two way travel time (also called range) of the detection
|:units = "s" | |
|:long_name = "two way travel time" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|short detection_tx_sector(swath, detection) |M |Transmitting sector number
|:long_name = "transmitting sector number" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|ushort detection_tx_transducer_index(swath, detection) |M |associated tx transducer index, as recorded in the Platform description. As a swath can be made of several transmit sectors and rx fans, those data are recorded per swath and per detection
|:long_name = "detection transmit transducer index" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|detection_type_t detection_type(swath, detection) | |type of detection
|:long_name = "Type of detection" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|float detection_x(swath, detection) |M |Distance from vessel reference point at time of first tx pulse in ping, to depth point. Measured in the surface coordinate system (SCS)
|:crs = "SCS" | |
|:units = "m" | |
|:long_name = "Horizontal distance x" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|float detection_y(swath, detection) |M |Distance from vessel reference point at time of first tx pulse in ping, to depth point. Measured in the surface coordinate system (SCS)
|:crs = "SCS" | |
|:units = "m" | |
|:long_name = "Horizontal distance y" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|float detection_z(swath, detection) |M |Distance from vessel reference point at time of first tx pulse in ping, to depth point. Measured in the surface coordinate system (SCS)
|:crs = "SCS" | |
|:units = "m" | |
|:long_name = "Vertical distance z" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|float equivalent_beam_angle(swath, beam) |M |Equivalent beam angle.
|float :valid_range = 0.0f,12.56637061435917295385f | |Maximum value is equivalent to 4π.
|:units = "sr" | |
|:long_name = "Equivalent beam angle" | |
| | |
|int ping(swath) |M |raw ping counter, can be identical for several swath and rewinded to zero, match the ping number given by the constructor (can be rewinded to zero by the sensor)
|:long_name = "raw ping counter as given by the constructor" | |
| | |
|float platform_heading(swath) |M |heading of vessel at time of midpoint of first tx pulse
|float:valid_min = 0 | |
|float:valid_max = 360 | |
|:units = "deg" | |
|:long_name = "vessel heading" | |
| | |
|double platform_latitude(swath) |M |latitude of the vessel reference point in WGS-84 reference system
|double:valid_min = -90 | |
|double:valid_max = 90 | |
|:standard_name = "latitude" | |
|:units = "degrees_north" | |
|:long_name = "latitude" | |
|double:_FillValue = Double.NaN | |
| | |
|double platform_longitude(swath) |M |latitude of the vessel reference point in WGS-84 reference system
|double:valid_min = -180 | |
|double:valid_max = 180 | |
|:standard_name = "longitude" | |
|:units = "degrees_east" | |
|:long_name = "longitude" | |
|double:_FillValue = Double.NaN | |
| | |
|float platform_pitch(swath) |M |platform pitch in VCS coordinate system
|:crs = "VCS" | |
|:standard_name = "platform_pitch_angle" | |
|:units = "degree" | |
|:long_name = "pitch angle" | |
| | |
|float platform_roll(swath) |M |platform roll in VCS coordinate system
|:crs = "VCS" | |
|:standard_name = "platform_roll_angle" | |
|:units = "degree" | |
|:long_name = "roll angle" | |
| | |
|float platform_vertical_offset(swath) |M |Distance from the platform reference point to the water line (distance are positives downwards) . For ships and similar, this is called heave, but the concept applies equally well to underwater vehicle depth
|:units = "m" | |
|:long_name = "Platform vertical distance from reference point to the water line" | |
| | |
|int sector(sector) | |The sector ids used by the vendor, can be different from the sector indexes. Used to have a matching between vendor ids and indexes
|:long_name = "sector ids" | |
| | |
|float sound_speed_at_transducer(swath) |O |Sound speed at tx transducer depth at the mid-time of emission of the first tx pulse
|float :valid_min = 0.0 | |
|:standard_name = "speed_of_sound_in_sea_water" | |
|:units = "m/s" | |
|:long_name = "Indicative sound speed at tx time and depth" | |
| | |
|byte status(swath, detection) | |invalidity flag for soundings data, if one of the byte field is set (value != 0) the data are considered as invalid for the given reasons : -rejected : rejected by user operation, detailed reason is given by the detailed status field -invalid_acquisition : marked invalid by sounder -invalid_conversion : tagged as invalid during file creation (typically missing datagram) -invalid_swath : swath is invalidated (typically by the user) -invalid_sounding_row (range of sounding invalidated along sounding_row dimension) see http://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/cf-conventions.html#flags
|:flag_meanings = "rejected invalid_acquis invalid_conversion invalid_swath invalid_sounding_row " | |
|:flag_mask = "1b,2b,4b,8b,16b,32b,64b" | |
|:long_name = "status" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|byte status_detail(swath, detection) | |detailed status for rejected sounding (byte field of status) -manual rejected manually by operator - rejected automatically -doubtfull (typically cube algorithm) -unknown rejected by another reason see http://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/cf-conventions.html#flags
|:flag_values = "1b,2b,3b,4b" | |
|:flag_meanings = "manual auto doubful unknown" | |
|:long_name = "status_detail" | |
|:coordinates = "detection_latitude detection_longitude" | |
| | |
|float swath_dynamic_draught(swath) |M |dynamic draught level interpolated for each swath (distance from nominal warter line, positif down)
|:units = "m" | |
|:long_name = "interpolated dynamic draught" | |
| | |
|float swath_tide(swath) |M |tide interpolated for each swath (distance from nominal warter line, positif down), tide is considered as the distance from the water line to the reference coordinate (could be geoid, ellipsoid, or chart datum specified in vertical reference attribute)
|:units = "m" | |
|:long_name = "interpolated tide" | |
| | |
|ulong swath_time(swath) |M |Timestamp at which each ping occurred.
|:calendar = "gregorian" | |
|:standard_name = "time" | |
|:units = "nanoseconds since 1970-01-01 00:00:00Z" | |
|:axis = "T" | |
|:long_name = "Time-stamp of each ping" | |
| | |
|float tx_center_frequency(swath, sector) |M |center frequency of transmit sector
|:long_name = "center frequency of transmit sector" | |
|:units = "Hz" | |
| | |
|float tx_tilt_angle(swath, sector) |M |the along ship steering angle of beam relative the transducer face in TACS coordinate system
|:long_name = "the along ship steering angle of beam relative the transducer face in TACS coordinate system" | |
|:crs = "TACS" | |
|float :valid_range = -90.0f, 90.0f | |
|:units = "arc_degree" | |
| | |
|float tx_transducer_zdepth(swath) |O |Tx transducer depth in meters below waterline, at time of midpoint of first tx pulse. For the tx array (head) used by this RX-fan. Use depth of TX1 to move depth point (XYZ) from water line to transducer (reference point of old datagram format).
|:units = "m" | |
|:long_name = "Tx transducer depth below waterline" | |
| | |
|float sample_interval(swath) |M |Time between individual samples along a beam. Common for all beams in a swath
|:units = "s" | |
|:valid_min = "0.0" | |
|:long_name = "interval between recorded raw data samples" | |
| | |
|float sample_time_offset(swath, sector) |M |Time offset applied to sample time-stamps and intended for applying a range correction (e.g. as caused by signal processing delays).Positive values reduce the calculated range to a sample. For multibeam echo sounder, this match the transmit sector time delay
|:units = "s" | |
|:valid_min = "0.0" | |
|:long_name = "Time offset that is subtracted from the timestamp of each sample (For multibeam echo sounder, this match the transmit sector time delay)" | |
| | |
|int sample_start_offset(swath, beam) |M |number of sample before the start of sample recording, this amount of empty sample should be added to the water column data
|:valid_min = "0" | |
|:long_name = "number of sample before the start of sample recording" | |
| | |
|int beam_detection_range(swath, beam) |0 |approximation for the main bottom detection range in sample
|:valid_min = "0" | |
|:long_name = "approximation of main bottom detection range in sample" | |
| | |
|short beam_sector(swath, beam) |O |sector associated with the given beam
|:valid_min = "0" | |
|:long_name = "sector associated with the given beam" | |
| | |
|int beam_rx_transducer_index(swath, beam) |O |receiving or monostatic transducer index associated with the given beam
|:valid_min = "0" | |
|:long_name = "receiving transducer index associated with the given beam" | |
|==============================================================================================================================================================================================================
|==============================================================================================================================================================================================================
|Description |Obligation |Comment
|Group attributes | |
|Dimensions | |
|time:time | |can be fixed or unlimited length, as appropriate
|Variables | |
|float draught_indicative(time) |M |mean dynamic draught level above WG84 at the given time
|:units = "m" | |
|:long_name = "indicative dynamic draught" | |
|:_FillValue = "0.0f" | |
| | |
|ulong time(time) |M |Time for the dynamic draught
|:calendar = "gregorian" | |
|:standard_name = "time" | |
|:units = "nanoseconds since 1970-01-01 00:00:00Z" | |
|:axis = "T" | |
|:long_name = "Timestamps for dynamic draught data" | |
|==============================================================================================================================================================================================================
|==============================================================================================================================================================================================================
|Description |Obligation |Comment
|Group attributes | |
|Dimensions | |
|frequency:frequency | |can be fixed or unlimited length, as appropriate
|sample:sample | |can be fixed or unlimited length, as appropriate, temporary use to prevent variable creation with no dimension
|Variables | |
|float absorption_indicative(frequency) |O |Indicative absorption values used to calculate the timevaried-gain (TVG), in the absence of more detailed data.
|float :valid_min = 0.0 | |
|:units = "dB/km" | |
|:long_name = "Indicative acoustic absorption" | |
| | |
|float sound_speed(sample) |M |Mean sound speed in water used to calculate echo range, in the absence of more detailed Sound-speed data.
|float :valid_min = 0.0 | |
|:standard_name = "speed_of_sound_in_sea_water" | |
|:units = "m/s" | |
|:long_name = "Indicative mean sound speed" | |
|==============================================================================================================================================================================================================
|==============================================================================================================================================================================================================
|Description |Obligation |Comment
|Group attributes | |
|:platform_code_ICES |O |Platform code from the ICES SHIPC vocabulary (http://vocab.ices.dk/services/pox/GetCodeList/SHIPC).
|:platform_name |O |Platform name of which the sonar is a part.
|:platform_type |O |Platform type that the sonar is part of. Use the description field from the ICES ”Platform Class” vocabulary (http://vocab.ices.dk/services/pox/GetCodeList/Platform%20Class).
|Types | |
|byte enum transducer_type_t {rx_transducer = 0, tx_transducer = 1, monostatic_transducer = 3 } | |transducer type indicate if the transducer is a Tx Transducer, Rx Transducer or both (monostatic)
|Dimensions | |
|transducer:transducer |M |transducer count
|position:position |M |position captor count
|MRU:MRU |M |MRU attitude captor count
|Variables | |
|float MRU_offset_x(MRU) |R |_x_-axis component of the vector from the platform coordinate system origin to the motion reference unit origin.
|:long_name = "Distance along +
the _x_-axis from the platform +
coordinate system origin to the +
motion reference unit sensor origin" | |
|:units = "m" | |
| | |
|float MRU_offset_y(MRU) |R |_y_-axis component of the vector from the platform coordinate system origin to the motion reference unit origin.
|:long_name = "Distance along +
the _y_-axis from the platform +
coordinate system origin to the +
motion reference unit sensor origin" | |
|:units = "m" | |
| | |
|float MRU_offset_z(MRU) |R |_z_-axis component of the vector from the platform coordinate system origin to the motion reference unit origin.
|:long_name = "Distance along +
the _z_-axis from the platform +
coordinate system origin to the +
motion reference unit sensor origin" | |
|:units = "m" | |
| | |
|float MRU_rotation_x(MRU) |R |Extrinsic angular rotation about the _x_-axis from the platform zero angle to the MRU zero angle.
|:long_name = "Extrinsic rotation +
about the _x_-axis from the platform +
to MRU coordinate systems" | |
|:units = "arc_degree" | |
|float :valid_range = -180.0f, 180.0f | |
| | |
|float MRU_rotation_y(MRU) |R |Extrinsic angular rotation about the _y_-axis from the platform zero angle to the MRU zero angle.
|:long_name = "Extrinsic rotation +
about the _y_-axis from the platform +
to MRU coordinate systems" | |
|:units = "arc_degree" | |
|float :valid_range = -180.0f, 180.0f | |
| | |
|float MRU_rotation_z(MRU) |R |Extrinsic angular rotation about the _z_-axis from the platform zero angle to the MRU zero angle.
|:long_name = "Extrinsic rotation +
about the _z_-axis from the platform +
to MRU coordinate systems" | |
|:units = "arc_degree" | |
|float :valid_range = -180.0f, 180.0f | |
| | |
|int MRU_ids(MRU) |R |MRU serial number
| | |
|int position_ids(position) |R |position captor serial number
| | |
|float position_offset_x(position) |R |Distance from the platform coordinate system origin to the latitude/longitude position origin along the _x_-axis.
|:long_name = "Distance along +
the _x_-axis from the platform +
coordinate system origin to the +
latitude/longitude sensor origin" | |
|:units = "m" | |
| | |
|float position_offset_y(position) |R |Distance from the platform coordinate system origin to the latitude/longitude position origin along the _y_-axis.
|:long_name = "Distance along +
the _y_-axis from the platform +
coordinate system origin to the +
latitude/longitude sensor origin" | |
|:units = "m" | |
| | |
|float position_offset_z(position) |R |Distance from the platform coordinate system origin to the latitude/longitude position origin along the _z_-axis.
|:long_name = "Distance along +
the _z_-axis from the platform +
coordinate system origin to the +
latitude/longitude sensor origin" | |
|:units = "m" | |
| | |
|float transducer_offset_x(transducer) |R |Distance from the platform coordinate system origin to the transducer along the _x_-axis.
|:long_name = "_x_-axis distance from the +
platform coordinate system +
origin to the sonar transducer" | |
|:units = "m" | |
| | |
|float transducer_offset_y(transducer) |R |Distance from the platform coordinate system origin to the transducer along the _y_-axis.
|:long_name = "_y_-axis distance from the +
platform coordinate system +
origin to the sonar transducer" | |
|:units = "m" | |
| | |
|float transducer_offset_z(transducer) |R |Distance from the platform coordinate system origin to the transducer along the _z_-axis.
|:long_name = "_z_-axis distance from the +
platform coordinate system +
origin to the sonar transducer" | |
|:units = "m" | |
| | |
|int transducer(transducer) |R |transducer serial number
| | |
|float transducer_rotation_x(transducer) |R |Extrinsic angular rotation about the _x_-axis from the platform zero angle to the coordinate system origin zero angle.
|float :valid_range = -180.0f, 180.0f | |
|:units = "arc_degree" | |
|:long_name = "Extrinsic rotation about the _x_-axis from the platform to reference coordinate systems" | |
| | |
|float transducer_rotation_y(transducer) |R |Extrinsic angular rotation about the _y_-axis from the platform zero angle to the coordinate system origin zero angle.
|float :valid_range = -180.0f, 180.0f | |
|:units = "arc_degree" | |
|:long_name = "Extrinsic rotation about the _y_-axis from the platform to reference coordinate systems" | |
| | |
|float transducer_rotation_z(transducer) |R |Extrinsic angular rotation about the _z_-axis from the platform zero angle to the coordinate system origin zero angle.
|float :valid_range = -180.0f, 180.0f | |
|:units = "arc_degree" | |
|:long_name = "Extrinsic rotation about the _z_-azis from the platform to reference coordinate systems" | |
| | |
|transducer_type_t transducer_type(transducer) |M |The type of transducer, might be rx , tx or monostatic
|:long_name = " type of transducer" | |
| | |
|float water_level |R |Distance from the origin of the platform coordinate system to the nominal water level measured along the _z_-axis of the platform coordinate system +
(positive values are below the origin). The distance between the nominal and actual water level is +
provided by vertical_offset.
|:long_name = "Distance from +
the platform coordinate system +
origin to the nominal water level +
along the _z_-axis" | |
|:units = "m" | |
|==============================================================================================================================================================================================================
|==============================================================================================================================================================================================================
|Description |Obligation |Comment
|Group attributes | |
|Variables | |
|==============================================================================================================================================================================================================
|==============================================================================================================================================================================================================
|Description |Obligation |Comment
|Group attributes | |
|:string |O |System description
|Dimensions | |
|time:time | |can be fixed or unlimited length, as appropriate
|Variables | |
|float course_over_ground(time) |O |a vessel course is the cardinal direction along which the vessel or aircraft is to be steered
|:standard_name = "platform_course" | |
|:units = "m/s" | |
|:long_name = "degree" | |
| | |
|float heading(time) |O |Heading refers to the direction a vessel is pointing. This may or may not be the direction that the vessel actually travels, which is known as its course or track. Any difference between course and heading is due to the motion of the underlying medium, the air or water, or other effects like skidding or slipping. Heading is typically based on compass directions, so 0° (or 360°) indicates a direction toward true North, 90° indicates a direction toward true East, 180° is true South, and 270° is true West.
|:standard_name = "platform_orientation" | |
|:units = "degree" | |
|:long_name = "Platform heading(true)" | |
| | |
|float height_above_reference(time) |O |height of the vessel reference point above reference coordinate system (could be geoid, ellipsoid, or chart datum specified in vertical reference attribute)
|:grid_mapping = "vertical_reference" | |
|:units = "m" | |
|:long_name = "height_above_reference" | |
| | |
|double latitude(time) |M |latitude of the vessel reference point in WGS-84 reference system
|double:valid_min = -90 | |
|double:valid_max = 90 | |
|:standard_name = "latitude" | |
|:units = "degrees_north" | |
|:long_name = "latitude" | |
|double:_FillValue = Double.NaN | |
| | |
|double longitude(time) |M |latitude of the vessel reference point in WGS-84 reference system
|double:valid_min = -180 | |
|double:valid_max = 180 | |
|:standard_name = "longitude" | |
|:units = "degrees_east" | |
|:long_name = "longitude" | |
|double:_FillValue = Double.NaN | |
| | |
|float speed_over_ground(time) |O |Speed is the magnitude of velocity. The platform speed with respect to ground is relative to the solid Earth beneath it, i.e. the sea floor for a ship.
|:standard_name = "platform_speed_wrt_ground" | |
|:units = "m/s" | |
|:long_name = "speed_over_ground" | |
| | |
|ulong time(time) |M |Time from position captor
|:calendar = "gregorian" | |
|:standard_name = "time" | |
|:units = "nanoseconds since 1970-01-01 00:00:00Z" | |
|:axis = "T" | |
|:long_name = "Time from position captor" | |
| | |
|int vertical_reference(time) |M |see 5.6. Horizontal Coordinate Reference Systems, Grid Mappings, and Projections in cf-convention
|:grid_mapping_name = " " | |
|==============================================================================================================================================================================================================
|==============================================================================================================================================================================================================
|Description |Obligation |Comment
|Group attributes | |
|:conversion_software_name |MA |Name of the software used to do the conversion.
|:conversion_software_version |MA |Version of the software used to do the conversion.
|:conversion_time |MA |Date and time of the start of the conversion process in extended ISO8601:2005 extended format, including time zone.
|Dimensions | |
|filenames:filenames | |Can be of fixed or unlimited length, as appropriate.
|Variables | |
|string source_filenames(filenames) |MA |Vector of datafile names that were used to generate the data in this SONARnetCDF4 file.
|:long_name = "Source filenames" | |
|==============================================================================================================================================================================================================
|==============================================================================================================================================================================================================
|Description |Obligation |Comment
|Group attributes | |
|string :conventions |M |A comma-separated list of the conventions followed in the file. Include the XSF convention and version (e.g. ”XSF-1.0”) and the relevant CF and ACDD conventions (e.g. ”CF-1.7” and ”ACDD-1.3”).
|string :institution |M |The name of the institution principally responsible for originating this data. This attribute is recommended by the CF convention.
|string :title |M |A short phrase or sentence describing the dataset. For direct generated files, this can be as simple as "Files generated by the XYZ sonar ".
|string :summary |M |A paragraph describing the dataset, analogous to an abstract for a paper. For direct generated files, this can be blank.
|string :xsf_convention_version |M |version number in the form “major.minor”, where major and minor are non-negative integers.
|string :date_created |M |Timestamp of file creation in ISO8601:2004 extended format, including the time zone (e.g. 2017- 05-06T20:21:35Z).
|string :source |M |The method of production of the original data. If it was model-generated, source should name the model and its version. If it is observational, source should characterize it. This attribute is defined in the CF Conventions. Examples: 'temperature from CTD #1234'; 'world model v.0.1'.
|string :date_modified |O |The date on which the data was last modified. Note that this applies just to the data, not the metadata. The ISO 8601:2004 extended date format is recommended, as described in the Attributes Content Guidance section.
|string :license |O |Either enter the URL to a standard or specific license, enter “Freely distributed” or “None”, or describe any restrictions to data access and distribution in free text.
|string :rights |O |Description of the usage rights of data in the file.
|Variables | |
|double crs |O | A container variable storing information about the grid_mapping. All the attributes within a grid_mapping variable are described in http://cfconventions.org/Data/cf-conventions/cf-conventions-1.6/build/cf-conventions.html#grid-mappings-and-projections. For all the measurements based on WSG84, the default coordinate system used for GPS measurements, the values shown here should be used.
|:grid_mapping_name = "latitude_longitude" | |
|:epsg_code = "EPSG:4326" | |
|:semi_major_axis = "6378137.0d" | |
|:inverse_flattening  = "298.257223563d" | |
|double:_FillValue = Double.NaN | |
|==============================================================================================================================================================================================================