Skip to main content
Skip table of contents

i1Display

class i1.I1Display

Bases: object

Class Definition for the i1Display device.

measurement

Measurements taken by the i1Display.

PYTHON 
>>> from pypixxlib.i1 import I1Display
>>> my_device = I1Display()
>>> my_device.function()
close()

Releases the handle on the current I1Display device.

This method should be the last call made on a I1Display object.

getAllMeasurement()

Gets all the measurements taken by the i1Display.

This method returns a list which contains all measurements taken since the creation of the I1Display object. Each item in the list is a dictionary with both chromaticity coordinates and luminance.

Returns:

All measurements taken by the I1Display.

Return type:

measurements (list)

See Also: getAllMeasurement, printLatestMeasurement

getCurrentCalibration()

Gets the i1Display calibration mode.

This method allows the user to get the calibration mode of the i1Display.

Returns:

Calibration is one of the following predefined constants:

  • CCFL: Calibration used for displays with CCFL backlights.

  • WHITE LED: Calibration used for displays with white LED backlights.

  • RGB LED: Calibration used for displays with RGB LED backlights.

  • CRT: Calibration used for CRT.

  • PROJECTOR: Calibration used for projectors.

  • VPIXX: Calibration used for VIEWPixx and VIEWPixx /3D displays and PROPixx projectors.

  • EEG: Calibration used for VIEWPixx /EEG displays.

Return type:

mode (string)

See Also: getCurrentCalibration

getFirmwareDate()

Gets the i1Display firmware date.

Returns:

Firmware date.

Return type:

revision (string)

getFirmwareRevision()

Gets the i1Display firmware revision.

Returns:

Firmware revision.

Return type:

revision (string)

getIntegrationTime()

Gets the integration time used by the i1Display.

This method allows the user to know the current integration time used by the i1Display to take measurements.

Returns:

Any value greater than 0.0.

Return type:

time (float)

getLatestMeasurement()

Gets the latest measurements taken by the i1Display.

All measurements are kept in a list. This method returns the last item from that list, which is a dictionary. Using the chrominance key, gives the x and y coordinates of the measurement on the chromaticity chart. Using the luminance key gives the luminance value of the measurement.

Returns:

  • chrominance: Tuple of floating points coordinates. Ranges from 0 to 1.

  • luminance: floating point value in cd/m^2.

Return type:

measurements (dict)

See Also: getAllMeasurement, printLatestMeasurement

isDiffuserOn()

Verifies if the i1Display’s diffuser is currently placed in front of the detector.

Returns:

True if the diffuser is in front of the detector, otherwise False.

Return type:

state (Bool)

printLatestMeasurement()

Displays the latest measurements taken by the i1Display.

This method allows the user to display on the monitor the last measurement taken by the I1Display.

Returns:

Chrominance coordinates and luminance with 4 decimal points.

Return type:

measurements (string)

See Also: getAllMeasurement, getLatestMeasurement

runMeasurement()

Triggers an acquisition on the i1Display.

This method triggers an acquisition on the I1Dsiplay. Since the measurement is affected by the position of the diffuser, the method verifies if the diffuser is located in front of the I1Dsiplay detector. Once the acquisition is done, it is added to the measurement list.

setCurrentCalibration(calibration)

Sets the i1Display calibration mode.

This method allows the user to set the calibration mode of the i1Display. The calibration mode should be chosen based on the display that the i1Display will be measuring. The default value is RGB LED. When using a VPixx device, the default value should be kept.

Parameters:

mode (string) –

Calibration is one of the following predefined constants:

  • CCFL: Calibration used for displays with CCFL backlights.

  • WHITE LED: Calibration used for displays with white LED backlights.

  • RGB LED: Calibration used for displays with RGB LED backlights.

  • CRT: Calibration used for CRT.

  • PROJECTOR: Calibration used for projectors.

  • VPIXX: Calibration used for VIEWPixx and VIEWPixx /3D displays and PROPixx projectors.

  • EEG: Calibration used for VIEWPixx /EEG displays.

See Also: getCurrentCalibration

setIntegrationTime(time=1.0)

Sets the integration time for the i1Display.

This method allows the user to change the time taken by the i1Display to take measurements.

Parameters:

time (float) – Any value greater than 0.0.

class i1.I1Pro

Bases: object

Class Definition for the i1Pro device.

spectrum

Spectrum measurements taken by the i1Pro.

