Skip to content

Development documentation, built from main against PROJ 9.9.0. Every example on this site was executed during the build.

geodetic-engine 0.1.0

Getting started

User guide

Geodesy
Persistable references (OSDU)
Georepository client
Custom PROJ database

Examples

Gallery
- geodetic-engine – Quickstart Examples
- geodetic-engine examples

Reference

API reference
Command-line tools
- geodetic-projdb
- geodetic-osdudb
Background
Glossary
Changelog

Project

Development
GitHub repository

Index

_ | A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W

_

__init__() (geodetic_engine.errors.GeodeticEngineError method)

__new__() (geodetic_engine.errors.GeodeticEngineError class method)

A

abbrev (geodetic_engine.geodesy.AxisSpec attribute)
accuracy (geodetic_engine.geodesy.AppliedOperation attribute)
- (geodetic_engine.geodesy.OperationCandidate attribute)
Accuracy of a transformation
aliases() (geodetic_engine.georepository.GeorepositoryClient method)
AmbiguousOperationError
annotate_foreign_objects (geodetic_engine.projdb.ProjDbBuildConfig attribute)
ANY_OPERATION (geodetic_engine.geodesy.OperationRoute attribute)
AnyReference (in module geodetic_engine.persistablereference)
api_url (geodetic_engine.georepository.GeorepositoryConfig attribute)
- (geodetic_engine.projdb.ProjDbBuildConfig property)
append (geodetic_engine.osdudb.OsduBuildConfig attribute)
- (geodetic_engine.projdb.ProjDbBuildConfig attribute)
appended (geodetic_engine.projdb.BuildReport attribute)
AppliedOperation (class in geodetic_engine.geodesy)
Area of use
area_of_use (geodetic_engine.geodesy.OperationCandidate attribute)
AreaOfUse (class in geodetic_engine.geodesy)
as_dict() (geodetic_engine.projdb.BuildReport method)
auth_name (geodetic_engine.geodesy.AppliedOperation attribute)

authorities (geodetic_engine.osdudb.OsduBuildConfig attribute)
- (geodetic_engine.projdb.ProjDbBuildConfig attribute)
Authority code
authority_code (geodetic_engine.geodesy.AppliedOperation property)
authority_preference (geodetic_engine.osdudb.OsduBuildConfig attribute)
- (geodetic_engine.projdb.ProjDbBuildConfig attribute)
AuthorityCode (class in geodetic_engine.persistablereference)
AuthorityPreference (class in geodetic_engine.projdb)
authorization_header() (geodetic_engine.georepository.GeorepositoryCredential method)
available (geodetic_engine.geodesy.GridUsage attribute)
available_operations() (in module geodetic_engine.geodesy)
axes (geodetic_engine.geodesy.CoordinateReferenceSystem property)
axis_abbreviations (geodetic_engine.geodesy.CoordinateReferenceSystem property)
axis_order_corrected (geodetic_engine.geodesy.AppliedOperation attribute)
axis_units (geodetic_engine.geodesy.CoordinateReferenceSystem property)
AxisSpec (class in geodetic_engine.geodesy)

B

Ballpark
ballpark (geodetic_engine.geodesy.AppliedOperation attribute)
- (geodetic_engine.geodesy.OperationCandidate attribute)
BallparkOnlyOperationError
BallparkTransformationError
base_proj_db (geodetic_engine.osdudb.OsduBuildConfig attribute)
- (geodetic_engine.projdb.ProjDbBuildConfig attribute)

BOUND (geodetic_engine.geodesy.OperationRoute attribute)
Bound CRS
bound_operations (geodetic_engine.geodesy.AppliedOperation attribute)
bounds (geodetic_engine.geodesy.AreaOfUse property)
build() (in module geodetic_engine.osdudb)
- (in module geodetic_engine.projdb)
BuildReport (class in geodetic_engine.projdb)

C

