Getting Started
Software
Hardware
Guides
About
AddPatternBufferView
Parameters
(Filter)
Name
AdjustExposureAndGain
Parameters
(AdjustExposure)
(AdjustGain)
(Apply)
Brightness
(Cameras)
(Exposure)
(Gain)
(MaxFlashTime)
Result
Exposure
Gain
Break
Calibrate
Parameters
Cameras
PatternCount
StereoCalibrationOnly
Threads
Result
Progress
MonocularCalibration
StereoCalibration
CalibrateHandEye
Parameters
Angles
0
0
1
…
1
0
1
…
…
CameraPose
Cameras
Fixed
Link
Rotation
Translation
PatternPose
Rotation
Translation
Scaling
Iterations
Links
0
1
…
MeasureCalibration
PatternPose
Scaling
Setup
Target
Threads
Tolerance
Transformations
0
1
…
Result
Angles
Iterations
Link
PatternPose
PoseError
Poses
Progress
Iterations
Residual
Residual
Scaling
CalibrateWorkspace
Parameters
(AlignAxis)
(Cameras)
(DefinedPose)
(Offset)
(PatternPose)
(Plane)
(Rotation)
(Target)
(Type)
Result
Capture
Parameters
(Cameras)
(ClearImageBufferOnTrigger)
(FinalTrigger)
(ImageSet)
(InitialTrigger)
(Timeout)
(WaitFor)
(WaitForProjector)
Result
<SerialNumber>
(CaptureEvents)
0
Message
Symbol
Timestamp
FinalTrigger
InitialTrigger
(PacketsResent)
Retrieved
ChainTransformations
Parameters
Transformations
(0)
Result
Transformation
ClearImageBuffer
Parameters
(Cameras)
ClearOverlay
Parameters
(Cameras)
(ShowRectifiedArea)
Close
Parameters
(Cameras)
(Threads)
(Unsafe)
CollectPattern
Parameters
(Blur)
(Buffer)
(Cameras)
(DecodeData)
(Direction)
0
1
(Downsample)
(DrawAxes)
(Filter)
(MarkOnly)
(Projector)
(Refinement)
(ReturnAllPattern)
(ShowObjectPoints)
(Threads)
(UpdateGlobalPatternData)
Result
GlobalPatternDataUpdated
Patterns
(Stereo)
0
(GridSize)
0
1
(GridSpacing)
Left
Brightness
Contrast
Transformation
(Offset)
0
1
Right
Brightness
Contrast
Transformation
(Thickness)
(Type)
ComputeDisparityMap
Parameters
(Cameras)
(CUDA)
(Device)
(Enabled)
(UseFloat16)
(Threads)
(Timeout)
ComputeImageContrast
Parameters
(Cameras)
(Region)
(Left)
(0)
(Right)
(0)
(Threads)
(UseBufferedPatterns)
Result
<SerialNumber>
Contrast
Left
0
Right
0
ComputeNormals
Parameters
(Cameras)
(CUDA)
(Device)
(Enabled)
(UseFloat16)
(PointMap)
(Radius)
(Threads)
Result
(Normals)
ComputePointMap
Parameters
(BoundingBox)
(Link)
(Target)
Size
0
1
2
(Cameras)
(CUDA)
(Device)
(Enabled)
(UseFloat16)
(Threads)
ComputeTexture
Parameters
(Cameras)
(CUDA)
(Device)
(Enabled)
(UseFloat16)
(Left)
(Right)
(Texture)
(Threads)
ConfigureIp
Parameters
Configuration
(0)
(Blind)
(IpConfiguration)
(Address)
(Gateway)
(Method)
(PrefixLength)
(MAC)
SerialNumber
ConvertTransformation
Parameters
(Extrinsic)
(MinimalAngles)
(SplitRotation)
Transformation
Result
Transformation
(Transformations)
0
CreateCamera
Parameters (Virtual Mono Camera)
Aperture
CalibrationFile
FocusDistance
Lens
ModelName
NoiseLevel
Sensor
SerialNumber
Vignetting
Parameters (Virtual Stereo Camera)
Aperture
Baseline
CalibrationFile
FocusDistance
HalfVergence
Lens
ModelName
NoiseLevel
PatternType
ProjectorPower
Sensor
SerialNumber
Vignetting
CreateFileCamera
Parameters
Path
SerialNumber
Result
Cameras
0
SerialNumber
DeleteCamera
Parameters
Cameras
DiscardPatterns
Parameters
(Cameras)
DistributeBandwidth
Parameters
(Cameras)
(ReserveFactor)
DownloadImages
Parameters
(Cameras)
(Timeout)
EstimateCaptureTimeout
Parameters
(Cameras)
Result
Timeout
EstimateDisparitySettings
Parameters
(Cameras)
(Threads)
Result
<SerialNumber>
MinimumDisparity
NumberOfDisparities
EstimatePatternPose
Parameters
(Average)
(DrawAxes)
(EstimateGridSpacing)
(Filter)
(Pose)
(Recalibrate)
(Relative)
(ReprojectionErrorScale)
(Threads)
(Type)
Result
Patterns
0
(EpipolarError)
(GridSize)
0
1
(GridSpacing)
(Left)
ReprojectionError
PatternPose
(PoseError)
(RayDistanceError)
ReferenceDiagonal
ReprojectionError
(Right)
ReprojectionError
(TriangulationError)
(Type)
FilterPatternBuffer
Parameters
(Filter)
FitPrimitive
Primitive Search Parameters
Parameters
BoundingBox
Cameras
FailureProbability
InlierFraction
InlierThreshold
Iterations
Normal
Radius
Primitive
0 (Plane example)
Type
1 (Sphere example)
Count
Radius
Max
Min
Type
2 (Cylinder example)
Radius
Max
Min
Type
…
Scaling
Threads
Result
Primitive
0
Index
1
2
…
Flash
Parameters
(Cameras)
(FrontLight)
(Glow)
(Projector)
GenerateCalibrationPattern
Parameters
Filename
ImageSize
Patterns
0
Encoding
GridSpacing
Offset
0
1
Text
Thickness
…
Result
Patterns
0
…
GetModelInfo
Parameters
(Cameras)
(Disparity)
(0)
(Distance)
(0)
(MinimumDisparity)
(ModelName)
(NumberOfDisparities)
(WorldCoordinates)
Result
(Blur)
0
CompleteModelName
Disparity
0
DisparityAccuracy
Distance
0
FocalLength
(FocusDistance)
LeftBottom
0
0
1
2
LeftTop
0
0
1
2
(Pattern)
GridSize
0
1
GridSpacing
OuterSize
Thickness
PixelPitch
PixelSize
0
RightBottom
0
0
1
2
RightTop
0
0
1
2
Vergence
GetPatternBuffer
Parameters
(Filter)
Result
Patterns
GetPresets
Parameters
(Condition)
(Data)
(FolderPath)
(0)
(IgnoreInstalled)
(Name)
(Tags)
(0)
Result
ExcludedPresets
0
Filter
Message
Name
Presets
0
Condition
Data
DataMatches
Description
Extends
0
Name
Tags
0
GetRawCalibrationData
Parameters
(Cameras)
Result
Calibration
GetSensorTags
Parameters
Cameras
Result
Left
Right
InternalPwm
Parameters
Cameras
(DutyCycle)
(Frequency)
(Output)
(LED)
(Left)
Result
<SerialNumber>
DutyCycle
Frequency
LoadCalibration
Parameters
Calibration
Cameras
Factory
GenerateEmptyCalibration
Result
EepromFormat
LoadImage
Parameters
Filename
(ForceGrayscale)
(Node)
Result
Images
LoadParameters
Parameters
(Apply)
(Cameras)
(Check)
(Version)
(Nodes)
(Calibration)
(Link)
(Parameters)
Source
(Data)
(Device)
(Filename)
(Node)
Result
Data
Description
Protection
(Timestamp)
LoadUEyeParameterSet
Parameters
(Cameras)
Filename
MeasureCalibration
Parameters
(Direction)
(Filter)
(Index)
(ReprojectionErrorScale)
Result
PatternPose
Patterns
0
PatternPose
ReprojectionError
ReprojectionError
NavigateView
Parameters
(Function)
(Move)
(PivotPoint)
(Position)
0
1
2
(Screen)
(0)
(1)
(Steps)
(0)
(1)
(2)
(Rotate)
(Anchor)
(Screen)
(0)
(1)
(Snap)
(Steps)
(0)
(1)
(2)
(UpVector)
(Zoom)
View
PivotPoint
(Distance)
Pose
(UpVector)
Result
View
PivotPoint
Distance
Position
0
1
2
Pose
UpVector
Open
Parameters
(BandwidthLimit)
(Automatic)
(ReserveFactor)
Cameras
(FirmwareUpload)
(Camera)
(Projector)
(LoadCalibration)
(Threads)
(WiringTest)
PartFinder
Parameters
Angle
AngularResolution
BoundingBox
Camera
Cameras
Cluster
Count
MaximumClusterSize
Overlap
CombinedScore
ComplementViewpoints
CompressModel
CoverageDistanceThreshold
CoverageScore
CropRegions
CUDA
Device
Enabled
Distance
ExcludeObjects
Function
Model
ModelId
ModelPath
Objects
RefineCombined
Iterations
RelativeModelSamplingDistance
ScoreRegions
Subsampling
Supplementary
Symmetries
Target
TexturePenalty
Threads
ViewPoints
Result
Camera
Distance
Far
GenerateModel
Hypothesis
Count
ModelId
Models
0
Angle
AngularResolution
ComplementViewpoints
Distance
Filename
ModelId
RelativeModelSamplingDistance
Subsampling
TemplateCount
ViewPoints
…
Near
Objects
0
Coverage
Score
Texture
ViewPointIndex
…
PointMap
Supplementary
Texture
PatternBufferInfo
Parameters
(Filter)
Result
Count
PrepareSynchronizedTrigger
Parameters
(Cameras)
(Mode)
(Timeout)
ProjectPattern
Parameters
(Cameras)
(GridSize)
(0)
(1)
(GridSpacing)
(Link)
(Target)
PatternPose
(Reference)
(Rectified)
(Threads)
Result
Corners
Pattern
GridSize
0
1
GridSpacing
(Type)
Points
Left
0
0
1
Right
0
0
1
Stereo
Pattern
GridSize
0
1
GridSpacing
(Type)
Points
Left
0
0
1
Right
0
0
1
Visible
ProjectPoints
Parameters
(Cameras)
Points
(0)
0
1
2
(Pose)
(Reference)
(Rectified)
Result
Points
Left
0
0
1
Right
0
0
1
Recalibrate
Parameters
(Cameras)
(Filter)
(Threads)
Result
<SerialNumber>
Epipolar
OpticalAxis
Patterns
Vergence
RectifyImages
Parameters
(Cameras)
(CUDA)
(Device)
(Enabled)
(UseFloat16)
(Raw)
(RawTexture)
(Threads)
ReducePatternBuffer
Parameters
Count
(Mode)
Result
Reduced
RemovePatternBufferView
Parameters
Name
RenderPointMap
Parameters
(BoundingBox)
(Link)
(Target)
Size
0
1
2
(Camera)
(Cameras)
(Far)
(FillXYCoordinates)
(Near)
(PixelSize)
(Scaling)
(Size)
0
1
(Texture)
(Threads)
(UseOpenGL)
(ViewPose)
(ZBufferOnly)
Result
Images
RenderPointMap
RenderPointMapTexture
RenderView
Parameters
(BoundingBox)
(Mode)
(Visible)
(Camera)
(Cameras)
(Far)
(Grid)
(Enabled)
(Normal)
(Near)
(Objects)
(Origin)
(Enabled)
(Position)
0
1
2
(PivotPoint)
(Center)
0
1
2
(Scaling)
(PointCloud)
(BillboardSize)
(ColoringMode)
(ColorMap)
(ColorOffset)
(ColorProportion)
(ColorRepetitionDistance)
(Downsample)
(OverlayColorWithMonoTexture)
(PointSize)
(RenderingMode)
(Primitive)
(0)
(ShowCameras)
(ShowFieldOfView)
(ShowNormals)
(ShowSurface)
(ShowUserDefinedModels)
(Size)
(0)
(1)
(Style)
(Axes)
(X)
(Color)
0
1
2
(Y)
(Color)
0
1
2
(Z)
(Color)
0
1
2
(Background)
(Color)
0
1
2
(Gradient)
(Range)
(BoundingBox)
(Color)
0
1
2
(Lines)
(Width)
(Frustum)
(Monocular)
(Color)
0
1
2
(Lines)
(Width)
(Stereo)
(Color)
0
1
2
(Lines)
(Width)
(Grid)
(Color)
0
1
2
(Lines)
(Width)
(Origin)
(Lines)
(Width)
(PivotPoint)
(Lines)
(Width)
(Threads)
(ViewPose)
Result
Images
RenderView
ReprojectPoints
Parameters
(Cameras)
Points
(0)
0
1
(Rectified)
(Sensor)
Result
Directions
0
0
1
2
Origin
0
1
2
ResetDevice
Parameters
Cameras
(Threads)
(Timeout)
Result
Cameras
<SerialNumber>
Found
Reset
Retrieve
Parameters
(Cameras)
(Timeout)
Result
<SerialNumber>
(CaptureEvents)
0
Message
Symbol
Timestamp
(PacketsResent)
Retrieved
SaveCameraModel
Parameters
(Cameras)
Filename
(Relative)
(ShowCameras)
(ShowFieldOfView)
SaveFileCamera
Parameters
(Cameras)
(Format)
Path
(Source)
SaveImage
Parameters
Filename
Node
SaveModel
Parameters
BoundingBox
Cameras
Filename
Normals
PointCloud
Texture
Threads
SaveParameters
Parameters
(Cameras)
(Clear)
(Description)
(Device)
(Filename)
(Protection)
Result
Data
SetPatternBuffer
Parameters
Patterns
SimulatePhysics
Parameters
ResetClock
Time
StoreCalibration
Parameters
(Calibration)
(Cameras)
(DynamicOffsets)
(Force)
(Link)
Synchronize
Parameters
Cameras
Nodes
Trigger
Parameters
(Cameras)
(ClearImageBufferOnTrigger)
(ImageSet)
(Subset)
(Timeout)
(WaitFor)
(WaitForProjector)
Result
<SerialNumber>
Ptp
(ErrorText)
Triggered
Triggered
UpdateDeviceList
UpdateFirmware
Parameters
(Components)
(0)
SerialNumber
(Source)
(Download)
(Filename)
VisualizePatternBuffer
Parameters
Cameras
Filter
Wifi
Parameters
Command
Default
Passphrase
Ssid
Commands - Ensenso SDK
»
SaveParameters
»
Parameters
»
(Filename)
(Filename)
¶
The path to an
.ensparam
file where the parameters will be saved.
JSON Format
¶
Type
String
