Skip to content

OL 756¤

Communicate with an OL 756 spectroradiometer from Optronic Laboratories.

OL756 (Interface) ¤

OL756(equipment: Equipment)


              flowchart LR
              msl.equipment_resources.optronic_labs.ol756ocx_64.OL756[OL756]
              msl.equipment.schema.Interface[Interface]

                              msl.equipment.schema.Interface --> msl.equipment_resources.optronic_labs.ol756ocx_64.OL756
                


              click msl.equipment_resources.optronic_labs.ol756ocx_64.OL756 href "" "msl.equipment_resources.optronic_labs.ol756ocx_64.OL756"
              click msl.equipment.schema.Interface href "" "msl.equipment.schema.Interface"

Communicate with an OL 756 spectroradiometer from Optronic Laboratories.

This class can be used with either a 32- or 64-bit Python interpreter to call the 32-bit functions in the OL756SDKActiveXCtrl library.

Regular-expression patterns that are used to select this Resource when connect() is called. 

manufacturer=r"Optronic"
model=r"(OL)?\s*756"
flags=IGNORECASE

Parameters:

Name Type Description Default
equipment Equipment

An Equipment instance.

 required

A Connection instance supports the following properties for an OL 756 spectroradiometer.

Connection Properties:

Name Type Description
mode int

Connection mode (0: RS-232, 1: USB). Default: 1 (USB)
com_port int

The COM port number (RS-232 mode only). Default: 1
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
def __init__(self, equipment: Equipment) -> None:
    r"""Communicate with an OL 756 spectroradiometer from Optronic Laboratories.

    This class can be used with either a 32- or 64-bit Python interpreter
    to call the 32-bit functions in the `OL756SDKActiveXCtrl` library.

    Regular-expression patterns that are used to select this Resource when
    [connect()][msl.equipment.schema.Equipment.connect] is called.
    ```python
    manufacturer=r"Optronic"
    model=r"(OL)?\s*756"
    flags=IGNORECASE
    ```

    Args:
        equipment: An [Equipment][] instance.

    A [Connection][msl.equipment.schema.Connection] instance supports the following
    _properties_ for an OL 756 spectroradiometer.

    Attributes: Connection Properties:
        mode (int): Connection mode (`0`: RS-232, `1`: USB). _Default: `1` (USB)_
        com_port (int): The COM port number (RS-232 mode only). _Default: `1`_
    """
    self._client: Client64 | None = None
    super().__init__(equipment)

    assert equipment.connection is not None  # noqa: S101

    try:
        self._client = Client64(
            Path(__file__).parent / "ol756ocx_32.py",
            prog_id=equipment.connection.address[5:],
            mode=equipment.connection.properties.get("mode", 1),
            com_port=equipment.connection.properties.get("com_port", 1),
        )
    except ConnectionTimeoutError as e:
        msg = f"Cannot initialize the OL756 SDK.\n{e.reason}"
        raise MSLConnectionError(self, msg) from None

    self._request32: Callable[..., Any] = self._client.request32

    if self._request32("mode") == -1:
        self.disconnect()
        msg = "Cannot connect to the OL756 spectroradiometer. Is it turned on and connected to the computer?"
        raise MSLConnectionError(self, msg) from None

accumulate_signals ¤

accumulate_signals(meas_type: Literal[0, 1, 2, 3, 4, 5]) -> None

Function needs to be called after a measurement was performed.

This essentially accumulates the data together until the user is ready to average out the data. This function is used in combination with reset_averaging and do_averaging.

Parameters:

Name Type Description Default
meas_type Literal[0, 1, 2, 3, 4, 5]

The measurement type.

  • 0 — Irradiance
  • 1 — Radiance
  • 2 — Transmittance
  • 3 — Irradiance Calibration
  • 4 — Radiance Calibration
  • 5 — Transmittance Calibration
 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def accumulate_signals(self, meas_type: Literal[0, 1, 2, 3, 4, 5]) -> None:
    """Function needs to be called after a measurement was performed.

    This essentially accumulates the data together until the user is
    ready to average out the data. This function is used in combination with
    [reset_averaging][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.reset_averaging]
    and [do_averaging][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.do_averaging].

    Args:
        meas_type: The measurement type.

            * `0` — Irradiance
            * `1` — Radiance
            * `2` — Transmittance
            * `3` — Irradiance Calibration
            * `4` — Radiance Calibration
            * `5` — Transmittance Calibration

    """
    self._send("accumulate_signals", meas_type)

disconnect ¤

disconnect() -> None

Disconnect from the OL756 spectroradiometer.

Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
def disconnect(self) -> None:  # pyright: ignore[reportImplicitOverride]
    """Disconnect from the OL756 spectroradiometer."""
    if self._client is None:
        return

    with contextlib.suppress(Server32Error):
        self._send("connect_to_ol756", -1)

    try:
        stdout, stderr = self._client.shutdown_server32()
    except Server32Error:
        pass
    else:
        stdout.close()
        stderr.close()

    self._client = None
    super().disconnect()

do_averaging ¤

do_averaging(meas_type: Literal[0, 1, 2, 3, 4, 5], n_scans: int) -> None

Function divides the accumulated signal by the number of scans performed.

It then sets the array containing the data with the averaged data. This function is used in combination with reset_averaging and accumulate_signals.

Parameters:

Name Type Description Default
meas_type Literal[0, 1, 2, 3, 4, 5]

The measurement type.

  • 0 — Irradiance
  • 1 — Radiance
  • 2 — Transmittance
  • 3 — Irradiance Calibration
  • 4 — Radiance Calibration
  • 5 — Transmittance Calibration
 required
n_scans int

The number of scans to average.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
def do_averaging(self, meas_type: Literal[0, 1, 2, 3, 4, 5], n_scans: int) -> None:
    """Function divides the accumulated signal by the number of scans performed.

    It then sets the array containing the data with the averaged data. This function is used in combination with
    [reset_averaging][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.reset_averaging]
    and [accumulate_signals][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.accumulate_signals].

    Args:
        meas_type: The measurement type.

            * `0` — Irradiance
            * `1` — Radiance
            * `2` — Transmittance
            * `3` — Irradiance Calibration
            * `4` — Radiance Calibration
            * `5` — Transmittance Calibration

        n_scans: The number of scans to average.
    """
    self._send("do_averaging", meas_type, n_scans)

do_calculations ¤

do_calculations(meas_type: Literal[0, 1, 2, 3, 4, 5]) -> None

Function needs to be called after each measurement to update the calculations.

Parameters:

Name Type Description Default
meas_type Literal[0, 1, 2, 3, 4, 5]

The measurement type.

  • 0 — Irradiance
  • 1 — Radiance
  • 2 — Transmittance
  • 3 — Irradiance Calibration
  • 4 — Radiance Calibration
  • 5 — Transmittance Calibration
 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
def do_calculations(self, meas_type: Literal[0, 1, 2, 3, 4, 5]) -> None:
    """Function needs to be called after each measurement to update the calculations.

    Args:
        meas_type: The measurement type.

            * `0` — Irradiance
            * `1` — Radiance
            * `2` — Transmittance
            * `3` — Irradiance Calibration
            * `4` — Radiance Calibration
            * `5` — Transmittance Calibration

    """
    self._send("do_calculations", meas_type)

enable_calibration_file ¤

enable_calibration_file(meas_type: Literal[3, 4, 5], *, enable: bool) -> None

Enables or disables the use of a calibration file.

Use this option to generate calibrated results. To open a standard file used to create a calibration, use enable_standard_file instead.

The user should call load_calibration_file first to load the calibration file before enabling it.

Parameters:

Name Type Description Default
meas_type Literal[3, 4, 5]

The measurement type.

  • 3 — Irradiance Calibration
  • 4 — Radiance Calibration
  • 5 — Transmittance Calibration
 required
enable bool

Whether to enable or disable the use of a calibration file.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
def enable_calibration_file(self, meas_type: Literal[3, 4, 5], *, enable: bool) -> None:
    """Enables or disables the use of a calibration file.

    Use this option to generate calibrated results. To open a standard file
    used to create a calibration, use
    [enable_standard_file][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.enable_standard_file]
    instead.

    The user should call
    [load_calibration_file][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.load_calibration_file]
    first to load the calibration file before enabling it.

    Args:
        meas_type: The measurement type.

            * `3` — Irradiance Calibration
            * `4` — Radiance Calibration
            * `5` — Transmittance Calibration

        enable: Whether to enable or disable the use of a calibration file.
    """
    self._send("enable_calibration_file", meas_type, enable)

enable_dark_current ¤

enable_dark_current(*, enable: bool = True) -> None

Turn the dark current on or off.

