.\" Man page generated from reStructuredText.
.
.TH "X2SYS_REPORT" "1gmt" "Nov 05, 2016" "5.3.1" "GMT"
.SH NAME
x2sys_report \- Report statistics from crossover data base
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBx2sys_report\fP  \fB\-C\fP\fIcolumn\fP  \fB\-T\fP\fITAG\fP [ \fIcoedbase.txt\fP ]
[  \fB\-A\fP ]
[  \fB\-I\fP[\fIlist\fP] ]
[  \fB\-L\fP[\fIcorrtable\fP] ]
[  \fB\-N\fP\fInx_min\fP ]
[  \fB\-Q\fP\fBe\fP|\fBi\fP ]
[ [  \fB\-R\fP\fIregion\fP ]
[  \fB\-S\fP\fItrack\fP ]
[  \fB\-V\fP[\fIlevel\fP] ]
.sp
\fBNote:\fP No space is allowed between the option flag and the associated arguments.
.SH DESCRIPTION
.sp
\fBx2sys_report\fP will read the input crossover ASCII data base
\fIcoedbase.txt\fP (or \fIstdin\fP) and report on the statistics of crossovers
(\fIn\fP, \fImean\fP, \fIstdev\fP, \fIrms\fP, \fIweight\fP) for each track. Options are
available to let you exclude tracks and limit the output.
.SH REQUIRED ARGUMENTS
.INDENT 0.0
.TP
.B \fIcoedbase.txt\fP
The name of the input ASCII crossover error data base as produced by
\fBx2sys_cross\fP\&. If not given we read standard input instead.
.UNINDENT
.INDENT 0.0
.TP
\fB\-C\fP\fIcolumn\fP
Specify which data column you want to process. Crossovers related to
this column name must be present in the crossover data base.
.UNINDENT
.INDENT 0.0
.TP
\fB\-T\fP\fITAG\fP
Specify the x2sys \fITAG\fP which tracks the attributes of this data type.
.UNINDENT
.SH OPTIONAL ARGUMENTS
.INDENT 0.0
.TP
\fB\-A\fP
Eliminate COEs by distributing the COE between the two tracks in
proportion to track weight and producing (dist, adjustment) spline
knots files for each track (for the selected \fIcolumn\fP). Such
adjustments may be used by \fBx2sys_datalist\fP\&. The adjustment files
are called \fItrack.column\fP\&.adj and are placed in the
\fB$X2SYS_HOME\fP/\fITAG\fP directory. For background information on how
these adjustments are designed, see \fIMittal\fP [1984].
.UNINDENT
.INDENT 0.0
.TP
\fB\-I\fP[\fIlist\fP]
Name of ASCII file with a list of track names (one per record) that
should be excluded from consideration [Default includes all tracks].
.UNINDENT
.INDENT 0.0
.TP
\fB\-L\fP[\fIcorrtable\fP]
Apply optimal corrections to the chosen observable. Append the
correction table to use [Default uses the correction table
\fITAG\fP_corrections.txt which is expected to reside in the
\fB$X2SYS_HOME\fP/\fITAG\fP directory]. For the format of this file, see
\fBx2sys_solve\fP\&.
.UNINDENT
.INDENT 0.0
.TP
\fB\-N\fP\fInx_min\fP
Only report data from tracks involved in at least \fInx_min\fP crossovers [all tracks].
.UNINDENT
.INDENT 0.0
.TP
\fB\-Qe\fP|\fBi\fP
Append \fBe\fP for external crossovers or \fBi\fP for internal
crossovers only [Default is external].
.UNINDENT
.INDENT 0.0
.TP
\fB\-R\fP[\fIunit\fP]\fIwest\fP/\fIeast\fP/\fIsouth\fP/\fInorth\fP[/\fIzmin\fP/\fIzmax\fP][\fBr\fP]
\fIwest\fP, \fIeast\fP, \fIsouth\fP, and \fInorth\fP specify the region of interest,
and you may specify them in decimal degrees or in
[+\-]dd:mm[:ss.xxx][W|E|S|N] format. Append \fBr\fP if lower left
and upper right map coordinates are given instead of w/e/s/n. The
two shorthands \fB\-Rg\fP and \fB\-Rd\fP stand for global domain (0/360
and \-180/+180 in longitude respectively, with \-90/+90 in latitude).
Alternatively for grid creation, give \fBR\fP\fIcode\fP\fIlon\fP/\fIlat\fP/\fInx\fP/\fIny\fP, where
\fIcode\fP is a 2\-character combination of L, C, R (for left, center, or right)
and T, M, B for top, middle, or bottom. e.g., BL for lower left.  This
indicates which point on a rectangular region the \fIlon\fP/\fIlat\fP coordinate
refers to, and the grid dimensions \fInx\fP and \fIny\fP with grid spacings via
\fB\-I\fP is used to create the corresponding region.
Alternatively, specify the name of an existing grid file and the
\fB\-R\fP settings (and grid spacing, if applicable) are copied from
the grid. Using \fB\-R\fP\fIunit\fP expects projected (Cartesian)
coordinates compatible with chosen \fB\-J\fP and we inversely project
to determine actual rectangular geographic region.
For perspective view (\fB\-p\fP), optionally append /\fIzmin\fP/\fIzmax\fP\&.
In case of perspective view (\fB\-p\fP), a z\-range (\fIzmin\fP, \fIzmax\fP)
can be appended to indicate the third dimension. This needs to be
done only when using the \fB\-Jz\fP option, not when using only the
\fB\-p\fP option. In the latter case a perspective view of the plane is
plotted, with no third dimension. For Cartesian
data just give \fIxmin/xmax/ymin/ymax\fP\&. This option bases the
statistics on those COE that fall inside the specified domain.
.UNINDENT
.INDENT 0.0
.TP
\fB\-S\fP\fItrack\fP
Name of a single track. If given we restrict output to those
crossovers involving this track [Default output is crossovers
involving any track pair].
.UNINDENT
.INDENT 0.0
.TP
\fB\-V\fP[\fIlevel\fP] (more ...)
Select verbosity level [c].  
.UNINDENT
.INDENT 0.0
.TP
\fB\-^\fP or just \fB\-\fP
Print a short message about the syntax of the command, then exits (NOTE: on Windows use just \fB\-\fP).
.TP
\fB\-+\fP or just \fB+\fP
Print an extensive usage (help) message, including the explanation of
any module\-specific option (but not the GMT common options), then exits.
.TP
\fB\-?\fP or no arguments
Print a complete usage (help) message, including the explanation of options, then exits.
.UNINDENT
.SH EXAMPLES
.sp
To report statistics of all the external magnetic crossovers associated
with the tag MGD77 from the file COE_data.txt, restricted to occupy a
certain region in the south Pacific, try
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gmt x2sys_report COE_data.txt \-V \-TMGD77 \-R180/240/\-60/\-30 \-Cmag >
                 mag_report.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
To report on the faa crossovers globally that involves track 12345678, try
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gmt x2sys_report COE_data.txt \-V \-TMGD77 \-Cfaa \-S2345678 > faa_report.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SH REFERENCES
.sp
Mittal, P. K. (1984), Algorithm for error adjustment of potential field
data along a survey network, \fIGeophysics\fP, \fB49\fP(4), 467\-469.
.SH SEE ALSO
.sp
x2sys_binlist
x2sys_cross
x2sys_datalist
x2sys_get
x2sys_init
x2sys_list
x2sys_put
x2sys_solve
.SH COPYRIGHT
2016, P. Wessel, W. H. F. Smith, R. Scharroo, J. Luis, and F. Wobbe
.\" Generated by docutils manpage writer.
.