STScI Logo

qpshift xray.ximages


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

NAME

qpshift -- apply linear shift to a qpoe file through filters

USAGE

qpshift input_qpoe qpoe xshift yshift

DESCRIPTION

qpshift transforms a qpoe file according to the specified parameters. position X1,Y1 is changed to:


	X2 = X1 + Xshift
	Y2 = Y1 + Yshift

where Xshift,Yshift is the amount of shift in pixels.

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. (Of course, usually one makes the output record equal to or smaller than the input. 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.)

PARAMETERS

qpoe = "" prompt = input qpoe filename

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.

oqpoe = "" prompt = output qpoe filename

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.

xshift = 0. prompt = pixel shift in x

The shift to apply in x, so that xout = xin + xshift.

yshift = 0. prompt = pixel shift in y

The shift to apply in x, so that yout = yin + yshift.

(region = "") [string]

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.

(eventdef = "") [string]

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.

(clob = no) [boolean]

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

(display = 1) [int]

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

(mwcs = yes) [bool]

Normally, the transformation done to the image, must be reflected in the reference coordinate grid. However, if the transformation is to correct an ERROR in the original grid, then this option should be turned off.

(random = yes) [bool]

Apply a random number fraction to transformation before truncation. Smooths out digitization affects. Turning to no is helpful for debugging.

(sort = yes) [boolean]

Flag if events are to be sorted. If true, the type of sort is determined by the sorttype parameter.

(sorttype = "position") [string]

The type of sort to perform. This string consists of a list of event element names that specifies the order in which to sort the event record. For example, "y x time" will sort on the "y" element as the primary key, the "x" element as the secondary key, and "time" as the tertiary key. If sorting is not to be performed, this parameter can be used as a string that will go into the x_sort qpoe param to indicate the type of sorting of the events. For example, if the events are already sorted by time, and are not to be resorted, one can set sort to false and sorttype to "time", and the qpoe file will be indistinguishable from one whose events were sorted by time.

(ssize = 1000000) [int]

The number of bytes that are to be sorted at a time. This allows users to tailor the task to the amount of available memory. If there is a lot of memory available, sortsize should be set large enough so that the task will do an in-core sort. (This requires knowing the approximate number of events and the byte size of each event.) If only a small amount of memory is available, use a smaller number. In this case, several core loads will be sorted and written to temp files, which are then merged.

(qpi = 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.)

(psize = 1024) [int]

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

(bsize = 2048) [int]

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

(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.

(key = "y x") [string]

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

(debug = 0) [int]

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

EXAMPLES

1. Shift the x-axis by 3.2 pixels and the y-axis by -1.65 pixels. Make the resulting qpoe file of size small.

	cl> qpshift xdata$rp110590.qp rp_shift.qp 3.2 -1.65 eventdef="small"
	 display=1 

	xdata$rp110590.qp (; no exp.) -> rp_shift.qp (xin=7681.00 
	 yin=7681.00 xrot=0.00 yrot=0.00 xout=7684.20 yout=7679.35)
	QPEX Warning: bad attribute name `time'
	Creating QPOE output file: rp_shift.qp

TIME REQUIREMENTS

BUGS

For large QPOE files (> 25MBytes) it will be necessary to optimize the QPOE internal parameters.

SEE ALSO

The task QPLINTRAN which is the underlying utility for this task

The task GEOMAP can be used to determine correction factors to align to distorted images.

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