STScI Logo

qpcopy xray.ximages


NAME · USAGE · DESCRIPTION · PARAMETERS · EXAMPLES · TIME_REQUIREMENTS
BUGS · SEE_ALSO

NAME

qpcopy -- copy a qpoe file to another qpoe file through filters

USAGE

qpcopy input_qpoe region qpoe eventdef

DESCRIPTION

qpcopy copies one qpoe file to another qpoe file. Any type of filtering can be applied to the input qpoe file, including region filtering. In addition, the size of the output event record can be different from the size of the input event record. ( If the output record size is made greater than the input record, a warning is issued and the "extra" part of the record is undefined.) However, since the output file is a QPOE event list, no 'block'ing factor can be supported. The imcopy task is needed for this. Also there is no provision for changing the dimension of the output QPOE file. The output dimensions are unchanged, regardless of the screening and selecting applied. This may result in an output file that is mostly empty, and it may be difficult to find the events that remain.

PARAMETERS

input_qpoe = "xdata$snr.qp" prompt = input qpoe file name

The input qpoe file name. The extension ".qp" will be added to the file if there is no extension. Qpoe filters can be applied using the bracket notation to filter the input photons.

region = "" prompt = region descriptor

The region descriptor. If null is input, the entire field is copied (subject to the qpoe filters specified with the input file name). Otherwise only those photons are copied which pass the spatial region filter.

qpoe = "copy.qp" prompt = output qpoe file name

The output qpoe file name. The extension ".qp" will be added to the file if there is no extension. The output file can be the same as the input file.

eventdef = "" prompt = event definition

The event definition of the output QPOE file. If the user enters the empty string, "", the event definition will be copied from the input QPOE file. See help qpoe for information on modifying the event definition.

(exposure = "NONE") [string]

The PLIO mask containing exposure information for the specified source image. If the null string is input, the name will be the same root as the source image file with a "_exp.pl" extension. If "NONE" is input, no exposure filtering is performed.

(expthresh = 0.) [real]

The percentage of total exposure required for a given source pixel to pass the exposure filter, (if an exposure mask is present). For example, if expthresh is 50.0, then only pixels whose exposure time is >= 50% will be used. An exposure threshold of 0% allows all photons to pass the exposure filter.

(clobber = no) [boolean]

Boolean flag specifying whether or not the qpoe file can be overwritten, if it already exists.

(display = 0) [int]

The display level. A display level of 0 generates no display. A display level of 1 generates a display of header information.

(qp_internals = yes) [boolean]

Boolean flag controlling whether the internal qpoe parameters (see below) are prompted for, or whether they are defaulted to internally hardwired values. This parameter is not usually changed by the user. (Prompting is normally turned off during stand-alone debugging only.)

(qp_pagesize = 1024) [int]

Page size for the qpoe file. This parameter is internal to qpoe and should not normally be changed.

(qp_bucketlen = 2048) [int]

Bucket length for the qpoe file. This parameter is internal to qpoe and should not normally be changed.

(qp_blockfact = 1) [int]

The default block factor for IMIO. This parameter is internal to qpoe and should not normally be changed.

(qp_mkindex = yes) [boolean]

Boolean flag that an index should be made for the qpoe file. This parameter is internal to qpoe and should not normally be changed.

(qp_key = "") [string]

Key on which to make the qpoe index. This parameter is internal to qpoe and should not normally be changed.

(qp_debug = 0) [int]

Debug level for qpoe internals. This parameter is internal to qpoe and should not normally be changed.

EXAMPLES

1. Copy a qpoe file to another, accepting only photons whose pi value is in the range 0:7, and whose x,y values are in the mask i296.pl defined by:

annulus(449.74,409.2,0,200,n=3)&pie(449.74,409.2,0,360,n=3)

The output file, i296_small, is of event size small, i.e., only x, y, pha, pi values are saved in the file. The display value is 1, i.e., minimal display.


cl> qpcopy "i296.qp[pi=(0:7)]" i296.pl "i296_small" "small" display=1

i296.qp[pi=(0:7)] (i296.pl; no exp.) -> i296_small.qp
QPEX Warning: bad attribute name `time'
Creating QPOE output file: i296_small.qp

TIME REQUIREMENTS

BUGS

SEE ALSO

imcopy which will copy a qpoe file to an image file. However, currently this task will NOT correctly update the WCS information. The task blkavg with option=sum is recommended instead.

Documentation on region filtering (help regions ) for a description of the spatial filter user interface.

Documentation on qpoe filtering (help qpoe ) for a description of the qpoe filter user interface.

Documentation on file extensions (help extensions ) for a description of PROS file extensions.

Documentation on coordinates (help coords ) for a description of PROS coordinate conventions.


Source Code · Search Form · STSDAS