Skip to main content

A Sensor Geometry Application Re-usable by-Design

Project description

ASGARD

A Sensor Geometry Application Reusable by-Design

ASGARD is available on PyPI and can be installed with:

pip install asgard-eopf

→ Read the full ASGARD documentation here.

Purpose

Main purposes of the GEOLIB are to:

  • Serve as a base geometry bloc for different types of sensors
  • Provide a flexible abstraction layer
  • Support the generation of L1/L2 products.
  • Provide compatibility with Sentinel missions 1, 2, 3 and beyond

The current Legacy codes for geometry application are:

  • EOCFI library for Sentinel-1/3,
  • S2GEO library, which SXGEO is a simplification for Sentinel-2

However, these codes are not in Python and not Open source. ASGARD was first developed to tackle those points of the Sentinel-1/2/3 geo-libraries, being in Python and Open-source.

Two versions of ASGARD can be used:

  • ASGARD (refactored): Full re-implemented library not calling the Legacy code (EOCFI and SXGEO) of Sentinel1/2/3. It contains all the Geometry init schemas and Generic Models presented below
  • ASGARD-Legacy: It is based on ASGARD in order to take and have the same the Geometry init schemas than ASGARD. It also uses generic parts of ASGARD as some models for example. It was developed to have a common interface than ASGARD but calling Legacy libraries instead of the Python re-implementation. This version can be used to assess geometric quality and processing performances of ASGARD. However, it will be deprecated at the end, once the ASGARD library will be fully validated and deployed. Note: It is to be noted that ASGARD is already intensively validated as presented in the Validation, but not yet fully deployed.

High-level API

Geometries

This tool is based on a Geometry abstraction, derived into specialized types of sensors. At the end, you find a geometry object for each Sentinel sensor. These geometries expose the High-level API. This object is initialized from a JSON-like structure with necessary metadata. This metadata must be extracted from products, auxiliary data files.

Each geometry builds a set of coherent Low-level Models.

Geometries initialization

The abstract class AbstractGeometry is derived for each sensor:

  • {class}S1SARGeometry <asgard.sensors.sentinel1.csar.S1SARGeometry>
  • {class}S2MSIGeometry <asgard.sensors.sentinel2.msi.S2MSIGeometry>
  • {class}S3OLCIGeometry <asgard.sensors.sentinel3.olci.S3OLCIGeometry>
  • {class}S3SLSTRGeometry <asgard.sensors.sentinel3.slstr.S3SLSTRGeometry>
  • ...

Each class is initialized with a custom dictionary. This dictionary must match the JSON schema given by the init_schema method. This will look like:

from asgard.sensors.sentinel3 import S3OLCIGeometry

config = {
  "sat": "SENTINEL_3",
  "orbit_aux_info": {
    "orbit_state_vectors": [
      {
        "times": {
            "TAI": {"offsets": np.array([...])},
            "UTC": {"offsets": np.array([...])},
            "UT1": {"offsets": np.array([...])},
        },
        "positions": np.array([...]),
        "velocities": np.array([...]),
        "absolute_orbit": np.array([...]),
      },
    ],
  },
  "dem_config_file": "path_to_dem",
  "pointing_vectors": {
    "X": np.array([...]),
    "Y": np.array([...]),
  },
  "thermoelastic": {
    "julian_days": np.array([...]),
    "quaternions_1": np.array([...]),
    "quaternions_2": np.array([...]),
    "quaternions_3": np.array([...]),
    "quaternions_4": np.array([...]),
    "on_orbit_positions_angle": np.array([...]),
  },
  "frame": {
      "times": {"offsets": np.array([...])},
  },
}

my_product = S3OLCIGeometry(**config)

The input dictionary should contain all numeric and string values necessary to initialize the geometry. Most of the parsing from L0/L1 product tree metadata files should be done before. When the input data is large, Numpy arrays will be used instead of plain Python Lists.

High-level functions

Each class implementing the Geometry abstraction should provide the following features:

  • direct_loc(): perform direct location for a set of measurements
  • inverse_loc(): perform inverse location for a set of ground locations
  • sun_angles(): compute Sun angles for a set of ground locations and times
  • sun_distances(): compute Sun distances given times and optional ground locations
  • incidence_angles(): compute the viewing angles (ground to satellite) for a set of ground locations and times
  • footprint(): compute the ground footprint of a geometric unit

Low-level models

Each geometry builds a set of coherent models. For example for Sentinel-2:

These models are an abstraction layers to provide a set of features:

  • TimestampModel:
    • Give a timestamp for each measurement
  • OrbitModel:
    • Propagates the orbit
    • Interpolates the orbit to retrieve position, velocity and acceleration
  • PlatformModel:
    • Models the different frame transformation between the satellite orbital frame and the instrument frame
    • Computes the attitude of the instrument frame at a given time
  • PointingModel:
    • Models the directions where the instrument can look. Examples:
      • field of view of an optical sensor
      • synthetic antenna orientation
    • Computes the line of sight (at the sensor side) for a given measurement/detector/time.
  • PropagationModel:
    • Handles the propagation of a signal (micro-wave, light, ...) from a target (Earth, Moon, star) to the sensor.
    • Examples:
      • Intersection of a line-of-sight (estimated at the instrument side) with a DEM.
      • Intersection of a range/azimuth SAR pointing with a DEM

Other objects provide some base functions:

  • Frame:
    • Handles frames and coordinate system
  • Transform:
    • Handles frames transforms (maybe time dependant)
  • Body:
    • Model of the Earth, Moon and Sun
    • Handles Earth position bulletin
    • Handle surface models (ellipsoid, DEM)
  • TimeReference:
    • Handles conversion between time references

Low-level API

