InitParameters Class Reference

Struct containing all parameters passed to the SDK when initializing the ZED. These parameters will be fixed for the whole execution life time of the camera. More...

Functions

 InitParameters ()
 Constructor. Sets default initialization parameters. More...
 

Attributes

sl.INPUT_TYPE inputType
 
sl.RESOLUTION resolution
 Resolution the ZED will be set to. More...
 
int cameraFPS
 Requested FPS for this resolution. Setting it to 0 will choose the default FPS for this resolution. More...
 
int cameraDeviceID
 ID for identifying which of multiple connected ZEDs to use. More...
 
string pathSVO = ""
 Path to a recorded SVO file to play, including filename. More...
 
bool svoRealTimeMode
 In SVO playback, this mode simulates a live camera and consequently skipped frames if the computation framerate is too slow. More...
 
UNIT coordinateUnits
 Define a unit for all metric values (depth, point clouds, tracking, meshes, etc.). More...
 
COORDINATE_SYSTEM coordinateSystem
 This defines the order and the direction of the axis of the coordinate system. More...
 
sl.DEPTH_MODE depthMode
 Quality level of depth calculations. Higher settings improve accuracy but cost performance. More...
 
float depthMinimumDistance
 Minimum distance from the camera from which depth will be computed, in the defined coordinateUnit. More...
 
float depthMaximumDistance
 When estimating the depth, the SDK uses this upper limit to turn higher values into TOO_FAR ones. The current maximum distance that can be computed in the defined UNIT. Changing this value has no impact on performance and doesn't affect the positional tracking nor the spatial mapping. (Only the depth, point cloud, normals) More...
 
FLIP_MODE cameraImageFlip
 Defines if images are horizontally flipped. More...
 
bool enableRightSideMeasure
 Defines if measures relative to the right sensor should be computed (needed for MEASURE_XXX_RIGHT). More...
 
bool cameraDisableSelfCalib
 True to disable self-calibration and use the optional calibration parameters without optimizing them. False is recommended, so that calibration parameters can be optimized. More...
 
int sdkVerbose
 True for the SDK to provide text feedback. More...
 
int sdkGPUId
 ID of the graphics card on which the ZED's computations will be performed. More...
 
string sdkVerboseLogFile = ""
 If set to verbose, the filename of the log file into which the SDK will store its text output. More...
 
int depthStabilization
 True to stabilize the depth map. Recommended. More...
 
string optionalSettingsPath = ""
 Optional path for searching configuration (calibration) file SNxxxx.conf. (introduced in ZED SDK 2.6) More...
 
bool sensorsRequired
 True to stabilize the depth map. Recommended. More...
 
string ipStream = ""
 Path to a recorded SVO file to play, including filename. More...
 
ushort portStream = 30000
 Path to a recorded SVO file to play, including filename. More...
 
bool enableImageEnhancement = true
 Whether to enable improved color/gamma curves added in ZED SDK 3.0. More...
 
string optionalOpencvCalibrationFile
 Set an optional file path where the SDK can find a file containing the calibration information of the camera computed by OpenCV. More...
 
float openTimeoutSec
 Define a timeout in seconds after which an error is reported if the open() command fails. Set to '-1' to try to open the camera endlessly without returning error in case of failure. Set to '0' to return error in case of failure at the first attempt. This parameter only impacts the LIVE mode. More...
 

Detailed Description

Struct containing all parameters passed to the SDK when initializing the ZED. These parameters will be fixed for the whole execution life time of the camera.

For more details, see the InitParameters class in the SDK API documentation: https://www.stereolabs.com/docs/api_3.X/structsl_1_1InitParameters.html

Constructor and Destructor

◆ InitParameters()

InitParameters ( )
inline

Constructor. Sets default initialization parameters.

Variables

◆ inputType

◆ resolution

sl.RESOLUTION resolution

Resolution the ZED will be set to.

Referenced by InitParameters.InitParameters().

◆ cameraFPS

int cameraFPS

Requested FPS for this resolution. Setting it to 0 will choose the default FPS for this resolution.

◆ cameraDeviceID

int cameraDeviceID

ID for identifying which of multiple connected ZEDs to use.

Referenced by Camera.GetInitParameters().

◆ pathSVO

string pathSVO = ""

Path to a recorded SVO file to play, including filename.

◆ svoRealTimeMode

bool svoRealTimeMode

In SVO playback, this mode simulates a live camera and consequently skipped frames if the computation framerate is too slow.

◆ coordinateUnits

UNIT coordinateUnits

Define a unit for all metric values (depth, point clouds, tracking, meshes, etc.).

◆ coordinateSystem

COORDINATE_SYSTEM coordinateSystem

This defines the order and the direction of the axis of the coordinate system.

◆ depthMode

sl.DEPTH_MODE depthMode

Quality level of depth calculations. Higher settings improve accuracy but cost performance.

Referenced by InitParameters.InitParameters().

◆ depthMinimumDistance

float depthMinimumDistance

Minimum distance from the camera from which depth will be computed, in the defined coordinateUnit.

◆ depthMaximumDistance

float depthMaximumDistance

When estimating the depth, the SDK uses this upper limit to turn higher values into TOO_FAR ones. The current maximum distance that can be computed in the defined UNIT. Changing this value has no impact on performance and doesn't affect the positional tracking nor the spatial mapping. (Only the depth, point cloud, normals)

◆ cameraImageFlip

FLIP_MODE cameraImageFlip

Defines if images are horizontally flipped.

◆ enableRightSideMeasure

bool enableRightSideMeasure

Defines if measures relative to the right sensor should be computed (needed for MEASURE_XXX_RIGHT).

◆ cameraDisableSelfCalib

bool cameraDisableSelfCalib

True to disable self-calibration and use the optional calibration parameters without optimizing them. False is recommended, so that calibration parameters can be optimized.

◆ sdkVerbose

int sdkVerbose

True for the SDK to provide text feedback.

◆ sdkGPUId

int sdkGPUId

ID of the graphics card on which the ZED's computations will be performed.

◆ sdkVerboseLogFile

string sdkVerboseLogFile = ""

If set to verbose, the filename of the log file into which the SDK will store its text output.

◆ depthStabilization

int depthStabilization

True to stabilize the depth map. Recommended.

◆ optionalSettingsPath

string optionalSettingsPath = ""

Optional path for searching configuration (calibration) file SNxxxx.conf. (introduced in ZED SDK 2.6)

◆ sensorsRequired

bool sensorsRequired

True to stabilize the depth map. Recommended.

◆ ipStream

string ipStream = ""

Path to a recorded SVO file to play, including filename.

◆ portStream

ushort portStream = 30000

Path to a recorded SVO file to play, including filename.

◆ enableImageEnhancement

bool enableImageEnhancement = true

Whether to enable improved color/gamma curves added in ZED SDK 3.0.

◆ optionalOpencvCalibrationFile

string optionalOpencvCalibrationFile

Set an optional file path where the SDK can find a file containing the calibration information of the camera computed by OpenCV.

Using this will disable the factory calibration of the camera.

<warning> Erroneous calibration values can lead to poor SDK modules accuracy. </warning>

◆ openTimeoutSec

float openTimeoutSec

Define a timeout in seconds after which an error is reported if the open() command fails. Set to '-1' to try to open the camera endlessly without returning error in case of failure. Set to '0' to return error in case of failure at the first attempt. This parameter only impacts the LIVE mode.