processing.module module

class processing.module.Module

Bases: ABC

An interface to implement new processing modules against.

Is meant to perform and unify all the necessary work that is needed to streamline processing on Sea-Bird CTD data. Implementing classes should only overwrite the transformation method, that does the actual altering of the data. All other organizational overhead should be covered by this interface. This includes parsing to .cnv output with correct handling of the metadata header.

shortname = ''

longname = ''

unit = ''

add_processing_metadata()

Parses the module processing information into cnv-compliant metadata lines.

These take on the form of {MODULE_NAME}_{KEY} = {VALUE} for every key-value pair inside of the given dictionary with the modules processing info.

load_file(file_path)

Loads the target files information into an CnvFile instance.

Parameters:

file_path (Path :) – Path to the target file.

Return type:

CnvFile object representing the file in the file system.

abstractmethod to_cnv()

class processing.module.ArrayModule

Bases: Module

abstractmethod transformation()

Return type:

bool

to_cnv()

class processing.module.DataFrameModule

Bases: Module

abstractmethod transformation()

The actual data transformation on the CTD data.

Needs to be implemented by the implementing classes.

Return type:

DataFrame

to_cnv(additional_data_columns=[], custom_data_columns=None)

Writes the internal CnvFile instance to disk.

Uses the CnvFile’s output parser for that and organizes the different bits of information for that.

Parameters:

• additional_data_columns (list[str] :) –

  A list of columns that in addition to the ones inside the original dataframe.

  (Default value = [])

• custom_data_columns (list | None :) –

  A list of coulumns that will exclusively used to select the data items for the output .cnv .

  (Default value = None)

to_csv()

Writes the dataframe as .csv to disk.

exception processing.module.MissingParameterError(step_name, parameter_name)

Bases: Exception

A custom error to throw when necessary parameters are missing from the input .cnv file.