.TH STILTS-TMATCHN 1 "Mar 2017" "" "Stilts commands"
.SH NAME
stilts-tmatchn \- Crossmatches multiple tables using flexible criteria
.SH SYNOPSIS
.ad l
.HP 15
.hy 0
\fBstilts tmatchn\fR [nin=\fI<count>\fR] [ifmtN=\fI<in-format>\fR] [inN=\fI<tableN>\fR] [icmdN=\fI<cmds>\fR] [ocmd=\fI<cmds>\fR] [omode=\fIout|meta|stats|count|checksum|cgi|discard|topcat|samp|tosql|gui\fR] [out=\fI<out-table>\fR] [ofmt=\fI<out-format>\fR] [multimode=\fIpairs|group\fR] [iref=\fI<table-index>\fR] [matcher=\fI<matcher-name>\fR] [params=\fI<match-params>\fR] [tuning=\fI<tuning-params>\fR] [valuesN=\fI<expr-list>\fR] [joinN=\fIdefault|match|nomatch|always\fR] [fixcols=\fInone|dups|all\fR] [suffixN=\fI<label>\fR] [progress=\fInone|log|time|profile\fR] [runner=\fIparallel|parallel<n>|parallel-all|sequential|classic|partest\fR]
.hy
.ad
.SH DESCRIPTION
.PP
\fItmatchn\fR performs efficient and flexible crossmatching between multiple tables. It can match rows on the basis of their relative position in the sky, or alternatively using many other criteria such as separation in in some isotropic or anisotropic Cartesian space, identity of a key value, or some combination of these; the full range of match criteria is dicussed in SUN/256. 

.PP
Since the match criteria define what counts as a match between two objects, it is not immediately obvious what is meant by a multi-table match. In fact the command can work in one of two distinct modes, controlled by the \fImultimode\fR parameter. In \fIpairs\fR mode, one table (by default the first input table) is designated the reference table, and pair matches between each of the other tables and that one are identified. In \fIgroup\fR mode groups of objects from all the input tables are identified, as discussed in SUN/256. Currently, in both cases an output matched row cannot contain more than one object from each input table. Options for output of multiple rows per input table per match may be forthcoming in future releases if there is demand. 

.PP
\fItmatchn\fR is intended for use with more than two input tables - see \fItmatch1\fR and \fItmatch2\fR for 1- and 2-table crossmatching respectively. 

.SH OPTIONS
.TP
\fBnin=\fI<count>\fR
.RS
The number of input tables for this task. For each of the input tables N there will be associated parameters \fIifmtN\fR, \fIinN\fR and \fIicmdN\fR. 

.RE
.TP
\fBifmtN=\fI<in-format>\fR
.RS
Specifies the format of input table #N as specified by parameter \fIinN\fR. The known formats are listed in SUN/256. This flag can be used if you know what format your table is in. If it has the special value \fI(auto)\fR (the default), then an attempt will be made to detect the format of the table automatically. This cannot always be done correctly however, in which case the program will exit with an error explaining which formats were attempted. This parameter is ignored for scheme-specified tables. 

.RE
.TP
\fBinN=\fI<tableN>\fR
.RS
The location of input table #N. This may take one of the following forms: 
.RS 2
 
.IP * 2
A filename. 
.IP * 2
A URL. 
.IP * 2
The special value "\fI-\fR", meaning standard input. In this case the input format must be given explicitly using the \fIifmtN\fR parameter. Note that not all formats can be streamed in this way. 
.IP * 2
A scheme specification of the form \fI:<scheme-name>:<scheme-args>\fR. 
.IP * 2
A system command line with either a "\fI<\fR" character at the start, or a "\fI|\fR" character at the end ("\fI<syscmd\fR" or "\fIsyscmd|\fR"). This executes the given pipeline and reads from its standard output. This will probably only work on unix-like systems. 
.RE
 In any case, compressed data in one of the supported compression formats (gzip, Unix compress or bzip2) will be decompressed transparently. 

.RE
.TP
\fBicmdN=\fI<cmds>\fR
.RS
Specifies processing to be performed on input table #N as specified by parameter \fIinN\fR, before any other processing has taken place. The value of this parameter is one or more of the filter commands described in SUN/256. If more than one is given, they must be separated by semicolon characters (";"). This parameter can be repeated multiple times on the same command line to build up a list of processing steps. The sequence of commands given in this way defines the processing pipeline which is performed on the table. 
.PP
Commands may alteratively be supplied in an external file, by using the indirection character '@'. Thus a value of "\fI@filename\fR" causes the file \fIfilename\fR to be read for a list of filter commands to execute. The commands in the file may be separated by newline characters and/or semicolons, and lines which are blank or which start with a '\fI#\fR' character are ignored. 

