Map

sunpy.map.Map = <sunpy.map.map_factory.MapFactory object>

A factory for generating coordinate aware 2D images.

This factory takes a variety of inputs, such as file paths, wildcard patterns or (data, header) pairs.

Depending on the input different return types are possible.

Parameters:

• *inputs – Inputs to parse for map objects. This can be one or more of the following:

  • A string or Path object pointing to a FITS file.

  • A directory containing FITS files (if there is more than one FITS file in the directory, it will return a list of Map objects).

  • A tuple containing a data array and a header (for modifying the data or header).

  • A MetaDict object, which includes data and metadata as a dictionary-like object.

  • An astropy.wcs.WCS object, which represents the World Coordinate System for the data.

  • A glob pattern to match multiple FITS files (e.g., eit_*.fits).

  • A URL pointing to a FITS file (can be remote).

  • A combination of any of the above inputs.

• sequence (bool, optional) – Return a sunpy.map.MapSequence object comprised of all the parsed maps.

• composite (bool, optional) – Return a sunpy.map.CompositeMap object comprised of all the parsed maps.

Returns:

• sunpy.map.GenericMap – If the input results in a singular map object, then that is returned.

• list of GenericMap – If multiple inputs are given and sequence=False and composite=False (the default) then a list of GenericMap objects will be returned.

• sunpy.map.MapSequence – If the input corresponds to multiple maps and sequence=True is set, then a MapSequence object is returned.

• sunpy.map.CompositeMap – If the input corresponds to multiple maps and composite=True is set, then a CompositeMap object is returned.

Examples

>>> import sunpy.map
>>> from astropy.io import fits
>>> import sunpy.data.sample
>>> mymap = sunpy.map.Map(sunpy.data.sample.AIA_171_IMAGE)