Perception Tool Kit (PTK) API Guide

Introduction

Collaboration diagram for Virtual Sensor Creator:

Functions

vscHandle VirtualSensorCreator_create (char databaseDir[], int seqId, char parentFolderName[], char outFolderName[], char descTxtFiles[], uint32_t dataTypechar, uint32_t overwriteExistingData)
 Constructor. More...
 
void VirtualSensorCreator_delete (vscHandle ss)
 Deletes a previously created context. More...
 
uint32_t VirtualSensorCreator_is_disabled (vscHandle ss)
 Checks to see if the virtual sensor has been disabled. More...
 
void VirtualSensorCreator_add_record (vscHandle ss, char **dstFilePath, uint64_t timestamp, void *dataPtr, size_t dataSize)
 Add record to virtual sensor (append timestamp in timestamps.txt). More...
 

Function Documentation

◆ VirtualSensorCreator_create()

vscHandle VirtualSensorCreator_create ( char  databaseDir[],
int  seqId,
char  parentFolderName[],
char  outFolderName[],
char  descTxtFiles[],
uint32_t  dataTypechar,
uint32_t  overwriteExistingData 
)

Constructor.

Parameters
[in]databaseDirbase directory of database: WARNING: Use double backslashes for paths!
[in]seqIddata seqence id for this sensor
[in]parentFolderNamesubfolder name of the sensor, e.g. "camera002" or "lidar001", from which this virtual sensor is derived. Determines virtual sensor's folder name. Extrinsic calibration and sensor processor delay info will be copied from this sensor.
[in]outFolderNamesnake-style output folder name for the virtual sensor
[in]descTxtFilesspace separated list of text files that will be appended to the virtual sensor's intrinsic calibration file (e.g., parameters used to produce virtual sensor)
[in]dataTypecharoutput data type, 0=raw (binary data) or 3=png (images)
[in]overwriteExistingDataerase existing data in destination folder, if destination folder already exists (1=yes, 0=no)?
Returns
A handle to the virctaul sensor context.

◆ VirtualSensorCreator_delete()

void VirtualSensorCreator_delete ( vscHandle  ss)

Deletes a previously created context.

Parameters
[in]sspointer to Virtual Sensor context.

◆ VirtualSensorCreator_is_disabled()

uint32_t VirtualSensorCreator_is_disabled ( vscHandle  ss)

Checks to see if the virtual sensor has been disabled.

Parameters
[in]ssHandle to the virtual sensor context.
Returns
  • 1 if disabled
  • 0, otherwise

◆ VirtualSensorCreator_add_record()

void VirtualSensorCreator_add_record ( vscHandle  ss,
char **  dstFilePath,
uint64_t  timestamp,
void *  dataPtr,
size_t  dataSize 
)

Add record to virtual sensor (append timestamp in timestamps.txt).

Depending on data type being "raw" or "png", the method behaves differently.

For raw data: Data pointed by dataPtr is written to bin file and path to bin file is returned.

For image data: Does not write the data file, just returns the path for image to be written to. !!! Application is expected to write its image data to that file !!!

Parameters
[in]ssHandle to the virtual sensor context
[out]dstFilePathpath to file written (BIN data) or to be written by user (PNG data)
[in]timestamptimestamp for the recorded to be written
[in]dataPtrpointer to data to be written (only BIN data), otherwise NULL
[in]dataSizesize of data to be written (only BIN data), otherwise 0