NAME
kepclip -- Remove unwanted time ranges from Kepler time series data
USAGE
kepclip infile outfile ranges plot clobber verbose logfile status
PARAMETERS
infile = string
The name of a
MAST standard format FITS file containing a Kepler light curve
within the first data extension.
outfile = string
The name of the output FITS file with unwanted data removed.
ranges = string
The user must choose here specific time ranges of data to detrend. Ranges can
be supplied using one of two methods.
- Time ranges are supplied as comma-separated pairs of Barycentric Julian
Dates (BJDs). Multiple ranges are separated by a semi-colon. An example
containing two time ranges is:
'2455012.48517,2455014.50072;2455022.63487,2455025.08231'.
- The user can provide time ranges within a pre-prepared ascii file containing
one time range per line, e.g.:
2455012.48517,2455014.50072
2455022.63487,2455025.08231
etc
The file 'arbitraryname.txt' is provided to the task using ranges =
@arbitraryname.txt, where the '@' tells the task that a file is being provided.
Files containing time ranges can be generated manually or with the aid of
data inspection using the task keprange.
plot = boolean
Plot the output data?
clobber = boolean (optional)
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)
Print informative messages and warnings to the shell and 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
kepclip allows the user to remove unwanted or problematic
data from specified time ranges. Ranges to be removed are
provided as pairs of BJDs either as a list or by loading an
ASCII file of times. The ASCII file can be constructed using
keprange.
EXAMPLE
- kepclip infile=kplr002436324-2009259160929_llc.fits
outfile=output.fits range=@ranges.txt plot=y
TIME REQUIREMENTS
Full completion upon one quarter of Kepler long cadence target using a 3.06
GHz Intel Core 2 Duo Mac running OS 10.6.4 takes a few seconds. Running times
increase by several factors if input data contains NaNs. These will be
filtered out before task execution.
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
|
|
|
|
|
Initial software release (MS)
|
|
|
Updated for Kepler FITS v2.0 (MS)
|
|
|
Code can now be run from the command line (TB)
|
|
|
more reliable plot rendering on linux operating systems (MS)
|
SEE ALSO
keprange
|