.RE
.TP
\fBocmd=\fI<cmds>\fR
.RS
Specifies processing to be performed on the output table, after all other processing has taken place. The value of this parameter is one or more of the filter commands described in SUN/256. If more than one is given, they must be separated by semicolon characters (";"). This parameter can be repeated multiple times on the same command line to build up a list of processing steps. The sequence of commands given in this way defines the processing pipeline which is performed on the table. 
.PP
Commands may alteratively be supplied in an external file, by using the indirection character '@'. Thus a value of "\fI@filename\fR" causes the file \fIfilename\fR to be read for a list of filter commands to execute. The commands in the file may be separated by newline characters and/or semicolons, and lines which are blank or which start with a '\fI#\fR' character are ignored. 

.RE
.TP
\fBomode=\fIout|meta|stats|count|checksum|cgi|discard|topcat|samp|tosql|gui\fR
.RS
The mode in which the result table will be output. The default mode is \fIout\fR, which means that the result will be written as a new table to disk or elsewhere, as determined by the \fIout\fR and \fIofmt\fR parameters. However, there are other possibilities, which correspond to uses to which a table can be put other than outputting it, such as displaying metadata, calculating statistics, or populating a table in an SQL database. For some values of this parameter, additional parameters (\fI<mode-args>\fR) are required to determine the exact behaviour. 
.PP
Possible values are 
.RS 2
 
.IP * 2
\fIout\fR 
.IP * 2
\fImeta\fR 
.IP * 2
\fIstats\fR 
.IP * 2
\fIcount\fR 
.IP * 2
\fIchecksum\fR 
.IP * 2
\fIcgi\fR 
.IP * 2
\fIdiscard\fR 
.IP * 2
\fItopcat\fR 
.IP * 2
\fIsamp\fR 
.IP * 2
\fItosql\fR 
.IP * 2
\fIgui\fR 
.RE
 Use the \fIhelp=omode\fR flag or see SUN/256 for more information. 

.RE
.TP
\fBout=\fI<out-table>\fR
.RS
The location of the output table. This is usually a filename to write to. If it is equal to the special value "-" (the default) the output table will be written to standard output. 
.PP
This parameter must only be given if \fIomode\fR has its default value of "\fIout\fR". 

.RE
.TP
\fBofmt=\fI<out-format>\fR
.RS
Specifies the format in which the output table will be written (one of the ones in SUN/256 - matching is case-insensitive and you can use just the first few letters). If it has the special value "\fI(auto)\fR" (the default), then the output filename will be examined to try to guess what sort of file is required usually by looking at the extension. If it's not obvious from the filename what output format is intended, an error will result. 
.PP
This parameter must only be given if \fIomode\fR has its default value of "\fIout\fR". 

.RE
.TP
\fBmultimode=\fIpairs|group\fR
.RS
Defines what is meant by a multi-table match. There are two possibilities: 
.RS 2
 
.IP * 2
\fIpairs\fR: Each output row corresponds to a single row of the reference table (see parameter \fIiref\fR) and contains entries from other tables which are pair matches to that. If a reference table row matches multiple rows from one of the other tables, only the best one is included. 
.IP * 2
\fIgroup\fR: Each output row corresponds to a group of entries from the input tables which are mutually linked by pair matches between them. This means that although you can get from any entry to any other entry via one or more pair matches, there is no guarantee that any entry is a pair match with any other entry. No table has privileged status in this case. If there are multiple entries from a given table in the match group, an arbitrary one is chosen for inclusion (there is no unique way to select the best). See SUN/256 for more discussion. 
.RE
 Note that which rows actually appear in the output is also influenced by the \fIjoinN\fR parameter. 

.RE
.TP
\fBiref=\fI<table-index>\fR
.RS
If \fImultimode\fR=\fIpairs\fR this parameter gives the index of the table in the input table list which is to serve as the reference table (the one which must be matched by other tables). Ignored in other modes. 
.PP
Row ordering in the output table is usually tidiest if the default setting of 1 is used (i.e. if the first input table is used as the reference table). 

.RE
.TP
\fBmatcher=\fI<matcher-name>\fR
.RS
Defines the nature of the matching that will be performed. Depending on the name supplied, this may be positional matching using celestial or Cartesian coordinates, exact matching on the value of a string column, or other things. A list and explanation of the available matching algorithms is given in SUN/256. The value supplied for this parameter determines the meanings of the values required by the \fIparams\fR, \fIvalues*\fR and \fItuning\fR parameter(s). 

.RE
.TP
\fBparams=\fI<match-params>\fR
.RS
Determines the parameters of this match. This is typically one or more tolerances such as error radii. It may contain zero or more values; the values that are required depend on the match type selected by the \fImatcher\fR parameter. If it contains multiple values, they must be separated by spaces; values which contain a space can be 'quoted' or "quoted". 

.RE
.TP
\fBtuning=\fI<tuning-params>\fR
.RS
Tuning values for the matching process, if appropriate. It may contain zero or more values; the values that are permitted depend on the match type selected by the \fImatcher\fR parameter. If it contains multiple values, they must be separated by spaces; values which contain a space can be 'quoted' or "quoted". If this optional parameter is not supplied, sensible defaults will be chosen. 

