CitraClient.Schemas.DiscreteFilterConfig (citra_client v0.3.0)

View Source

Configuration for telescopes with discrete filter wheels.

Example:

{
    "type": "discrete",
    "filters": [
        {"name": "Red", "central_wavelength_nm": 630, "bandwidth_nm": 100},
        {"name": "Ha", "central_wavelength_nm": 656.3, "bandwidth_nm": 7},
        {"name": "Clear", "central_wavelength_nm": 550, "bandwidth_nm": 300}
    ]
}

Fields

  • :filters — list of CitraClient.Schemas.FilterSpec.t() — List of available filters
  • :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.DiscreteFilterConfig{
  filters: [CitraClient.Schemas.FilterSpec.t() | map() | 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.