Skip to content

Commit

Permalink
Merge pull request #1323 from Cadair/map_docs
Browse files Browse the repository at this point in the history
some map documentation fixes
  • Loading branch information
Cadair committed Mar 23, 2015
2 parents adf5ac9 + f0dcb0a commit a48abe9
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 6 deletions.
29 changes: 23 additions & 6 deletions doc/source/code_ref/map.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,34 @@ created using the Map factory sunpy.map.Map.
Creating Map Objects
--------------------
SunPy Map objects are constructed using the special factory
class :class:`Map`: ::
class `~sunpy.map.Map`: ::

>>> x = sunpy.map.Map('file.fits')

The result of a call to `Map` will be either a `mapbase.GenericMap` object,
or a subclass of `mapbase.GenericMap` which either deals with a specific type of data,
e.g. `AIAMap` or `LASCOMap`, or if no instrument matches, a 2D map `mapbase.GenericMap`.
The result of a call to `~sunpy.map.Map` will be either a `~sunpy.map.mapbase.GenericMap` object,
or a subclass of `~sunpy.map.mapbase.GenericMap` which either deals with a specific type of data,
e.g. `~sunpy.map.sources.sdo.AIAMap` or `~sunpy.map.sources.soho.LASCOMap`, or if no
instrument matches, a 2D map `~sunpy.map.mapbase.GenericMap`.


.. autoclass:: sunpy.map.map_factory.MapFactory


Using Map Objects
-----------------

Once a map object has been created using `~sunpy.map.Map` it will be a instance
or a subclass of the `~sunpy.map.mapbase.GenericMap` class. Irrespective of
the instrument the map is constructed for, all maps behave the same and are
interchangeable with one another. It is possible to manipulate the map or access
meta data about the map from the methods and proprties of the map class.
The following documentation of `~sunpy.map.mapbase.GenericMap` lists the
attributes and methods that are availible on all Map objects.

.. autoclass:: sunpy.map.mapbase.GenericMap
:members:


.. autoclass:: sunpy.map.Map

Map Classes
-----------
There are a series of base map classes which are specalised for each
Expand Down
2 changes: 2 additions & 0 deletions sunpy/map/map_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ class DatabaseEntry(object):

class MapFactory(BasicRegistrationFactory):
"""
Map(*args, **kwargs)
Map factory class. Used to create a variety of Map objects. Valid map types
are specified by registering them with the factory.
Expand Down

0 comments on commit a48abe9

Please sign in to comment.