aboutsummaryrefslogtreecommitdiff
path: root/noao/digiphot/ptools/doc/txselect.hlp
diff options
context:
space:
mode:
Diffstat (limited to 'noao/digiphot/ptools/doc/txselect.hlp')
-rw-r--r--noao/digiphot/ptools/doc/txselect.hlp121
1 files changed, 121 insertions, 0 deletions
diff --git a/noao/digiphot/ptools/doc/txselect.hlp b/noao/digiphot/ptools/doc/txselect.hlp
new file mode 100644
index 00000000..b80357ea
--- /dev/null
+++ b/noao/digiphot/ptools/doc/txselect.hlp
@@ -0,0 +1,121 @@
+.help txselect Aug91 noao.digiphot.ptools
+.ih
+NAME
+txselect - select records from an APPHOT/DAOPHOT text database
+.ih
+USAGE
+txselect textfiles outfiles expr
+.ih
+PARAMETERS
+.ls textfiles
+The APPHOT/DAOPHOT text database(s) containing the records from which the
+selection is to be made.
+.le
+.ls outfiles
+The output APPHOT/DAOPHOT text database(s) containing the selected records.
+.le
+.ls expr
+The boolean expression to be evaluated once for each record.
+Each input record for which \fIexpr\fR evaluates as "yes" will be
+written to the output file.
+If \fIexpr\fR = yes, a copy is made of the input file.
+.le
+
+.ih
+DESCRIPTION
+TXSELECT selects a subset of the records
+from a set of APPHOT/DAOPHOT text databases
+and writes the new records out to another set of text databases.
+
+The output records are selected on the basis of an input boolean
+expression \fIexpr\fR whose variables are the field names
+specified by the #N keywords or the parameters specified by the
+#K keywords in the APPHOT/DAOPHOT text database.
+If after substituting the values associated
+with a particular record into the field name variables the
+expression evaluates
+to yes, that record is included in the output database.
+
+The supported
+operators and functions are briefly described below. A detailed description
+of the boolean expression evaluator and its syntax can be found
+in the manual page for the IMAGES package HEDIT task.
+
+The following logical operators can be used in the boolean expression.
+
+.nf
+ equal == not equal !=
+ less than < less than or equal <=
+ greater than > greater than or equal >=
+ or || and &&
+ negation ! pattern match ?=
+ concatenation //
+.fi
+
+The pattern match character ?= takes a
+string expression as its first argument and a pattern as its second argument.
+The result is yes if the pattern is contained in the string expression.
+Patterns are strings which may contain pattern matching meta-characters.
+The meta-characters themselves can be matched by preceeding them with the escape
+character. The meta-characters listed below.
+
+.nf
+ beginning of string ^ end of string $
+ one character ? zero or more characters *
+ white space # escape character \
+ ignore case { end ignore case }
+ begin character class [ end character class ]
+ not, in char class ^ range, in char class -
+.fi
+
+The boolean expression may also include arithmetic operators and functions.
+The following arithmetic operators and functions are supported.
+
+.nf
+addition + subtraction -
+multiplication * division /
+negation - exponentiation **
+absolute value abs(x) cosine cos(x)
+sine sin(x) tangent tan(x)
+arc cosine acos(x) arc sine asin(x)
+arc tangent atan(x) arc tangent atan2(x,y)
+exponential exp(x) square root sqrt(x)
+natural log log(x) common log log10(x)
+minimum min(x,y) maximum max(x,y)
+convert to integer int(x) convert to real real(x)
+nearest integer nint(x) modulo mod(x)
+.fi
+
+.ih
+EXAMPLES
+
+1. Select the records from the output of the APPHOT CENTER task for
+which 100. <= XCENTER <= 200. and 300. <= YCENTER <= 400.
+
+.nf
+ pt> txselect m92.ctr.1 m92out \
+ "XCE >= 100. && XCE <= 200. && YCE >= 300. && YCE <= 400."
+.fi
+
+2. Select the records from the output of the APPHOT PHOT task for which
+the first magnitude is not equal to INDEF.
+
+.nf
+ pt> txselect n4147.mag.2 n4147out "MAG[1] != INDEF"
+.fi
+
+3. Select the records from the output of the DAOPHOT ALLSTAR task
+ for which CHI <= 5.0 and MERR <= .10 magnitudes.
+
+.nf
+ pt> txselect m92b.al.1 m92out "CHI <= 5.0 && MERR <= 1.0"
+.fi
+
+.ih
+BUGS
+TXSELECT does not allow arrays in the expression field.
+
+.ih
+SEE ALSO
+images.hselect,images.hedit,ptools.tbselect,tables.tselect,ptools.pselect
+.endhelp