add_streak

acstools.utils_findsat_mrt.add_streak(image, width, value, rho=None, theta=None, endpoints=None, psf_sigma=None)

Generates a (optionally) PSF-convolved model trail and add it to an image.

Parameters:
imagendarray

The input image onto which the trail should be added.

widthfloat

Width of the trail. Note that as of now this function does not super- sample the image in order to precisely model the trail width.

valuefloat

Uniform intensity within the trail prior to convolving with a PSF.

rhofloat or None, optional

Trail offset from center. The default is None.

thetafloat or None, optional

Trail angle in degrees with respect to x-axis. The default is None.

endpointsarray of tuples or None, optional

Endpoints of the trail. Format is [(x0, y0), (x1, y1)]. The default is None.

psf_sigmafloat or None, optional

Sigma of Gaussian model PSF to be convolved with trail image. The default is None, in which case no convolution is performed.

Returns:
imagendarray

The input image with the streak added on.