CitraClient.Schemas.CafSurfaceResponse (citra_client v0.3.0)

View Source

CAF surface data for visualization (base64-encoded float32 arrays).

Fields

  • :doppler_shifts — list of number() (API key: dopplerShifts)
  • :num_delay_bins — integer() (API key: numDelayBins)
  • :num_doppler_bins — integer() (API key: numDopplerBins)
  • :surface_base64 — String.t() (API key: surfaceBase64)
  • :time_delays — list of number() (API key: timeDelays)

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.CafSurfaceResponse{
  doppler_shifts: [number() | nil],
  num_delay_bins: integer() | nil,
  num_doppler_bins: integer() | nil,
  surface_base64: String.t() | nil,
  time_delays: [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.