Class VSLAMKeyFrame

Hierarchy (View Summary)

VSLAMFrame
- VSLAMKeyFrame

Index

Constructors

constructor

new VSLAMKeyFrame(frame?: DataFrame): VSLAMKeyFrame
Create a new data frame
Parameters
- Optionalframe: DataFrame
  Data frame to copy
Returns VSLAMKeyFrame
Inherited from VSLAMFrame.constructor
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:54
new VSLAMKeyFrame(source?: DataObject): VSLAMKeyFrame
Create a new data frame
Parameters
- Optionalsource: DataObject
  Source data object
Returns VSLAMKeyFrame
Inherited from VSLAMFrame.constructor
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:59

Properties

createdTimestamp

createdTimestamp: number

Data frame created timestamp (ISO 8601)

fourcc

fourcc: number

fps

fps: number

height

height: number

Height (rows)

image

image: any

`Optional`phenomenonTimestamp

phenomenonTimestamp?: number

Data frame sensor data pheonomenon timestamp (ISO 8601)

systemUID

systemUID: string

uid

uid: string

Data frame unique identifier

width

width: number

Width (cols)

willBeErased

willBeErased: boolean = false

Accessors

cameraPose

get cameraPose(): Matrix4
Get the camera pose at the time of the frame

Returns Matrix4
Camera pose as a matrix with translation and rotation
Inherited from VSLAMFrame.cameraPose
- Defined in src/data/VSLAMFrame.ts:20
set cameraPose(pose: Matrix4): void
Set the camera at the time of the frame
Parameters
- pose: Matrix4
  Camera pose
Returns void
Inherited from VSLAMFrame.cameraPose
- Defined in src/data/VSLAMFrame.ts:36

cols

get cols(): number
Width of image

Returns number
Width
Inherited from VSLAMFrame.cols
- Defined in node_modules/@openhps/video/dist/types/ImageFrame.d.ts:25
set cols(value: number): void
Parameters
- value: number
Returns void
Inherited from VSLAMFrame.cols
- Defined in node_modules/@openhps/video/dist/types/ImageFrame.d.ts:26

landmarks

get landmarks(): VSLAMLandmark[]
Get frame landmarks

Returns VSLAMLandmark[]
Array of landmarks found in this frame
- Defined in src/data/VSLAMKeyFrame.ts:32
set landmarks(values: VSLAMLandmark[]): void
Set frame landmarks
Parameters
- values: VSLAMLandmark[]
  Array of landmarks
Returns void
- Defined in src/data/VSLAMKeyFrame.ts:40

rows

get rows(): number
Height of image

Returns number
Height
Inherited from VSLAMFrame.rows
- Defined in node_modules/@openhps/video/dist/types/ImageFrame.d.ts:19
set rows(value: number): void
Parameters
- value: number
Returns void
Inherited from VSLAMFrame.rows
- Defined in node_modules/@openhps/video/dist/types/ImageFrame.d.ts:20

source

get source(): C
Source object clone that captured the data frame

Returns C
Source data object
Inherited from VSLAMFrame.source
- Defined in node_modules/@openhps/video/dist/types/ImageFrame.d.ts:31
set source(object: C): void
Set the source object clone that captured the data frame
Parameters
- object: C
  Source data object
Returns void
Inherited from VSLAMFrame.source
- Defined in node_modules/@openhps/video/dist/types/ImageFrame.d.ts:36

Methods

addLandmark

addLandmark(landmark: VSLAMLandmark): void
Add a landmark to the frame
Parameters
- landmark: VSLAMLandmark
  Landmark to add
Returns void
- Defined in src/data/VSLAMKeyFrame.ts:48

addObject

addObject(object: DataObject): this
Add a new object relevant to this data frame
Parameters
- object: DataObject
  Relevant object
Returns this
instance
Inherited from VSLAMFrame.addObject
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:100

addReferenceSpace

