.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "MRCAL 1"
.TH MRCAL 1 2024-02-04 "mrcal 2.3-4.1~exp1" "mrcal: camera projection, calibration toolkit"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
mrcal\-is\-within\-valid\-intrinsics\-region \- Reports which input points lie within the valid\-intrinsics region
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\&  $ < points\-in.vnl
\&    mrcal\-is\-within\-valid\-intrinsics\-region \-\-cols\-xy x y
\&      camera.cameramodel
\&    > points\-annotated.vnl
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
mrcal camera models may have an estimate of the region of the imager where the
intrinsics are trustworthy (originally computed with a low-enough error and
uncertainty). When using a model, we may want to process points that fall
outside of this region differently from points that fall within this region.
This tool augments an incoming vnlog with a new column, indicating whether each
point does or does not fall within the region.
.PP
The input data comes in on standard input, and the output data is written to
standard output. Both are vnlog data: a human-readable table of ascii text. The
names of the x and y columns in the input are given in the required \-\-cols\-xy
argument. The output contains all the columns from the input, with an extra
column appended at the end, containing the results. The name of this column can
be specified with \-\-col\-output, but this can be omitted if the default
\&'is\-within\-valid\-intrinsics\-region' is acceptable.
.SH OPTIONS
.IX Header "OPTIONS"
.SS "POSITIONAL ARGUMENTS"
.IX Subsection "POSITIONAL ARGUMENTS"
.Vb 1
\&  model                 Camera model
.Ve
.SS "OPTIONAL ARGUMENTS"
.IX Subsection "OPTIONAL ARGUMENTS"
.Vb 8
\&  \-h, \-\-help            show this help message and exit
\&  \-\-cols\-xy COLS_XY COLS_XY
\&                        The names of the columns in the input containing the x
\&                        and y pixel coordinates respectively. This is required
\&  \-\-col\-output COL_OUTPUT
\&                        The name of the column to append in the output. This
\&                        is optional; a reasonable default will be used if
\&                        omitted
.Ve
.SH REPOSITORY
.IX Header "REPOSITORY"
<https://www.github.com/dkogan/mrcal>
.SH AUTHOR
.IX Header "AUTHOR"
Dima Kogan, \f(CW\*(C`<dima@secretsauce.net>\*(C'\fR
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright (c) 2017\-2021 California Institute of Technology ("Caltech"). U.S.
Government sponsorship acknowledged. All rights reserved.
.PP
Licensed under the Apache License, Version 2.0 (the "License");
You may obtain a copy of the License at
.PP
.Vb 1
\&    http://www.apache.org/licenses/LICENSE\-2.0
.Ve