.RE
.TP
\fBvaluesN=\fI<expr-list>\fR
.RS
Defines the values from table N which are used to determine whether a match has occurred. These will typically be coordinate values such as RA and Dec and perhaps some per-row error values as well, though exactly what values are required is determined by the kind of match as determined by \fImatcher\fR. Depending on the kind of match, the number and type of the values required will be different. Multiple values should be separated by whitespace; if whitespace occurs within a single value it must be 'quoted' or "quoted". Elements of the expression list are commonly just column names, but may be algebraic expressions calculated from zero or more columns as explained in SUN/256. 

.RE
.TP
\fBjoinN=\fIdefault|match|nomatch|always\fR
.RS
Determines which rows from input table N are included in the output table. The matching algorithm determines which of the rows in each of the input tables correspond to which rows in the other input tables, and this parameter determines what to do with that information. 
.PP
The default behaviour is that a row will appear in the output table if it represents a match of rows from two or more of the input tables. This can be altered on a per-input-table basis however by choosing one of the non-default options below: 
.RS 2
 
.IP * 2
\fImatch\fR: Rows are included only if they contain an entry from input table N. 
.IP * 2
\fInomatch\fR: Rows are included only if they do not contain an entry from input table N. 
.IP * 2
\fIalways\fR: Rows are included if they contain an entry from input table N (overrides any match and nomatch settings of other tables). 
.IP * 2
\fIdefault\fR: Input table N has no special effect on whether rows are included. 
.RE
 

.RE
.TP
\fBfixcols=\fInone|dups|all\fR
.RS
Determines how input columns are renamed before use in the output table. The choices are: 
.RS 2
 
.IP * 2
\fInone\fR: columns are not renamed 
.IP * 2
\fIdups\fR: columns which would otherwise have duplicate names in the output will be renamed to indicate which table they came from 
.IP * 2
\fIall\fR: all columns will be renamed to indicate which table they came from 
.RE
 If columns are renamed, the new ones are determined by \fIsuffix*\fR parameters. 

.RE
.TP
\fBsuffixN=\fI<label>\fR
.RS
If the \fIfixcols\fR parameter is set so that input columns are renamed for insertion into the output table, this parameter determines how the renaming is done. It gives a suffix which is appended to all renamed columns from table N. 

.RE
.TP
\fBprogress=\fInone|log|time|profile\fR
.RS
Determines whether information on progress of the match should be output to the standard error stream as it progresses. For lengthy matches this is a useful reassurance and can give guidance about how much longer it will take. It can also be useful as a performance diagnostic. 
.PP
The options are: 
.RS 2
 
.IP * 2
\fInone\fR: no progress is shown 
.IP * 2
\fIlog\fR: progress information is shown 
.IP * 2
\fItime\fR: progress information and some time profiling information is shown 
.IP * 2
\fIprofile\fR: progress information and limited time/memory profiling information are shown 
.RE
 

.RE
.TP
\fBrunner=\fIparallel|parallel<n>|parallel-all|sequential|classic|partest\fR
.RS
Selects the threading implementation. The options are currently: 
.RS 2
 
.IP * 2
\fIparallel\fR: uses multithreaded implementation for large tables, with default parallelism, which is the smaller of 6 and the number of available processors 
.IP * 2
\fIparallel<n>\fR: uses multithreaded implementation for large tables, with parallelism given by the supplied value \fI<n>\fR 
.IP * 2
\fIparallel-all\fR: uses multithreaded implementation for large tables, with a parallelism given by the number of available processors 
.IP * 2
\fIsequential\fR: uses multithreaded implementation but with only a single thread 
.IP * 2
\fIclassic\fR: uses legacy sequential implementation 
.IP * 2
\fIpartest\fR: uses multithreaded implementation even when tables are small 
.RE
 The \fIparallel*\fR options should normally run faster than \fIsequential\fR or \fIclassic\fR (which are provided mainly for testing purposes), at least for large matches and where multiple processing cores are available. 
.PP
The default value "\fIparallel\fR" is currently limited to a parallelism of 6 since larger values yield diminishing returns given that some parts of the matching algorithms run sequentially (Amdahl's Law), and using too many threads can sometimes end up doing more work or impacting on other operations on the same machine. But you can experiment with other concurrencies, e.g. "\fIparallel16\fR" to run on 16 cores (if available) or "\fIparallel-all\fR" to run on all available cores. 
.PP
The value of this parameter should make no difference to the matching results. If you notice any discrepancies \fBplease report them\fR. 

.RE
.SH SEE ALSO
\fBstilts\fR(1)
.PP
If the package stilts-doc is installed,
the full documentation \fBSUN/256\fR is available in HTML format:
.br
\%file:///usr/share/doc/stilts/sun256/index.html
.SH VERSION
STILTS version 3.4.7-debian
.PP
This is the Debian version of Stilts, which lack the support
of some file formats and network protocols. For differences see
.br
\%file:///usr/share/doc/stilts/README.Debian
.SH AUTHOR
Mark Taylor (Bristol University)