cache (geodetic_engine.projdb.BuildReport attribute)
cache_db (geodetic_engine.projdb.ProjDbBuildConfig attribute)
cache_mode (geodetic_engine.projdb.ProjDbBuildConfig attribute)
cache_path() (geodetic_engine.projdb.ProjDbBuildConfig method)
catalog (geodetic_engine.osdudb.OsduBuildConfig attribute)
catalog_version (geodetic_engine.osdudb.OsduBuildConfig attribute)
CHAINED (geodetic_engine.geodesy.OperationRoute attribute)
children (geodetic_engine.persistablereference.esriwkt.Node attribute)
client_id (geodetic_engine.georepository.GeorepositoryConfig attribute)
client_secret (geodetic_engine.georepository.GeorepositoryConfig attribute)
close() (geodetic_engine.georepository.GeorepositoryClient method)
- (geodetic_engine.georepository.GeorepositoryCredential method)
code (geodetic_engine.geodesy.AppliedOperation attribute)
coefficients (geodetic_engine.persistablereference.UnitReference attribute)
collapse_concatenated() (in module geodetic_engine.geodesy.utils)
compose() (in module geodetic_engine.geodesy.utils)
Concatenated operation

CONCATENATED_TRANSFORMATION (geodetic_engine.persistablereference.Kind attribute)
ConfigurationError
Conversion
convert_to() (geodetic_engine.persistablereference.UnitReference method)
Coordinate epoch
Coordinate operation
Coordinate system (CS)
coordinate_epoch (geodetic_engine.geodesy.TransformationResult attribute)
COORDINATE_FRAME (geodetic_engine.geodesy.utils.Rotation attribute)
coordinate_order (geodetic_engine.geodesy.TransformationResult attribute)
CoordinateOutOfRangeError
CoordinateReferenceSystem (class in geodetic_engine.geodesy)
Coordinates (class in geodetic_engine.geodesy)
coordinates (geodetic_engine.geodesy.TransformationResult attribute)
count (geodetic_engine.geodesy.TransformationResult property)
CRS
crs (geodetic_engine.geodesy.CoordinateReferenceSystem property)
crs() (geodetic_engine.osdudb.OsduCatalog method)
CrsReference (class in geodetic_engine.persistablereference)
CUSTOM_FIRST (geodetic_engine.projdb.AuthorityPreference attribute)
CUSTOM_ONLY (geodetic_engine.projdb.AuthorityPreference attribute)

D

data (geodetic_engine.osdudb.catalog.Record attribute)
database_fingerprints (geodetic_engine.geodesy.TransformationResult attribute)
Datum
Declared axis order
DEFAULT_PAGE_SIZE (in module geodetic_engine.georepository)
DEFAULT_SCOPE (in module geodetic_engine.georepository)
definition (geodetic_engine.geodesy.CoordinateReferenceSystem property)
- (geodetic_engine.geodesy.OperationRequest attribute)

descendants() (geodetic_engine.persistablereference.esriwkt.Node method)
described (geodetic_engine.osdudb.catalog.Record property)
detail() (geodetic_engine.georepository.GeorepositoryClient method)
dimension (geodetic_engine.geodesy.CoordinateReferenceSystem property)
direct_download (geodetic_engine.geodesy.GridUsage attribute)
direction (geodetic_engine.geodesy.AxisSpec attribute)
Dynamic CRS

E

Early binding
EARLY_BOUND_CRS (geodetic_engine.persistablereference.Kind attribute)
east (geodetic_engine.geodesy.AreaOfUse attribute)

endpoint() (geodetic_engine.georepository.GeorepositoryConfig method)
- (geodetic_engine.projdb.ProjDbBuildConfig method)
execution_direction (geodetic_engine.geodesy.AppliedOperation attribute)

F

fallback_authorities (geodetic_engine.osdudb.OsduBuildConfig attribute)
- (geodetic_engine.projdb.ProjDbBuildConfig attribute)
find_in() (geodetic_engine.geodesy.OperationRequest method)
ForeignAuthorityCollision
from_document() (geodetic_engine.osdudb.OsduCatalog class method)

from_file() (geodetic_engine.osdudb.OsduCatalog class method)
from_persistable_reference() (geodetic_engine.geodesy.CoordinateReferenceSystem class method)
from_si() (geodetic_engine.persistablereference.UnitReference method)
from_user_input() (geodetic_engine.geodesy.CoordinateReferenceSystem class method)
full_name (geodetic_engine.geodesy.GridUsage attribute)

G

GeodesyError
geodetic_engine.errors
- module
geodetic_engine.geodesy
- module
geodetic_engine.geodesy.utils
- module
geodetic_engine.georepository
- module
geodetic_engine.osdudb
- module
geodetic_engine.persistablereference
- module
geodetic_engine.projdb
- module
GeodeticEngineError

