adpCombine: ADCP Combine

View source: R/adcpToolbox.R

adpCombineR Documentation

ADCP Combine

Description

Combines archived data and metadata from raw, odf and netCDF sources into adp object which can be exported as netCDF or saved

@details If either netCDF or Raw file is unavailable this function can still run, however if only ODF files are available please use only odf2adp to combine odf files If netCDF file is missing some metadata may be required to be added manually. If raw file is missing dataset will not be complete but will include null values where set is missing data. Either way the object produced can still be passed to adpNC() for export.

Usage

adpCombine(adp, raw, ncin = "", dt = NULL)

Arguments

adp

an adp object sourced from ODF files using odf2adp

raw

a raw ADCP file (.000)

ncin

an archived netCDF file (.nc)

dt

The time offset to be applied to raw data in order to match times produced in ODF files. If left NULL the script will use the default action used in the program which wrote the ODF files which is to add 1/2 the sampling interval to each time value. Where sampling interval = pingsPerEnsemble * ensembleInterval

Details

a) Raw file (.000)

Contains:

Data: heading, pressure, sound speed data, BEAM_02-_04, PGDP_02-_04, PTCH, ROLL, HGHT, Tx, D( D is not actually equal to depth values recorded in raw file but calculated using swDepth from recorded pressure values)

Metadata: firmwareVersion, frequency, beamPattern, orientation, beamAngle, numberOfBeams (janus), pingsPerEnsemble, velocityResolution (pred_accuracy), lowCorrThresh (valid_correlation_range), percentGdMinimum (minmax_percent_good), errorVelocityMaximum (error_velocity_threshold), xmitPulseLength (transmit_pulse_length), falseTargetThresh (false_target_reject_values), serialNumber, instrumentType(data_type), bin1Distance

b) Archived netCDF

Contains:

Data: BEAM_02-_04, PGDP_02-_04, PTCH, ROLL, HGHT, Tx, D ***note this DATA is pulled from the RAW file in case NC file is corrupted or missing

Metadata: creation_date, start_time, stop_time, inst_type, history, , , , transform, data_subtype, coord_system, water_mass, , , , var_fill, experiment, project, descript, data_cmnt, fill_flag, , magnetic_variation, , delta_t_sec, time_between_ping_groups, depth: xducer_offset_from_bottom, depth: bin_size

c) Archived ODFs (series for each mooring)

Contains:

Data: PROCESSED EWCT, NSCT, VCSP, ERRV, BEAM_01 (!which is actually the average echo intensity), PGDP_04, time, distance

Metadata: units (v, distance), cellSize, numberOfBeams, orientation, model, type, serialNumber, ship (platform), scientist (chief_scientist), institution (data_origin), cruise (cruise_name), station (mooring), countryInstituteCode, cruiseNumber, startTime, latitude, longitude, waterDepth, sounding

Note: The time offset is a major source of error, not all files were produced in the same format some times may have no offset, some files may have offset up to a few hours. Be careful when selecting a value for dt, if NULL is not working please investigate within the ODF and raw files to calculate or attempt to match the times.

See Also

Other odf: odf2adp

Other NC: adpNC, oceNc_create

Other processing: limit_depthbytime, limit_time, oceNc_create


Echisholm21/mooredDataProcessing_adcp documentation built on March 29, 2022, 2:22 p.m.