ctdam.conv package

Submodules

ctdam.conv.cast_borders module

ctdam.conv.cast_borders.smoothing(x)[source]
Return type:

ndarray

ctdam.conv.cast_borders.get_cast_borders(pressure, downcast_only=True, min_size_factor=0.01, min_soak_window=100, max_fd_quotient=6, prominence_divisor=7, win_size_divisor=500, min_velocity_quotient=15, min_velocity=0.045)[source]

Gets the borders of a given cast.

Return type:

dict

ctdam.conv.cast_borders.get_downcast_end(smoothed_pressure, first_derivative, second_derivative)[source]

Gets the downcast end of a given cast, accounting for heave due to waves. Returns the index of the highest pressure where the descent rate is below min_descent_rate.

Return type:

int

Parameters:

pressurenp.ndarray

The pressure array.

Returns:

: The index of the end of the downcast.

ctdam.conv.cast_borders.get_downcast_start(first_derivative, second_derivative, base_data_size, min_soak_window=100, max_fd_quotient=6, prominence_divisor=7, win_size_divisor=500, min_velocity_quotient=15, min_velocity=0.045)[source]

Gets the downcast start of a given cast, removing soaking/waiting time. Returns the index where the CTD begins to continuously move downward.

Return type:

Tuple[int, list, list]

Parameters:

pressurenp.ndarray

The pressure array.

Returns:

: The index of the start of the downcast.

ctdam.conv.cast_borders.get_upcast_start(ind_dc_end, smooth_velo)[source]
Return type:

int | None

ctdam.conv.cast_borders.get_upcast_end(ind_dc_end, smooth_velo)[source]
Return type:

int | None

ctdam.conv.hexdecoder module

ctdam.conv.hexdecoder.hex_reading(hex)[source]
Return type:

DataFrame

ctdam.conv.hexdecoder.sorting_parameters(sensor_info, rule=['Pressure', 'Temperature', 'Temperature2', 'Conductivity', 'Conductivity2'])[source]
Return type:

list

ctdam.conv.hexdecoder.get_time_gaps(raw_data)[source]
ctdam.conv.hexdecoder.handle_time(gap_sizes, hex, data_size, parameters)[source]
ctdam.conv.hexdecoder.decode_hex(hex, xmlcon='', downcast_only=True, **kwargs)[source]
Return type:

CTDData

ctdam.conv.parameter_mapping module

class ctdam.conv.parameter_mapping.ParameterMapping(xmlcon_part, raw_data, parameters, voltage_sensors_start=6)[source]

Bases: object

extract_coefficients(source)[source]
locate_sensor_data(raw_data)[source]
Return type:

ndarray | None

create_parameter(data, metadata={}, name='')[source]
convert_freq_temperature()[source]
convert_temperature()[source]
convert_pressure()[source]
convert_conductivity()[source]
convert_salinity(conductivity, t_values, p_values)[source]
convert_sbe43_oxygen(voltage, temperature, pressure, salinity, coefs, apply_tau_correction=False, apply_hysteresis_correction=False, window_size=1, sample_interval=1)[source]

Overwrite of Sea-Birds super slow function.

convert_oxygen()[source]
convert_oxygen_pyro_science()[source]
map_metadata(name='')[source]
Return type:

dict

Module contents