aboutsummaryrefslogtreecommitdiff
path: root/pkg/xtools/catquery/doc/cqistati.hlp
blob: beeec2c991bf7d816d5eebdcaa08bce001bd4dca (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
.help cqistati Mar00 "Catquery Package"
.ih
NAME
cqistati -- get an image survey results integer parameter
.ih
SYNOPSIS
include <cq.h>

ival = cq_istati (imres, parameter)

.nf
pointer	imres		# the survey results descriptor
int	parameter	# the parameter to be returned
.fi
.ih
ARGUMENTS
.ls imres    
The survey results descriptor.
.le
.ls parameter
The survey parameter to be returned.  The currently supported survey
parameters defined in cq.h are:
.nf
CQINQPARS	# the number of query params used to produce results
CQIMTYPE	# the image results type, CQFITS
CQIMRECSIZE	# the image record size, 0 if undefined 
CQIMHSKIP	# the number of leading bytes to skip, 0 if undefined
CQIMHREAD	# the number of leading dummy reads, 0 if undefined
CQWCS		# the image wcs status, CQ_WFITS or CQ_WDSS or CQ_WNONE
CQNWCS		# the number of wcs parameters, 0 if none defined
CQNIMPARS	# the number of image parameters, 0 if none defined
.fi
.le
.ih
DESCRIPTION
Cq_istati returns the values of image survey results integer parameters.
Cq_istati is an integer function which returns the value of the requested
parameter as its function value.

.ih
NOTES
More information about the image survey results parameters and their
relationship to the parent image survey is available by typing
"help surveys".

.ih
SEE ALSO
cq_istats, cq_istatt
.endhelp