Skip to content

Commit

Permalink
Merge pull request #305 from MSeifert04/include_read_write_method_doc…
Browse files Browse the repository at this point in the history
…string

include read and write method documentation to CCDData [skip ci]
  • Loading branch information
crawfordsm committed Feb 15, 2016
2 parents 228f1df + d6c7fd1 commit 8aa38e5
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion ccdproc/ccddata.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
from astropy.wcs import WCS


__all__ = ['CCDData']
__all__ = ['CCDData', 'fits_ccddata_reader', 'fits_ccddata_writer']


class CCDData(NDDataArray):
Expand Down Expand Up @@ -70,6 +70,18 @@ class CCDData(NDDataArray):
If the ``uncertainty`` or ``mask`` inputs cannot be broadcast (e.g.,
match shape) onto ``data``.
Methods
-------
read(*args, **kwargs)
``Classmethod`` to create an CCDData instance based on a ``FITS`` file.
This method uses :func:`fits_ccddata_reader` with the provided
parameters.
write(*args, **kwargs)
Writes the contents of the CCDData instance into a new ``FITS`` file.
This method uses :func:`fits_ccddata_writer` with the provided
parameters.
Notes
-----
`~astropy.nddata.NDData` objects can be easily converted to a regular
Expand Down

0 comments on commit 8aa38e5

Please sign in to comment.