imap_processing.codice.codice_l1a.get_params

imap_processing.codice.codice_l1a.get_params(dataset: Dataset) → tuple[int, int, int, int]

Return the four ‘main’ parameters used for l1a processing.

The combination of these parameters largely determines what steps/values are used to create CoDICE L1a data products and what steps are needed in the pipeline algorithm.

Parameters:

dataset (xarray.Dataset) – The dataset for the APID of interest. We expect each packet in the dataset to have the same values for the four main parameters, so the first index of the dataset can be used to determine them.

Returns:

• table_id (int) – A unique ID assigned to a specific table configuration. This field is used to link the overall acquisition and processing settings to a specific table configuration.

• plan_id (int) – The plan table that was in use. In conjunction with plan_step, describes which counters are included in the data packet.

• plan_step (int) – Plan step that was active when the data was acquired and processed. In conjunction with plan_id, describes which counters are included in the data packet.

• view_id (int) – Provides information about how data was collapsed and/or compressed.