DepthMediaFrame.MinReliableDepth Property

Definition

Gets a value that specifies the minimum reliable depth value for the camera that captured the depth frame.

public:
 property unsigned int MinReliableDepth { unsigned int get(); };
uint32_t MinReliableDepth();
public uint MinReliableDepth { get; }
var uInt32 = depthMediaFrame.minReliableDepth;
Public ReadOnly Property MinReliableDepth As UInteger

Property Value

UInt32

A value that specifies the minimum reliable depth value for the camera that captured the depth frame.

Windows requirements

Device family
Windows 10 Creators Update (introduced in 10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v4.0)

Remarks

A depth camera may not be able to reliably sense the depth for the full range of the UInt16 value that is used to express depth in a depth media frame. The value of MinReliableDepth is set by the depth camera device to indicate the lower limit of values within the UInt16 range for which the device can reliably capture depth data. You can safely clamp depth pixel values lower than this value. The upper limit of reliable depth values is specified with the MaxReliableDepth property. These properties are expressed in the same units as the individual depth pixel values. You can convert MinReliableDepth to meters by multiplying it by the value of the DepthScaleInMeters property of the DepthFormat property of the DepthMediaFrame object.

Applies to