Interface KNNFingerprintingOptions

Hierarchy

Properties

classifier? frameFilter? k? locked? naive? name? objectFilter? serializeContext? similarityFunction? uid? valueFilter? weightFunction? weighted?

Properties

Optional classifier

classifier?: string

Fingerprint classifier

Default

""

Optional frameFilter

frameFilter?: ((frame: DataFrame) => boolean)

Type declaration

    • (frame: DataFrame): boolean

    • Frame filter to specify what frames are processed by this node

      Parameters

      • frame: DataFrame

      Returns boolean

Optional k

k?: number

Number of neighbours to use

Optional locked

locked?: boolean

Optional naive

naive?: boolean

Naive algorithm (no KD-tree)

Optional name

name?: string

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

Optional objectFilter

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

Type declaration

    • (object: DataObject, frame?: DataFrame): boolean

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

      Parameters

      • object: DataObject
      • Optional frame: DataFrame

      Returns boolean

Optional serializeContext

serializeContext?: boolean

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

Optional similarityFunction

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

Type declaration

    • (point: number[], fingerprint: number[]): number

    • Similarity function (distance function)

      Default

      DistanceFunction.EUCLIDEAN

      Parameters

      • point: number[]
      • fingerprint: number[]

      Returns number

Optional uid

uid?: string

Manually set the unique identifier of the node

Optional valueFilter

valueFilter?: ((pos: RelativePosition<number, Unit>) => boolean)

Type declaration

    • (pos: RelativePosition<number, Unit>): boolean

    • Filter on relative positions

      Parameters

      • pos: RelativePosition<number, Unit>

      Returns boolean

Optional weightFunction

weightFunction?: ((distance: number) => number)

Type declaration

    • (distance: number): number

    • Weight function

      Default

      WeightFunction.DEFAULT

      Parameters

      • distance: number

      Returns number

Optional weighted

weighted?: boolean

Use weighted KNN

Settings

Member Visibility

Theme