Decorating Functions to Accept NDData Objects#
Consider the following function:
def test(data, wcs=None, unit=None, n_iterations=3): ...
from astropy.nddata import support_nddata @support_nddata def test(data, wcs=None, unit=None, n_iterations=3): ...
Which makes it so that when the user calls
test(nd), the function would
automatically be called with:
test(nd.data, wcs=nd.wcs, unit=nd.unit)
The decorator looks at the signature of the function and checks if any
of the arguments are also properties of the
NDData object, and passes them
as individual arguments. The function can also be called with separate
arguments as if it was not decorated.
A warning is emitted if an
NDData property is set but the function does
not accept it — for example, if
wcs is set, but the function cannot support
WCS objects. On the other hand, if an argument in the function does not exist
NDData object or is not set, it is left to its default value.
If the function call succeeds, then the decorator returns the values from the
function unmodified by default. However, in some cases we may want to return
wcs, etc. if these were passed in separately, and a new
NDData instance otherwise. To do this, you can specify
repack=True in the decorator and provide a list of the names of the output
arguments from the function:
@support_nddata(repack=True, returns=['data', 'wcs']) def test(data, wcs=None, unit=None, n_iterations=3): ...
With this, the function will return separate values if
test is called with
separate arguments, and an object with the same class type as the input if the
input is an
NDData or subclass instance.
Finally, the decorator can be made to restrict input to specific
subclasses (and the subclasses of those) using the
@support_nddata(accepts=CCDImage) def test(data, wcs=None, unit=None, n_iterations=3): ...