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, cg_corrected: bool = False, direction: Literal['ram', 'anti-ram', 'full'] = 'full', map_spacing: int = 4) → RectangularSkyMap

Project Hi PSET data into a rectangular 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.

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

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

• map_spacing (int, Optional) – Pixel spacing, in degrees, of the output map in degrees. Defaults to 4.

Returns:

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

Return type:

RectangularSkyMap