Class Fingerprint

Hierarchy

DataObject
- Fingerprint

Index

Constructors

constructor

new Fingerprint(displayName?: string): Fingerprint
Parameters
- Optional displayName: string
Returns Fingerprint
Overrides DataObject.constructor
- Defined in src/data/Fingerprint.ts:15

Properties

classifier

classifier: string

createdTimestamp

createdTimestamp: number

Created timestamp

displayName

displayName: string

Object display name

features

features: Map<string, FingerprintFeature> = ...

parentUID

parentUID: string

processed

processed: boolean

uid

uid: string

Object identifier

Returns

Unique object identifier

vector

vector: number[]

Accessors

position

get position(): AbsolutePosition
Get the current absolute position of the object relative to the global reference space

Returns
Absolute position of data object

Returns AbsolutePosition
Inherited from DataObject.position
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:59
set position(position: AbsolutePosition): void
Set the current absolute position of the object relative to the global reference space
Parameters
- position: AbsolutePosition
Returns void
Inherited from DataObject.position
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:64

relativePositions

get relativePositions(): RelativePosition<any, Unit>[]
Get relative positions

Returns
Array of relative positions

Returns RelativePosition<any, Unit>[]
Inherited from DataObject.relativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:92
set relativePositions(relativePostions: RelativePosition<any, Unit>[]): void
Parameters
- relativePostions: RelativePosition<any, Unit>[]
Returns void
Inherited from DataObject.relativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:93

source

set source(obj: DataObject): void
Set the fingerprint source. This can be used to identify the user or device that captured the data.
Parameters
- obj: DataObject
  
  Fingerprint source
Returns void
- Defined in src/data/Fingerprint.ts:49

Methods

addFeature

addFeature(key: string, value: number): Fingerprint
Add a feature to the fingerprint

Returns
instance
Parameters
- key: string
  
  Feature key
- value: number
  
  Feature value
Returns Fingerprint
- Defined in src/data/Fingerprint.ts:36

addRelativePosition

addRelativePosition(relativePosition: RelativePosition<any, Unit>): Fingerprint
Add a relative position to this data object

Returns
Data object instance
Parameters
- relativePosition: RelativePosition<any, Unit>
  
  Relative position to add
Returns Fingerprint
Inherited from DataObject.addRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:108

bind

bind(service: DataService<string, Fingerprint>): DataObjectBinding<Fingerprint>
Bind the data object to a service

Returns
Data object binding with a service
Parameters
- service: DataService<string, Fingerprint>
  
  Service to bind it to
Returns DataObjectBinding<Fingerprint>
Inherited from DataObject.bind
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:131

clone

clone(): Fingerprint
Clone the data object

Returns
Cloned data object

Returns Fingerprint
Inherited from DataObject.clone
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:137

computeVector

computeVector(aggFn: ((values: number[], key?: string) => number)): void
Compute the relative position vector from the relative positions
Parameters
- aggFn: ((values: number[], key?: string) => number)
  
  Aggregation function
  - - (values: number[], key?: string): number
    - Parameters
      
      values: number[]
      
      Optional key: string
      
      Returns number
Returns void
- Defined in src/data/Fingerprint.ts:58

getPosition

getPosition(referenceSpace?: TransformationSpace): AbsolutePosition
Get the current absolute position of the object

Returns
Position of the data object
Parameters
- Optional referenceSpace: TransformationSpace
  
  Reference space to transform it to
Returns AbsolutePosition
Inherited from DataObject.getPosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:71

getRelativePosition

getRelativePosition(referenceObjectUID: string, type?: string): RelativePosition<any, Unit>
Get relative position of a specified object

Returns
Relative position to reference object
Parameters
- referenceObjectUID: string
  
  Reference object identifier
- Optional type: string
  
  Constructor type of the relative position
Returns RelativePosition<any, Unit>
Inherited from DataObject.getRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:123

getRelativePositions

getRelativePositions(referenceObjectUID?: string): RelativePosition<any, Unit>[]
Get relative positions for a different target

Returns
Array of relative positions for the reference object
Parameters
- Optional referenceObjectUID: string
  
  Reference object identifier
Returns RelativePosition<any, Unit>[]
Inherited from DataObject.getRelativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:115

hasFeature

hasFeature(key: string): boolean
Check if a fingerprint has a feature

Returns
Existance of feature
Parameters
- key: string
  
  Feature key
Returns boolean
- Defined in src/data/Fingerprint.ts:25

hasRelativePosition

hasRelativePosition(referenceObjectUID: string): boolean
Parameters
- referenceObjectUID: string
Returns boolean
Inherited from DataObject.hasRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:124

removeRelativePositions

removeRelativePositions(referenceObjectUID: string): void
Parameters
- referenceObjectUID: string
Returns void
Inherited from DataObject.removeRelativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:101

setParent

setParent(object: string | DataObject): Fingerprint
Set a parent object to the data object

Returns
instance
Parameters
- object: string | DataObject
  
  Data object or UID to add as parent
Returns Fingerprint
Inherited from DataObject.setParent
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:100

setPosition

setPosition(position: AbsolutePosition, referenceSpace?: TransformationSpace): Fingerprint
Set the current absolute position of the object

Returns
Data object instance
Parameters
- position: AbsolutePosition
  
  Position to set
- Optional referenceSpace: TransformationSpace
  
  Reference space
Returns Fingerprint
Inherited from DataObject.setPosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:79

setUID

setUID(uid: string): Fingerprint
Set the unique identifier of this object

Returns
Data object instance
Parameters
- uid: string
  
  Unique Identifier
Returns Fingerprint
Inherited from DataObject.setUID
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:86

Class Fingerprint

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional displayName: string

Returns Fingerprint

Properties

classifier

createdTimestamp

displayName

features

parentUID

processed

uid

Returns

vector

Accessors

position

Returns

Returns AbsolutePosition

Parameters

position: AbsolutePosition

Returns void

relativePositions

Returns

Returns RelativePosition<any, Unit>[]

Parameters

relativePostions: RelativePosition<any, Unit>[]

Returns void

source

Parameters

obj: DataObject

Returns void

Methods

addFeature

Returns

Parameters

key: string

value: number

Returns Fingerprint

addRelativePosition

Returns

Parameters

relativePosition: RelativePosition<any, Unit>

Returns Fingerprint

bind

Returns

Parameters

service: DataService<string, Fingerprint>

Returns DataObjectBinding<Fingerprint>

clone

Returns

Returns Fingerprint

computeVector

Parameters

aggFn: ((values: number[], key?: string) => number)

Parameters

values: number[]

Optional key: string

Returns number

Returns void

getPosition

Returns

Parameters

Optional referenceSpace: TransformationSpace

Returns AbsolutePosition

getRelativePosition

Returns

Parameters

referenceObjectUID: string

Optional type: string

Returns RelativePosition<any, Unit>

getRelativePositions

Returns

`Optional` displayName: string

`Optional` key: string

`Optional` referenceSpace: TransformationSpace

`Optional` type: string

`Optional` referenceObjectUID: string

`Optional` referenceSpace: TransformationSpace