geogtran() (in module geodetic_engine.persistablereference)
georepository (geodetic_engine.projdb.ProjDbBuildConfig attribute)
georepository_version (geodetic_engine.projdb.ProjDbBuildConfig attribute)
GeorepositoryApiError
GeorepositoryAuthError
GeorepositoryClient (class in geodetic_engine.georepository)
GeorepositoryConfig (class in geodetic_engine.georepository)
GeorepositoryConfigError
GeorepositoryCredential (class in geodetic_engine.georepository)
GeorepositoryError
get_object() (geodetic_engine.georepository.GeorepositoryClient method)
Grid
grids (geodetic_engine.geodesy.OperationCandidate attribute)
- (geodetic_engine.geodesy.Transformation property)
- (geodetic_engine.geodesy.TransformationResult attribute)
GridUsage (class in geodetic_engine.geodesy)

H

Helmert transformation
helmert_parameters() (in module geodetic_engine.geodesy.utils)

HelmertParameters (class in geodetic_engine.geodesy.utils)
Hub CRS

I

imported_objects() (geodetic_engine.projdb.BuildReport method)
include_deprecated (geodetic_engine.georepository.GeorepositoryConfig attribute)
- (geodetic_engine.osdudb.OsduBuildConfig attribute)
- (geodetic_engine.projdb.ProjDbBuildConfig attribute)
is_bound (geodetic_engine.persistablereference.CrsReference property)
is_chained (geodetic_engine.geodesy.OperationCandidate property)

is_collapsible() (in module geodetic_engine.geodesy.utils)
is_concatenated (geodetic_engine.persistablereference.OperationReference property)
is_dynamic (geodetic_engine.geodesy.CoordinateReferenceSystem property)
is_geographic (geodetic_engine.geodesy.CoordinateReferenceSystem property)
is_operation (geodetic_engine.osdudb.catalog.Record attribute)
is_satisfied_by() (geodetic_engine.geodesy.OperationRequest method)
iter_collection() (geodetic_engine.georepository.GeorepositoryClient method)

K

keyword (geodetic_engine.persistablereference.esriwkt.Node attribute)

Kind (class in geodetic_engine.persistablereference)
kind (geodetic_engine.persistablereference.Reference attribute)

L

Late binding
late_bound (geodetic_engine.persistablereference.CrsReference attribute)
LATE_BOUND_CRS (geodetic_engine.persistablereference.Kind attribute)

latest_version() (geodetic_engine.georepository.GeorepositoryClient method)
load_config() (in module geodetic_engine.osdudb)
- (in module geodetic_engine.projdb)
looks_like_reference() (in module geodetic_engine.persistablereference)

M

MalformedReferenceError
measurement (geodetic_engine.persistablereference.UnitReference attribute)
method_name (geodetic_engine.geodesy.AppliedOperation attribute)
- (geodetic_engine.geodesy.OperationCandidate attribute)
- (geodetic_engine.geodesy.OperationStep attribute)
method_names (geodetic_engine.persistablereference.OperationReference property)
missing_grids (geodetic_engine.geodesy.TransformationResult property)
MissingCoordinateEpochError
MissingGridError, [1]

MissingReferencedObjectError
module

N

name (geodetic_engine.geodesy.AppliedOperation attribute)

naming_systems (geodetic_engine.osdudb.OsduBuildConfig attribute)
- (geodetic_engine.projdb.ProjDbBuildConfig attribute)
Node (class in geodetic_engine.persistablereference.esriwkt)
node() (geodetic_engine.persistablereference.esriwkt.Node method)
nodes() (geodetic_engine.persistablereference.esriwkt.Node method)
NONE (geodetic_engine.projdb.AuthorityPreference attribute)
north (geodetic_engine.geodesy.AreaOfUse attribute)
NotCollapsibleError

O

offset (geodetic_engine.persistablereference.UnitReference property)
open_license (geodetic_engine.geodesy.GridUsage attribute)
operation (geodetic_engine.geodesy.Transformation property)
- (geodetic_engine.geodesy.TransformationResult attribute)
- (geodetic_engine.persistablereference.CrsReference attribute)
operation() (geodetic_engine.osdudb.OsduCatalog method)
operation_from_geogtran() (in module geodetic_engine.persistablereference)
OperationCandidate (class in geodetic_engine.geodesy)
OperationNotAvailableError
OperationReference (class in geodetic_engine.persistablereference)
OperationRequest (class in geodetic_engine.geodesy)

