@openhps/fingerprinting
    Preparing search index...

    Interface FingerprintingNodeOptions<T>

    interface FingerprintingNodeOptions<T extends DataObject = DataObject> {
        classifier?: string;
        features?: (
            | keyof {
                [K in string
                | number
                | symbol as T[K] extends number ? K : never]: T[K]
            }
            | { key: string; value: (obj: T) => number }
        )[];
        frameFilter?: (frame: DataFrame) => boolean;
        locked?: boolean;
        name?: string;
        objectFilter?: (object: DataObject, frame?: DataFrame) => boolean;
        serializeContext?: boolean;
        uid?: string;
        valueFilter?: (pos: RelativePosition) => boolean;
    }

    Type Parameters

    • T extends DataObject = DataObject

    Hierarchy (View Summary)

    Index
    classifier? features? frameFilter? locked? name? objectFilter? serializeContext? uid? valueFilter?
    classifier?: string

    Fingerprint classifier

    ""
    features?: (
        | keyof {
            [K in string
            | number
            | symbol as T[K] extends number ? K : never]: T[K]
        }
        | { key: string; value: (obj: T) => number }
    )[]

    A list of features to include in the fingerprint Only features of type number are allowed

    frameFilter?: (frame: DataFrame) => boolean

    Frame filter to specify what frames are processed by this node

    locked?: boolean
    name?: string

    User friendly name of the node Used for querying a node by its name.

    objectFilter?: (object: DataObject, frame?: DataFrame) => boolean

    Object filter to specify what data object are processed by this node

    serializeContext?: boolean

    Serialize contextual information about fingerprint features This option uses more memory.

    uid?: string

    Manually set the unique identifier of the node

    valueFilter?: (pos: RelativePosition) => boolean

    Filter on relative positions

    Settings
    Member Visibility

    On This Page
    Properties