CitraClient.Images (citra_client v0.3.0)
View SourceGenerated operations for OpenAPI tag images.
Summary
Functions
Delete Image
Get Fits Image Data
Get Satellite Image Statuses
Get Task Image Statuses
Get Telescope Image Statuses
Get Upload Status
List My Images
Upload Initiate
Functions
Delete Image
Delete an uploaded image and its associated S3 files
DELETE /my/images/{upload_id}
Path parameters
upload_id(path)
Get Fits Image Data
Get FITS image data formatted for Plotly heatmap visualization with ZScale contrast and region overlays.
Returns the processed FITS image data as a 2D array along with statistics and region data. If use_original is True, returns the original uploaded file instead.
GET /images/{upload_id}/data
Path parameters
upload_id(path)
Options (passed via keyword list)
:bin_factor— Binning factor for downsampling (1=full res, 2=half res, 4=quarter res, etc.):use_original— Return original file instead of processed file
Get Satellite Image Statuses
Get all image statuses for tasks associated with a specific satellite
GET /satellites/{satellite_id}/images
Path parameters
satellite_id(path)
Options (passed via keyword list)
:limit— Maximum number of uploads to return:offset— Number of uploads to skip
Get Task Image Statuses
Get all image statuses for a specific task
GET /tasks/{task_id}/images
Path parameters
task_id(path)
Get Telescope Image Statuses
Get image statuses for a specific telescope with pagination
GET /telescopes/{telescope_id}/images
Path parameters
telescope_id(path)
Options (passed via keyword list)
:limit— Maximum number of uploads to return:offset— Number of uploads to skip
Get Upload Status
Get the processing status of an uploaded image
GET /my/images/{upload_id}
Path parameters
upload_id(path)
List My Images
Get all uploaded images for the current user
GET /my/images
Upload Initiate
POST /my/images
Options (passed via keyword list)
:filename(required) — FITS filename with valid extension (.fits, .fit, .fts):telescope_id(required) — Telescope ID to upload image to:file_size(required) — File size in bytes:task_id— Optional task ID to associate with this upload:max_sources— Optional maximum number of sources to detect (defaults to 50):fov— Optional field of view in degrees (defaults to sensor FOV)