files_to_map#

sunkit_instruments.suvi.files_to_map(files, despike_l1b=False, only_long_exposures=False, only_short_exposures=False, only_short_flare_exposures=False)[source]#

Read SUVI L1b FITS or netCDF files or L2 HDR composite FITS files and return a Map or a MapSequence. For SUVI L1b FITS files, the broken FITS header is fixed automatically (broken because of the wrong implementation of the CONTINUE convention).

Note

The first file in the (sorted, if sort_files=True) list determines what will be accepted further on, i.e. L2 HDR composites or L1b files. If L1b files are appearing in a file list that started with an L2 HDR composite, they will be rejected (and vice versa). The type of file is determined by pattern matching in the filenames, e.g. “-L1b-Fe171” for a 171 L1b file and “-l2-ci171” for a 171 L2 HDR composite. If those patterns are not found in the filename, the files will not be recognized.

Parameters:
  • files (str or list of str) – File(s) to read.

  • despike_l1b (bool, optional. Default: False.) – If True and input is L1b, data will get despiked with the standard filter_width=7. Can not be used for early SUVI files where the DQF extension is missing.

  • only_long_exposures (bool, optional. Default: False.) – If True, only long exposure L1b files from the input list will be accepted and converted to a map. Ignored for L2 HDR composites.

  • only_short_exposures (bool, optional. Default: False.) – If True, only short exposure L1b files from the input list will be accepted and converted to a map. Ignored for L2 HDR composites and any wavelengths other than 94 and 131 (because for everything >131, there are no observations that are labeled “short”, only “long” and “short_flare”).

  • only_short_flare_exposures (bool, optional. Default: False.) – If True, only short flare exposure L1b files from the input list will be accepted and converted to a map. Ignored for L2 HDR composites.

Returns:

A map (sequence) of the SUVI data, or None if no data was found matching the given criteria.

Return type:

Map, MapSequence, or None.