CitraClient.Schemas.TunableFilterConfig (citra_client v0.3.0)

View Source

Configuration for tunable filters (LCTF, AOTF).

Can observe any wavelength within the specified range with fixed bandwidth.

Example:

{
    "type": "tunable",
    "min_wavelength_nm": 400,
    "max_wavelength_nm": 900,
    "bandwidth_nm": 10,
    "wavelength_step_nm": 1.0
}

Fields

  • :bandwidth_nm — number() — Fixed bandwidth at all wavelengths (FWHM) in nanometers
  • :max_wavelength_nm — number() — Maximum tunable wavelength in nanometers
  • :min_wavelength_nm — number() — Minimum tunable wavelength in nanometers
  • :type — String.t() — Configuration type discriminator
  • :wavelength_step_nm — number() — Minimum wavelength adjustment step in nanometers

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.TunableFilterConfig{
  bandwidth_nm: number() | nil,
  max_wavelength_nm: number() | nil,
  min_wavelength_nm: number() | nil,
  type: String.t() | nil,
  wavelength_step_nm: 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.