From e7f2ea7b648b276153e3dab685d4202e74bc506c Mon Sep 17 00:00:00 2001 From: Thomas Robitaille Date: Wed, 6 May 2015 21:32:23 +0200 Subject: [PATCH] Add information about being able to specify filenames as the first argument --- docs/celestial.rst | 19 ++++++++++++++----- reproject/interpolation/high_level.py | 5 +++-- reproject/spherical_intersect/high_level.py | 5 +++-- 3 files changed, 20 insertions(+), 9 deletions(-) diff --git a/docs/celestial.rst b/docs/celestial.rst index 6614990ff..986c80cc7 100644 --- a/docs/celestial.rst +++ b/docs/celestial.rst @@ -56,11 +56,20 @@ Reprojection using interpolation can be done using the high-level >>> from reproject import reproject_interp This function takes two main arguments. The first argument is the image to -reproject, together with WCS information about the image. This can be either an -Astropy HDU object (specifically :class:`~astropy.io.fits.PrimaryHDU`, -:class:`~astropy.io.fits.ImageHDU`, or :class:`~astropy.io.fits.CompImageHDU`), or a tuple with two elements: a Numpy -array and either a :class:`~astropy.wcs.WCS` or a -:class:`~astropy.io.fits.Header` instance. +reproject, together with WCS information about the image. This can be either: + +* The name of a FITS file +* An :class:`~astropy.io.fits.HDUList` object +* An image HDU object such as a :class:`~astropy.io.fits.PrimaryHDU`, + :class:`~astropy.io.fits.ImageHDU`, or + :class:`~astropy.io.fits.CompImageHDU` instance +* A tuple where the first element is a :class:`~numpy.ndarray` and the + second element is either a :class:`~astropy.wcs.WCS` or a + :class:`~astropy.io.fits.Header` object + +In the case of a FITS file or an :class:`~astropy.io.fits.HDUList` object, if +there is more than one Header-Data Unit (HDU), the ``hdu_in`` argument is +also required and should be set to the ID or the name of the HDU to use. The second argument is the WCS information for the output image, which should be specified either as a :class:`~astropy.wcs.WCS` or a diff --git a/reproject/interpolation/high_level.py b/reproject/interpolation/high_level.py index 4d1ed2bb5..37a8b999c 100644 --- a/reproject/interpolation/high_level.py +++ b/reproject/interpolation/high_level.py @@ -28,8 +28,9 @@ def reproject_interp(input_data, output_projection, shape_out=None, hdu_in=None, * The name of a FITS file * An `~astropy.io.fits.HDUList` object - * An image HDU object such as a `~astropy.io.fits.PrimaryHDU` or - `~astropy.io.fits.ImageHDU` + * An image HDU object such as a `~astropy.io.fits.PrimaryHDU`, + `~astropy.io.fits.ImageHDU`, or `~astropy.io.fits.CompImageHDU` + instance * A tuple where the first element is a `~numpy.ndarray` and the second element is either a `~astropy.wcs.WCS` or a `~astropy.io.fits.Header` object diff --git a/reproject/spherical_intersect/high_level.py b/reproject/spherical_intersect/high_level.py index 46f90ef87..dfc0d5b8e 100644 --- a/reproject/spherical_intersect/high_level.py +++ b/reproject/spherical_intersect/high_level.py @@ -20,8 +20,9 @@ def reproject_exact(input_data, output_projection, shape_out=None, hdu_in=None, * The name of a FITS file * An `~astropy.io.fits.HDUList` object - * An image HDU object such as a `~astropy.io.fits.PrimaryHDU` or - `~astropy.io.fits.ImageHDU` + * An image HDU object such as a `~astropy.io.fits.PrimaryHDU`, + `~astropy.io.fits.ImageHDU`, or `~astropy.io.fits.CompImageHDU` + instance * A tuple where the first element is a `~numpy.ndarray` and the second element is either a `~astropy.wcs.WCS` or a `~astropy.io.fits.Header` object