# IMeasurementData

interface IMeasurementData

Interface defining the properties and methods provided by Nix device measurements

#### Inheritors

Pro
Mini
QC
Pro2
Mini2
Spectro2
Mini3
SpectroL

## Types

Companion
Link copied to clipboard
object Companion

## Properties

deviceType
Link copied to clipboard
abstract val deviceType: DeviceType

Device type that was used to make this measurement.

mode
Link copied to clipboard
abstract val mode: ScanMode

Scan mode for this measurement (one of ScanMode.M0, ScanMode.M1, or ScanMode.M2)

providesDensity
Link copied to clipboard
open val providesDensity: Boolean

Flag indicating if this measurement provides absolute density values. This value depends on both the deviceType and LicenseManager supporting the LicenseFeature.DENSITY_DATA feature. See also DeviceType.isFeatureSupported and LicenseManager.Shared.isFeatureEnabled.

providesSpectral
Link copied to clipboard
open val providesSpectral: Boolean

Flag indicating if this measurement provides spectral values. This value depends on both the deviceType and availability of the LicenseFeature.SPECTRAL_DATA feature. See also DeviceType.isFeatureSupported and LicenseManager.Shared.isFeatureEnabled.

raw
Link copied to clipboard
abstract val raw: String

Raw data for a measurement. Can be used for measurement object reconstruction.

spectralData
Link copied to clipboard
abstract val spectralData: ISpectralData?

Provides a spectral data object from this measurement, or `null` if spectral data is not available. See also providesSpectral.

status
Link copied to clipboard
abstract val status: Byte

Scan status byte. A value of `0x01` indicates success, all other values indicate error states.

supportedReferences
Link copied to clipboard
open val supportedReferences: Array<ReferenceWhite>

Array describing all reference white points that are available when requesting color data from this measurement using IMeasurementData.toColorData

tCompEnabled
Link copied to clipboard
abstract val tCompEnabled: Boolean?

Flag indicating if temperature compensation was applied to the calibrated output for this measurement. Value is `null` if the device did not support temperature measurements.

tileDelta
Link copied to clipboard
abstract val tileDelta: Double?

Delta E value between this measurement and factory reference. Value is non-null for measurement values from IDeviceCompat.runFieldCalibration and `null` in all other cases.

tileEnabled
Link copied to clipboard
abstract val tileEnabled: Boolean?

Flag indicating if in-field profiling corrections / white reference tile measurements were applied to the calibrated output data. Value is `null` if the device did not support in-field profiling.

tReal
Link copied to clipboard
abstract val tReal: Boolean?

Flag describing the units for the reported temperature measurement. When `true`, temperature values are 'real' (floating point, degrees C). When `false`, temperatures are reported on an arbitrary raw scale. Value is `null` if the device did not support temperature measurements.

tRef
Link copied to clipboard
abstract val tRef: Float?

Baseline reference temperature for this measurement, or `null` if the device did not support temperature measurements.

tScan
Link copied to clipboard
abstract val tScan: Float?

Temperature of the Nix device at the time of this measurement, or `null` if the device did not support temperature measurements.

## Functions

providesColor
Link copied to clipboard
abstract fun providesColor(reference: ReferenceWhite): Boolean
open fun providesColor(illuminant: Illuminant, observer: Observer): Boolean

Returns `true` if color data for the selected combination of illuminant and observer are available for this measurement.

toColorData
Link copied to clipboard
abstract fun toColorData(reference: ReferenceWhite = ReferenceWhite.D50_2, type: IColorData.ColorType = CIEXYZ): IColorData?
open fun toColorData(illuminant: Illuminant = Illuminant.D50, observer: Observer = Observer.CIE1931, type: IColorData.ColorType = CIEXYZ): IColorData?

Provides color data from this measurement for the specified illuminant and observer white point. Result is `null` if the specified white point is not available for this measurement.

toColorInt
Link copied to clipboard
@ColorInt
open fun toColorInt(reference: ReferenceWhite = ReferenceWhite.D50_2): Int?
@ColorInt
open fun toColorInt(illuminant: Illuminant = Illuminant.D50, observer: Observer = Observer.CIE1931): Int?

Provides an sRGB value (as a `ColorInt`) for this measurement for the specified illuminant and observer white point. Result is `null` if the specified white point is not available for this measurement.

toDensityData
Link copied to clipboard
abstract fun toDensityData(status: DensityStatus = DensityStatus.T): IDensityData?

Provides absolute density values for this measurement for the specified density status evaluated as per ISO 5-3:2009, or `null` if density data is not available. See also providesDensity.

toRgbValue
Link copied to clipboard
open fun toRgbValue(reference: ReferenceWhite = ReferenceWhite.D50_2): IntArray?
open fun toRgbValue(illuminant: Illuminant = Illuminant.D50, observer: Observer = Observer.CIE1931): IntArray?

Provides an sRGB value for this measurement for the specified illuminant and observer white point. Result is `null` if the specified white point is not available for this measurement.