WavelengthsRange

class ansys.speos.core.sensor.BaseSensor.WavelengthsRange(wavelengths_range, default_parameters=None, stable_ctr=False)

Range of wavelengths.

By default, a range from 400nm to 700nm is chosen, with a sampling of 13.

Parameters:

wavelengths_rangeansys.api.speos.sensor.v1.common_pb2.WavelengthsRange

Wavelengths range protobuf object to modify.

default_parametersansys.speos.core.generic.parameters.WavelengthsRangeParameters, 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:

• wavelengths_range (Union[ansys.api.speos.sensor.v1.common_pb2.WavelengthsRange, ansys.api.speos.sensor.v1.sensor_pb2.TypeColorimetric])

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

• stable_ctr (bool)

Notes

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

Overview

Properties

start	Minimum wavelength of the range.
end	Maximum wavelength of the range.
sampling	Wavelength sampling of between start and end value.

Import detail

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

Property detail

property WavelengthsRange.start: float

Minimum wavelength of the range.

Parameters:

valuefloat

Minimum wavelength (nm). By default, 400.

Returns:

float

Lower Bound of the wavelength range.

property WavelengthsRange.end: float

Maximum wavelength of the range.

Parameters:

valuefloat

Maximum wavelength (nm). By default, 700.

Returns:

float

Upper Bound of the wavelength range.

property WavelengthsRange.sampling: int

Wavelength sampling of between start and end value.

Parameters:

valueint

Number of wavelengths to be taken into account between the minimum and maximum wavelengths range. By default, 13.

Returns:

int

Number of Samples used to split the wavelength range.