addReferenceSpace(referenceSpace: ReferenceSpace): void
Add a new reference space relevant to this data frame.
Parameters
- referenceSpace: ReferenceSpace
  Relevant reference space
Returns void

Alias
addObject Alias for addObject
Inherited from VSLAMFrame.addReferenceSpace
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:112

addSensor

addSensor(object: SensorObject): this
Add a new sensor relevant to this data frame
Parameters
- object: SensorObject
  Relevant sensor
Returns this
instance
Inherited from VSLAMFrame.addSensor
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:106

clearObjects

clearObjects(objectFilter?: (object: DataObject) => boolean): void
Clear all objects
Parameters
- OptionalobjectFilter: (object: DataObject) => boolean
  object filter
Returns void
Inherited from VSLAMFrame.clearObjects
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:122

clone

clone(): this
Clone the data frame

Returns this
Cloned data frame
Inherited from VSLAMFrame.clone
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:127

getObjectByUID

getObjectByUID<T extends DataObject>(uid: string): T
Get a specific object by its identifier
Type Parameters
- T extends DataObject
Parameters
- uid: string
  Object UID
Returns T
Data object if found
Inherited from VSLAMFrame.getObjectByUID
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:88

getObjects

getObjects<T extends DataObject>(dataType?: new () => T): T[]
Get known objects used in this data frame
Type Parameters
- T extends DataObject
Parameters
- OptionaldataType: new () => T
  Data object type
Returns T[]
Array of found data objects
Inherited from VSLAMFrame.getObjects
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:82

getSensor

getSensor<T extends SensorObject<Object | Orientation | SensorValue<Unit>>>(
type: new (uid?: string) => T,
defaultUID?: string,
): T
Get known sensor objects used in this data frame
Type Parameters
- T extends SensorObject<Object | Orientation | SensorValue<Unit>>
Parameters
- type: new (uid?: string) => T
  Sensor type
- OptionaldefaultUID: string
  Default UID. When sensor is not added, it will be created
Returns T
Found data objects
Inherited from VSLAMFrame.getSensor
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:76

hasObject

hasObject(object: DataObject): boolean
Check if the data frame has an object
Parameters
- object: DataObject
  Data object to find
Returns boolean
Object exist
Inherited from VSLAMFrame.hasObject
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:94

removeObject

removeObject(object: string | DataObject): void
Remove an object from the data frame
Parameters
- object: string | DataObject
  Object to remove
Returns void
Inherited from VSLAMFrame.removeObject
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:117

`Static`fromNative

fromNative(keyframe: KeyFrame): VSLAMKeyFrame
Create a VSLAM keyframe from native object
Parameters
- keyframe: KeyFrame
  Native object
Returns VSLAMKeyFrame
VSLAM keyframe instance
- Defined in src/data/VSLAMKeyFrame.ts:15

Class VSLAMKeyFrame

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns VSLAMKeyFrame

Parameters

Returns VSLAMKeyFrame

Properties

createdTimestamp

fourcc

fps

height

image

OptionalphenomenonTimestamp

systemUID

uid

width

willBeErased

Accessors

cameraPose

Returns Matrix4

Parameters

Returns void

cols

Returns number

Parameters

Returns void

landmarks

Returns VSLAMLandmark[]

Parameters

Returns void

rows

Returns number

Parameters

Returns void

source

Returns C

Parameters

Returns void

Methods

addLandmark

Parameters

Returns void

addObject

Parameters

Returns this

addReferenceSpace

Parameters

Returns void

Alias

addSensor

Parameters

Returns this

clearObjects

Parameters

Returns void

clone

Returns this

getObjectByUID

Type Parameters

Parameters

Returns T

getObjects

Type Parameters

Parameters

Returns T[]

getSensor

Type Parameters

Parameters

Returns T

hasObject

Parameters

Returns boolean

removeObject

`Optional`phenomenonTimestamp

`Static`fromNative