Enable this feature if you want the dark current automatically acquired and subtracted before each measurement. If you wish to take a dark current manually, see the get_dark_current function.

The parameters for the dark current will need to be set using set_dark_current_params.

Parameters:

Name Type Description Default
enable bool

Whether to turn the dark current on or off.

 True
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
def enable_dark_current(self, *, enable: bool = True) -> None:
    """Turn the dark current on or off.

    Enable this feature if you want the dark current automatically
    acquired and subtracted before each measurement. If you wish to
    take a dark current manually, see the
    [get_dark_current][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.get_dark_current]
    function.

    The parameters for the dark current will need to be set using
    [set_dark_current_params][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.set_dark_current_params].

    Args:
        enable: Whether to turn the dark current on or off.
    """
    self._send("enable_dark_current", enable)

enable_pmt_protection_mode ¤

enable_pmt_protection_mode(*, enable: bool) -> None

Turn the PMT protection routines on or off.

Enable this feature if you want the PMT to be shielded while travelling through high intensity spikes. This feature will make the scan slower since the wavelength and filter drive will move asynchronously.

The PMT is still protected by the hardware. This function prevents exposure of the PMT while travelling.

Parameters:

Name Type Description Default
enable bool

Whether to turn the PMT protection routines on or off.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
206
207
208
209
210
211
212
213
214
215
216
217
218
219
def enable_pmt_protection_mode(self, *, enable: bool) -> None:
    """Turn the PMT protection routines on or off.

    Enable this feature if you want the PMT to be shielded while travelling
    through high intensity spikes. This feature will make the scan slower
    since the wavelength and filter drive will move asynchronously.

    The PMT is still protected by the hardware. This function prevents
    exposure of the PMT while travelling.

    Args:
        enable: Whether to turn the PMT protection routines on or off.
    """
    self._send("enable_pmt_protection_mode", enable)

enable_standard_file ¤

enable_standard_file(meas_type: Literal[0, 1, 2], *, enable: bool) -> None

Function enables standard files to be used.

To open a calibration file used to create a measurement, use enable_calibration_file instead.

The user should call load_standard_file first to load the standard file before enabling it.

Parameters:

Name Type Description Default
meas_type Literal[0, 1, 2]

The calibration measurement type.

  • 0 — Irradiance
  • 1 — Radiance
  • 2 — Transmittance
 required
enable bool

Whether to turn the application of the standard file on or off.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
def enable_standard_file(self, meas_type: Literal[0, 1, 2], *, enable: bool) -> None:
    """Function enables standard files to be used.

    To open a calibration file used to create a measurement, use
    [enable_calibration_file][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.enable_calibration_file]
    instead.

    The user should call
    [load_standard_file][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.load_standard_file]
    first to load the standard file before enabling it.

    Args:
        meas_type: The calibration measurement type.

            * `0` — Irradiance
            * `1` — Radiance
            * `2` — Transmittance

        enable: Whether to turn the application of the standard file on or off.
    """
    self._send("enable_standard_file", meas_type, enable)

export_config_file ¤

export_config_file(file_path: PathLike) -> None

Exports the config file into a OL756 compatible configuration file.

Not all settings used will be applicable.

Parameters:

Name Type Description Default
file_path PathLike

A valid path to save the file at.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
243
244
245
246
247
248
249
250
251
def export_config_file(self, file_path: PathLike) -> None:
    """Exports the config file into a OL756 compatible configuration file.

    Not all settings used will be applicable.

    Args:
        file_path: A valid path to save the file at.
    """
    self._send("export_config_file", os.fsdecode(file_path))

export_registry ¤

export_registry() -> None

Save data out to the Windows registry.

Make sure that a read was done at some point using import_registry. Does not create a configuration file that can be loaded into another computer. For that particular function, call export_config_file.

Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
253
254
255
256
257
258
259
260
261
def export_registry(self) -> None:
    """Save data out to the Windows registry.

    Make sure that a read was done at some point using
    [import_registry][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.import_registry].
    Does not create a configuration file that can be loaded into another computer. For that particular function,
    call [export_config_file][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.export_config_file].
    """
    self._send("export_registry")

get_adaptive_int_time_index ¤

get_adaptive_int_time_index(gain_index: int) -> int

Get the adaptive integration time index.

Parameters:

Name Type Description Default
gain_index int

The index of the gain to use to get the integration time.

  • 0 — 1.0E-5
  • 1 — 1.0E-6
  • 2 — 1.0E-7
  • 3 — 1.0E-8
  • 4 — 1.0E-9
  • 5 — 1.0E-10
  • 6 — 1.0E-11
 required

Returns:

Type Description
int

The adaptive integration time index.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
def get_adaptive_int_time_index(self, gain_index: int) -> int:
    """Get the adaptive integration time index.

    Args:
        gain_index: The index of the gain to use to get the integration time.

            * `0` — 1.0E-5
            * `1` — 1.0E-6
            * `2` — 1.0E-7
            * `3` — 1.0E-8
            * `4` — 1.0E-9
            * `5` — 1.0E-10
            * `6` — 1.0E-11

    Returns:
        The adaptive integration time index.
    """
    index = int(self._send("get_adaptive_int_time_index", gain_index))
    if index == -1:
        msg = f"Invalid gain index, {gain_index}"
        raise MSLConnectionError(self, msg)
    return index

get_cal_array ¤

get_cal_array() -> NDArray[int32]

This method allows user to get the spectral data of a calibration after it is made.

Returns:

Type Description
NDArray[int32]

The calibrated spectral data.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
326
327
328
329
330
331
332
def get_cal_array(self) -> NDArray[np.int32]:
    """This method allows user to get the spectral data of a calibration after it is made.

    Returns:
        The calibrated spectral data.
    """
    return np.array(self._send("get_cal_array"))

get_cal_file_enabled ¤

get_cal_file_enabled(meas_type: Literal[3, 4, 5]) -> bool

Checks to see if the calibration file is enabled.

The user should call load_calibration_file first to load the calibration file before enabling it.

Parameters:

Name Type Description Default
meas_type Literal[3, 4, 5]

The measurement type.

  • 3 — Irradiance Calibration
  • 4 — Radiance Calibration
  • 5 — Transmittance Calibration
 required

Returns:

Type Description
bool

Whether the calibration file is enabled.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
def get_cal_file_enabled(self, meas_type: Literal[3, 4, 5]) -> bool:
    """Checks to see if the calibration file is enabled.

    The user should call
    [load_calibration_file][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.load_calibration_file]
    first to load the calibration file before enabling it.

    Args:
        meas_type: The measurement type.

            * `3` — Irradiance Calibration
            * `4` — Radiance Calibration
            * `5` — Transmittance Calibration

    Returns:
        Whether the calibration file is enabled.
    """
    return bool(self._send("get_cal_file_enabled", meas_type))

get_calculated_data ¤

get_calculated_data(meas_type: Literal[0, 1, 2, 3, 4, 5], index: int) -> float

Get data calculated from the intensities.

The user should call do_calculations at least once before calling this function.

Parameters:

Name Type Description Default
meas_type Literal[0, 1, 2, 3, 4, 5]

The measurement type.

  • 0 — Irradiance
  • 1 — Radiance
  • 2 — Transmittance
  • 3 — Irradiance Calibration
  • 4 — Radiance Calibration
  • 5 — Transmittance Calibration
 required
index int

The index to retrieve data of.

  • 0 — Color Temperature
  • 1 — Dominant Wavelength
  • 2 — LED Half Bandwidth
  • 3 — Left Half Bandwidth
  • 4 — Right Half Bandwidth
  • 5 — Peak Spectral Value
  • 6 — LEDPeakWavelength
  • 7 — Radiometric Value
  • 8 — Purity
  • 9 — Center Wavelength
  • 10 — Photometric Value
 required

Returns:

Type Description
float

The calculated data.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
def get_calculated_data(self, meas_type: Literal[0, 1, 2, 3, 4, 5], index: int) -> float:
    """Get data calculated from the intensities.

    The user should call
    [do_calculations][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.do_calculations]
    at least once before calling this function.

    Args:
        meas_type: The measurement type.

            * `0` — Irradiance
            * `1` — Radiance
            * `2` — Transmittance
            * `3` — Irradiance Calibration
            * `4` — Radiance Calibration
            * `5` — Transmittance Calibration

        index: The index to retrieve data of.

            * `0` — Color Temperature
            * `1` — Dominant Wavelength
            * `2` — LED Half Bandwidth
            * `3` — Left Half Bandwidth
            * `4` — Right Half Bandwidth
            * `5` — Peak Spectral Value
            * `6` — LEDPeakWavelength
            * `7` — Radiometric Value
            * `8` — Purity
            * `9` — Center Wavelength
            * `10` — Photometric Value

    Returns:
        The calculated data.
    """
    return float(self._send("get_calculated_data", meas_type, index))

