DisplayParameters

class ansys.speos.core.generic.parameters.DisplayParameters

Parameters class for Display Source.

Overview

Attributes

image_file_uri	to the display image (png, jpeg, bmp, tiff, rgb).
x_start	Lower bound x axis.
x_end	Upper bound x axis.
y_start	Lower bound y axis.
y_end	Upper bound y axis.
axis_system	Location and orientation of the display source.
luminance	Luminance value in cd/m^2.
contrast_ratio	Contrast ratio of the display (None means not set).
intensity_type	Intensity parameters for the display (e.g., library intensity).
color_space_type	Color space type of the display, either ColorSpaceType enum for predefined or

Import detail

from ansys.speos.core.generic.parameters import DisplayParameters

Attribute detail

DisplayParameters.image_file_uri: str | pathlib.Path = ''

to the display image (png, jpeg, bmp, tiff, rgb).

DisplayParameters.x_start: float = -50.0

Lower bound x axis.

DisplayParameters.x_end: float = 50.0

Upper bound x axis.

DisplayParameters.y_start: float = -50.0

Lower bound y axis.

DisplayParameters.y_end: float = 50.0

Upper bound y axis.

DisplayParameters.axis_system: list[float] = [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1]

Location and orientation of the display source.

DisplayParameters.luminance: float = 50.0

Luminance value in cd/m^2.

DisplayParameters.contrast_ratio: int | None = None

Contrast ratio of the display (None means not set).

DisplayParameters.intensity_type: IntensityLambertianParameters | IntensityCosParameters | IntensitySymmetricGaussianParameters | IntensitAsymmetricGaussianParameters | IntensityLibraryParameters

Intensity parameters for the display (e.g., library intensity).

DisplayParameters.color_space_type: ColorSpaceType | UserDefinedColorSpaceParameters

Color space type of the display, either ColorSpaceType enum for predefined or UserDefinedColorSpaceParameters for custom.