@openhps/fingerprinting
    Preparing search index...

    Interface KNNFingerprintingOptions

    interface KNNFingerprintingOptions {
        classifier?: string;
        features?: (
            | "createdTimestamp"
            | { key: string; value: (obj: DataObject) => number }
        )[];
        frameFilter?: (frame: DataFrame) => boolean;
        k?: number;
        locked?: boolean;
        naive?: boolean;
        name?: string;
        objectFilter?: (object: DataObject, frame?: DataFrame) => boolean;
        serializeContext?: boolean;
        similarityFunction?: (point: number[], fingerprint: number[]) => number;
        uid?: string;
        valueFilter?: (pos: RelativePosition) => boolean;
        weighted?: boolean;
        weightFunction?: (distance: number) => number;
    }

    Hierarchy (View Summary)

    Index
    classifier? features? frameFilter? k? locked? naive? name? objectFilter? serializeContext? similarityFunction? uid? valueFilter? weighted? weightFunction?
    classifier?: string

    Fingerprint classifier

    ""
    features?: (
        "createdTimestamp"
        | { key: string; value: (obj: DataObject) => 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

    k?: number

    Number of neighbours to use

    locked?: boolean
    naive?: boolean

    Naive algorithm (no KD-tree)

    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.

    similarityFunction?: (point: number[], fingerprint: number[]) => number

    Similarity function (distance function)

    DistanceFunction.EUCLIDEAN
    uid?: string

    Manually set the unique identifier of the node

    valueFilter?: (pos: RelativePosition) => boolean

    Filter on relative positions

    weighted?: boolean

    Use weighted KNN

    weightFunction?: (distance: number) => number

    Weight function

    WeightFunction.DEFAULT

    Settings
    Member Visibility

    On This Page
    Properties