realTimeloads-package: Tools For Computing Loads From Real-time Estimates of...

realTimeloads-packageR Documentation

Tools For Computing Loads From Real-time Estimates of Concentration and Discharge with Code for Processing Acoustic Backscatter

Description

Code for computing loads from real-time estimates of concentration and discharge and processing of acoustic backscatter from acoustic Doppler velocimeters (ADVM) and acoustic Doppler current profilers (ADCP) per Livsey (in review)

Functions

acoustic_backscatter_processing Process acoustic backscatter from horizontally profiling ADVM/ADCP

attenuation_of_sound_by_water Computes attenuation of sound in water for acoustic backscatter processing

bootstrap_regression Compute regression parameters with uncertainty from analyte(surrogate(s))

butterworth_tidal_filter Estimate non-tidal variabilty using butterworth filter of Rulh and Simpson (2005)

compute_load Compute analyte load from surrogate, regression, and discharge data

ctd2sal Convert conductance to salinity in PSU

estimate_timeseries Estimate timeseries with uncertainty using outputs from bootstrap_regression() and timeseries of surrogate(s)

ExampleCode Process acoustic backscatter from synthetic data detailed in Livsey et al (in review)

ExampleCodeSCI Compute load from synthetic data using "Sediment Composition Index" (SCI) after Livsey et al (2023)

hADCPLoads Process acoustic backscatter from user data and compute load using list generated by import_Data()

import_data Import data from files in user-specified folder for use in hADCPLoads()

impute_data impute non-tidal or tidal data using ARIMA and decision tree algorithms

linear_interpolation_with_time_limit Interpolate timeseries onto new timestep, Nan returned when nearest observation exceeds time limit specified

near_field_correction Compute near-field correction for acoustic backscatter processing

speed_of_sound Compute speed of sound in water for acoustic backscatter processing

surrogate_to_analyte_interpolation Pair surrogate timeseries t(x) to analyte sample times t(y)

Author(s)

Daniel Livsey (2023) ORCID: 0000-0002-2028-6128

References

Livsey, D.N. (in review). National Industry Guidelines for hydrometric monitoring–Part 12: Application of acoustic Doppler velocity meters to measure suspended-sediment load. Bureau of Meteorology. Melbourne, Australia.


realTimeloads documentation built on Oct. 18, 2023, 5:09 p.m.