kepmask: plot, create or edit custom target masks for target pixel files

pyke.kepmask.kepmask(infile, frameno=100, maskfile='maskfile.txt', plotfile='kepmask.png', imin=None, imax=None, iscale='linear', cmap='bone', verbose=False, logfile='kepmask.log')

kepmask - plots, creates or edits custom target masks for target pixel files.

The product from this task is a target mask definition file which can be used by kepextract to extract a light curve from target pixel data. This tool is a GUI interface for defining a pixel mask by moving a mouse over image pixels and selecting them by pressing the left-button of your mouse/keypad.

Parameters:

infile : str

The name of a target pixel file from the MAST Kepler archive, containing a standard mask definition image in the second data extension.

frameno : int

Frame number in the target pixel file.

maskfile : str

The name of an ASCII mask definition file. This is either the name of a file to be plotted, a file to be created, or a file to be edited.

plotfile : str

The name of a PNG plot file containing a record of the mask defined or uploaded by this task.

imin : float or None

Minimum intensity value (in electrons per cadence) for the image display. The default minimum intensity level is the median of the faintest 10% of pixels in the image.

imax : float or None

Maximum intensity value (in electrons per cadence) for the image display. The default maximum intensity level is the median of the brightest 10% of pixels in the image.

iscale : str

Type of intensity scaling for the image display. * linear * log * sqrt

cmap : str

Color intensity scheme for the image display.

verbose : bool

Print informative messages and warnings to the shell and logfile?

logfile : str

Name of the logfile containing error and warning messages.

Examples

$ kepmask ktwo202933888-c02_lpd-targ.fits.gz
../_images/kepmask.png