Skip to main content

URFT - Universal Reference Frame Transformer

Overview

The Universal Reference Frame Transformer transforms coordinates between supported reference frames, including epoch handling for dynamic frames and optional uncertainty propagation.

This repository also includes:

  • A batch file module (file_transformer.py) used for processing csv data.
  • A Streamlit GUI (app.py) for interactive single-point and batch transformations.

Installation

To install URFT use pip

pip install urft

If you want to use the gui use following pip command

pip install urft[gui]

Supported Reference Frames

Transformations can be completed between any of the following frames.

Static

GDA2020, GDA94, AGD66, AGD84, MGA94, MGA2020

Dynamic

Australian:

ATRF2014

ITRF:

ITRF88, ITRF89, ITRF90, ITRF91, ITRF92, ITRF93, ITRF94, ITRF96, ITRF97, ITRF2000, ITRF2005, ITRF2008, ITRF2014, ITRF2020

WGS84:

WGS84 (Transit), WGS84 (G730), WGS84 (G873), WGS84 (G1150), WGS84 (G1674), WGS84 (G1762), WGS84 (G2139), WGS84 (G2296), WGS84 Ensemble

Dependencies

  • GeodePy
  • NumPy
  • Shapely
  • PyProj

For GUI:

  • Streamlit
  • pydeck

Core Functionality

Transformation can take place in any of the three coordinate types. Depending on which coordinate type is input will decide which function should be used.

XYZ (Cartesian)

universal_transform(
    x, y, z,
    from_ref, to_ref,
    from_epoch=None, to_epoch=None,
    plate_motion="auto", vcv=None,
    return_type="xyz", output_zone=None, 
    ignore_errors=False, verbose=False
)

LLH (Latitude/Longitude/Height)

universal_transform_llh(
    lat, lon, el_height,
    from_ref, to_ref,
    from_epoch=None, to_epoch=None,
    plate_motion="auto", vcv=None,
    return_type="llh", output_zone=None,
    ignore_errors=False, verbose=False
)

ENU (Projected Easting/Northing/Height + Zone)

universal_transform_enu(
    east, north, height, zone,
    from_ref, to_ref,
    from_epoch=None, to_epoch=None,
    plate_motion="auto", vcv=None,
    return_type="enu", output_zone=None,
    ignore_errors=False, verbose=False
)

Key parameters

  • plate_motion: "auto" selects plate motion automatically; "aus" forces the Australian plate motion model.
  • vcv: optional 3×3 NumPy array for uncertainty propagation.
  • return_type: one of "xyz", "llh", "enu".
  • output_zone: Will set output_zone if using "enu" return type.
  • ignore_errors: When set to true will run transformation even if it shouldn't
  • verbose: When set to true transformation path will be printed

Epoch Requirements

Epoch inputs depend on whether the source/target frames are static or dynamic.

  • Static → Static: no epochs required
  • Static → Dynamic: to_epoch required
  • Dynamic → Static: from_epoch required
  • Dynamic → Dynamic: from_epoch and to_epoch required

Output

Output can be in any of the three coordinate types. All functions return a dictionary containing:

  • type: output coordinate type (xyz, llh, or enu)
  • vcv: 3×3 NumPy array if uncertainties are available, else None
  • coords: coordinate fields matching the output type

For example to access the coords from an llh coordinate type you would use to following

latitude = result['coords']['lat']
longitude = results['coords']['lon']

Streamlit GUI

A Streamlit app is provided in app.py with two pages:

  • Single Point
  • Batch Processing

To run:

streamlit run app.py

GUI Screenshot

Batch / File Transformation Helper

file_transformer.py let you complete batch processing of points in a csv. To do so it has two classes to handle required data:

  • TransformParams holds transformation parameters that are not the coordinates
  • CSVCoordinateMapping for mapping coordinate columns in csv (supports xyz, llh, and enu)

Using these classes a csv file can be transformed using the following function.

csv_transformation(file_path, CSVCoordinateMapping, TransformParams)

Metadata

Release files for urft 0.2.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for urft 0.2.5
File Size Uploaded
urft-0.2.5.tar.gz 1.3 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for urft 0.2.5
File Interpreter ABI Platform
urft-0.2.5-py3-none-any.whl Python 3 none any Details

Total release size: 2.5 MB

Release files / urft-0.2.5.tar.gz

Download URL urft-0.2.5.tar.gz
Size 1.3 MB
Tags Source
SHA-256 checksum
How to use checksums
8565cc2ba098e5b4e2de820d0024f2a2be9b4d39c10226dcb9cfe64dd03509aa
BLAKE2b-256 checksum
How to use checksums
be29a33f8f1893a9b8df8a13f650b915d730bf664f488e0416baf0757b5c5af9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release files / urft-0.2.5-py3-none-any.whl

Download URL urft-0.2.5-py3-none-any.whl
Size 1.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
c6a2b45072f44a2c968cdf01edf40db4c57fadc4cd99d7ae6dc550e1da0d9dba
BLAKE2b-256 checksum
How to use checksums
3d9c4bdda639b61862ec8ed7ff059de8418e0a04858a5f4115e0f27db662d974
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release history Release notifications | RSS feed

This release

0.2.5 This release

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page