CitraClient.Schemas.FITSImageDataResponse (citra_client v0.3.0)

View Source

Response model for FITS image data formatted for Plotly heatmap

Fields

  • :circles — list of CitraClient.Schemas.RegionCircle.t()
  • :headers — map()
  • :height — integer()
  • :image_data — String.t() (API key: imageData)
  • :max_value — number() (API key: maxValue)
  • :mean_value — number() (API key: meanValue)
  • :min_value — number() (API key: minValue)
  • :original_filename — String.t() (API key: originalFilename)
  • :polygons — list of CitraClient.Schemas.RegionPolygon.t()
  • :std_value — number() (API key: stdValue)
  • :upload_id — UUID String.t() (API key: uploadId)
  • :width — integer()
  • :zscale_max — number() (API key: zscaleMax)
  • :zscale_min — number() (API key: zscaleMin)

Summary

Types

t()

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.

Types

t()

@type t() :: %CitraClient.Schemas.FITSImageDataResponse{
  circles: [CitraClient.Schemas.RegionCircle.t() | map() | nil],
  headers: map() | nil,
  height: integer() | nil,
  image_data: String.t() | nil,
  max_value: number() | nil,
  mean_value: number() | nil,
  min_value: number() | nil,
  original_filename: String.t() | nil,
  polygons: [CitraClient.Schemas.RegionPolygon.t() | map() | nil],
  std_value: number() | nil,
  upload_id: String.t() | nil,
  width: integer() | nil,
  zscale_max: number() | nil,
  zscale_min: number() | nil
}

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.