OperationRoute (class in geodetic_engine.geodesy)
OperationStep (class in geodetic_engine.geodesy)
OsduBuildConfig (class in geodetic_engine.osdudb)
OsduCatalog (class in geodetic_engine.osdudb)
OsduCatalogError
output_db (geodetic_engine.osdudb.OsduBuildConfig attribute)
- (geodetic_engine.projdb.ProjDbBuildConfig attribute)
OutputWouldBeDiscarded
overwrite_rows (geodetic_engine.osdudb.OsduBuildConfig attribute)
- (geodetic_engine.projdb.BuildReport attribute)
- (geodetic_engine.projdb.ProjDbBuildConfig attribute)

P

package_name (geodetic_engine.geodesy.GridUsage attribute)
page_size (geodetic_engine.georepository.GeorepositoryConfig attribute)
PaginationTruncatedError
parse() (geodetic_engine.geodesy.OperationRequest class method)
parse_persistable_reference() (in module geodetic_engine.persistablereference)
persistableReference
PersistableReferenceError
Pipeline

pipeline (geodetic_engine.geodesy.TransformationResult attribute)
POSITION_VECTOR (geodetic_engine.geodesy.utils.Rotation attribute)
PROJ_DEFAULT (geodetic_engine.geodesy.OperationRoute attribute)
proj_string() (geodetic_engine.geodesy.utils.HelmertParameters method)
ProjDbBuildConfig (class in geodetic_engine.projdb)
ProjDbBuildError
projjson (geodetic_engine.geodesy.AppliedOperation attribute)
- (geodetic_engine.geodesy.OperationCandidate attribute)

R

raw (geodetic_engine.persistablereference.Reference attribute)
Record (class in geodetic_engine.osdudb.catalog)
records() (geodetic_engine.osdudb.OsduCatalog method)
Reference (class in geodetic_engine.persistablereference)
reference (geodetic_engine.geodesy.OperationStep property)
references (geodetic_engine.geodesy.OperationCandidate property)
register_versions (geodetic_engine.projdb.BuildReport attribute)
replace (geodetic_engine.osdudb.OsduBuildConfig attribute)
- (geodetic_engine.projdb.ProjDbBuildConfig attribute)
request_timeout (geodetic_engine.georepository.GeorepositoryConfig attribute)
requested (geodetic_engine.geodesy.AppliedOperation attribute)

requires_epoch (geodetic_engine.geodesy.AppliedOperation attribute)
- (geodetic_engine.geodesy.OperationCandidate attribute)
- (geodetic_engine.geodesy.Transformation property)
resolve() (geodetic_engine.georepository.GeorepositoryClient method)
Rotation (class in geodetic_engine.geodesy.utils)
rotations_arc_seconds() (geodetic_engine.geodesy.utils.HelmertParameters method)
Route
route (geodetic_engine.geodesy.AppliedOperation attribute)
rx (geodetic_engine.geodesy.utils.HelmertParameters attribute)
ry (geodetic_engine.geodesy.utils.HelmertParameters attribute)
rz (geodetic_engine.geodesy.utils.HelmertParameters attribute)

S

scale (geodetic_engine.geodesy.utils.HelmertParameters attribute)
- (geodetic_engine.persistablereference.UnitReference property)
scale_in_parts_per_million() (in module geodetic_engine.geodesy.utils)
scale_ppm() (geodetic_engine.geodesy.utils.HelmertParameters method)
SchemaDriftError
scope (geodetic_engine.georepository.GeorepositoryConfig attribute)
self_href() (geodetic_engine.georepository.GeorepositoryClient method)
source (geodetic_engine.projdb.BuildReport attribute)
source_axes (geodetic_engine.geodesy.TransformationResult property)
source_crs (geodetic_engine.geodesy.Transformation property)
- (geodetic_engine.geodesy.TransformationResult attribute)
source_file (geodetic_engine.osdudb.OsduBuildConfig attribute)
- (geodetic_engine.projdb.ProjDbBuildConfig attribute)

