CitraClient.CafResults (citra_client v0.3.0)

View Source

Generated operations for OpenAPI tag caf-results.

Summary

Functions

get_caf_collection_requests(satellite_id)

Get Caf Collection Requests

Get collection requests that have CAF results for a satellite, with aggregated CAF timeline data on each CR.

GET /satellites/{satellite_id}/caf-collection-requests

Path parameters

  • satellite_id (path)

get_caf_results(collection_request_id, opts \\ [])

Get Caf Results

Get CAF results for a collection request, optionally filtered by time bin.

Returns all antenna pair results with peaks (no surface data).

GET /collection-requests/{collection_request_id}/caf-results

Path parameters

  • collection_request_id (path)

Options (passed via keyword list)

  • :time_bin_index — Filter to a specific time bin index

get_caf_surface(caf_result_id)

Get Caf Surface

Get CAF surface data for a specific result (lazy-loaded from S3).

Returns base64-encoded float32 surface array with time delay and doppler shift axes.

GET /caf-results/{caf_result_id}/surface

Path parameters

  • caf_result_id (path)