coadd_user

sofia_redux.instruments.forcast.register.coadd_user(data, reference, position, header=None, variance=None, crpix=None, get_offsets=False, shift_order=None, missing=nan)[source]

Shift an image for coaddition using header information

Parameters:
datanumpy.ndarray

Data to be shifted (nrow, ncol)

referencearray_like of float

2-element (x, y) reference position in pixels

positionarray_like of float

2-element (x, y) user position in pixels

headerThe fits header of the new input data file, optional
varianceNone or numpy.ndarray, optional

Propagate the provided variance (nrow, ncol)

shift_orderint, optional

Order of interpolation for the shift. The shift order must be between 0 and 5, with a default of 3

crpixarray-like, optional

If provided, will be updated to match image shift_image [x, y]

get_offsetsbool, optional

Only return the (x, y) shift. Do not shift the data.

missingfloat, optional

Value to represent missing data during shift

Returns:
2-tuple

The shifted image (nrow, ncol) The shifted variance (nrow, ncol)