CitraClient.Schemas.CafTimeBinSummary (citra_client v0.3.0)

View Source

Aggregated summary for a single time bin across all antenna pairs.

Fields

  • :antenna_names — list of String.t() (API key: antennaNames)
  • :bandwidth_hz — number() (API key: bandwidthHz)
  • :best_snr_db — number() (API key: bestSnrDb)
  • :center_frequency_hz — number() (API key: centerFrequencyHz)
  • :overlap_duration_seconds — number() (API key: overlapDurationSeconds)
  • :pair_count — integer() (API key: pairCount)
  • :time_bin_epoch — DateTime.t() (API key: timeBinEpoch)
  • :time_bin_index — integer() (API key: timeBinIndex)

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.CafTimeBinSummary{
  antenna_names: [String.t() | nil],
  bandwidth_hz: number() | nil,
  best_snr_db: number() | nil,
  center_frequency_hz: number() | nil,
  overlap_duration_seconds: number() | nil,
  pair_count: integer() | nil,
  time_bin_epoch: DateTime.t() | nil,
  time_bin_index: integer() | 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.