aboutsummaryrefslogtreecommitdiff
path: root/pkg/xtools/catquery/doc/cqwinfon.hlp
blob: 04fab301dfab1bbb5b0517982841dcd994af0d33 (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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
.help cqwinfon Mar00 "Catquery Package"
.ih
NAME
cqwinfon -- get the results wcs description by number
.ih
SYNOPSIS

wcsno = cq_winfo (imres, wcsno, wname, max_wname, wkname, max_wkname, wkvalue,
        max_wkvalue, wktype, wkunits, max_wkunits)

.nf
pointer	imres		# the image results descriptor
int	wcsno		# the wcs parameter sequence number
char	wname		# the wcs parameter name
int	max_wname	# the maximum size of the wcs parameter name
char	wkname		# the default wcs keyword name (INDEF if undefined)
int	max_wkname	# the maximum size of the keyword name
char	wkvalue		# the default wcs keyword value (INDEF if undefined)
int	max_wkvalue	# the maximum size of the parameter value
int	wktype		# the wcs parameter data type
char	wkunits		# the wcs parameter units (INDEF if undefined)
int	max_wkunits	# the maximum size of the wcs parameter units
.fi
.ih
ARGUMENTS
.ls imres    
The image results descriptor.
.le
.ls wcsno
The sequence number of the wcs parameter to be returned.
.le
.ls wname
The returned wcs parameter name.
.le
.ls max_wname
The maximum size of the returned wcs parameter name.
.le
.ls wkname
The returned wcs parameter keyword name.
.le
.ls max_wkname
The maximum size of the returned wcs parameter keyword name.
.le
.ls wkvalue
The returned wcs parameter value.
.le
.ls max_wkvalue
The maximum size of the returned wcs parameter value.
.le
.ls wktype
The returned wcs parameter type. The options are TY_DOUBLE, TY_REAL, TY_LONG,
TY_INT, TY_SHORT, and TY_CHAR.
.le
.ls wkunits
The returned wcs parameter units.
.le
.ls max_wkunits
The maximum size of the returned wcs parameter units.
.le
.ih
DESCRIPTION
Cq_winfon returns the parameter name, keyword name, default value, data type,
and units of the requested wcs parameter. Cq_winfon is an integer function
which returns the sequence number of the wcs parameter as its function
value. Zero is returned if the wcs parameter is not found.

.ih
NOTES
For more information about the wcs parameters and their relationship
to the image surveys configuration file type "help surveys".

.ih
SEE ALSO
cqwinfo
.endhelp