source_units (geodetic_engine.geodesy.TransformationResult property)
source_version (geodetic_engine.projdb.BuildReport attribute)
south (geodetic_engine.geodesy.AreaOfUse attribute)
Stated operation
stated() (geodetic_engine.geodesy.OperationRequest class method)
StatedOperation (class in geodetic_engine.geodesy)
Static CRS
status (geodetic_engine.projdb.BuildReport property)
steps (geodetic_engine.geodesy.AppliedOperation attribute)
- (geodetic_engine.geodesy.OperationCandidate attribute)
- (geodetic_engine.persistablereference.OperationReference attribute)
symbol (geodetic_engine.persistablereference.UnitReference attribute)

T

target_axes (geodetic_engine.geodesy.TransformationResult property)
target_crs (geodetic_engine.geodesy.Transformation property)
- (geodetic_engine.geodesy.TransformationResult attribute)
target_units (geodetic_engine.geodesy.TransformationResult property)
text (geodetic_engine.geodesy.OperationRequest attribute)
to_bound_crs() (geodetic_engine.persistablereference.CrsReference method)
to_crs() (geodetic_engine.persistablereference.CrsReference method)
to_dataframe() (geodetic_engine.geodesy.Coordinates method)
to_json() (geodetic_engine.geodesy.TransformationResult method)
- (geodetic_engine.projdb.BuildReport method)
to_json_dict() (geodetic_engine.geodesy.OperationCandidate method)
- (geodetic_engine.geodesy.TransformationResult method)
to_list() (geodetic_engine.geodesy.Coordinates method)
to_numpy() (geodetic_engine.geodesy.Coordinates method)
to_operation() (geodetic_engine.geodesy.StatedOperation method)
- (geodetic_engine.persistablereference.OperationReference method)

to_persistable_reference() (in module geodetic_engine.persistablereference)
to_si() (geodetic_engine.persistablereference.UnitReference method)
to_wkt() (geodetic_engine.geodesy.AppliedOperation method)
- (geodetic_engine.geodesy.OperationCandidate method)
token_url (geodetic_engine.georepository.GeorepositoryConfig attribute)
transform() (geodetic_engine.geodesy.Transformation method)
- (in module geodetic_engine.geodesy)
Transformation
- (class in geodetic_engine.geodesy)
TRANSFORMATION (geodetic_engine.persistablereference.Kind attribute)
TransformationFailedError
TransformationResult (class in geodetic_engine.geodesy)
TRANSFORMER_GROUP (geodetic_engine.geodesy.OperationRoute attribute)
tx (geodetic_engine.geodesy.utils.HelmertParameters attribute)
ty (geodetic_engine.geodesy.utils.HelmertParameters attribute)
type (geodetic_engine.osdudb.catalog.Record attribute)
tz (geodetic_engine.geodesy.utils.HelmertParameters attribute)

U

UnembeddableOperationError
UNIT_ABCD (geodetic_engine.persistablereference.Kind attribute)
unit_code (geodetic_engine.geodesy.AxisSpec attribute)
unit_conversion_factor (geodetic_engine.geodesy.AxisSpec attribute)
unit_name (geodetic_engine.geodesy.AxisSpec attribute)
UNIT_SCALE_OFFSET (geodetic_engine.persistablereference.Kind attribute)
UnitReference (class in geodetic_engine.persistablereference)
UnreadableDefinitionError

UnresolvableCRSError
UnresolvableGridError
unsupported_method_codes (geodetic_engine.osdudb.OsduBuildConfig attribute)
- (geodetic_engine.projdb.ProjDbBuildConfig attribute)
UnsupportedMethodError, [1]
UnsupportedReferenceError
url (geodetic_engine.geodesy.GridUsage attribute)
urn (geodetic_engine.geodesy.OperationRequest property)
usable (geodetic_engine.geodesy.OperationCandidate attribute)

V

validate() (in module geodetic_engine.projdb)
Value order
value_axis_abbreviations (geodetic_engine.geodesy.CoordinateReferenceSystem property)

value_axis_order (geodetic_engine.geodesy.CoordinateReferenceSystem property)
values (geodetic_engine.persistablereference.esriwkt.Node property)
version (geodetic_engine.persistablereference.Reference attribute)
versions() (geodetic_engine.georepository.GeorepositoryClient method)

W

west (geodetic_engine.geodesy.AreaOfUse attribute)
wkt (geodetic_engine.persistablereference.CrsReference attribute)

wkt() (geodetic_engine.georepository.GeorepositoryClient method)
write() (geodetic_engine.projdb.BuildReport method)
- (in module geodetic_engine.persistablereference.esriwkt)

Made with Sphinx and @pradyunsg's Furo