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 file.

  • A directory containing files.

  • A glob pattern matching multiple files (for example, eit_*.fits).

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

  • An existing GenericMap.

  • A tuple of (data, metadata) or (data, wcs), where metadata is a dict (including MetaDict) or an astropy.io.fits.Header, and wcs is an astropy.wcs.WCS.

  • A data array followed immediately by that same metadata or astropy.wcs.WCS.

  These inputs can be mixed in one call, but any data array must be immediately followed by its metadata or WCS.

• 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)