CitraClient.Schemas.CafResultSummary (citra_client v0.3.0)

View Source

Full CAF result record for a single antenna pair (no surface data).

Fields

  • :bandwidth_hz — number() (API key: bandwidthHz)
  • :best_fdoa_hz — number() (API key: bestFdoaHz)
  • :best_snr_db — number() (API key: bestSnrDb)
  • :best_tdoa_seconds — number() (API key: bestTdoaSeconds)
  • :center_frequency_hz — number() (API key: centerFrequencyHz)
  • :collection_request_id — UUID String.t() (API key: collectionRequestId)
  • :comparison_antenna_id — UUID String.t() (API key: comparisonAntennaId)
  • :comparison_antenna_name — String.t() (API key: comparisonAntennaName)
  • :comparison_task_id — UUID String.t() (API key: comparisonTaskId)
  • :comparison_upload_id — UUID String.t() (API key: comparisonUploadId)
  • :creation_epoch — DateTime.t() (API key: creationEpoch)
  • :has_surface — boolean() (API key: hasSurface)
  • :id — UUID String.t()
  • :is_self_comparison — boolean() (API key: isSelfComparison)
  • :overlap_duration_seconds — number() (API key: overlapDurationSeconds)
  • :peaks — list of CitraClient.Schemas.CafPeak.t()
  • :reference_antenna_id — UUID String.t() (API key: referenceAntennaId)
  • :reference_antenna_name — String.t() (API key: referenceAntennaName)
  • :reference_task_id — UUID String.t() (API key: referenceTaskId)
  • :reference_upload_id — UUID String.t() (API key: referenceUploadId)
  • :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.CafResultSummary{
  bandwidth_hz: number() | nil,
  best_fdoa_hz: number() | nil,
  best_snr_db: number() | nil,
  best_tdoa_seconds: number() | nil,
  center_frequency_hz: number() | nil,
  collection_request_id: String.t() | nil,
  comparison_antenna_id: String.t() | nil,
  comparison_antenna_name: String.t() | nil,
  comparison_task_id: String.t() | nil,
  comparison_upload_id: String.t() | nil,
  creation_epoch: DateTime.t() | nil,
  has_surface: boolean() | nil,
  id: String.t() | nil,
  is_self_comparison: boolean() | nil,
  overlap_duration_seconds: number() | nil,
  peaks: [CitraClient.Schemas.CafPeak.t() | map() | nil],
  reference_antenna_id: String.t() | nil,
  reference_antenna_name: String.t() | nil,
  reference_task_id: String.t() | nil,
  reference_upload_id: String.t() | 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.