Dimensions

class ansys.speos.core.sensor.BaseSensor.Dimensions(sensor_dimensions, default_parameters=None, stable_ctr=False)

Dimensions of the sensor.

By default, for both x and y axis: from -50mm to 50mm is chosen, with a sampling of 100.

Parameters:

sensor_dimensionsansys.api.speos.sensor.v1.common_pb2.SensorDimensions

SensorDimensions protobuf object to modify.

default_parametersansys.speos.core.generic.parameters.DimensionsParameters, optional

If defined the values in the sensor instance will be overwritten by the values of the data class

stable_ctrbool

Variable to indicate if usage is inside class scope

Parameters:

• sensor_dimensions (ansys.api.speos.sensor.v1.common_pb2.SensorDimensions)

• default_parameters (Union[None, ansys.speos.core.generic.parameters.DimensionsParameters])

• stable_ctr (bool)

Notes

Do not instantiate this class yourself, use set_dimensions method available in sensor classes.

Overview

Properties

x_start	Minimum value on x axis.
x_end	Maximum value on x axis.
x_sampling	Value of the sampling on x axis.
y_start	Minimum value on y axis.
y_end	Maximum value on y axis.
y_sampling	Value of the sampling on y axis.

Import detail

from ansys.speos.core.sensor.BaseSensor import Dimensions

Property detail

property Dimensions.x_start: float

Minimum value on x axis.

Parameters:

valuefloat

Minimum value on x axis (mm). By default, -50.

Returns:

float

minimum value in x axis

property Dimensions.x_end: float

Maximum value on x axis.

Parameters:

valuefloat

Maximum value on x axis (mm). By default, 50.

Returns:

float

maximum value on x axis.

property Dimensions.x_sampling: int

Value of the sampling on x axis.

Parameters:

valueint

The number of pixels of the XMP map on x axis. By default, 100.

Returns:

float

sampling value on x axis.

property Dimensions.y_start: float

Minimum value on y axis.

Parameters:

valuefloat

Minimum value on y axis (mm). By default, -50.

Returns:

float

minimum value in y axis

property Dimensions.y_end: float

Maximum value on y axis.

Parameters:

valuefloat

Maximum value on y axis (mm). By default, 50.

Returns:

float

maximum value on y axis.

property Dimensions.y_sampling: int

Value of the sampling on y axis.

Parameters:

valueint

The number of pixels of the XMP map on y axis. By default, 100.

Returns:

float

sampling value on y axis.