aboutsummaryrefslogtreecommitdiff
path: root/pkg/xtools/catquery/doc/cqkinfon.hlp
diff options
context:
space:
mode:
Diffstat (limited to 'pkg/xtools/catquery/doc/cqkinfon.hlp')
-rw-r--r--pkg/xtools/catquery/doc/cqkinfon.hlp73
1 files changed, 73 insertions, 0 deletions
diff --git a/pkg/xtools/catquery/doc/cqkinfon.hlp b/pkg/xtools/catquery/doc/cqkinfon.hlp
new file mode 100644
index 00000000..e57f0d47
--- /dev/null
+++ b/pkg/xtools/catquery/doc/cqkinfon.hlp
@@ -0,0 +1,73 @@
+.help cqkinfon Mar00 "Catquery Package"
+.ih
+NAME
+cqkinfon -- get the results standard image parameter description by number
+.ih
+SYNOPSIS
+
+ipno = cq_kinfo (imres, ipno, pname, max_pname, pkname, max_pkname, pkvalue,
+ max_pkvalue, pktype, pkunits, max_pkunits)
+
+.nf
+pointer imres # the survey results descriptor
+int ipno # the image parameter sequence number
+char pname # the image parameter name
+int max_pname # the maximum size of the parameter name
+char pkname # the default image keyword name (INDEF if undefined)
+int max_pkname # the maximum size of the keyword name
+char pkvalue # the default parameter value (INDEF if undefined)
+int max_pkvalue # the maximum size of the parameter value
+int pktype # the parameter data type
+char pkunits # the parameter units (INDEF if undefined)
+int max_wpunits # the maximum size of the parameter units
+.fi
+.ih
+ARGUMENTS
+.ls imres
+The image results descriptor.
+.le
+.ls ipno
+The sequence number of the requested parameter.
+.le
+.ls pname
+The returned image parameter name.
+.le
+.ls max_pname
+The maximum size of the returned parameter name.
+.le
+.ls pkname
+The returned image parameter keyword name. Pkname is "INDEF" if undefined.
+.le
+.ls max_pkname
+The maximum size of the returned image parameter keyword name.
+.le
+.ls pkvalue
+The returned image parameter value. Pkvalue is "INDEF" if undefined.
+.le
+.ls max_pkvalue
+The maximum size of the returned image parameter value.
+.le
+.ls pktype
+The image parameter data type. The options are TY_DOUBLE, TY_REAL, TY_LONG,
+TY_INT, TY_SHORT, and TY_CHAR.
+.le
+.ls pkunits
+The returned image parameter units. Pkunits is "INDEF" if undefined.
+.le
+.ls max_pkunits
+The maximum size of the returned image parameter units.
+.le
+.ih
+DESCRIPTION
+Cq_kinfon returns the keyword name, default value, data type, and units
+of the requested standard image parameter. Cq_kinfon is an integer function
+which returns the sequence number of the standard image parameter as its
+function value. Zero is returned if the standard image parameter is not found.
+.ih
+NOTES
+For more information about the standard image parameters and their relationship
+to the image surveys configuration file type "help surveys".
+.ih
+SEE ALSO
+cqkinfo
+.endhelp