CitraClient.Schemas.HyperspectralConfig (citra_client v0.3.0)

View Source

Configuration for hyperspectral instruments and spectrographs.

Captures entire spectrum simultaneously across many channels.

Example:

{
    "type": "hyperspectral",
    "min_wavelength_nm": 400,
    "max_wavelength_nm": 1000,
    "spectral_resolution_nm": 2.0,
    "num_channels": 300
}

Fields

  • :max_wavelength_nm — number() — Maximum wavelength coverage in nanometers
  • :min_wavelength_nm — number() — Minimum wavelength coverage in nanometers
  • :num_channels — integer() — Number of spectral channels (optional)
  • :spectral_resolution_nm — number() — Spectral resolution (wavelength per channel) in nanometers
  • :type — String.t() — Configuration type discriminator

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.HyperspectralConfig{
  max_wavelength_nm: number() | nil,
  min_wavelength_nm: number() | nil,
  num_channels: integer() | nil,
  spectral_resolution_nm: number() | nil,
  type: String.t() | 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.