MRCAL(1)

💖 MRCAL(1) — the mrcal-is-within-valid-intrinsics-region era 💖

okay bestie, welcome to the mrcal manual page for mrcal-is-within-valid-intrinsics-region, aka the tool that tells you which of ur points are living their best life inside the valid-intrinsics region and which ones are out there in the ✨wilderness✨. it's giving camera projection + calibration toolkit energy. periodt.

---

🌸 NAME 🌸

mrcal-is-within-valid-intrinsics-region — reports which input points lie within the valid-intrinsics region 🎀

---

🦋 SYNOPSIS 🦋

  $ < points-in.vnl
    mrcal-is-within-valid-intrinsics-region --cols-xy x y
      camera.cameramodel
    > points-annotated.vnl

---

✨ DESCRIPTION ✨

so like, mrcal camera models can carry around an estimate of the region of the imager where the intrinsics are actually trustworthy — and by "trustworthy" we mean it was originally computed with a low-enough error and uncertainty. no cap. 💅

when you're using a model, you might wanna treat points that fall outside that region differently from the points that fall within it. this tool is literally here for that: it takes an incoming vnlog and augments it with a new column that says, for every single point, whether it does or does not fall within the region. slay. 👑

the input data comes in on standard input, and the output data gets written to standard output. both of them are vnlog data: a human-readable table of ascii text, fr fr. 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. you can name that column with --col-output, but you can totally skip it if the default 'is-within-valid-intrinsics-region' is acceptable to you. 🫶

---

🎀 OPTIONS 🎀

🍓 POSITIONAL ARGUMENTS 🍓

• model — camera model 💖

🌈 OPTIONAL ARGUMENTS 🌈

• -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 one is required, bestie, no skipping it 😤
• --col-output COL_OUTPUT — the name of the column to append in the output. this one is optional; a reasonable default will be used if you omit it ✨

---

💜 REPOSITORY 💜

<https://www.github.com/dkogan/mrcal>

---

👑 AUTHOR 👑

Dima Kogan, "<dima@secretsauce.net>"

---

📜 LICENSE AND COPYRIGHT 📜

Copyright (c) 2017-2023 California Institute of Technology ("Caltech"). U.S. Government sponsorship acknowledged. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

---

not me making a whole legal section cute, but like… it's still legally binding, bestie. read it. 🙈

and that's the whole vibe check, babes — this page is mrcal 2.5.2-4build1, dated 2026-03-20, filed under the good old MRCAL(1). go annotate some points, you absolute icon 🦋✨💖