def make_map(*args, **kwargs):
"""Processes one or more inputs and returns a Map, MapCube, or CompositeMap
instance.
Parameters
----------
args : filepath(s), data array
The data source used to create the map object. This can be either a
filepath to an image, a 2d list, or an ndarray.
type : {'composite' | 'cube'}
Type of multimap to construct when passed more than one input. The
default choice is a CompositeMap which is more lenient with respect
to how similar the input data is.
Returns
-------
out : Map, MapCube, CompositeMap
Returns a subclass instance
Examples
--------
>>> import sunpy
>>> sunpy.make_map("file.fts")
>>> sunpy.make_map("file1.fts", "file2.fts",..)
>>> sunpy.make_map(["file1.fts", "file2.fts",..])
>>> sunpy.make_map("path/to/files/*.fts")
>>> sunpy.make_map(Map)
>>> sunpy.make_map(Map1, Map2,..)
>>> sunpy.make_map([[0, 1],[2, 3]], {'telescop': 'sunpy',..})
"""
if len(args) is 0:
raise TypeError("Invalid input.")
# First check to see if data/header were passed in
if isinstance(args[0], list) or isinstance(args[0], np.ndarray):
data = None
# n-dimensional list
if isinstance(args[0][0], list) or isinstance(args[0], np.ndarray):
data = args[0]
else:
try:
float(args[0][0])
except (ValueError, TypeError):
pass
else:
# 1-dimensional data
data = args[0]
# if either of the above cases hold, then create a new Map
if data is not None:
if len(args) > 1:
return Map(args[0], args[1])
else:
return Map(args[0], {})
# If not, check for one or more maps or filepaths
if len(args) == 1:
# String
if isinstance(args[0], basestring):
filepath = os.path.expanduser(args[0])
# Wildcard string
if filepath.find("*") != -1:
import glob
maps = glob.glob(filepath)
# Directory (use all files)
elif os.path.isdir(filepath):
maps = [os.path.join(filepath, x) for x in os.listdir(filepath)]
# Filepath
else:
return Map.read(filepath)
# Map/MapCube/CompositeMap
elif (isinstance(args[0], Map) or
isinstance(args[0], CompositeMap) or
isinstance(args[0], MapCube)):
return args[0]
# List of filepaths or Maps
elif isinstance(args[0], list):
# list of maps or filepaths
maps = args[0]
# Unrecognized input
else:
raise InvalidMapInput("Invalid input for make_map. Please specify "
"one or more filepaths, Maps, directories, "
"or wildcard expressions.")
else:
maps = args
# Make sure we found some data
if len(maps) is 0:
raise NoMapsFound("Specified path contains no valid files.")
mtype = kwargs.get("type", "composite")
# MapCube
if mtype == "cube":
return MapCube(*maps)
# CompositeMap (default)
elif mtype == "composite":
return CompositeMap(*maps)
else:
raise InvalidMapType("Invalid multi-map type specified. Please choose "
"between 'composite' or 'cube'.")
def make_map(*args, **kwargs):
"""Processes one or more inputs and returns a Map, MapCube, or CompositeMap
instance.
Parameters
----------
args : filepath(s), data array
The data source used to create the map object. This can be either a
filepath to an image, a 2d list, or an ndarray.
type : {'composite' | 'cube'}
Type of multimap to construct when passed more than one input. The
default choice is a CompositeMap which is more lenient with respect
to how similar the input data is.
Returns
-------
out : Map, MapCube, CompositeMap
Returns a subclass instance
Examples
--------
>>> import sunpy
>>> sunpy.make_map("file.fts")
>>> sunpy.make_map("file1.fts", "file2.fts",..)
>>> sunpy.make_map(["file1.fts", "file2.fts",..])
>>> sunpy.make_map("path/to/files/*.fts")
>>> sunpy.make_map(Map)
>>> sunpy.make_map(Map1, Map2,..)
>>> sunpy.make_map([[0, 1],[2, 3]], {'telescop': 'sunpy',..})
"""
if len(args) is 0:
raise TypeError("Invalid input.")
# First check to see if data/header were passed in
if isinstance(args[0], list) or isinstance(args[0], np.ndarray):
data = None
# n-dimensional list
if isinstance(args[0][0], list) or isinstance(args[0], np.ndarray):
data = args[0]
else:
try:
float(args[0][0])
except (ValueError, TypeError):
pass
else:
# 1-dimensional data
data = args[0]
# if either of the above cases hold, then create a new Map
if data is not None:
if len(args) > 1:
return Map(args[0], args[1])
else:
return Map(args[0], {})
# If not, check for one or more maps or filepaths
if len(args) == 1:
# String
if isinstance(args[0], basestring):
filepath = os.path.expanduser(args[0])
# Wildcard string
if filepath.find("*") != -1:
import glob
maps = glob.glob(filepath)
# Directory (use all files)
elif os.path.isdir(filepath):
maps = [os.path.join(filepath, x) for x in os.listdir(filepath)]
# Filepath
else:
return Map.read(filepath)
# Map/MapCube/CompositeMap
elif (isinstance(args[0], Map) or
isinstance(args[0], CompositeMap) or
isinstance(args[0], MapCube)):
return args[0]
# List of filepaths or Maps
elif isinstance(args[0], list):
# list of maps or filepaths
maps = args[0]
# Unrecognized input
else:
raise InvalidMapInput("Invalid input for make_map. Please specify "
"one or more filepaths, Maps, directories, "
"or wildcard expressions.")
else:
maps = args
# Make sure we found some data
if len(maps) is 0:
raise NoMapsFound("Specified path contains no valid files.")
mtype = kwargs.get("type", "composite")
# MapCube
if mtype == "cube":
return MapCube(*maps)
# CompositeMap (default)
elif mtype == "composite":
return CompositeMap(*maps)
else:
raise InvalidMapType("Invalid multi-map type specified. Please choose "
"between 'composite' or 'cube'.")
def read_header(filepath):
"""Parses a file header and return some important parameters"""
return Map.read_header(filepath)
def read_header(filepath):
"""Parses a file header and return some important parameters"""
return Map.read_header(filepath)
