imap_processing.hi.hi_l2.generate_hi_map

imap_processing.hi.hi_l2.generate_hi_map(psets: list[str | Path], geometric_factors_path: str | Path, esa_energies_path: str | Path, output_map: AbstractSkyMap, cg_corrected: bool = False, spin_phase: str = 'full') → AbstractSkyMap

Project Hi PSET data into a sky map.

Parameters:

• psets (list of str or pathlib.Path) – List of input PSETs to make a map from.

• geometric_factors_path (str or pathlib.Path) – Where to get the geometric factors from.

• esa_energies_path (str or pathlib.Path) – Where to get the energies from.

• output_map (AbstractSkyMap) – The map object to collect data into. Determines pixel spacing, coordinate system, etc.

• cg_corrected (bool, Optional) – Whether to apply Compton-Getting correction to the energies. Defaults to False.

• spin_phase (str, Optional) – Apply filtering to PSET data include ram or anti-ram or full spin data. Defaults to “full”.

Returns:

sky_map – The sky map with all the PSET data projected into the map.

Return type:

AbstractSkyMap