# IMeasurementData

public 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
public class Companion

## Functions

getDeviceType
Link copied to clipboard
public abstract DeviceType getDeviceType()

Device type that was used to make this measurement.

getMode
Link copied to clipboard
public abstract ScanMode getMode()

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

getProvidesDensity
Link copied to clipboard
public Boolean getProvidesDensity()

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.

getProvidesSpectral
Link copied to clipboard
public Boolean getProvidesSpectral()

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.

getRaw
Link copied to clipboard
public abstract String getRaw()

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

getSpectralData
Link copied to clipboard
public abstract ISpectralData getSpectralData()

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

getStatus
Link copied to clipboard
public abstract Byte getStatus()

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

getSupportedReferences
Link copied to clipboard
public Array<ReferenceWhite> getSupportedReferences()

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

getTCompEnabled
Link copied to clipboard
public abstract Boolean getTCompEnabled()

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.

getTileDelta
Link copied to clipboard
public abstract Double getTileDelta()

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.

getTileEnabled
Link copied to clipboard
public abstract Boolean getTileEnabled()

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.

getTReal
Link copied to clipboard
public abstract Boolean getTReal()

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.

getTRef
Link copied to clipboard
public abstract Float getTRef()

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

getTScan
Link copied to clipboard
public abstract Float getTScan()

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

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

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

toColorData
Link copied to clipboard
public abstract IColorData toColorData(ReferenceWhite reference, IColorData.ColorType type)
public IColorData toColorData(Illuminant illuminant, Observer observer, IColorData.ColorType type)

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()
public Integer toColorInt(ReferenceWhite reference)
@ColorInt()
public Integer toColorInt(Illuminant illuminant, Observer observer)

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
public abstract IDensityData toDensityData(DensityStatus status)

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
public IntArray toRgbValue(ReferenceWhite reference)
public IntArray toRgbValue(Illuminant illuminant, Observer observer)

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.