InitSensorsParameters Class Reference

Structure containing a set of parameters for the Sensors module initialization. More...

Functions

def __init__ (self, coordinate_units=UNIT.MILLIMETER, coordinate_system=COORDINATE_SYSTEM.IMAGE, output_performance_metrics=False, verbose=0, sdk_gpu_id=-1, maximum_working_resolution=Resolution(0, 0), execution_mode=SENSORS_EXECUTION_MODE.EAGER, sync_policy=SENSORS_SYNC_POLICY.NONE, sync_tolerance=None)
 Default constructor. More...
 
UNIT coordinate_units (self)
 Unit to be used for all metric values of the SDK.
 
COORDINATE_SYSTEM coordinate_system (self)
 Coordinate system used by the Sensors to return its measures.
 
bool output_performance_metrics (self)
 Extract some stats of the Fusion API like drop frame of each camera, latency, etc...
 
int verbose (self)
 Enable the verbosity mode of the SDK.
 
int sdk_gpu_id (self)
 NVIDIA graphics card to use.
 
SENSORS_EXECUTION_MODE execution_mode (self)
 Execution mode for the Sensors pipeline (EAGER or PIPELINED). More...
 
SENSORS_SYNC_POLICY sync_policy (self)
 Sync policy for temporal alignment across devices in pipelined mode.
 
Timestamp sync_tolerance (self)
 Maximum timestamp difference (nanoseconds) for temporal sync. More...
 

Detailed Description

Structure containing a set of parameters for the Sensors module initialization.

Constructor and Destructor

◆ __init__()

def __init__ (   self,
  coordinate_units = UNIT.MILLIMETER,
  coordinate_system = COORDINATE_SYSTEM.IMAGE,
  output_performance_metrics = False,
  verbose = 0,
  sdk_gpu_id = -1,
  maximum_working_resolution = Resolution(0,0),
  execution_mode = SENSORS_EXECUTION_MODE.EAGER,
  sync_policy = SENSORS_SYNC_POLICY.NONE,
  sync_tolerance = None 
)

Default constructor.

Parameters
coordinate_units: Chosen coordinate_units
coordinate_system: Chosen coordinate_system
output_performance_metrics: Activates output_performance_metrics
verbose: Sets verbose
sdk_gpu_id: Chosen sdk_gpu_id
maximum_working_resolution: Sets maximum_working_resolution
execution_mode: Execution mode (EAGER or PIPELINED).
sync_policy: Sync policy for temporal alignment across devices.
sync_tolerance: Maximum timestamp difference for sync (in nanoseconds as a Timestamp).

Functions

◆ execution_mode()

SENSORS_EXECUTION_MODE execution_mode (   self)

Execution mode for the Sensors pipeline (EAGER or PIPELINED).

In PIPELINED mode, after a one-frame setup phase, worker threads run autonomously.

◆ sync_tolerance()

Timestamp sync_tolerance (   self)

Maximum timestamp difference (nanoseconds) for temporal sync.

Only effective when sync_policy is not NONE.