sub2full

wfc3tools.sub2full.sub2full(filename, x=None, y=None, fullExtent=False)

Given an image specified by the user which contains a subarray readout, return the location of the corner of the subarray in a full frame reference image (including the full physical extent of the chip), in 1-indexed pixels.

Parameters:

filenamestr or list

Input image name or list of image names. The rootname will be used to find the SPT files in the same directory, the SPT file has all the necessary information for the transform.

xint, optional

Specify an x coordinate in the subarray to translate. If an x and y are specified, the fullExtent option is turned off and only the translated x,y coords are returned. Default is None.

yint, optional

Specify a y coordinate in the subarray to translate. If an x and y are specified, the fullExtent option is turned off and only the translated x,y coords are returned. Default is None.

fullExtentbool, optional

If True, the returned values will include the full extent of the subarray in the reference image, for example: (x0,x1,y0,y1). Default is False.

Returns:

coordslist

A list of tuples which specify the translated coordinates, either (x0,y0) for each image or the full extent sections.

Examples

>>> from wfc3tools import sub2full
>>> filename = 'ibbso1fdq_flt.fits'
>>> coords = sub2full(filename, x=None, y=None, fullExtent=False)