Table of Contents

Interface IMeasurementData

Namespace
NixUniversalSDK
Assembly
NixUniversalSDK.dll

Interface defining the properties and methods provided by Nix device measurements. See also IMeasurementDataExtensions for extension methods.

public interface IMeasurementData
Extension Methods

Properties

DeviceType

Device type that was used to make this measurement.

DeviceType DeviceType { get; }

Property Value

DeviceType

Mode

Scan mode for this measurement.

ScanMode Mode { get; }

Property Value

ScanMode

ProvidesDensity

Flag indicating if this measurement provides absolute density values.

bool ProvidesDensity { get; }

Property Value

bool

ProvidesSpectral

Flag indicating if this measurement provides spectral values.

bool ProvidesSpectral { get; }

Property Value

bool

Raw

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

string Raw { get; }

Property Value

string

SpectralData

Provides a spectral data object from this measurement, or null if spectral data is not supported.

ISpectralData SpectralData { get; }

Property Value

ISpectralData

Status

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

byte Status { get; }

Property Value

byte

SupportedReferences

List describing all reference white points that are available when requesting color data from this measurement using ToColorData(ReferenceWhite, ColorType)

IEnumerable<ReferenceWhite> SupportedReferences { get; }

Property Value

IEnumerable<ReferenceWhite>

TCompEnabled

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.

bool? TCompEnabled { get; }

Property Value

bool?

TReal

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.

bool? TReal { get; }

Property Value

bool?

TRef

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

float? TRef { get; }

Property Value

float?

TScan

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

float? TScan { get; }

Property Value

float?

TileDelta

Delta E value between this measurement and factory reference. Value is non-null for measurement values from RunFieldCalibrationAsync(string) and null in all other cases.

double? TileDelta { get; }

Property Value

double?

TileEnabled

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.

bool? TileEnabled { get; }

Property Value

bool?

Methods

ToColorData(ReferenceWhite, ColorType)

Provides color data from this measurement for the specified illuminant and observer white point.

IColorData ToColorData(ReferenceWhite reference = ReferenceWhite.D50_2, ColorType type = ColorType.CIEXYZ)

Parameters

reference ReferenceWhite

Selected reference white (defaults to D50_2)

type ColorType

Output color type (defaults to CIEXYZ)

Returns

IColorData

Color data, or null if the specified white point it not available for this measurement.

ToDensityData(DensityStatus)

Provides absolute density values for this measurement for the specified density status evaluated as per ISO 5-3:2009.

IDensityData ToDensityData(DensityStatus status = DensityStatus.T)

Parameters

status DensityStatus

Density status (defaults to T)

Returns

IDensityData

Density data, or null if density data is not supported