Interface IMeasurementData
Interface defining the properties and methods provided by Nix device measurements. See also IMeasurementDataExtensions for extension methods.
Namespace: NixUniversalSDK
Assembly: NixUniversalSDK.dll
Syntax
public interface IMeasurementData
Properties
DeviceType
Device type that was used to make this measurement.
Declaration
DeviceType DeviceType { get; }
Property Value
Type | Description |
---|---|
DeviceType |
Mode
Scan mode for this measurement.
Declaration
ScanMode Mode { get; }
Property Value
Type | Description |
---|---|
ScanMode |
ProvidesDensity
Flag indicating if this measurement provides absolute density values.
Declaration
bool ProvidesDensity { get; }
Property Value
Type | Description |
---|---|
bool |
ProvidesSpectral
Flag indicating if this measurement provides spectral values.
Declaration
bool ProvidesSpectral { get; }
Property Value
Type | Description |
---|---|
bool |
Raw
Raw data for a measurement. Can be used for measurement object reconstruction.
Declaration
string Raw { get; }
Property Value
Type | Description |
---|---|
string |
SpectralData
Provides a spectral data object from this measurement, or null
if spectral data is not supported.
Declaration
ISpectralData SpectralData { get; }
Property Value
Type | Description |
---|---|
ISpectralData |
Status
Scan status byte. A value of 0x01
indicates success, all other values indicate error states.
Declaration
byte Status { get; }
Property Value
Type | Description |
---|---|
byte |
SupportedReferences
List describing all reference white points that are available when requesting color data from this measurement using ToColorData(ReferenceWhite, ColorType)
Declaration
IEnumerable<ReferenceWhite> SupportedReferences { get; }
Property Value
Type | Description |
---|---|
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.
Declaration
bool? TCompEnabled { get; }
Property Value
Type | Description |
---|---|
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.
Declaration
bool? TReal { get; }
Property Value
Type | Description |
---|---|
bool? |
TRef
Baseline reference temperature for this measurement, or null
if the device did not support temperature measurements.
Declaration
float? TRef { get; }
Property Value
Type | Description |
---|---|
float? |
TScan
Temperature of the Nix device at the time of this measurement, or null
if the device did not support temperature measurements.
Declaration
float? TScan { get; }
Property Value
Type | Description |
---|---|
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.
Declaration
double? TileDelta { get; }
Property Value
Type | Description |
---|---|
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.
Declaration
bool? TileEnabled { get; }
Property Value
Type | Description |
---|---|
bool? |
Methods
ToColorData(ReferenceWhite, ColorType)
Provides color data from this measurement for the specified illuminant and observer white point.
Declaration
IColorData ToColorData(ReferenceWhite reference = ReferenceWhite.D50_2, ColorType type = ColorType.CIEXYZ)
Parameters
Type | Name | Description |
---|---|---|
ReferenceWhite | reference | Selected reference white (defaults to D50_2) |
ColorType | type | Output color type (defaults to CIEXYZ) |
Returns
Type | Description |
---|---|
IColorData | Color data, or |
ToDensityData(DensityStatus)
Provides absolute density values for this measurement for the specified density status evaluated as per ISO 5-3:2009.
Declaration
IDensityData ToDensityData(DensityStatus status = DensityStatus.T)
Parameters
Type | Name | Description |
---|---|---|
DensityStatus | status | Density status (defaults to T) |
Returns
Type | Description |
---|---|
IDensityData | Density data, or |