The low-level API rely on the Model abstraction. Each model will implement a part of the "georeferencing pipeline". Most of them use the Rugged/Orekit wrappers as backend. Only two are also available with the EOCFI backend:

  • {class}ExplorerTimeReference <asgard-legacy.models.explorer.ExplorerTimeReference>
  • {class}ExplorerEarthBody <asgard-legacy.models.explorer.ExplorerEarthBody>

All the models are initialized based on keyword arguments, which conform to the JSON schema returned by init_schema(). Here is a list of low-level models, by category:

Category Model Role
Time {class}TimeReference <asgard.models.time.TimeReference> Conversion between timescales
leap seconds
Conversion from ascii, cuc, transport
Body {class}EarthBody <asgard.models.body.EarthBody> Cartesian geodetic conversion
Frame conversion
Sun position
Topocentric conversion
Timestamp {class}LineDetectorTimestampModel <asgard.models.lineardetector.LineDetectorTimestampModel> Line datation for line detector sensors
Timestamp {class}ScanningDetectorTimestampModel <asgard.models.scanningdetector.ScanningDetectorTimestampModel> Sample datation for scanning detector
(used for SLSTR)
Orbit {class}GenericOrbitModel <asgard.models.orbit.GenericOrbitModel> Interpolate OSV
Interpolate attitude
Orbit information (ANX, ...)
Platform {class}GenericPlatformModel <asgard.models.platform.GenericPlatformModel> Transform instrument frame to satellite frame
Pointing {class}LineDetectorPointingModel <asgard.models.lineardetector.LineDetectorPointingModel> Poining vector for line detector sensors
Pointing {class}ScanningDetectorPointingModel <asgard.models.scanningdetector.ScanningDetectorPointingModel> SLSTR pointing model
Propagation {class}PropagationModel <asgard.models.propagation.PropagationModel> Line of sight propagation
DEM and ellipsoid intersection
Propagation {class}GroundRangePropagationModel <asgard.models.range.GroundRangePropagationModel> Ground range propagation
Replacement of xp_target_ground_range

Validation

The validation of ASGARD and ASGARD-Legacy implementations is presented in the validation document.

Some complementary and new results (overwriting the ones from the validation document) for 0.5.2 are available in the Additional_results_for_V5_2024-12

Additional comparisons/validations were performed (0.5.2) to compare asgard-legacy behaviour versus EOCFI and are available in EOCFI_ASGARD_Comparison_TechnicalNote.pdf

New dedicated L0 footprints validation (0.7.0) is available here: FootprintL0Validation.pdf Please note that this is in complement to the tests implemented directly in ASGARD.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

asgard_eopf-2.0.0rc9.tar.gz (82.6 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

asgard_eopf-2.0.0rc9-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.whl (387.9 kB view details)

Uploaded CPython 3.14manylinux: glibc 2.17+ x86-64

asgard_eopf-2.0.0rc9-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl (378.8 kB view details)

Uploaded CPython 3.13manylinux: glibc 2.17+ x86-64

asgard_eopf-2.0.0rc9-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl (387.5 kB view details)

Uploaded CPython 3.12manylinux: glibc 2.17+ x86-64

asgard_eopf-2.0.0rc9-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl (385.8 kB view details)

Uploaded CPython 3.11manylinux: glibc 2.17+ x86-64

File details

Details for the file asgard_eopf-2.0.0rc9.tar.gz.

File metadata

  • Download URL: asgard_eopf-2.0.0rc9.tar.gz
  • Upload date:
  • Size: 82.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for asgard_eopf-2.0.0rc9.tar.gz
Algorithm Hash digest
SHA256 e5b0a5543d146eed23924168363d06382c105c4f0273d0d061493018b0c804be
MD5 026a93d38ee47ef527b54a4ca3199338
BLAKE2b-256 6aed2b031efc3c98e0e28edc80f19ae4d5340386bbe8f4d0f0bc195084209ea6

See more details on using hashes here.

File details

Details for the file asgard_eopf-2.0.0rc9-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for asgard_eopf-2.0.0rc9-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 e95fae823e154194ffcc6726aed9be68c650a9b77a4ff909a5063029f7384378
MD5 e4dbf3fdcfc84fdc466db160a57c4b3b
BLAKE2b-256 5ee8dcd1f8d2345ef0712e500b0be1dafe496c4e6ecb20842e0f0d28b713e289

See more details on using hashes here.

File details

Details for the file asgard_eopf-2.0.0rc9-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for asgard_eopf-2.0.0rc9-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 9be45cb8d32b75bd12e713713f2b405311f7ae38693a47c40491c49364aef0fa
MD5 76e38cd3dd0d233000187791e4fe4a50
BLAKE2b-256 9da584611578972a9ffb85c5b0a9654ac0618d4557fa14a7da4a302bcf4536fb

See more details on using hashes here.

File details

Details for the file asgard_eopf-2.0.0rc9-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for asgard_eopf-2.0.0rc9-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 abdf018dccda62f75c8399d4262a57b8cb80bcc49201575d5b972474def3f279
MD5 719ed8b52c878e84e74e072f21fb82db
BLAKE2b-256 f6eadebd72ef463038c3f3f4e8d9cf0d8ae5dcc922fa0200261715750ba608ac

See more details on using hashes here.

File details

Details for the file asgard_eopf-2.0.0rc9-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for asgard_eopf-2.0.0rc9-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 6c51621dfb37024a1071f43131c0d4f55f4290bb0c18ee1c5310adee9e8c7dd3
MD5 e515f22794a51a60b5afba2a97247f47
BLAKE2b-256 356a7ace8c5075aa0e9a0a7e1ee832cab95ba9e9035dd09b95828dfd067166c4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page