imap_processing.codice.codice_l1a.CoDICEL1aPipeline#

class imap_processing.codice.codice_l1a.CoDICEL1aPipeline(table_id: int, plan_id: int, plan_step: int, view_id: int)#

Contains methods for processing L0 data and creating L1a data products.

Parameters:

  • 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.

apply_despinning()#

Apply the despinning algorithm to lo- angular and priority products.

decompress_data(science_values)#

Perform decompression on the data.

define_coordinates()#

Create xr.DataArrays for the coords needed in the final dataset.

define_data_variables()#

Define and add the appropriate data variables to the dataset.

define_dimensions()#

Define the dimensions of the data arrays for the final dataset.

define_energy_bins()#

Define/add variables to the dataset that correspond to the energy bins.

define_support_variables()#

Define and add ‘support’ CDF data variables to the dataset.

get_acquisition_times()#

Retrieve the acquisition times via the Lo stepping table.

get_energy_table()#

Retrieve the ESA sweep values.

get_hi_energy_table_data(species)#

Retrieve energy table data for CoDICE-Hi products

reshape_binned_data(dataset)#

Reshape data arrays for binned datasets.

reshape_data()#

Reshape the data arrays based on the data product being made.

set_data_product_config()#

Set the various settings for defining the data products.

__init__(table_id: int, plan_id: int, plan_step: int, view_id: int)#

Initialize a CoDICEL1aPipeline class instance.

Methods

__init__(table_id, plan_id, plan_step, view_id)

Initialize a CoDICEL1aPipeline class instance.

apply_despinning()

Apply the despinning algorithm to lo- angular and priority products.

decompress_data(science_values)

Perform decompression on the data.

define_coordinates()

Create xr.DataArrays for the coords needed in the final dataset.

define_data_variables()

Define and add the appropriate data variables to the dataset.

define_energy_bins(dataset, species)

Define/add variables to the dataset that correspond to the energy bins.

define_support_variables(dataset)

Define and add 'support' CDF data variables to the dataset.

get_acquisition_times()

Retrieve the acquisition times via the Lo stepping table.

get_energy_table()

Retrieve the ESA sweep values.

get_hi_energy_table_data(species)

Retrieve energy table data for CoDICE-Hi products.

reshape_binned_data(dataset)

Reshape data arrays for binned datasets.

reshape_data()

Reshape the data arrays based on the data product being made.

set_data_product_config(apid, dataset)

Set the various settings for defining the data products.