@openhps/opencv
    Preparing search index...

    Class ImageFrame<I, C>

    Type Parameters

    Hierarchy (View Summary)

    Index
    constructor
    createdTimestamp fourcc fps height image phenomenonTimestamp? uid width
    cols rows source
    addObject addReferenceSpace addSensor clearObjects clone getObjectByUID getObjects getSensor hasObject removeObject

    • Create a new data frame

      Type Parameters

      Parameters

      • Optionalframe: DataFrame

        Data frame to copy

      Returns ImageFrame<I, C>

    • Create a new data frame

      Type Parameters

      Parameters

      • Optionalsource: DataObject

        Source data object

      Returns ImageFrame<I, C>

    createdTimestamp: number

    Data frame created timestamp (ISO 8601)

    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)

    • get cols(): number

      Width of image

      Returns number

      Width

    • set cols(value: number): void

      Parameters

      • value: number

      Returns void

    • get rows(): number

      Height of image

      Returns number

      Height

    • set rows(value: number): 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: C): void

      Set the source object clone that captured the data frame

      Parameters

      • object: C

        Source data object

      Returns void

    • Add a new object relevant to this data frame

      Parameters

      • object: DataObject

        Relevant object

      Returns this

      instance

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

      Parameters

      • referenceSpace: ReferenceSpace

        Relevant reference space

      Returns void

      addObject Alias for addObject

    • Add a new sensor relevant to this data frame

      Parameters

      • object: SensorObject

        Relevant sensor

      Returns this

      instance

    • Clear all objects

      Parameters

      • OptionalobjectFilter: (object: DataObject) => boolean

        object filter

      Returns void

    • Clone the data frame

      Returns this

      Cloned data frame

    • 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

      • OptionaldataType: new () => T

        Data object type

      Returns T[]

      Array of found data objects

    • Get known sensor objects used in this data frame

      Type Parameters

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

      Parameters

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

        Sensor type

      • OptionaldefaultUID: 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

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods