CitraClient.Schemas.OpticalObservationHistoryPoint (citra_client v0.3.0)

View Source

A single point in the optical observation history.

Fields

  • :angular_noise — number() (API key: angularNoise) — Angular noise in degrees
  • :angular_rate_noise — number() (API key: angularRateNoise) — Angular rate noise in degrees per second
  • :creation_epoch — DateTime.t() (API key: creationEpoch) — When the observation was created in the system
  • :declination — number() — Declination in degrees
  • :declination_rate — number() (API key: declinationRate) — Declination rate in degrees per second
  • :epoch — DateTime.t() — Observation epoch time
  • :id — UUID String.t() — Unique identifier for the observation
  • :max_wavelength — number() (API key: maxWavelength) — Maximum wavelength in nanometers
  • :min_wavelength — number() (API key: minWavelength) — Minimum wavelength in nanometers
  • :review_status — ReviewStatus (see OpenAPI spec) (API key: reviewStatus) — Review status of the observation
  • :right_ascension — number() (API key: rightAscension) — Right ascension in degrees
  • :right_ascension_rate — number() (API key: rightAscensionRate) — Right ascension rate in degrees per second
  • :satellite_id — UUID String.t() (API key: satelliteId) — Satellite this observation belongs to
  • :sensor_altitude — number() (API key: sensorAltitude) — Sensor altitude in kilometers above sea level
  • :sensor_latitude — number() (API key: sensorLatitude) — Sensor latitude in degrees
  • :sensor_longitude — number() (API key: sensorLongitude) — Sensor longitude in degrees
  • :solar_phase_angle — number() (API key: solarPhaseAngle) — Solar phase angle in degrees (-180 to 180)
  • :task_id — UUID String.t() (API key: taskId) — Task associated with this observation
  • :telescope_id — UUID String.t() (API key: telescopeId) — Telescope/sensor that made the observation
  • :user_group_id — UUID String.t() (API key: userGroupId) — User group that owns the observation
  • :user_id — UUID String.t() (API key: userId) — User who created the observation
  • :visual_magnitude — number() (API key: visualMagnitude) — Visual magnitude (apparent)

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.OpticalObservationHistoryPoint{
  angular_noise: number() | nil,
  angular_rate_noise: number() | nil,
  creation_epoch: DateTime.t() | nil,
  declination: number() | nil,
  declination_rate: number() | nil,
  epoch: DateTime.t() | nil,
  id: String.t() | nil,
  max_wavelength: number() | nil,
  min_wavelength: number() | nil,
  review_status: map() | String.t() | nil,
  right_ascension: number() | nil,
  right_ascension_rate: number() | nil,
  satellite_id: String.t() | nil,
  sensor_altitude: number() | nil,
  sensor_latitude: number() | nil,
  sensor_longitude: number() | nil,
  solar_phase_angle: number() | nil,
  task_id: String.t() | nil,
  telescope_id: String.t() | nil,
  user_group_id: String.t() | nil,
  user_id: String.t() | nil,
  visual_magnitude: 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.