Interface FingerprintingNodeOptions<T>

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

Type Parameters

  • T extends DataObject = DataObject

Hierarchy (view full)

Properties

classifier? features? frameFilter? locked? name? objectFilter? serializeContext? uid? valueFilter?

Properties

Optional classifier

classifier?: string

Fingerprint classifier

Default

""

Optional features

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

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

Optional frameFilter

frameFilter?: ((frame) => boolean)

Frame filter to specify what frames are processed by this node

Type declaration

    • (frame): boolean

    • Parameters

      • frame: DataFrame

      Returns boolean

Optional locked

locked?: boolean

Optional name

name?: string

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

Optional objectFilter

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

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

Type declaration

    • (object, frame?): boolean

    • Parameters

      • object: DataObject
      • Optional frame: DataFrame

      Returns boolean

Optional serializeContext

serializeContext?: boolean

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

Optional uid

uid?: string

Manually set the unique identifier of the node

Optional valueFilter

valueFilter?: ((pos) => boolean)

Filter on relative positions

Type declaration

    • (pos): boolean

    • Parameters

      • pos: RelativePosition<number, Unit>

      Returns boolean

Settings

Member Visibility

Theme

On This Page

classifierfeaturesframeFilterlockednameobjectFilterserializeContextuidvalueFilter