NxAudio.Visualizations.SpectrogramConfig (nx_audio v0.3.1)

View Source

Defines the configuration schema for the Spectrogram visualization.

Summary

Types

t()

  • :title (String.t/0) - Title of the plot. The default value is "Spectrogram".

Functions

validate!(config)

Validates the given configuration options and returns the parsed configuration.

Types

t()

@type t() :: [
  title: binary(),
  scale_type: term(),
  color_domain: term(),
  color_scheme: term(),
  bin_maxbins: non_neg_integer(),
  x_axis_label: binary(),
  y_axis_label: binary(),
  width: non_neg_integer(),
  height: non_neg_integer()
]

  • :title (String.t/0) - Title of the plot. The default value is "Spectrogram".

  • :scale_type - Scale for the color encoding. The default value is :linear.

  • :color_domain (term/0) - [min, max] for the color scale (e.g. [0, 500])

  • :color_scheme - Color scheme for the plot. The default value is :viridis.

  • :bin_maxbins (non_neg_integer/0) - Approx. max bins for the time and frequency dimensions. The default value is 60.

  • :x_axis_label (String.t/0) - Label for the x-axis. The default value is "Time Index".

  • :y_axis_label (String.t/0) - Label for the y-axis. The default value is "Frequency Index".

  • :width (non_neg_integer/0) - Chart width in pixels. The default value is 800.

  • :height (non_neg_integer/0) - Chart height in pixels. The default value is 600.

Functions

validate!(config)

@spec validate!(backend_options :: Keyword.t()) :: t()

Validates the given configuration options and returns the parsed configuration.