NAME

USAGE

DESCRIPTION

The batpos, xrtpos, uvotpos, and groundpos parameters all use the same scheme for specifying a position/error circle. They can either be a region file containing a single included fk5 circle, for example fk5;circle(280.32,-23.5,5") or a string of the form ra+dec~error, for example 280.32-23.5~5 would specify the same error circle as the preceding region file.

There is a known issue in uvotproduct that can cause the significances, upper limits, and magnitude errors to be incorrect for very faint sources. Users should use caution when considering reported detections with magnitude errors greater than approximately 0.3 mag.

PARAMETERS

infile [filename]

A comma separated list of files or @filename to load the file names from a file containing one file name per line.

outfile [filename]

Name for output magnitude history.

plotfile [filename]

Name for output magnitude history plot or NONE. The extension of plotfile can be used to control the PGPLOT device.

srcreg [filename]

Source region file.

bkgreg [filename]

Background region file or DEFAULT. The special value DEFAULT automatically creates a region file based on an annulus around the source position with inner radius 12.5" and outer radius 25". Additionally, 6" circular exclusion regions are applied for sources which are detected that overlap the annulus.

batpos [string]

A region file name or a string ra+dec~error giving the BAT position/error circle.

xrtpos [string]

A region file name or a string ra+dec~error giving the XRT position/error circle.

uvotpos [string]

A region file name or a string ra+dec~error giving the UVOT position/error circle.

groundpos [string]

A region file name or a string ra+dec~error giving a ground position/error circle.

reportfile [filename]

Name for output report or NONE.

(timezero = TRIGTIME) [string]

Reference time for output. The special value TRIGTIME requires that the primary header of the first input file contains the TRIGTIME keyword and uses the corresponding value. Alternatively, the user can enter an arbitrary MET, for example, 123456789.0 or a UTC time formatted as YYYY-MM-DDTHH:MM:SS.

(plotmag = yes) [boolean]

If true, plotfile will use magnitudes; otherwise rates.

(zerofile = CALDB) [filename]

Zero points file or CALDB.

(coinfile = CALDB) [filename]

Coincidence loss file or CALDB.

(psffile = CALDB) [filename]

PSF file or CALDB.

(lssfile = NONE) [filename]

Large scale sensitivity file or NONE.

(apercorr = NONE) [NONE|CURVEOFGROWTH]

uvotsource apercorr parameter.

(nsigma = 3.0) [real]

N sigma for determining faintest detection.

(exclude = DEFAULT) [string]

Extensions to exclude.

(frametime = DEFAULT) [string]

Frame time [s] or DEFAULT to use FRAMTIME keyword.

(fcprefix = NONE) [boolean]

Finding chart prefix or NONE. If this parameter is not NONE, then two jpg images will be produced starting with fcprefix. One will be an image from a DSS server. The other will be based on the earliest available non-SETTLING V or WHITE exposure. The size of these images will depend on what positions are available. If only a BAT position is available, they will be 6' square; otherwise they will be 2' square.

The scripting involved only works with ds9 version 4.

(centroid = no) [boolean]

Perform centroiding? See uvotsource centroid parameter.

(fwhmsig = 3) [real]

Percentage uncertainty in FWHM of PSF. See uvotapercorr fwhmsig parameter. This parameter is only used if apercorr=CURVEOFGROWTH.

(rebin = NONE) [string]

User specified rebinning parameters. Available parameters (default value) are:

MIN_SIGMA (2) Neighboring points are combined until a signal-to-noise ratio (SNR) exceeding MIN_SIGMA is obtained (subject to limits on the range of times and consistency of values -- see below). Larger values of MIN_SIGMA produce fewer data points.

MAX_TIME_RATIO (2) The next data point will not be combined with the earlier data if the ratio of the (new) end time to the start time exceeds MAX_TIME_RATIO. In this case the earlier data will become a value in the rebinned light curve even though its SNR is low. Larger values of MAX_TIME_RATIO produce fewer data points.

MIN_TIME_RATIO (1.2) Neighboring data points will be combined until the ratio of the end time to start time exceeds MIN_TIME_RATIO even if the SNR of the combined data exceeds MIN_SIGMA. This allows significant detections to be combined if they are close together in time. Larger values of MIN_TIME_RATIO produce fewer data points. Setting MIN_TIME_RATIO to a value < 1 turns this off.

SNR_DIFF (2) A new data point will not be combined with earlier data if its value is significantly different (i.e., the differnce is signficant at the MIN_SIGMA sigma level). Larger values of SNR_DIFF produce fewer data points.

SNR_DIFF_ORPHAN (2) The initial rebinned light curve is processed in a second pass in an attempt to eliminate "orphans". An orphan is a data point with very low SNR following a point with a high SNR. They typically occur immediately before a gap in the light curve. The orphan is combined with the previous point if the resulting time span satisfies MAX_TIME_RATIO and the difference in the two values is less than SNR_DIFF_ORPHAN sigma. Larger values of SNR_DIFF_ORPHAN produce fewer points.

Each rebinning parameter is specified using key=value. Multiple parameters are specified using a comma delimited list.

(clobber = no) [boolean]

Standard HEAdas clobber parameter; controls whether the output files are permitted to overwrite existing files.

(chatter = 1) [enumerated integer]

Standard HEAdas chatter parameter (1-5) controlling the verbosity of the task.

EXAMPLES

The following examples illustrate running uvotproduct

1. run uvotproduct prompting for all mandatory options:

      uvotproduct

      uvotproduct infile=@img.lis outfile=maghist.fits plotfile=maghist.cps batpos=23.33-41.83~120 xrtpos=23.334-41.839~5.0 uvotpos=23.334743-41.839381~1.0 reportfile=summary.txt chatter=5 

SEE ALSO

LAST MODIFIED