Dimensions

class ansys.speos.core.sensor.BaseSensor.Dimensions(sensor_dimensions, default_values=True, 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_valuesbool

Uses default values when True.

stable_ctrbool

Variable to indicate if usage is inside class scope

Parameters:

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

• default_values (bool)

• stable_ctr (bool)

Notes

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

Overview

Methods

set_x_start	Set the minimum value on x axis.
set_x_end	Set the maximum value on x axis.
set_x_sampling	Set the sampling value on x axis.
set_y_start	Set the minimum value on y axis.
set_y_end	Set the maximum value on y axis.
set_y_sampling	Set the sampling value on y axis.

Import detail

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

Method detail

Dimensions.set_x_start(value=-50)

Set the minimum value on x axis.

Parameters:

valuefloat

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

Returns:

ansys.speos.core.sensor.BaseSensor.Dimensions

Dimensions.

Dimensions.set_x_end(value=50)

Set the maximum value on x axis.

Parameters:

valuefloat

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

Returns:

ansys.speos.core.sensor.BaseSensor.Dimensions

Dimensions.

Dimensions.set_x_sampling(value=100)

Set the sampling value on x axis.

Parameters:

valueint

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

Returns:

ansys.speos.core.sensor.BaseSensor.Dimensions

Dimensions.

Dimensions.set_y_start(value=-50)

Set the minimum value on y axis.

Parameters:

valuefloat

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

Returns:

ansys.speos.core.sensor.BaseSensor.Dimensions

Dimensions.

Dimensions.set_y_end(value=50)

Set the maximum value on y axis.

Parameters:

valuefloat

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

Returns:

ansys.speos.core.sensor.BaseSensor.Dimensions

Dimensions.

Dimensions.set_y_sampling(value=100)

Set the sampling value on y axis.

Parameters:

valueint

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

Returns:

ansys.speos.core.sensor.BaseSensor.Dimensions

Dimensions.