imap_processing.hi.hi_l2.calculate_ena_intensity#

imap_processing.hi.hi_l2.calculate_ena_intensity(map_ds: Dataset, l2_ancillary_path_dict: dict[str, Path], descriptor: MapDescriptor) Dataset#

Calculate the ena intensities.

Parameters:
  • map_ds (xarray.Dataset) – Map dataset that has ena_signal_rate fields calculated.

  • l2_ancillary_path_dict (dict[str, pathlib.Path]) – Mapping containing ancillary file descriptors as keys and file paths as values. Require keys are: [“cal-prod”, “esa-energies”, “esa-eta-fit-factors”].

  • descriptor (imap_processing.ena_maps.utils.naming.MapDescriptor) – Output filename descriptor. Contains full configuration for the options of how to generate the map. For this function, the principal data string is used to determine if a flux correction should be applied.

Returns:

map_ds – Map dataset with new variables: ena_intensity, ena_intensity_stat_uncert, ena_intensity_sys_err.

Return type:

xarray.Dataset