@openhps/core
    Preparing search index...

    Class DataFrame

    A data frame is information that is passed through each node in a positioning model.

    DataFrame content

    A data frame can be created with an optional source DataObject that represents the object responsible for generating the frame.

    const dataFrame = new DataFrame(new DataObject("phone"));

    Custom data frames can be created by extending the default DataFrame class. Important when handling data frames (and objects) is to add serializable decorators.

    import { DataFrame, SerializableObject, SerializableArrayMember } from '@openhps/core';

    @SerializableObject()
    export class CustomDataFrame extends DataFrame {
        @SerialisableArrayMember(Number)
        public customFrameAttribute: number[];
    }

    Adding data object will clone the data objects to the data frame. Any changes made to the object after cloning will not be applied to the data frame.

    Index
    constructor
    createdTimestamp phenomenonTimestamp? uid
    source
    addObject addReferenceSpace addSensor clearObjects clone getObjectByUID getObjects getSensor hasObject removeObject
    createdTimestamp: number

    Data frame created timestamp (ISO 8601)

    phenomenonTimestamp?: number

    Data frame sensor data pheonomenon timestamp (ISO 8601)

    uid: string = ...

    Data frame unique identifier

    • Get known objects used in this data frame

      Type Parameters

      Parameters

      • OptionaldataType: new () => T

        Data object type

      Returns T[]

      Array of found data objects

    Settings
    Member Visibility

    On This Page
    Usage
    Constructors
    Properties
    Accessors
    Methods