ocmw.dataman.adcp2netcdf module

Tools for standardizing the conversion of ADCP data to netCDF4 format for archiving and analysis.

metaDataObj	Data object for collating instrument deployment and data processing metadata.
create_adcp_netcdf	Create a generic netCDF data file structure
add_adcp_array_fields	Add specific ADCP array field data structures
build_adcp_netcdf	Build a netCDF4 data file for a specific instrument
populate_sig_core	Populate the core data for a Nortek Signature NetCDF4 file from pre-processed data in matlab format.
populate_sig_fields	Populate the data fields for a Nortek Signature NetCDF4 file from pre-processed data in matlab format.
populate_adcp_core	Populate the core data for an RDI Workhorse NetCDF4 file from pre-processed data in ReDAPT matlab format.
populate_adcp_fields	Populate the data fields for an RDI Workhorse NetCDF4 file from pre-processed data in ReDAPT matlab format.

Tools for standardizing the conversion of ADCP data to netCDF4 format for archiving and analysis.

class ocmw.dataman.adcp2netcdf.metaDataObj

Bases: object

Data object for collating instrument deployment and data processing metadata.

ocmw.dataman.adcp2netcdf.check_path(path)

ocmw.dataman.adcp2netcdf.is_correct_file_extension(filename, extension)

ocmw.dataman.adcp2netcdf.set_file_extension(filename, extension)

ocmw.dataman.adcp2netcdf.check_file(path, filename, extension)

ocmw.dataman.adcp2netcdf.create_adcp_netcdf(ncfilename, num_beams=None, num_bins=None, num_recs=None)

Create a generic netCDF data file structure

ocmw.dataman.adcp2netcdf.add_beam_amplitude(ncfile, num_beams)

Add beam amplitude data structure

ocmw.dataman.adcp2netcdf.add_beam_correlation(ncfile, num_beams)

Add beam correlation data structure

ocmw.dataman.adcp2netcdf.add_beam_percent_good(ncfile, num_beams)

Add beam percent good data structure

ocmw.dataman.adcp2netcdf.add_beam_vel(ncfile, num_beams)

Add beam velocity data structure

ocmw.dataman.adcp2netcdf.add_inst_vel(ncfile, num_beams=4)

Add instrument coordinate velocity data structure

ocmw.dataman.adcp2netcdf.add_earth_vel(ncfile)

Add earth coordinate horizontal velocity data structure

ocmw.dataman.adcp2netcdf.add_vertical_vel(ncfile)

Add earth coordinate vertical velocity data structure

ocmw.dataman.adcp2netcdf.add_qc_data(ncfile)

Add quality control data structure

ocmw.dataman.adcp2netcdf.add_stream_vel(ncfile)

Add streamwise coordinate horizontal velocity data structure

ocmw.dataman.adcp2netcdf.add_adcp_array_fields(ncfilename, fields: list, num_beams)

Add specific ADCP array field data structures

ocmw.dataman.adcp2netcdf.build_adcp_netcdf(path: str, filename: str, fields: list, num_beams=None, num_bins=None, num_recs=None)

Build a netCDF4 data file for a specific instrument

ocmw.dataman.adcp2netcdf.populate_sig_core(datpath, datfilename, ncpath, ncfilename, metadata)

Populate the core data for a Nortek Signature NetCDF4 file from pre-processed data in matlab format.

ocmw.dataman.adcp2netcdf.populate_sig_fields(datpath, datfilename, ncpath, ncfilename, fields, indices, metadata)

Populate the data fields for a Nortek Signature NetCDF4 file from pre-processed data in matlab format.

ocmw.dataman.adcp2netcdf.populate_adcp_core(datpath, datfilename, ncpath, ncfilename)

Populate the core data for an RDI Workhorse NetCDF4 file from pre-processed data in ReDAPT matlab format.

ocmw.dataman.adcp2netcdf.populate_adcp_fields(datpath, datfilename, ncpath, ncfilename, fields, indices)

Populate the data fields for an RDI Workhorse NetCDF4 file from pre-processed data in ReDAPT matlab format.