PixelSensors
NameSpace: Features
Classes
| Type | Name |
|---|---|
| class | MagicLeapPixelSensorFeature Enables the Magic Leap OpenXR Loader for Android, and modifies the AndroidManifest to be compatible with ML2. |
| class | PixelSensorAnalogGain The Analog gain metadata holder |
| class | PixelSensorAsyncOperationResult Represents the progress of an async Pixel sensor operation |
| struct | PixelSensorCapability Represents the capability data's type |
| class | PixelSensorCapabilityRange The capability range for a sensor capability |
| class | PixelSensorConfigData Represents a configuration to be applied for a sensor |
| class | PixelSensorDepthConfidenceBuffer The Depth Confidence Buffer metadata |
| class | PixelSensorDepthFlagBuffer The Depth Flag Buffer metadata |
| class | PixelSensorDepthFrameIllumination The Depth Frame Illumination metadata |
| class | PixelSensorDigitalGain The Digital gain metadata holder |
| class | PixelSensorExposureTime The exposure time metadata |
| class | PixelSensorFisheyeIntrinsics The Fisheye intrinsics camera model metadata. |
| struct | PixelSensorFrame Represents the frame data of a sensor |
| struct | PixelSensorId A Pixel Sensor Identifier |
| class | PixelSensorMetaData The base class for all metadata types. PixelSensors.MagicLeapPixelSensorFeature.GetSensorData will return an array of instances of the base class type Use the MetadataType to determine and cast to the corresponding metadata needed |
| class | PixelSensorPinholeIntrinsics The Pinhole camera model intrinsics metadata |
| struct | PixelSensorPlane Represents a plane from a sensor frame |
Enums
Enums Documentation
PixelSensorAutoExposureMode
The exposure mode of the pixel sensor
| Enumerator | Value | Description |
|---|---|---|
| EnvironmentTracking | Exposure mode optimized for environmental tracking | |
| ProximityIrTracking | Exposure mode optimized for proximity IR light source. |
PixelSensorCapabilityDataType
Represents the data types supported by a pixel sensor capability.
| Enumerator | Value | Description |
|---|---|---|
| Boolean | ||
| UnsignedInt32 | 100 | |
| Float | 101 | |
| Extent2D | 200 |
PixelSensorCapabilityRangeType
Represents the range type of pixel sensor capability.
| Enumerator | Value | Description |
|---|---|---|
| Boolean | A boolean value | |
| Continuous | Represents a range with a min and a max value | |
| Discrete | Represents a series of discrete values |
PixelSensorCapabilityType
The configurable capability types of a pixel sensor
| Enumerator | Value | Description |
|---|---|---|
| UpdateRate | Data Rate Per second of the sensor. This must be specified for a sensor to be configured | |
| Resolution | The resolution of the sensor data. This must be specified for a sensor to be configured | |
| Format | 3 | The data format for the sensor. This must be specified for a sensor to be configured |
| Depth | The range of a depth sensor | |
| MixedReality | The camera frame and the digital content will be blended into a single frame | |
| ManualExposureTime | 100 | Exposure time in milliseconds. If this is not specified then AutoExposureMode and AutoExposureTargetBrightness must be specified |
| AnalogGain | Higher gain is useful in low light conditions but may introduce noise. | |
| DigitalGain | Higher gain is useful in low light conditions but may introduce noise. | |
| AutoExposureMode | 200 | Enable/disable auto exposure mode. |
| AutoExposureTargetBrightness | Set target brightness for auto exposure mode. |
PixelSensorDepthFlags
The flags associated with PixelSensorDepthFlagBuffer each pixel
| Enumerator | Value | Description |
|---|---|---|
| Valid | 1 | |
| Invalid | 2 | |
| Saturated | 4 | |
| Inconsistent | 8 | |
| LowSignal | 0x10 | |
| FlyingPixel | 0x20 | |
| MaskedBit | 0x40 | |
| Sbi | 0x80 | |
| StrayLight | 0x100 | |
| ConnectedComponents | 0x200 |
PixelSensorDepthFrameIlluminationType
The status of the depth frame projector when the frame is obtained
| Enumerator | Value | Description |
|---|---|---|
| On | Depth camera frame projector is on | |
| Off | Depth camera frame projector is off |
PixelSensorFrameFormat
| Enumerator | Value | Description |
|---|---|---|
| Grayscale | Each pixel is 1 byte and represents a grayscale value | |
| Rgba8888 | Each pixel is 4 bytes and represents R,G,B, and A channels in that order | |
| Yuv420888 | Frame is represented in the YUV_420_888 planar format | |
| Jpeg | Frame is JPEG encoded | |
| Depth32 | Represents the depth. Depth is the radial distance (in meters) of the real world location with respect to the depth camera. | |
| DepthRaw | Raw pixel data representing light captured by the sensor. |
For depth cameras that have a projector this raw frame will include frames captured both when the projector is on and off. |
Details*
The frame format capabilities of a sensor.
Note: This is not the same as PixelSensorFrameType. PixelSensorFrameFormat represents the frame capabilities supported by a sensor while PixelSensorFrameType indicates the type of frame when the sensor data is fetched
PixelSensorFrameType
| Enumerator | Value | Description |
|---|---|---|
| Grayscale | Each pixel is 1 byte and represents a grayscale value | |
| Rgba8888 | Each pixel is 4 bytes and represents R,G,B, and A channels in that order | |
| Yuv420888 | Frame is represented in the YUV_420_888 planar format | |
| Jpeg | Frame is JPEG encoded | |
| Depth32 | Represents the depth. Depth is the radial distance (in meters) of the real world location with respect to the depth camera. | |
| DepthRaw | Raw pixel data representing light captured by the sensor. |
For depth cameras that have a projector this raw frame will include frames captured both when the projector is on and off. | | DepthConfidence | | The confidence data for each pixel in the sensor frame buffer The confidence score is derived from the sensor noise and it is not normalized | | DepthFlags | | The depth sensor flags for each pixel in the sensor frame buffer. See PixelSensorDepthFlags |
Details*
The frame format types of a sensor's data.
Note: This is not the same as PixelSensorFrameFormat. PixelSensorFrameFormat represents the frame capabilities supported by a sensor while PixelSensorFrameType indicates the type of frame when the sensor data is fetched
PixelSensorMetaDataType
The metadata types that can be supported by a sensor
| Enumerator | Value | Description |
|---|---|---|
| ExposureTime | Exposure time in milliseconds used to capture the frame. | |
| AnalogGain | Analog gain used to capture the frame | |
| DigitalGain | Digital gain used to capture the frame | |
| PinholeCameraModel | Pinhole camera model | |
| FishEyeCameraModel | Fisheye camera model | |
| DepthFrameIllumination | Illumination type used for the depth frame | |
| DepthConfidenceBuffer | Confidence values for each pixel in the camera frame. The confidence score is derived from the sensor noise. It is not normalized. The higher the value the higher the confidence. |
Applications can determine what confidence threshold to use based on their use case | | DepthFlagBuffer | | Flag bits for each pixel in the depth camera frame. See PixelSensorDepthFlags |
PixelSensorStatus
The status of a sensor
| Enumerator | Value | Description |
|---|---|---|
| Undefined | Sensor has not been created | |
| NotConfigured | Sensor has been created but not configured | |
| Configuring | Sensor is being configured | |
| Configured | Sensor has been configured | |
| Starting | Starting a configured sensor | |
| Started | Sensor has been started | |
| Stopping | Stopping a sensor | |
| Stopped | Sensor has been stopped |