Plan-Rect
Plan-Rect is command line tool for rectifying oblique images to a plane.
Installation
Plan-Rect is a python 3 package that can be installed with pip:
pip install plan-rect
Usage
Rectification is performed with the plan-rect command. It requires an image and marker locations as inputs, and creates a rectified image and rectification data file as outputs. Its options are described below:
| Option | Value | Description |
|---|---|---|
-im / --image |
FILE | Path / URI of the source image (required). |
-m / --marker |
ID X Y COL ROW | Marker ID and location in world and pixel coordinates, with pixel coordinate origin at the bottom left image corner. |
-g / --gcp |
FILE | Path / URI of an Orthority GCP file defining marker locations. |
-r / --res |
FLOAT | Rectified pixel size in meters. Can be used twice for non-square pixels: --res WIDTH --res HEIGHT. Defaults to the ground sampling distance. |
-i / --interp |
nearest, average, bilinear, cubic, lanczos |
Interpolation method for remapping source to rectified image. Defaults to cubic. |
-n / --nodata |
FLOAT | Nodata value for the rectified image. Defaults to the maximum value of the image data type if it is integer, and nan if it is floating point. |
-ep / --export-params |
Export interior parameters and markers to Orthority format files and exit. | |
-od / --out-dir |
DIRECTORY | Path / URI of the output file directory. Defaults to the current working directory. |
-o / --overwrite |
Overwrite existing output(s). | |
--version |
Show the version and exit. | |
--help |
Show the help and exit. |
Marker locations are required with either -m / --marker or -g / --gcp. The -m / --marker option can be provided multiple times. At least four markers are required.
Examples
Supply marker locations with -m / --marker:
plan-rect --image source.jpg --marker A 0 0 1002 1221 --marker B 2.659 0 4261 1067 --marker C 2.321 5.198 3440 3706 --marker D -0.313 4.729 1410 3663
Supply marker locations with -g / --gcp:
plan-rect --image source.jpg --gcp gcps.geojson
Set the rectified image pixel size with -r / --res:
plan-rect --image source.jpg --res 0.01 --gcp gcps.geojson
Export marker locations to an Orthority GCP file in the data directory, overwriting any existing file:
plan-rect --image source.jpg --export-params --out-dir data --overwrite --marker A 0 0 1002 1221 --marker B 2.659 0 4261 1067 --marker C 2.321 5.198 3440 3706 --marker D -0.313 4.729 1410 3663
Licence
Plan-Rect is licenced under the GNU Affero General Public License v3.0 (AGPLv3).
Acknowledgments
This project was funded by NedCAD.
1 maintainer
Metadata
1 maintainer
Release files for plan-rect 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| plan_rect-0.2.0.tar.gz | 24.5 kB | With provenance | Details for plan_rect-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| plan_rect-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for plan_rect-0.2.0-py3-none-any.whl |
Total release size: 48.1 kB
Release files / plan_rect-0.2.0.tar.gz
| Download URL | plan_rect-0.2.0.tar.gz |
|---|---|
| Size | 24.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2b99030717681fe4ff7b109cd599cef88c553c4df3b417fa9bb954cff9e99f52
|
|
BLAKE2b-256 checksum How to use checksums |
5863b6b134ca86fc6c68acdaed5f4a5e6f3f90f08c0ec3c42b65d2b21e10acf2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 12, 2025.
Transparency logRelease files / plan_rect-0.2.0-py3-none-any.whl
| Download URL | plan_rect-0.2.0-py3-none-any.whl |
|---|---|
| Size | 23.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
35459a0b5ff5d23ec5e80921c457ab6dfe47459f0f3aa5dcc9fc1277b3c18b63
|
|
BLAKE2b-256 checksum How to use checksums |
e5bdd198c5de434eed55e99fe5d4b42ab2a40c9ae9754aea07872d5a62cc80e8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 12, 2025.
Transparency logSecurity for plan-rect 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for plan_rect-0.2.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 12, 2025.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
