Class DepthImageFrame<D, I, C>

Type Parameters

Hierarchy

Constructors

Properties

createdTimestamp: number

Data frame created timestamp (ISO 8601)

depth: D
depthUnit: LengthUnit
fourcc: number
fps: number
height: number

Height (rows)

image: I
phenomenonTimestamp?: number

Data frame sensor data pheonomenon timestamp (ISO 8601)

uid: string

Data frame unique identifier

width: number

Width (cols)

Accessors

  • get cols(): number
  • Width of image

    Returns number

    Width

  • set cols(value): void
  • Parameters

    • value: number

    Returns void

  • get rows(): number
  • Height of image

    Returns number

    Height

  • set rows(value): void
  • Parameters

    • value: number

    Returns void

  • get source(): C
  • Source object clone that captured the data frame

    Returns C

    Source data object

  • set source(object): void
  • Set the source object clone that captured the data frame

    Parameters

    • object: C

      Source data object

    Returns void

Methods

  • Add a new object relevant to this data frame

    Parameters

    • object: DataObject

      Relevant object

    Returns DepthImageFrame<D, I, C>

    instance

  • Add a new reference space relevant to this data frame.

    Parameters

    • referenceSpace: ReferenceSpace

      Relevant reference space

    Returns void

    Alias

    addObject Alias for addObject

  • Add a new sensor relevant to this data frame

    Parameters

    • object: SensorObject<Object | SensorValue<Unit> | Orientation>

      Relevant sensor

    Returns DepthImageFrame<D, I, C>

    instance

  • Clear all objects

    Parameters

    • Optional objectFilter: ((object) => boolean)

      object filter

        • (object): boolean
        • Parameters

          • object: DataObject

          Returns boolean

    Returns void

  • Get a specific object by its identifier

    Type Parameters

    • T extends DataObject

    Parameters

    • uid: string

      Object UID

    Returns T

    Data object if found

  • Get known objects used in this data frame

    Type Parameters

    • T extends DataObject

    Parameters

    • Optional dataType: (new () => T)

      Data object type

        • new (): T
        • Returns T

    Returns T[]

    Array of found data objects

  • Get known sensor objects used in this data frame

    Type Parameters

    • T extends SensorObject<Object | SensorValue<Unit> | Orientation>

    Parameters

    • type: (new (uid?) => T)

      Sensor type

        • new (uid?): T
        • Parameters

          • Optional uid: string

          Returns T

    • Optional defaultUID: string

      Default UID. When sensor is not added, it will be created

    Returns T

    Found data objects

  • Check if the data frame has an object

    Parameters

    • object: DataObject

      Data object to find

    Returns boolean

    Object exist

  • Remove an object from the data frame

    Parameters

    • object: string | DataObject

      Object to remove

    Returns void