get_calibration_file ¤

get_calibration_file(meas_type: Literal[0, 1, 2]) -> str

Get a calibration file that is loaded.

Parameters:

Name Type Description Default
meas_type Literal[0, 1, 2]

The measurement type.

  • 0 — Irradiance
  • 1 — Radiance
  • 2 — Transmittance
 required

Returns:

Type Description
str

String containing the name and path of the calibration file that is loaded for a particular measurement type.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
def get_calibration_file(self, meas_type: Literal[0, 1, 2]) -> str:
    """Get a calibration file that is loaded.

    Args:
        meas_type: The measurement type.

            * `0` — Irradiance
            * `1` — Radiance
            * `2` — Transmittance

    Returns:
        String containing the name and path of the calibration file
            that is loaded for a particular measurement type.
    """
    return str(self._send("get_calibration_file", meas_type))

get_chromaticity_data ¤

get_chromaticity_data(
    meas_type: Literal[0, 1, 2, 3, 4, 5], index: int
) -> float

Get the calculated chromaticity values requested.

Must have called do_calculations at least once.

Parameters:

Name Type Description Default
meas_type Literal[0, 1, 2, 3, 4, 5]

The measurement type.

  • 0 — Irradiance
  • 1 — Radiance
  • 2 — Transmittance
  • 3 — Irradiance Calibration
  • 4 — Radiance Calibration
  • 5 — Transmittance Calibration
 required
index int

The chromaticity index value [0..70]. See the SDK manual for more details.

 required

Returns:

Type Description
float

The chromaticity data.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
def get_chromaticity_data(self, meas_type: Literal[0, 1, 2, 3, 4, 5], index: int) -> float:
    """Get the calculated chromaticity values requested.

    Must have called [do_calculations][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.do_calculations]
    at least once.

    Args:
        meas_type: The measurement type.

            * `0` — Irradiance
            * `1` — Radiance
            * `2` — Transmittance
            * `3` — Irradiance Calibration
            * `4` — Radiance Calibration
            * `5` — Transmittance Calibration

        index: The chromaticity index value [0..70]. See the SDK manual for more details.

    Returns:
        The chromaticity data.
    """
    return float(self._send("get_chromaticity_data", meas_type, index))

get_cri ¤

get_cri(meas_type: Literal[0, 1, 2, 3, 4, 5], index: int) -> float

Get the color-rendering information.

The user should call do_calculations at least once before calling this function.

Parameters:

Name Type Description Default
meas_type Literal[0, 1, 2, 3, 4, 5]

The measurement type.

  • 0 — Irradiance
  • 1 — Radiance
  • 2 — Transmittance
  • 3 — Irradiance Calibration
  • 4 — Radiance Calibration
  • 5 — Transmittance Calibration
 required
index int

