BaseSensor

class ansys.speos.core.sensor.BaseSensor(project, name, description='', metadata=None, sensor_instance=None)

Base class for Sensor.

Parameters:

projectansys.speos.core.project.Project

Project that will own the feature.

namestr

Name of the feature.

descriptionstr

Description of the feature. By default, "".

metadataMapping[str, str]

Metadata of the feature. By default, {}.

sensor_instanceansys.api.speos.scene.v2.scene_pb2.Scene.SensorInstance, optional

Sensor instance to provide if the feature does not has to be created from scratch By default, None, means that the feature is created from scratch by default.

Attributes:

sensor_template_linkansys.speos.core.kernel.sensor_template.SensorTemplateLink

Link object for the sensor template in database.

Parameters:

• project (BaseSensor.__init__.project)

• name (str)

• description (str)

• metadata (Optional[Mapping[str, str]])

• sensor_instance (Optional[ansys.speos.core.kernel.scene.ProtoScene.SensorInstance])

Notes

This is a Super class, Do not instantiate this class yourself

Overview

Methods

get	Get dictionary corresponding to the project - read only.
commit	Save feature: send the local data to the speos server database.
reset	Reset feature: override local data by the one from the speos server database.
delete	Delete feature: delete data from the speos server database.

Attributes

sensor_template_link

Link object for the sensor template in database.

Special methods

__str__

Return the string representation of the sensor.

Import detail

from ansys.speos.core.sensor import BaseSensor

Attribute detail

BaseSensor.sensor_template_link = None

Link object for the sensor template in database.

Method detail

BaseSensor.get(key='')

Get dictionary corresponding to the project - read only.

Parameters:

key: str

Returns:

str | dict

BaseSensor.__str__()

Return the string representation of the sensor.

BaseSensor.commit()

Save feature: send the local data to the speos server database.

Returns:

ansys.speos.core.sensor.BaseSensor

Sensor feature.

BaseSensor.reset()

Reset feature: override local data by the one from the speos server database.

Returns:

ansys.speos.core.sensor.BaseSensor

Sensor feature.

BaseSensor.delete()

Delete feature: delete data from the speos server database.

The local data are still available

Returns:

ansys.speos.core.sensor.BaseSensor

Sensor feature.

Classes

WavelengthsRange	Range of wavelengths.
Dimensions	Dimensions of the sensor.
Colorimetric	Type of sensor : Colorimetric.
Spectral	Type of sensor : Spectral.
FaceLayer	Layer composed of name and geometries.
LayerTypeFace	Type of layer : Face.
LayerTypeSequence	Type of layer : Sequence.
LayerTypeIncidenceAngle	Type of layer : IncidenceAngle.