4.2.5. thuner.option.visualize

Display options classes.

pydantic model thuner.option.visualize.FigureOptions

Bases: BaseOptions

Base class for figure options.

Fields:

• animate (bool)

• function (Callable | str | None)

• name (str)

• single_color (bool)

• style (str)

• template (Any)

• type (Literal['FigureOptions'])

Validators:

field animate: bool = True

Whether to animate the figure.

field function: Callable | str | None [Required]

The function used to generate the figure.

field name: str [Required]

The base name of the figure.

field single_color: bool = False

Whether to use a single color for the object masks.

field style: str = None

The style of the figure.

field template: Any = None

The template for the figure. This is typically created during runtime.

field type: Literal['FigureOptions'] = 'FigureOptions'

pydantic model thuner.option.visualize.HorizontalAttributeOptions

Bases: VisualizeOptions

Class for horizontal attribute visualization options.

Fields:

• altitude_titles (bool)

• attribute_handlers (dict[str, list[Any]])

• conversion_time_step (float)

• method (thuner.utils.Retrieval | Callable | None)

• name (str)

• object_name (str)

• single_color (bool)

• template (Any)

• type (Literal['HorizontalAttributeOptions'])

Validators:

• _initialize_method » all fields

field altitude_titles: bool = True

Show the altitudes the objects were detected at as titles.

field attribute_handlers: dict[str, list[Any]] = None

Handlers for all the attributes to be shown in the figure.

field conversion_time_step: float = 3600

Time step in seconds used to convert velocities to displacements.

field method: Retrieval | Callable | None = None

Function and keyword arguments used to generate the figure.

field name: str [Required]

The base name of the figure.

field object_name: str [Required]

The name of the object to visualize.

field single_color: bool = False

Whether to use a single color for the object masks.

field template: Any = None

The template for the figure. This is typically created during runtime.

field type: Literal['HorizontalAttributeOptions'] = 'HorizontalAttributeOptions'

pydantic model thuner.option.visualize.ObjectRuntimeOptions

Bases: VisualizeOptions

Class for a given object’s runtime visualization options.

Fields:

• animate (bool)

• figures (list[thuner.option.visualize.FigureOptions])

• name (str)

• single_color (bool)

• type (Literal['ObjectRuntimeOptions'])

Validators:

• initialize_figures » all fields

field animate: bool = True

Whether to animate the figures.

field figures: list[FigureOptions] [Required]

The types of figures to generate.

field name: str [Required]

The object to generate runtime figures for.

field single_color: bool = False

Whether to use a single color for the object masks.

field type: Literal['ObjectRuntimeOptions'] = 'ObjectRuntimeOptions'

validator initialize_figures  »  all fields

Initialize the figure options.

pydantic model thuner.option.visualize.RuntimeOptions

Bases: BaseOptions

Class for runtime visualization options.

Fields:

• objects (dict[str, thuner.option.visualize.ObjectRuntimeOptions])

• type (Literal['RuntimeOptions'])

Validators:

field objects: dict[str, ObjectRuntimeOptions] = {}

The objects to generate runtime figures for.

field type: Literal['RuntimeOptions'] = 'RuntimeOptions'

pydantic model thuner.option.visualize.VisualizeOptions

Bases: BaseOptions

Base class for visualization options.

Fields:

• parent_local (str | pathlib.PosixPath | None)

• style (str)

• type (Literal['VisualizeOptions'])

• weights_filepath (str | None)

Validators:

• validate_parent_local » all fields

field parent_local: str | PosixPath | None = None

The local parent directory in which to save the figures.

field style: str = 'presentation'

The style of the figures. See thuner.visualize.styles for options.

field type: Literal['VisualizeOptions'] = 'VisualizeOptions'

field weights_filepath: str | None = None

Filepath to the regridder weights.

validator validate_parent_local  »  all fields

Ensure that the parent_local directory is set.