Software: PyKE
Version: 2.0.1
Contributor:

NAME
keparith -- perform simple mathematical operations on time series data (add, subtract, multiply, divide by a constant or the mean, median etc.)

USAGE
keparith   infile   outfile   datacol   constantfunc   constant   operation   clobber   verbose   logfile   status

PARAMETERS
infile = string
Filename for the input light curve.

outfile = string
Filename for the output light curve.

datacol = string
The column in the FITS file which will be modified

constantfunc = string
A constant term which is calculated from a simple function to the time series. The functions used can be median, mean, MAD, std, max or range, where MAD is the median absolute deviation from the median, std is the standard deviation, max is the largest value in the time series and range is the maximum minus the minimum value in the time series.

constantval = float
A constant, the value can be any positive or negative real number.

operation = string
add, subtract, divide or multiply by a constant.

clobber = boolean (optional)
Option to overwrite the output file. If clobber = no and an existing file has the same name as outfile then the task will stop with an error.

verbose = boolean (optional)
Option for verbose mode, in which informative messages and warnings to the shell and a logfile.

logfile = string (optional)
Name of the logfile containing error and warning messages.

status = integer
Exit status of the script. It will be non-zero if the task halted with an error. This parameter is set by the task and should not be modified by the user.
 

DESCRIPTION
keparith allows you to add, subtract divide or multiply a time series in a FITS file by either a value that is calculated by a simple function or is given directly. The available functions are median, mean, standard deviation, max, range or median absolute deviation from the median. The error will also be correctly propagated if possible.

EXAMPLE

• keparith infile=kplr003096278-2010076075105_llc.fits   outfile=kic3096278_altmask1.fits   datacol=SAP_FLUX   constantfunc=median   constantval=''   operation='subtract'   clobber=y

TIME REQUIREMENTS
Execution of this program for 1 quarter of long cadence data using a 3.06 GHz Intel Core 2 Duo Mac running OS 10.6.4 takes a few seconds.

BUGS AND LIMITATIONS
The Kepler PyRAF package is privately-developed software made available to the community through the contributed software page of the GO program at http://keplergo.arc.nasa.gov/ContributedSoftware.shtml. It is not an official software product of the Kepler mission. Bugs and errors are not the responsibility of NASA or the Kepler Team. Please send bug reports and suggestions to keplergo@mail.arc.nasa.gov.

HISTORY