Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

sdynpy.fileio.sdynpy_psv.SensorHeadInfo

Signature

class sdynpy.fileio.sdynpy_psv.SensorHeadInfo(obj: 'Any') -> 'None'

Wrapper around COM sensor-head information.

Attributes

NameSummary
beam_gapBeam gap, including units when provided by the COM interface.
bragg_cell_frequencyBragg-cell frequency.
capsSensor-head capabilities as an IntFlag.
caps2Extended sensor-head capabilities as an IntFlag.
caps2_setIndividual extended sensor-head capability flags that are set.
caps2_valueExtended sensor-head capabilities as a raw integer bitmask.
caps_setIndividual sensor-head capability flags that are set.
caps_valueSensor-head capabilities as a raw integer bitmask.
coherence_optimizer_firmware_versionFirmware version of the coherence optimizer.
connectedWhether the sensor head is connected.
dimmer_maxMaximum laser-beam transmission.
dimmer_minMinimum laser-beam transmission.
firmware_versionSensor-head firmware version.
focus_far_limitFarthest focus position.
focus_near_limitNearest focus position.
illumination_intensity_maxMaximum illumination intensity.
illumination_intensity_minMinimum illumination intensity.
laser_delayLaser delay in seconds.
laser_firmware_versionLaser firmware version string.
laser_powerLaser power in milliwatts.
laser_wavelengthLaser wavelength in nanometers.
lower_objective_threshold_temperatureLower objective-threshold temperature.
max_rgb_led_color_indexMaximum RGB LED color index.
max_signal_balanceUpper end of the signal-balance range.
min_rgb_led_color_indexMinimum RGB LED color index.
min_signal_balanceLower end of the signal-balance range.
nameSensor-head name.
serial_numberSensor-head serial number.
sonde_nameSonde name.
standoff_distStand-off distance, including units when provided by the COM interface.
system_laser_powerSystem laser power in milliwatts.
unique_idUnique sensor-head identifier.
upper_objective_threshold_temperatureUpper objective-threshold temperature.

beam_gap

Beam gap, including units when provided by the COM interface.

bragg_cell_frequency

Bragg-cell frequency.

caps

Sensor-head capabilities as an IntFlag.

caps2

Extended sensor-head capabilities as an IntFlag.

caps2_set

Individual extended sensor-head capability flags that are set.

caps2_value

Extended sensor-head capabilities as a raw integer bitmask.

caps_set

Individual sensor-head capability flags that are set.

caps_value

Sensor-head capabilities as a raw integer bitmask.

coherence_optimizer_firmware_version

Firmware version of the coherence optimizer.

connected

Whether the sensor head is connected.

dimmer_max

Maximum laser-beam transmission.

dimmer_min

Minimum laser-beam transmission.

firmware_version

Sensor-head firmware version.

focus_far_limit

Farthest focus position.

focus_near_limit

Nearest focus position.

illumination_intensity_max

Maximum illumination intensity.

illumination_intensity_min

Minimum illumination intensity.

laser_delay

Laser delay in seconds.

laser_firmware_version

Laser firmware version string.

laser_power

Laser power in milliwatts.

laser_wavelength

Laser wavelength in nanometers.

lower_objective_threshold_temperature

Lower objective-threshold temperature.

max_rgb_led_color_index

Maximum RGB LED color index.

max_signal_balance

Upper end of the signal-balance range.

min_rgb_led_color_index

Minimum RGB LED color index.

min_signal_balance

Lower end of the signal-balance range.

name

Sensor-head name.

serial_number

Sensor-head serial number.

sonde_name

Sonde name.

standoff_dist

Stand-off distance, including units when provided by the COM interface.

system_laser_power

System laser power in milliwatts.

unique_id

Unique sensor-head identifier.

upper_objective_threshold_temperature

Upper objective-threshold temperature.

Methods

NameSummary
__init__Initialize self. See help(type(self)) for accurate signature.
has_capReturn whether the sensor head supports the given capability flag(s).
has_cap2Return whether the sensor head supports the given extended capability flag(s).

__init__

def sdynpy.fileio.sdynpy_psv.SensorHeadInfo.__init__(self, obj: 'Any') -> 'None'

Initialize self. See help(type(self)) for accurate signature.

has_cap

def sdynpy.fileio.sdynpy_psv.SensorHeadInfo.has_cap(self, cap: 'SensorHeadCaps') -> 'bool'

Return whether the sensor head supports the given capability flag(s).

has_cap2

def sdynpy.fileio.sdynpy_psv.SensorHeadInfo.has_cap2(self, cap: 'SensorHeadCaps2') -> 'bool'

Return whether the sensor head supports the given extended capability flag(s).