Module:
sdynpy.fileio.sdynpy_psvSource: GitHub
Signature¶
class sdynpy.fileio.sdynpy_psv.SensorHeadInfo(obj: 'Any') -> 'None'Wrapper around COM sensor-head information.
Attributes¶
| Name | Summary |
|---|---|
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. |
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¶
| Name | Summary |
|---|---|
__init__ | Initialize self. See help(type(self)) for accurate signature. |
has_cap | Return whether the sensor head supports the given capability flag(s). |
has_cap2 | Return whether the sensor head supports the given extended capability flag(s). |
__init__¶
Source: GitHub
def sdynpy.fileio.sdynpy_psv.SensorHeadInfo.__init__(self, obj: 'Any') -> 'None'Initialize self. See help(type(self)) for accurate signature.
has_cap¶
Source: GitHub
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¶
Source: GitHub
def sdynpy.fileio.sdynpy_psv.SensorHeadInfo.has_cap2(self, cap: 'SensorHeadCaps2') -> 'bool'Return whether the sensor head supports the given extended capability flag(s).