tristimulus

Tristimulus measurements taken by the i1Pro.

revision

Revision of the current i1Pro.

serial_number

Serial number of the current i1Pro.

PYTHON 
>>> from pypixxlib.i1 import I1Pro()
>>> my_device = I1Pro()
>>> my_device.function()
calibrate(measure_mode, pushButtonWait=True)

Calibrates the i1Pro.

This method allows the user to calibrate the i1Pro. It should be noted that when a calibration is done, it is done for a specific ‘measurement mode’. The required measurement mode must be specified.

Parameters:

measure_mode (string) –

mode is one of the following predefined constants:

  • Emission: Mode for an emission measurement on an emitting probe like a display.

  • Ambiant: Mode for an ambient light measurement.

  • Reflect: Mode for one spot measurement on a reflective surface.

close()

Releases the handle on the current i1Pro device.

This methods closes the i1Pro and should be the last call made on a I1Pro object.

getAllSpectrumMeasurements()

Gets all the spectrum measurements taken by the i1Pro.

This method returns a list which contains all spectrum values taken since the creation of the i1Pro object.

Returns:

All spectrum measurements taken by the i1Pro.

Return type:

spectrum (list)

See Also: getLatestSpectrum, getAllTriStimulus

getAllTriStimulus()

Gets all the triStimulus measurements taken by the i1Pro.

This method returns a list which contains all triStimulus values taken since the creation of the i1Pro object.

Returns:

All triStimulus measurements taken by the i1Pro.

Return type:

spectrum (list)

See Also: getLatestTriStimulus

getColorSpace()

Gets the current color space mode for the i1Pro.

This method allows the user to know what is the current color space mode on the i1Pro.

Returns:

measurement mode is one of the following predefined constants:

  • CIELab: Mode for an emission measurement on an emitting probe like a display.

  • CIELCh: Mode for an ambient light measurement.

  • CIELuv:

  • CIELChuv:

  • CIEuvY1960:

  • CIEuvY1976:

  • CIEXYZ:

  • CIExyY:

Return type:

mode (string)

See Also: setColorSpace

getConnectionStatus()

Gets the current connection status on the i1Pro.

This method allows the user to know what is the current connection status on the i1Pro. When an error occurs, this method will give the user an error code which indicates what the problem is.

Returns:

Connection status.

Return type:

mode (string)

getIlluminationMode()

Gets the current color illumination mode on the i1Pro.

This method allows the user to know what is the current illumination mode on the i1Pro.

Returns:

mode is one of the following predefined constants:

  • A

  • B

  • C

  • D50

  • D55

  • D65

  • D75

  • F2

  • F7

  • F11

  • Emission

Return type:

mode (string)

getLatestSpectrumMeasurements()

Gets the latest spectrum measurements taken by the i1Pro.

All measurements are kept in a list. This method returns the last item from that list.

Returns:

Latest spectrum measurement taken by he i1Pro.

Return type:

measurements (list)

See Also: getAllSpectrumMeasurements

getLatestTriStimulusMeasurements()

Gets the latest triStimulus measurements taken by the i1Pro.

All measurements are kept in a list. This method returns the last item from that list.

Returns:

Latest spectrum measurement taken by he i1Pro.

Return type:

measurements (list)

See Also: getAllSpectrumMeasurements

getMeasurementMode()

Gets the current measurement mode on the i1Pro.

This method allows the user to know what is the current measurement mode on the i1Pro.

Returns:

measurement mode is one of the following predefined constants:

  • Emission: Mode for an emission measurement on an emitting probe like a display.

  • Ambiant: Mode for an ambient light measurement.

Return type:

mode (string)

See Also: setMeasurementMode

getTimeUntilCalibrationExpire()

Gets the time left until the calibration on the i1Pro expires.

This method allows the user to know how much time is left until a calibration needs to be performed on the i1Pro. When an error occurs, this method will give the user an error code which indicates what the problem is.

Returns:

Time is a value greater than -1. When -1 is returned, it indicates that the time has expired.

Return type:

time (int)

isCalibrationExpired()

Verifies if the calibration on the i1Pro has expired.

In order to get precise results, the i1Pro needs to be calibrated frequently. This method allows the user to know if the calibration needs to be done. It should be noted that a calibration is required before each use of the device.

Returns:

True if the calibration has expired, otherwise False.

Return type:

state (Bool)

printLatestMeasurement()

