Get object inp for synchronization
getInpSync( sync_dat, max_epo_diff, min_hydros, time_keeper_idx, fixed_hydros_idx, n_offset_day, n_ss_day, keep_rate = 1, excl_self_detect = TRUE, lin_corr_coeffs = NA, ss_data_what = "est", ss_data = c(0), silent_check = FALSE )
sync_dat | List containing data.tables with hydrophone information and detections. See e.g. `?ssu1` for example |
---|---|
max_epo_diff | Sets the upper threshold for differences in TOA of sync tags. Best parameter value depends on burst rate of sync tags and how far apart the internal clocks of the hydros are prior to synchronization. A bit less than half of minimum sync tag burst rate is a good starting choice. |
min_hydros | Sets the lower threshold of how many hydrophones need to detect each sync tag ping in order to be included in the sync process. Should be as high as possible while observing that all hydrosphones are contributing. If too low, isolated hydrophones risk falling out completely. Future versions will work towards automising this. |
time_keeper_idx | Index of the hydrophone to use as time keeper. Could e.g. be the one with smallest overall clock-drift. |
fixed_hydros_idx | Vector of hydro idx's for all hydrophones where the position is assumed to be known with adequate accuracy and precission. Include as many as possible as fixed hydros to reduce overall computation time and reduce overall variability. As a bare minimum two hydros need to be fixed, but we strongly advice to use more than two. |
n_offset_day | Specifies the number of hydrophone specific quadratic polynomials to use per day. For PPM based systems, 1 or 2 is often adeqaute. |
n_ss_day | Specifies number of speed of sound to estimate per day if no ss data is supplied. It is recommended to use logged water temperature instead. However, estimating SS gives an extra option for sanity-checking the final sync-model. |
keep_rate | Syncing large data sets can take a really long time. However, there is typically an excess number of sync tag detections and a sub-sample is typically enough for good synchronization. This parameter EITHER specifies a proportion (0-1) of data to keep when sub-sampling OR (if keep_rate > 10) number of pings (approximate) to keep in each hydro X offset_idx combination if enough exists. |
excl_self_detect | Logical whether to excluded detections of sync tags on the hydros they are co-located with. Sometimes self detections can introduce excessive residuals in the sync model in which case they should be excluded. |
lin_corr_coeffs | Matrix of coefficients used for pre-sync linear correction. dim(lin_corr_coeffs)=(#hydros, 2). |
ss_data_what | Indicates whether to estimate ("est") speed of sound or to use data based on logged water temperature ("data"). |
ss_data | data.table containing timestamp and speed of sound for the entire period to by synchronised. Must contain columns 'ts' (POSIXct timestamp) and 'ss' speed of sound in m/s (typical values range 1400 - 1550). |
silent_check | Logical whether to get output from checkInpSync(). Default is FALSE |