CitraClient.Schemas.FilterExpandResponse (citra_client v0.3.0)

View Source

Response schema for filter expansion with wavelength information.

Fields

  • :bandwidth_nmnumber() — Full width at half maximum (FWHM) in nanometers
  • :central_wavelength_nmnumber() — Central wavelength in nanometers
  • :is_knownboolean() — Whether filter was found in standard library
  • :nameString.t() — Filter name (as provided)

Summary

Functions

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

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.FilterExpandResponse{
  bandwidth_nm: number() | nil,
  central_wavelength_nm: number() | nil,
  is_known: boolean() | nil,
  name: 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.