Assign altitude (height above sea floor) to each bin

Assign altitude (height above sea floor) to each bin

Usage

adcp_assign_altitude(
  dat_wide,
  metadata = NULL,
  inst_alt = NULL,
  bin_size = NULL,
  first_bin_range = NULL
)

Arguments

dat_wide

Data frame of ADCP data, as exported from adcp_read_txt().

metadata

Data frame with metadata information for the deployment in dat_wide (e.g., a row from CURRENT & WAVE TRACKING). Must include columns sensor_height_above_sea_floor_m, bin_size_m, and first_bin_range_m. Option to use default value metadata = NULL and provide the required values in the remaining arguments.

inst_alt

Height of the sensor above the sea floor (in metres). Not used if metadata argument is specified.

bin_size

Size of each bin (in metres). Not used if metadata argument is specified.

first_bin_range

Distance from the transducer face to the centre of the first bin (in metres). Not used if metadata argument is specified.

Value

Returns dat_wide, with bin columns re-named with corresponding altitude (in metres).

Details

The height to the centre of the bins is calculated as:

first bin altitude = inst altitude + first bin range

second bin altitude = first bin altitude + bin size

third bin altitude = second bin altitude + bin size

And so on.