WavelengthsRange

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

Uses default values when True.

stable_ctrbool

Variable to indicate if usage is inside class scope

Parameters:

• wavelengths_range (ansys.api.speos.sensor.v1.common_pb2.WavelengthsRange)

• default_values (bool)

• stable_ctr (bool)

Notes

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

Overview

Methods

set_start	Set the minimum wavelength of the range.
set_end	Set the maximum wavelength of the range.
set_sampling	Set the sampling of wavelengths range.

Import detail

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

Method detail

WavelengthsRange.set_start(value=400)

Set the minimum wavelength of the range.

Parameters:

valuefloat

Minimum wavelength (nm). By default, 400.

Returns:

ansys.speos.core.sensor.BaseSensor.WavelengthsRange

WavelengthsRange.

WavelengthsRange.set_end(value=700)

Set the maximum wavelength of the range.

Parameters:

valuefloat

Maximum wavelength (nm). By default, 700.

Returns:

ansys.speos.core.sensor.BaseSensor.WavelengthsRange

WavelengthsRange.

WavelengthsRange.set_sampling(value=13)

Set the sampling of wavelengths range.

Parameters:

valueint

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

Returns:

ansys.speos.core.sensor.BaseSensor.WavelengthsRange

WavelengthsRange.