ctdam.parser.processing_steps module

class ctdam.parser.processing_steps.CnvProcessingSteps(raw_processing_info)[source]

Bases: UserList

A python representation of the individual ctdam.proc steps conducted in the process of a cnv file creation. These modules are stored in a dictionary structure, together with all the variables/metadata/etc. given in the header of a cnv file.

Parameters:

raw_processing_info (list) – The processing metadata lines of a .cnv file

get_names()[source]

Return the processing step names.

Return type:

list[str]

extract_individual_modules(raw_info)[source]

Helper function to extract processing modules from raw .cnv info.

Parameters:

raw_info (list[str]) – A list of metadata lines

Return type:

list

create_step_instance(module, raw_info)[source]

Create a new ProcessingStep instance.

Parameters:
  • module (str) – The name of the step

  • raw_info (list[str]) – The key-value style metadata lines

Return type:

ProcessingStep

get_step(step)[source]

Getter for ProcessingSteps.

Parameters:

step (str) – The step to get

Return type:

ProcessingStep | None

add_info(module, key, value)[source]

Adds new processing lines to the list of processing module information

Parameters:
  • module (str) – The name of the processing module

  • key (str) – The description of the value

  • value (str) – The information

Return type:

ProcessingStep | None

class ctdam.parser.processing_steps.ProcessingStep(name, metadata)[source]

Bases: object

Class that is meant to represent one individual processing step.

A processing step is one single task that changed the data of a CTD cast.

Parameters:
  • name (str) – The name of the step

  • metadata (dict) – The metadata information for this step