The color-rendering index.

  • 0 — General CRI
  • 1 — Light Greyish Red (CRI#1)
  • 2 — Dark Greyish Yellow (CRI#2)
  • 3 — Strong Yellow Green (CRI#3)
  • 4 — Moderate Yellowish Green (CRI#4)
  • 5 — Light Bluish Green (CRI#5)
  • 6 — Light Blue (CRI#6)
  • 7 — Light Violet (CRI#7)
  • 8 — Light Reddish Purple (CRI#8)
  • 9 — Strong Red (CRI#9)
  • 10 — Strong Yellow (CRI#10)
  • 11 — Strong Green (CRI#11)
  • 12 — Strong Blue (CRI#12)
  • 13 — Light Yellowish Pink (CRI#13)
  • 14 — Moderate Olive Green (CRI#14)
 required

Returns:

Type Description
float

The color-rendering information.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
def get_cri(self, meas_type: Literal[0, 1, 2, 3, 4, 5], index: int) -> float:
    """Get the color-rendering information.

    The user should call
    [do_calculations][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.do_calculations]
    at least once before calling this function.

    Args:
        meas_type: The measurement type.

            * `0` — Irradiance
            * `1` — Radiance
            * `2` — Transmittance
            * `3` — Irradiance Calibration
            * `4` — Radiance Calibration
            * `5` — Transmittance Calibration

        index: The color-rendering index.

            * `0` — General CRI
            * `1` — Light Greyish Red (CRI#1)
            * `2` — Dark Greyish Yellow (CRI#2)
            * `3` — Strong Yellow Green (CRI#3)
            * `4` — Moderate Yellowish Green (CRI#4)
            * `5` — Light Bluish Green (CRI#5)
            * `6` — Light Blue (CRI#6)
            * `7` — Light Violet (CRI#7)
            * `8` — Light Reddish Purple (CRI#8)
            * `9` — Strong Red (CRI#9)
            * `10` — Strong Yellow (CRI#10)
            * `11` — Strong Green (CRI#11)
            * `12` — Strong Blue (CRI#12)
            * `13` — Light Yellowish Pink (CRI#13)
            * `14` — Moderate Olive Green (CRI#14)

    Returns:
        The color-rendering information.
    """
    return float(self._send("get_cri", meas_type, index))

get_dark_current ¤

get_dark_current(use_compensation: int) -> float

Takes a manual dark current.

User will have to subtract from data array by retrieving this array via a get_cal_array or get_signal_array. This is a special function and most users will want to use enable_dark_current instead because it automatically does the subtraction.

Function if called externally by user program will not have result saved out to data file. If the enable_dark_current was enabled, then this function need should not be called.

Parameters:

Name Type Description Default
use_compensation int

Adjusts dark current for more dynamic ranging using reverse current.

 required

Returns:

Type Description
float

The dark current.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
def get_dark_current(self, use_compensation: int) -> float:
    """Takes a manual dark current.

    User will have to subtract from data array by retrieving this array via
    a [get_cal_array][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.get_cal_array] or
    [get_signal_array][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.get_signal_array].
    This is a special function and most users will want to use
    [enable_dark_current][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.enable_dark_current]
    instead because it automatically does the subtraction.

    Function if called externally by user program will not have result
    saved out to data file. If the
    [enable_dark_current][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.enable_dark_current]
    was enabled, then this function need should not be called.

    Args:
        use_compensation: Adjusts dark current for more dynamic ranging using reverse current.

    Returns:
        The dark current.
    """
    return float(self._send("get_dark_current", use_compensation))

get_dark_current_enable ¤

get_dark_current_enable() -> bool

Returns whether the dark-current mode is enabled.

Returns:

Type Description
bool

Whether the dark-current mode is enabled or disabled.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
463
464
465
466
467
468
469
def get_dark_current_enable(self) -> bool:
    """Returns whether the dark-current mode is enabled.

    Returns:
        Whether the dark-current mode is enabled or disabled.
    """
    return bool(self._send("get_dark_current_enable"))

get_dark_current_mode ¤

get_dark_current_mode() -> int

Returns whether the dark current is taken at a wavelength or in shutter mode.

Returns:

Type Description
int

The dark-current mode.

  • 0 — Dark current in wavelength mode (taken at a particular wavelength designated by the user).
  • 1 — Dark current in shutter mode
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
471
472
473
474
475
476
477
478
479
480
481
def get_dark_current_mode(self) -> int:
    """Returns whether the dark current is taken at a wavelength or in shutter mode.

    Returns:
        The dark-current mode.

            * `0` — Dark current in wavelength mode (taken at a particular wavelength designated by the user).
            * `1` — Dark current in shutter mode

    """
    return int(self._send("get_dark_current_mode"))

get_dark_current_wavelength ¤

get_dark_current_wavelength() -> float

Get the dark current wavelength.

Returns:

Type Description
float

Wavelength that the dark current will be taken at.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
483
484
485
486
487
488
489
def get_dark_current_wavelength(self) -> float:
    """Get the dark current wavelength.

    Returns:
        Wavelength that the dark current will be taken at.
    """
    return float(self._send("get_dark_current_wavelength"))

get_ending_wavelength ¤

get_ending_wavelength() -> float

Get the ending wavelength of the scan range.

Returns:

Type Description
float

The ending wavelength, in nm, of the scan range.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
491
492
493
494
495
496
497
def get_ending_wavelength(self) -> float:
    """Get the ending wavelength of the scan range.

    Returns:
        The ending wavelength, in nm, of the scan range.
    """
    return float(self._send("get_ending_wavelength"))

get_gain_index ¤

get_gain_index() -> int

Get the index of the gain that will be applied when the parameters are to be sent down.

Applies to both quick scan and point to point scans.

Returns:

Type Description
int

The gain index.

  • 0 — 1.0E-5
  • 1 — 1.0E-6
  • 2 — 1.0E-7
  • 3 — 1.0E-8
  • 4 — 1.0E-9
  • 5 — 1.0E-10 (Point to Point mode only)
  • 6 — 1.0E-11 (Point to Point mode only)
  • 7 — Auto Gain Ranging (Point to Point mode only)
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
def get_gain_index(self) -> int:
    """Get the index of the gain that will be applied when the parameters are to be sent down.

    Applies to both quick scan and point to point scans.

    Returns:
        The gain index.

            * `0` — 1.0E-5
            * `1` — 1.0E-6
            * `2` — 1.0E-7
            * `3` — 1.0E-8
            * `4` — 1.0E-9
            * `5` — 1.0E-10 (Point to Point mode only)
            * `6` — 1.0E-11 (Point to Point mode only)
            * `7` — Auto Gain Ranging (Point to Point mode only)

    """
    return int(self._send("get_gain_index"))

get_increment ¤

get_increment() -> float

Get the wavelength increment that is used for a scan.

Returns:

Type Description
float

The wavelength increment, in nm.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
519
520
521
522
523
524
525
def get_increment(self) -> float:
    """Get the wavelength increment that is used for a scan.

    Returns:
        The wavelength increment, in nm.
    """
    return float(self._send("get_increment"))

get_increment_index ¤

get_increment_index() -> int

Get the index of the wavelength increment that is used for a scan.

Applies to both quick scan and point to point scans.

Returns:

Type Description
int

Index of the wavelength increment of a scan.

  • 0 — 0.025 nm
  • 1 — 0.05 nm
  • 2 — 0.1 nm
  • 3 — 0.2 nm
  • 4 — 0.5 nm
  • 5 — 1.0 nm
  • 6 — 2.0 nm
  • 7 — 5.0 nm
  • 8 — 10.0 nm
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
def get_increment_index(self) -> int:
    """Get the index of the wavelength increment that is used for a scan.

    Applies to both quick scan and point to point scans.

    Returns:
        Index of the wavelength increment of a scan.

            * `0` — 0.025 nm
            * `1` — 0.05 nm
            * `2` — 0.1 nm
            * `3` — 0.2 nm
            * `4` — 0.5 nm
            * `5` — 1.0 nm
            * `6` — 2.0 nm
            * `7` — 5.0 nm
            * `8` — 10.0 nm

    """
    return int(self._send("get_increment_index"))

get_integration_time_index ¤

get_integration_time_index(scan_mode: Literal[0, 1]) -> int

Get the index into the integration time array.

Applies to both quick scan and point to point scans. In quick scan, the speed will vary based on the scan range and increments.

Parameters:

Name Type Description Default
scan_mode Literal[0, 1]

The scan mode to use to get the index of. Point to Point mode (0) or Quick Scan mode (1).

 required

Returns:

Type Description
int

Point to Point mode

  • 0 — 1.000 sec
  • 1 — 0.500 sec
  • 2 — 0.200 sec
  • 3 — 0.100 sec
  • 4 — 0.050 sec
  • 5 — 0.020 sec
  • 6 — 0.010 sec
  • 7 — 0.005 sec
  • 8 — 0.002 sec
  • 9 — 0.001 sec
  • 10 — Adaptive (Point To Point mode only)

Quick Scan mode

* `0` — slowest
* `10` — fastest
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
def get_integration_time_index(self, scan_mode: Literal[0, 1]) -> int:
    """Get the index into the integration time array.

    Applies to both quick scan and point to point scans. In quick scan,
    the speed will vary based on the scan range and increments.

    Args:
        scan_mode: The scan mode to use to get the index of.
            Point to Point mode (0) or Quick Scan mode (1).

    Returns:
        Point to Point mode

            * `0` — 1.000 sec
            * `1` — 0.500 sec
            * `2` — 0.200 sec
            * `3` — 0.100 sec
            * `4` — 0.050 sec
            * `5` — 0.020 sec
            * `6` — 0.010 sec
            * `7` — 0.005 sec
            * `8` — 0.002 sec
            * `9` — 0.001 sec
            * `10` — Adaptive	(Point To Point mode only)

            Quick Scan mode

                * `0` — slowest
                * `10` — fastest

    """
    return int(self._send("get_integration_time_index", scan_mode))

get_ocx_version ¤

get_ocx_version() -> str

Get the version of the OL756 SDK ActiveX control.

Returns:

Type Description
str

The software version.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
581
582
583
584
585
586
587
def get_ocx_version(self) -> str:
    """Get the version of the OL756 SDK ActiveX control.

    Returns:
        The software version.
    """
    return str(self._send("get_ocx_version"))

get_pmt_flux_overload ¤

get_pmt_flux_overload() -> float

Get the voltage of the photomultiplier tube flux overload.

Returns:

Type Description
float

Voltage that the PMT will determine to be at the overload point.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
589
590
591
592
593
594
595
def get_pmt_flux_overload(self) -> float:
    """Get the voltage of the photomultiplier tube flux overload.

    Returns:
        Voltage that the PMT will determine to be at the overload point.
    """
    return float(self._send("get_pmt_flux_overload"))

get_pmt_voltage ¤

get_pmt_voltage() -> float

Returns the voltage that will sent or has been sent down to the PMT.

Returns:

Type Description
float

Voltage value, in volts, of the photomultiplier tube.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
605
606
607
608
609
610
611
def get_pmt_voltage(self) -> float:
    """Returns the voltage that will sent or has been sent down to the PMT.

    Returns:
        Voltage value, in volts, of the photomultiplier tube.
    """
    return float(self._send("get_pmt_voltage"))

get_quick_scan_rate ¤

get_quick_scan_rate() -> float

Returns the rate at the quick scan index.

Returns:

Type Description
float

Rate of the quick scan at the current index in nm/s.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
613
614
615
616
617
618
619
def get_quick_scan_rate(self) -> float:
    """Returns the rate at the quick scan index.

    Returns:
        Rate of the quick scan at the current index in nm/s.
    """
    return float(self._send("get_quick_scan_rate"))

get_quick_scan_rate_index ¤

get_quick_scan_rate_index() -> int

Returns the index of the quick scan rate.

Returns:

Type Description
int

Index of the quick scan rate.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
621
622
623
624
625
626
627
def get_quick_scan_rate_index(self) -> int:
    """Returns the index of the quick scan rate.

    Returns:
        Index of the quick scan rate.
    """
    return int(self._send("get_quick_scan_rate_index"))

get_scan_mode ¤

get_scan_mode() -> int

Get the mode the scan will be done in.

Returns:

Type Description
int

The scan mode.

  • 0 — Point to Point mode
  • 1 — Quick Scan mode
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
637
638
639
640
641
642
643
644
645
646
647
def get_scan_mode(self) -> int:
    """Get the mode the scan will be done in.

    Returns:
        The scan mode.

            * `0` — Point to Point mode
            * `1` — Quick Scan mode

    """
    return int(self._send("get_scan_mode"))

get_settling_time ¤

get_settling_time() -> float

Get the settling time.

Settling time is time where the wavelength drive pauses once it reaches its target wavelength.

Returns:

Type Description
float

Settling time, in seconds, to be sent down or has already been sent to the system.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
649
650
651
652
653
654
655
656
657
def get_settling_time(self) -> float:
    """Get the settling time.

    Settling time is time where the wavelength drive pauses once it reaches its target wavelength.

    Returns:
        Settling time, in seconds, to be sent down or has already been sent to the system.
    """
    return float(self._send("get_settling_time"))

get_signal_array ¤

get_signal_array() -> NDArray[int32]

Get the spectral data of a measurement after it is made.

Returns:

Type Description
NDArray[int32]

The spectral data.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
659
660
661
662
663
664
665
def get_signal_array(self) -> NDArray[np.int32]:
    """Get the spectral data of a measurement after it is made.

    Returns:
        The spectral data.
    """
    return np.array(self._send("get_signal_array"))

get_standard_file ¤

get_standard_file(meas_type: Literal[3, 4, 5]) -> str

Retrieves the name of standard file.

Parameters:

Name Type Description Default
meas_type Literal[3, 4, 5]

The calibration measurement type.

  • 3 — Irradiance calibration
  • 4 — Radiance calibration
  • 5 — Transmittance calibration
 required

Returns:

Type Description
str

String containing the name and path of the standard file that is loaded for a particular calibration type.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
def get_standard_file(self, meas_type: Literal[3, 4, 5]) -> str:
    """Retrieves the name of standard file.

    Args:
        meas_type: The calibration measurement type.

            * `3` — Irradiance calibration
            * `4` — Radiance calibration
            * `5` — Transmittance calibration

    Returns:
        String containing the name and path of the standard file that is
            loaded for a particular calibration type.
    """
    return str(self._send("get_standard_file", meas_type))

get_start_wavelength ¤

get_start_wavelength() -> float

Get the starting wavelength of a scan.

Applies to both quick scan and point to point scans.

Returns:

Type Description
float

The wavelength, in nm, that the scan will start from.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
683
684
685
686
687
688
689
690
691
def get_start_wavelength(self) -> float:
    """Get the starting wavelength of a scan.

    Applies to both quick scan and point to point scans.

    Returns:
        The wavelength, in nm, that the scan will start from.
    """
    return float(self._send("get_start_wavelength"))

get_std_file_enabled ¤

get_std_file_enabled(meas_type: Literal[0, 1, 2]) -> bool

Checks to see if the standard file is enabled.

The user should call load_standard_file first to load the standard file before enabling it.

Parameters:

Name Type Description Default
meas_type Literal[0, 1, 2]

The measurement type.

  • 0 — Irradiance
  • 1 — Radiance
  • 2 — Transmittance
 required

Returns:

Type Description
bool

Whether a standard file is enabled.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
def get_std_file_enabled(self, meas_type: Literal[0, 1, 2]) -> bool:
    """Checks to see if the standard file is enabled.

    The user should call
    [load_standard_file][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.load_standard_file]
    first to load the standard file before enabling it.

    Args:
        meas_type: The measurement type.

            * `0` — Irradiance
            * `1` — Radiance
            * `2` — Transmittance

    Returns:
        Whether a standard file is enabled.
    """
    return bool(self._send("get_std_file_enabled", meas_type))

import_config_file ¤

import_config_file(path: PathLike) -> None

The file is a standard OL756 configuration file.

Not all settings used will be applicable. Measurement type is not used because in the SDK, the take_point_to_point_measurement function has as an input the measurement type. The user should select the type and not have it based on the configuration file.

Parameters:

Name Type Description Default
path PathLike

A valid path to load the file at.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
712
713
714
715
716
717
718
719
720
721
722
723
724
def import_config_file(self, path: PathLike) -> None:
    """The file is a standard OL756 configuration file.

    Not all settings used will be applicable. Measurement type is not used
    because in the SDK, the
    [take_point_to_point_measurement][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.take_point_to_point_measurement]
    function has as an input the measurement type. The user should select
    the type and not have it based on the configuration file.

    Args:
        path: A valid path to load the file at.
    """
    self._send("import_config_file", os.fsdecode(path))

import_registry ¤

import_registry() -> None

Loads data from the registry.

Loads default if no registry exists. To import the configuration from another computer, use import_config_file instead.

Not all settings used will be applicable. Measurement type is not used because in the SDK, the take_point_to_point_measurement function has as an input the measurement type. The user should select the type and not have it based on the configuration file.

Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
def import_registry(self) -> None:
    """Loads data from the registry.

    Loads default if no registry exists. To import the configuration
    from another computer, use
    [import_config_file][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.import_config_file]
    instead.

    Not all settings used will be applicable. Measurement type is not
    used because in the SDK, the
    [take_point_to_point_measurement][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.take_point_to_point_measurement]
    function has as an input the measurement type. The user should
    select the type and not have it based on the configuration file.
    """
    self._send("import_registry")

load_calibration_file ¤

load_calibration_file(path: PathLike, meas_type: Literal[3, 4, 5]) -> None

Load a calibration file.

Parameters:

Name Type Description Default
path PathLike

The path of a calibration file.

 required
meas_type Literal[3, 4, 5]

The calibration measurement type.

  • 3 — Irradiance calibration
  • 4 — Radiance calibration
  • 5 — Transmittance calibration
 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
746
747
748
749
750
751
752
753
754
755
756
757
758
def load_calibration_file(self, path: PathLike, meas_type: Literal[3, 4, 5]) -> None:
    """Load a calibration file.

    Args:
        path: The path of a calibration file.
        meas_type: The calibration measurement type.

            * `3` — Irradiance calibration
            * `4` — Radiance calibration
            * `5` — Transmittance calibration

    """
    self._send("load_calibration_file", os.fsdecode(path), meas_type)

load_standard_file ¤

load_standard_file(path: PathLike, meas_type: Literal[0, 1, 2]) -> None

Load a standard file.

Parameters:

Name Type Description Default
path PathLike

The path of a standard file.

 required
meas_type Literal[0, 1, 2]

The measurement type.

  • 0 — Irradiance
  • 1 — Radiance
  • 2 — Transmittance
 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
760
761
762
763
764
765
766
767
768
769
770
771
772
def load_standard_file(self, path: PathLike, meas_type: Literal[0, 1, 2]) -> None:
    """Load a standard file.

    Args:
        path: The path of a standard file.
        meas_type: The measurement type.

            * `0` — Irradiance
            * `1` — Radiance
            * `2` — Transmittance

    """
    self._send("load_standard_file", os.fsdecode(path), meas_type)

manual_filter_drive_connect ¤

manual_filter_drive_connect(*, connect: bool) -> None

Used to connect or disconnect the filter drive.

Disconnecting essentially acquires scans without the filter.

Parameters:

Name Type Description Default
connect bool

Connect or disconnect the filter drive. Reconnecting will home the wavelength and filter drive.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
774
775
776
777
778
779
780
781
782
783
def manual_filter_drive_connect(self, *, connect: bool) -> None:
    """Used to connect or disconnect the filter drive.

    Disconnecting essentially acquires scans without the filter.

    Args:
        connect: Connect or disconnect the filter drive. Reconnecting will
            home the wavelength and filter drive.
    """
    self._send("manual_filter_drive_connect", connect)

manual_get_gain ¤

manual_get_gain() -> int

The index of the gain that will be applied when the parameters are to be sent down.

Returns:

Type Description
int

The gain index.

  • 0 — 1.0E-5
  • 1 — 1.0E-6
  • 2 — 1.0E-7
  • 3 — 1.0E-8
  • 4 — 1.0E-9
  • 5 — 1.0E-10 (Point to Point mode only)
  • 6 — 1.0E-11 (Point to Point mode only)
  • 7 — Auto Gain Ranging (Point to Point mode only)
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
def manual_get_gain(self) -> int:
    """The index of the gain that will be applied when the parameters are to be sent down.

    Returns:
        The gain index.

            * `0` — 1.0E-5
            * `1` — 1.0E-6
            * `2` — 1.0E-7
            * `3` — 1.0E-8
            * `4` — 1.0E-9
            * `5` — 1.0E-10 (Point to Point mode only)
            * `6` — 1.0E-11 (Point to Point mode only)
            * `7` — Auto Gain Ranging (Point to Point mode only)

    """
    return int(self._send("manual_get_gain"))

manual_get_integration_time ¤

manual_get_integration_time() -> float

Returns the integration time set in the system.

Only applies to the integration time used for Point to Point scans.

Returns:

Type Description
float

The integration time in seconds.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
803
804
805
806
807
808
809
810
811
def manual_get_integration_time(self) -> float:
    """Returns the integration time set in the system.

    Only applies to the integration time used for Point to Point scans.

    Returns:
        The integration time in seconds.
    """
    return float(self._send("manual_get_integration_time"))

manual_get_pmt_overload ¤

manual_get_pmt_overload() -> float

Returns the PMT overload voltage set in the system.

Returns:

Type Description
float

Overload voltage, in volts, of the photomultiplier tube.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
813
814
815
816
817
818
819
def manual_get_pmt_overload(self) -> float:
    """Returns the PMT overload voltage set in the system.

    Returns:
        Overload voltage, in volts, of the photomultiplier tube.
    """
    return float(self._send("manual_get_pmt_overload"))

manual_get_pmt_voltage ¤

manual_get_pmt_voltage() -> float

Returns the PMT high voltage set in the system.

Returns:

Type Description
float

Voltage, in volts, of the photomultiplier tube.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
821
822
823
824
825
826
827
def manual_get_pmt_voltage(self) -> float:
    """Returns the PMT high voltage set in the system.

    Returns:
        Voltage, in volts, of the photomultiplier tube.
    """
    return float(self._send("manual_get_pmt_voltage"))

manual_get_settling_time ¤

manual_get_settling_time() -> float

Returns the settling time of the instrument.

Returns:

Type Description
float

Settling time of the system in seconds.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
829
830
831
832
833
834
835
def manual_get_settling_time(self) -> float:
    """Returns the settling time of the instrument.

    Returns:
        Settling time of the system in seconds.
    """
    return float(self._send("manual_get_settling_time"))

manual_get_signal ¤

manual_get_signal() -> float

Returns the signal at the current position of the wavelength drive.

Returns:

Type Description
float

The signal, in amperes.
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
837
838
839
840
841
842
843
def manual_get_signal(self) -> float:
    """Returns the signal at the current position of the wavelength drive.

    Returns:
        The signal, in amperes.
    """
    return float(self._send("manual_get_signal"))

manual_home_ol756 ¤

manual_home_ol756() -> None

Homes the wavelength and filter drive.

Will reconnect the filter drive if it was disconnected

Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
845
846
847
848
849
850
def manual_home_ol756(self) -> None:
    """Homes the wavelength and filter drive.

    Will reconnect the filter drive if it was disconnected
    """
    self._send("manual_home_ol756")

manual_move_to_wavelength ¤

manual_move_to_wavelength(wavelength: float) -> None

Moves the wavelength drive to a particular location.

Parameters:

Name Type Description Default
wavelength float

The wavelength to move the wavelength drive to.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
852
853
854
855
856
857
858
def manual_move_to_wavelength(self, wavelength: float) -> None:
    """Moves the wavelength drive to a particular location.

    Args:
        wavelength: The wavelength to move the wavelength drive to.
    """
    self._send("manual_move_to_wavelength", wavelength)

manual_set_gain ¤

manual_set_gain(gain_index: int, mode: int) -> None

Set the gain.

Parameters:

Name Type Description Default
gain_index int

The gain index.

  • 0 — 1.0E-5
  • 1 — 1.0E-6
  • 2 — 1.0E-7
  • 3 — 1.0E-8
  • 4 — 1.0E-9
  • 5 — 1.0E-10 (Point to Point mode only)
  • 6 — 1.0E-11 (Point to Point mode only)
  • 7 — Auto Gain Ranging (Point to Point mode only)
 required
mode int

The scan mode.

  • 0 — Point to point
  • 1 — Quick scan
 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
def manual_set_gain(self, gain_index: int, mode: int) -> None:
    """Set the gain.

    Args:
        gain_index: The gain index.

            * `0` — 1.0E-5
            * `1` — 1.0E-6
            * `2` — 1.0E-7
            * `3` — 1.0E-8
            * `4` — 1.0E-9
            * `5` — 1.0E-10 (Point to Point mode only)
            * `6` — 1.0E-11 (Point to Point mode only)
            * `7` — Auto Gain Ranging (Point to Point mode only)

        mode: The scan mode.

            * `0` — Point to point
            * `1` — Quick scan
    """
    self._send("manual_set_gain", gain_index, mode)

manual_set_integration_time ¤

manual_set_integration_time(time: float) -> None

Sets the integration time set in the system.

Only applies to the integration time used for Point to Point scans.

Parameters:

Name Type Description Default
time float

The integration time in seconds.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
882
883
884
885
886
887
888
889
890
def manual_set_integration_time(self, time: float) -> None:
    """Sets the integration time set in the system.

    Only applies to the integration time used for Point to Point scans.

    Args:
        time: The integration time in seconds.
    """
    self._send("manual_set_integration_time", time)

manual_set_pmt_overload ¤

manual_set_pmt_overload(overload: float) -> None

Sets the PMT overload voltage set in the system.

Parameters:

Name Type Description Default
overload float

Overload voltage, in volts, of the photomultiplier tube in Volts.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
892
893
894
895
896
897
898
def manual_set_pmt_overload(self, overload: float) -> None:
    """Sets the PMT overload voltage set in the system.

    Args:
        overload: Overload voltage, in volts, of the photomultiplier tube in Volts.
    """
    self._send("manual_set_pmt_overload", overload)

manual_set_pmt_voltage ¤

manual_set_pmt_voltage(voltage: float) -> None

Sets the PMT high voltage set in the system.

Parameters:

Name Type Description Default
voltage float

Voltage, in volts, of the photomultiplier tube.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
900
901
902
903
904
905
906
def manual_set_pmt_voltage(self, voltage: float) -> None:
    """Sets the PMT high voltage set in the system.

    Args:
        voltage: Voltage, in volts, of the photomultiplier tube.
    """
    self._send("manual_set_pmt_voltage", voltage)

manual_set_settling_time ¤

manual_set_settling_time(time: float) -> None

Sets the settling time of the instrument.

Parameters:

Name Type Description Default
time float

Settling time of the system.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
908
909
910
911
912
913
914
def manual_set_settling_time(self, time: float) -> None:
    """Sets the settling time of the instrument.

    Args:
        time: Settling time of the system.
    """
    self._send("manual_set_settling_time", time)

move_to_wavelength ¤

move_to_wavelength(wavelength: float) -> None

Moves the wavelength drive to a particular location.

Parameters:

Name Type Description Default
wavelength float

The wavelength, in nm, to move the wavelength drive to.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
916
917
918
919
920
921
922
def move_to_wavelength(self, wavelength: float) -> None:
    """Moves the wavelength drive to a particular location.

    Args:
        wavelength: The wavelength, in nm, to move the wavelength drive to.
    """
    self._send("move_to_wavelength", wavelength)

read_ol756_flash_settings ¤

read_ol756_flash_settings() -> None

Reads the saved settings from the flash memory.

Reads the settings such as the grating alignment factor, filter skew and wavelength skew. Loads these values into the ActiveX control memory.

Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
924
925
926
927
928
929
930
def read_ol756_flash_settings(self) -> None:
    """Reads the saved settings from the flash memory.

    Reads the settings such as the grating alignment factor, filter skew
    and wavelength skew. Loads these values into the ActiveX control memory.
    """
    self._send("read_ol756_flash_settings")

reset_averaging ¤

reset_averaging(meas_type: Literal[0, 1, 2, 3, 4, 5]) -> None

Resets the accumulated signal array for the specified measurement type.

This function is used in combination with do_averaging and accumulate_signals.

Parameters:

Name Type Description Default
meas_type Literal[0, 1, 2, 3, 4, 5]

The measurement type.

  • 0 — Irradiance
  • 1 — Radiance
  • 2 — Transmittance
  • 3 — Irradiance Calibration
  • 4 — Radiance Calibration
  • 5 — Transmittance Calibration
 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
def reset_averaging(self, meas_type: Literal[0, 1, 2, 3, 4, 5]) -> None:
    """Resets the accumulated signal array for the specified measurement type.

    This function is used in combination with
    [do_averaging][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.do_averaging]
    and [accumulate_signals][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.accumulate_signals].

    Args:
        meas_type: The measurement type.

            * `0` — Irradiance
            * `1` — Radiance
            * `2` — Transmittance
            * `3` — Irradiance Calibration
            * `4` — Radiance Calibration
            * `5` — Transmittance Calibration

    """
    self._send("reset_averaging", meas_type)

save_calibration_file ¤

save_calibration_file(meas_type: Literal[3, 4, 5], path: PathLike) -> None

Create a OL756-compatible calibration file.

Parameters:

Name Type Description Default
meas_type Literal[3, 4, 5]

The calibration measurement type.

  • 3 — Irradiance Calibration
  • 4 — Radiance Calibration
  • 5 — Transmittance Calibration
 required
path PathLike

The path to save the calibration file to.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
952
953
954
955
956
957
958
959
960
961
962
963
964
def save_calibration_file(self, meas_type: Literal[3, 4, 5], path: PathLike) -> None:
    """Create a OL756-compatible calibration file.

    Args:
        meas_type: The calibration measurement type.

            * `3` — Irradiance Calibration
            * `4` — Radiance Calibration
            * `5` — Transmittance Calibration

        path: The path to save the calibration file to.
    """
    self._send("save_calibration_file", meas_type, os.fsdecode(path))

save_measurement_data ¤

save_measurement_data(meas_type: Literal[0, 1, 2], path: PathLike) -> None

Save the measurement data to a OL756-compatible data file.

Parameters:

Name Type Description Default
meas_type Literal[0, 1, 2]

The measurement type.

  • 0 — Irradiance
  • 1 — Radiance
  • 2 — Transmittance
 required
path PathLike

The path to save the data to.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
966
967
968
969
970
971
972
973
974
975
976
977
978
def save_measurement_data(self, meas_type: Literal[0, 1, 2], path: PathLike) -> None:
    """Save the measurement data to a OL756-compatible data file.

    Args:
        meas_type: The measurement type.

            * `0` — Irradiance
            * `1` — Radiance
            * `2` — Transmittance

        path: The path to save the data to.
    """
    self._send("save_measurement_data", meas_type, os.fsdecode(path))

send_down_parameters ¤

send_down_parameters(scan_mode: Literal[0, 1]) -> None

Sends down the parameters to the system.

This needs to be called whenever parameters dealing with the PMT or integration time and gain has changed. Needs to be called once before doing any measurements or other signal acquisition including dark current.

The following methods affect the parameters

Parameters:

Name Type Description Default
scan_mode Literal[0, 1]

The scan mode.

  • 0 — Point to point
  • 1 — Quick scan
 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
def send_down_parameters(self, scan_mode: Literal[0, 1]) -> None:
    """Sends down the parameters to the system.

    This needs to be called whenever parameters dealing with the PMT or
    integration time and gain has changed. Needs to be called once before
    doing any measurements or other signal acquisition including dark
    current.

    The following methods affect the parameters

    * [set_pmt_flux_overload_voltage][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.set_pmt_flux_overload_voltage]
    * [set_gain][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.set_gain]
    * [set_integration_time][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.set_integration_time]
    * [set_pmt_high_voltage][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.set_pmt_high_voltage]
    * [set_settling_time][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.set_settling_time]
    * [set_scan_range][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.set_scan_range]
    * [set_adaptive_integration_time][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.set_adaptive_integration_time]

    Args:
        scan_mode: The scan mode.

            * `0` — Point to point
            * `1` — Quick scan

    """  # noqa: E501
    self._send("send_down_parameters", scan_mode)

set_adaptive_integration_time ¤

set_adaptive_integration_time(gain_index: int, speed_index: int) -> None

Sets the scan speed of the scan at a particular gain range.

Adaptive integration time is used solely for point to point scans in auto-gain ranging.

Parameters:

Name Type Description Default
gain_index int

The index of the gain to use to set the integration time.

  • 0 — 1.0E-5
  • 1 — 1.0E-6
  • 2 — 1.0E-7
  • 3 — 1.0E-8
  • 4 — 1.0E-9
  • 5 — 1.0E-10
  • 6 — 1.0E-11
 required
speed_index int

The scan speed index [0..12] — 0 (Slowest), 12 (Fastest).

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
def set_adaptive_integration_time(self, gain_index: int, speed_index: int) -> None:
    """Sets the scan speed of the scan at a particular gain range.

    Adaptive integration time is used solely for point to point
    scans in auto-gain ranging.

    Args:
        gain_index: The index of the gain to use to set the integration time.

            * `0` — 1.0E-5
            * `1` — 1.0E-6
            * `2` — 1.0E-7
            * `3` — 1.0E-8
            * `4` — 1.0E-9
            * `5` — 1.0E-10
            * `6` — 1.0E-11

        speed_index: The scan speed index [0..12] — `0` (Slowest), `12` (Fastest).
    """
    self._send("set_adaptive_integration_time", gain_index, speed_index)

set_averaging_number_of_scan ¤

set_averaging_number_of_scan(n_scans: int) -> None

Set the number of scans to average.

Parameters:

Name Type Description Default
n_scans int

The number of scans to average.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
1028
1029
1030
1031
1032
1033
1034
def set_averaging_number_of_scan(self, n_scans: int) -> None:
    """Set the number of scans to average.

    Args:
        n_scans: The number of scans to average.
    """
    self._send("set_averaging_number_of_scan", n_scans)

set_dark_current_params ¤

set_dark_current_params(mode: Literal[0, 1], wavelength: float) -> None

Sets the mode and the wavelength to use for a dark-current measurement.

Parameters:

Name Type Description Default
mode Literal[0, 1]

The mode to use to acquire a dark-current measurement.

  • 0 — wavelength
  • 1 — shutter
 required
wavelength float

The wavelength, in nm, to use for a dark-current measurement.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
def set_dark_current_params(self, mode: Literal[0, 1], wavelength: float) -> None:
    """Sets the mode and the wavelength to use for a dark-current measurement.

    Args:
        mode: The mode to use to acquire a dark-current measurement.

            * `0` — wavelength
            * `1` — shutter

        wavelength: The wavelength, in nm, to use for a dark-current measurement.
    """
    self._send("set_dark_current_params", mode, wavelength)

set_gain ¤

set_gain(scan_mode: Literal[0, 1], gain_index: int) -> None

Sets the index of the gain that will be applied when the parameters are to be sent down.

Applies to both quick scan and point to point scans.

Parameters:

Name Type Description Default
scan_mode Literal[0, 1]

The scan mode.

  • 0 — Point to Point
  • 1 — Quick Scan
 required
gain_index int

The gain index.

  • 0 — 1.0E-5
  • 1 — 1.0E-6
  • 2 — 1.0E-7
  • 3 — 1.0E-8
  • 4 — 1.0E-9
  • 5 — 1.0E-10 (available only in Point to Point mode)
  • 6 — 1.0E-11 (available only in Point to Point mode)
  • 7 — Auto Gain Ranging (available only in Point to Point mode)
 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
def set_gain(self, scan_mode: Literal[0, 1], gain_index: int) -> None:
    """Sets the index of the gain that will be applied when the parameters are to be sent down.

    Applies to both quick scan and point to point scans.

    Args:
        scan_mode: The scan mode.

            * `0` — Point to Point
            * `1` — Quick Scan

        gain_index: The gain index.

            * `0` — 1.0E-5
            * `1` — 1.0E-6
            * `2` — 1.0E-7
            * `3` — 1.0E-8
            * `4` — 1.0E-9
            * `5` — 1.0E-10 (available only in Point to Point mode)
            * `6` — 1.0E-11 (available only in Point to Point mode)
            * `7` — Auto Gain Ranging (available only in Point to Point mode)

    """
    self._send("set_gain", scan_mode, gain_index)

set_integration_time ¤

set_integration_time(scan_mode: Literal[0, 1], scan_speed: int) -> None

Sets the index of the scan speed used.

Applies to both quick scan and point to point scans. In quick scan, the speed will vary based on the scan range and increments.

Parameters:

Name Type Description Default
scan_mode Literal[0, 1]

The scan mode.

  • 0 — Point to Point
  • 1 — Quick Scan
 required
scan_speed int

Index to the integration time array.

Point to Point mode.

  • 0 — 1.000 sec
  • 1 — 0.500 sec
  • 2 — 0.200 sec
  • 3 — 0.100 sec
  • 4 — 0.050 sec
  • 5 — 0.020 sec
  • 6 — 0.010 sec
  • 7 — 0.005 sec
  • 8 — 0.002 sec
  • 9 — 0.001 sec
  • 10 — Adaptive (Point To Point mode only)
  • 11 — User defined (Point To Point mode only)

Quick Scan mode.

  • 0 — slowest
  • 10 — fastest
 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
def set_integration_time(self, scan_mode: Literal[0, 1], scan_speed: int) -> None:
    """Sets the index of the scan speed used.

    Applies to both quick scan and point to point scans.
    In quick scan, the speed will vary based on the scan range and increments.

    Args:
        scan_mode: The scan mode.

            * `0` — Point to Point
            * `1` — Quick Scan

        scan_speed: Index to the integration time array.

            Point to Point mode.

            * `0` — 1.000 sec
            * `1` — 0.500 sec
            * `2` — 0.200 sec
            * `3` — 0.100 sec
            * `4` — 0.050 sec
            * `5` — 0.020 sec
            * `6` — 0.010 sec
            * `7` — 0.005 sec
            * `8` — 0.002 sec
            * `9` — 0.001 sec
            * `10` — Adaptive	(Point To Point mode only)
            * `11` — User defined (Point To Point mode only)

            Quick Scan mode.

            * `0` — slowest
            * `10` — fastest

    """
    self._send("set_integration_time", scan_mode, scan_speed)

set_pmt_flux_overload_voltage ¤

set_pmt_flux_overload_voltage(voltage: float) -> None

Sets the value to use for the photomultiplier tube flux overload.

Parameters:

Name Type Description Default
voltage float

Voltage that the PMT will determine to be at the overload point. Software only, because PMT has built-in protection also.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
1111
1112
1113
1114
1115
1116
1117
1118
def set_pmt_flux_overload_voltage(self, voltage: float) -> None:
    """Sets the value to use for the photomultiplier tube flux overload.

    Args:
        voltage: Voltage that the PMT will determine to be at the overload point.
            Software only, because PMT has built-in protection also.
    """
    self._send("set_pmt_flux_overload_voltage", voltage)

set_pmt_high_voltage ¤

set_pmt_high_voltage(voltage: float) -> None

Sets the value to be determined to be a flux overload by the software.

Parameters:

Name Type Description Default
voltage float

Voltage, in volts, that the PMT will determine to be overload point.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
1120
1121
1122
1123
1124
1125
1126
def set_pmt_high_voltage(self, voltage: float) -> None:
    """Sets the value to be determined to be a flux overload by the software.

    Args:
        voltage: Voltage, in volts, that the PMT will determine to be overload point.
    """
    self._send("set_pmt_high_voltage", voltage)

set_reference_white_point ¤

set_reference_white_point(
    white: Literal[0, 1, 2, 3, 4, 5], x: float, y: float
) -> None

Sets the value of the reference illuminant.

Parameters:

Name Type Description Default
white Literal[0, 1, 2, 3, 4, 5]

The reference white point.

  • 0 — Incandescent (A)
  • 1 — Direct Sunlight (B)
  • 2 — Indirect Sunlight (C)
  • 3 — Natural Daylight (D65)
  • 4 — Normalized Reference (E)
  • 5 — User Defined
 required
x float

User defined x value on CIE chart.

 required
y float

User defined y value on CIE chart.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
def set_reference_white_point(self, white: Literal[0, 1, 2, 3, 4, 5], x: float, y: float) -> None:
    """Sets the value of the reference illuminant.

    Args:
        white: The reference white point.

            * `0` — Incandescent (A)
            * `1` — Direct Sunlight (B)
            * `2` — Indirect Sunlight (C)
            * `3` — Natural Daylight (D65)
            * `4` — Normalized Reference (E)
            * `5` — User Defined

        x: User defined x value on CIE chart.
        y: User defined y value on CIE chart.
    """
    self._send("set_reference_white_point", white, x, y)

set_scan_range ¤

set_scan_range(start: float, end: float, increment_index: int) -> None

Sets the wavelength scan range.

Parameters:

Name Type Description Default
start float

Starting wavelength, in nm.

 required
end float

Ending wavelength, in nm.

 required
increment_index int

Increment index, see get_increment_index.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
def set_scan_range(self, start: float, end: float, increment_index: int) -> None:
    """Sets the wavelength scan range.

    Args:
        start: Starting wavelength, in nm.
        end: Ending wavelength, in nm.
        increment_index: Increment index, see
            [get_increment_index][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.get_increment_index].
    """
    self._send("set_scan_range", start, end, increment_index)

set_settling_time ¤

set_settling_time(time: float) -> None

Set the settling time.

Settling time is the time that the wavelength drive pauses once it reaches its target wavelength.

Parameters:

Name Type Description Default
time float

Settling Time in seconds to be sent down or has already been sent to the system.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
def set_settling_time(self, time: float) -> None:
    """Set the settling time.

    Settling time is the time that the wavelength drive pauses once
    it reaches its target wavelength.

    Args:
        time: Settling Time in seconds to be sent down or has already been sent to the system.
    """
    self._send("set_settling_time", time)

set_tab_delimited_mode ¤

set_tab_delimited_mode(*, enable: bool) -> None

Purpose of function is to set what mode to write the data files as.

Setting the tab delimited to true will write the data in a tab delimited format, else a false will write in a comma delimited format. Tab delimited files will not be compatible with some versions of the software. If you want data files to be compatible with v1.32 software and below, leave the mode to False.

Parameters:

Name Type Description Default
enable bool

Whether to use the new file format using TABs as a delimited or the old file format compatible with v1.32 and below.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
def set_tab_delimited_mode(self, *, enable: bool) -> None:
    """Purpose of function is to set what mode to write the data files as.

    Setting the tab delimited to true will write the data in a tab
    delimited format, else a false will write in a comma delimited format.
    Tab delimited files will not be compatible with some versions of the
    software. If you want data files to be compatible with v1.32 software
    and below, leave the mode to `False`.

    Args:
        enable: Whether to use the new file format using TABs as a delimited or
            the old file format compatible with v1.32 and below.
    """
    self._send("set_tab_delimited_mode", enable)

set_user_defined_integration_time ¤

set_user_defined_integration_time(time: float) -> None

Sets the user defined integration time.

Used only in point to point scans and only if the user sets the integration time mode.

Parameters:

Name Type Description Default
time float

Integration time in seconds.

 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
1196
1197
1198
1199
1200
1201
1202
1203
1204
def set_user_defined_integration_time(self, time: float) -> None:
    """Sets the user defined integration time.

    Used only in point to point scans and only if the user sets the integration time mode.

    Args:
        time: Integration time in seconds.
    """
    self._send("set_user_defined_integration_time", time)

stop_measurement ¤

stop_measurement() -> None

Stops a measurement.

Applies only to Point to Point measurements. Quick scans are done so quickly that there is no need to stop a measurement once it starts.

Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
1206
1207
1208
1209
1210
1211
1212
def stop_measurement(self) -> None:
    """Stops a measurement.

    Applies only to Point to Point measurements. Quick scans are done
    so quickly that there is no need to stop a measurement once it starts.
    """
    self._send("stop_measurement")

take_point_to_point_calibration ¤

take_point_to_point_calibration(meas_type: Literal[3, 4, 5]) -> None

Takes a calibration in point to point mode.

Need to have called send_down_parameters at least once before calling any of the measurement functions or data acquisition functions.

Parameters:

Name Type Description Default
meas_type Literal[3, 4, 5]

The calibration measurement type.

  • 3 — Irradiance Calibration
  • 4 — Radiance Calibration
  • 5 — Transmittance Calibration
 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
def take_point_to_point_calibration(self, meas_type: Literal[3, 4, 5]) -> None:
    """Takes a calibration in point to point mode.

    Need to have called
    [send_down_parameters][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.send_down_parameters]
    at least once before calling any of the measurement functions or data acquisition functions.

    Args:
        meas_type: The calibration measurement type.

            * `3` — Irradiance Calibration
            * `4` — Radiance Calibration
            * `5` — Transmittance Calibration

    """
    self._send("take_point_to_point_calibration", meas_type)

take_point_to_point_measurement ¤

take_point_to_point_measurement(meas_type: Literal[0, 1, 2]) -> None

Takes a measurement in point to point mode.

Need to have called send_down_parameters at least once before calling any of the measurement functions or data acquisition functions.

Parameters:

Name Type Description Default
meas_type Literal[0, 1, 2]

The measurement type.

  • 0 — Irradiance
  • 1 — Radiance
  • 2 — Transmittance
 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
def take_point_to_point_measurement(self, meas_type: Literal[0, 1, 2]) -> None:
    """Takes a measurement in point to point mode.

    Need to have called
    [send_down_parameters][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.send_down_parameters]
    at least once before calling any of the measurement functions or data acquisition functions.

    Args:
        meas_type: The measurement type.

            * `0` — Irradiance
            * `1` — Radiance
            * `2` — Transmittance

    """
    self._send("take_point_to_point_measurement", meas_type)

take_quick_scan_calibration ¤

take_quick_scan_calibration(meas_type: Literal[3, 4, 5]) -> None

Takes a calibration in quick scan mode.

Need to have called send_down_parameters at least once before calling any of the measurement functions or data acquisition functions.

Parameters:

Name Type Description Default
meas_type Literal[3, 4, 5]

The calibration measurement type.

  • 3 — Irradiance Calibration
  • 4 — Radiance Calibration
  • 5 — Transmittance Calibration
 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
def take_quick_scan_calibration(self, meas_type: Literal[3, 4, 5]) -> None:
    """Takes a calibration in quick scan mode.

    Need to have called
    [send_down_parameters][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.send_down_parameters]
    at least once before calling any of the measurement functions or data acquisition functions.

    Args:
        meas_type: The calibration measurement type.

            * `3` — Irradiance Calibration
            * `4` — Radiance Calibration
            * `5` — Transmittance Calibration

    """
    self._send("take_quick_scan_calibration", meas_type)

take_quick_scan_measurement ¤

take_quick_scan_measurement(meas_type: Literal[0, 1, 2]) -> None

Takes a measurement in quick scan mode.

Need to have called send_down_parameters at least once before calling any of the measurement functions or data acquisition functions.

Parameters:

Name Type Description Default
meas_type Literal[0, 1, 2]

The measurement type.

  • 0 — Irradiance
  • 1 — Radiance
  • 2 — Transmittance
 required
Source code in packages/resources/src/msl/equipment_resources/optronic_labs/ol756ocx_64.py 
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
def take_quick_scan_measurement(self, meas_type: Literal[0, 1, 2]) -> None:
    """Takes a measurement in quick scan mode.

    Need to have called
    [send_down_parameters][msl.equipment_resources.optronic_labs.ol756ocx_64.OL756.send_down_parameters]
    at least once before calling any of the measurement functions or data acquisition functions.

    Args:
        meas_type: The measurement type.

            * `0` — Irradiance
            * `1` — Radiance
            * `2` — Transmittance

    """
    self._send("take_quick_scan_measurement", meas_type)