Displays the latest measurements taken by the i1Pro.

This method allows the user to display on the monitor the last measurement taken by the I1Pro.

Returns:

Chrominance coordinates and luminance with 4 decimal points.

Return type:

measurements (string)

See Also: getAllTriStimulus, getLatestSpectrumMeasurements

runMeasurement()

Triggers an acquisition on the i1Pro.

This method triggers an acquisition on the i1Pro. Once the acquisition is done, it is added to the measurement list.

setColorSpace(mode)

Sets the color space mode for the i1Pro.

This method allows the user to change the color space mode used during measurements. The mode should be chosen based on the light the source.

Parameters:

mode (string) –

measurement mode is one of the following predefined constants:

  • CIELab: Mode for an emission measurement on an emitting probe like a display.

  • CIELCh: Mode for an ambient light measurement.

  • CIELuv:

  • CIELChuv:

  • CIEuvY1960:

  • CIEuvY1976:

  • CIEXYZ:

  • CIExyY:

See Also: getColorSpace

setIlluminationMode(mode='Emission')

Sets the illumination mode the i1Pro.

This method allows the user to change the illumination mode used during measurements.

Parameters:

mode (string) –

mode is one of the following predefined constants:

  • A

  • B

  • C

  • D50

  • D55

  • D65

  • D75

  • F2

  • F7

  • F11

  • Emission

setMeasurementMode(mode, adaptative=False)

Sets the measurement mode on the i1Pro.

This method allows the user to change the measurement mode of the i1Pro. The mode should be chosen based on the light source.

Parameters:

  • mode (string) –

    measurement mode is one of the following predefined constants:

    • Emission: Mode for an emission measurement on an emitting probe like a display.

    • Ambiant: Mode for an ambient light measurement.

    • Reflect: Mode for one spot measurement on a reflective surface.

  • adaptative (Bool) – When this mode is True, a trial measurement is done first to get the best measurement result. When it is False, the measurement duration is lower, but the results precision is also lower.

See Also: getMeasurementMode

setModes(measurement='Ambiant', color_space='CIExyY', illumination='Emission')

Sets the measurement, color space and illumination mode on the i1Pro.

This method allows the user to set the three i1Pro modes in a single method call.

Parameters:

  • measurement (string) –

    One of the following predefined constants:

    • Emission: Mode for an emission measurement on an emitting probe like a display.

    • Ambiant: Mode for an ambient light measurement.

    • Reflect: Mode for one spot measurement on a reflective surface.

  • color_space (string) –

    One of the following predefined constants:

    • CIELab: Mode for an emission measurement on an emitting probe like a display.

    • CIELCh: Mode for an ambient light measurement.

    • CIELuv:

    • CIELChuv:

    • CIEuvY1960:

    • CIEuvY1976:

    • CIEXYZ:

    • CIExyY:

  • illumination (string) –

    One of the following predefined constants:

    • A

    • B

    • C

    • D50

    • D55

    • D65

    • D75

    • F2

    • F7

    • F11

    • Emission

See Also: setMeasurementMode, setColorSpace, setIlluminationMode, getMeasurementMode, getColorSpace, getIlluminationMode,

class i1.I1Pro3

Bases: I1Pro

Class Definition for the i1Pro3 device.

spectrum

Spectrum measurements taken by the i1Pro3.

tristimulus

Tristimulus measurements taken by the i1Pro3.

revision

Revision of the current i1Pro3.

serial_number

Serial number of the current i1Pro3.

PYTHON 
>>> from pypixxlib.i1 import I1Pro3()
>>> my_device = I1Pro3()
>>> my_device.function()
calibrate(measure_mode, pushButtonWait=True)

Calibrates the i1Pro.

This method allows the user to calibrate the i1Pro. It should be noted that when a calibration is done, it is done for a specific ‘measurement mode’. The required measurement mode must be specified.

Parameters:

measure_mode (string) –

mode is one of the following predefined constants:

  • Emission: Mode for an emission measurement on an emitting probe like a display.

  • Ambiant: Mode for an ambient light measurement.

  • Reflect: Mode for one spot measurement on a reflective surface.

close()

Releases the handle on the current i1Pro device.

This methods closes the i1Pro and should be the last call made on a I1Pro object.

runMeasurement()

Triggers an acquisition on the i1Pro.

This method triggers an acquisition on the i1Pro. Once the acquisition is done, it is added to the measurement list.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close