Introduction
System Requirements
Software Installation
Manual Installation of Halcon Interface and Procedures
Connect and Open a Camera
Camera Setup Considerations
Parameter Adjustment in NxView
Calibrating a Camera
Setting Up a Stereo System with an X30/X36 Projector
Software Components
Networking performance with GigE cameras
NxLib API
Overview
Binary Nodes and Commands
Json Types
C Interface
C API Types
Item Paths
API Return Codes
Read Access
nxLibGetBinary
nxLibGetBinaryInfo
nxLibGetBool
nxLibGetCount
nxLibGetDouble
nxLibGetInt
nxLibGetJson
nxLibGetJsonMeta
nxLibGetName
nxLibGetString
nxLibGetType
Write Access
nxLibErase
nxLibSetBinary
nxLibSetBool
nxLibSetDouble
nxLibSetInt
nxLibSetJson
nxLibSetNull
nxLibSetString
Waiting
nxLibWaitForChange
nxLibWaitForType
nxLibWaitForStringValue
nxLibWaitForIntValue
nxLibWaitForDoubleValue
nxLibWaitForBoolValue
Other
nxLibTranslateReturnCode
nxLibWriteDebugMessage
nxLibGetDebugMessages
NxLib
nxLibInitialize
nxLibFinalize
nxLibOpenTcpPort
nxLibCloseTcpPort
NxLibRemote
nxLibConnect
nxLibDisconnect
C++ Interface
NxLibItem
operator[]
operator<<
operator=
operator==,!=,>,<,>=,<=
compare
set
setJson
setNull
as
asInt
asBool
asDouble
asString
asJson
isNull
isString
isNumber
isBool
isArray
isObject
type
exists
erase
name
count
getBinaryDataInfo
getBinaryData
setBinaryData
waitForChange
waitForType
waitForValue
NxLibException
getErrorCode
getErrorText
getItemPath
NxLibCommand
parameters
result
execute
finished
successful
C# Interface / CLI
Basic Access
Read Access
GetBinary
GetBinaryInfo
GetBool
GetCount
GetDouble
GetInt
GetJson
GetJsonMeta
GetName
GetString
GetType
Write Access
Erase
SetBinary
SetBool
SetDouble
SetInt
SetJson
SetNull
SetString
Waiting
WaitForChange
WaitForType
WaitForStringValue
WaitForIntValue
WaitForDoubleValue
WaitForBoolValue
Other
TranslateReturnCode
WriteDebugMessage
GetDebugMessages
Initialize
Finalize
OpenTcpPort
CloseTcpPort
NxLibItem
property[]
Compare
Set
SetJson
SetNull
AsInt
AsBool
AsDouble
AsString
AsJson
IsNull
IsString
IsNumber
IsBool
IsArray
IsObject
Type
Exists
Erase
Name
Count
GetBinaryDataInfo
GetBinaryData
SetBinaryData
WaitForChange
WaitForType
WaitForValue
NxLibException
GetErrorCode
GetErrorText
GetItemPath
NxLibCommand
Parameters
Result
Execute
Finished
Successful
Common Tree Elements
Vector
Matrix
Transformation
Primitive
Plane
Sphere
Cylinder
Filter
Cameras
Invert
Or
0
Invert
And
0
Invert
Type
Value
...
...
Reduce
UseModel
Tree
Cameras
ByEepromId
0
1
...
BySerialNo
120001 (a stereo camera)
Calibration
Dynamic
Stereo
Left
Camera
Rotation
Reprojection
Right
Camera
Rotation
Angle
Epipolar
Vergence
Monocular
Left
Camera
Distortion
Right
Camera
Distortion
Stereo
Angle
Epipolar
OpticalAxis
Vergence
Baseline
Left
Camera
Rotation
Reprojection
Right
Camera
Rotation
EepromId
FirmwareVersion
Application
Bootloader
ImageFolder
Images
DisparityMap
PointMap
Normals
Raw
Left
Right
Raw (with FlexView enabled)
0
Left
Right
1
Left
Right
...
Rectified
Left
Right
Rectified (with FlexView enabled)
0
Left
Right
1
Left
Right
...
WithOverlay
Left
Right
Link
Target
ModelName
Parameters
Capture
AutoBlackLevel
AutoExposure
AutoGain
Binning
BlackLevelOffset
BlackLevelOffsetCalibration
Left
Right
Exposure
FlexView
FrontLight
Gain
GainBoost
HardwareGamma
Hdr
ImageBuffer
Count
OverflowPolicy
Size
MaxFlashTime
MaxGain
MultiExposureFactor
PixelClock
Projector
TargetBrightness
TriggerDelay
Triggered
TriggerMode
UseDisparityMapAreaOfInterest
DisparityMap
AreaOfInterest
LeftTop
RightBottom
MeasurementVolume
Far
DisparityStep
LeftBottom
LeftTop
PixelSize
RightBottom
RightTop
Near
DisparityStep
LeftBottom
LeftTop
PixelSize
RightBottom
RightTop
PostProcessing
Filling
BorderSpread
RegionSize
MedianFilterRadius
SpeckleRemoval
ComponentThreshold
RegionSize
UniquenessRatio
Scaling
StereoMatching
DepthChangeCost
DepthStepCost
Method
MinimumDisparity
NumberOfDisparities
Padding
ScaledMinimumDisparity
ScaledNumberOfDisparities
ShadowingThreshold
UseRecalibrator
ValidRegion
LeftTop
RightBottom
IO
Input
Output
Driver
Sink
Source
Duration
DutyCycle
Frequency
Mode
Overlay
Text
Angle
Color
Mirror
Horizontal
Vertical
Port
DefaultGateway
DHCP
IpAddress
IpSubnetMask
NetworkAdapterIpAddress
NetworkAdapterIpSubnetMask
Type
Sensor
Left
ModelName
Port
Bandwidth
IpAddress
IpSubnetMask
NetworkAdapterIpAddress
NetworkAdapterIpSubnetMask
Type
SerialNumber
Temperature
Right
ModelName
Port
Bandwidth
IpAddress
IpSubnetMask
NetworkAdapterIpAddress
NetworkAdapterIpSubnetMask
Type
SerialNumber
Temperature
Size
Sensor (for an N20/N30/N35 camera)
ModelName
Port
Bandwidth
IpAddress
IpSubnetMask
NetworkAdapterIpAddress
NetworkAdapterIpSubnetMask
Type
SerialNumber
Size
Temperature
SerialNumber
Status
Available
Calibrated
DynamicCalibrationLimitReached
MinimumVoltage
Open
Overtemperature
Paired
ValidFirmware
ValidIpAddress
Temperature
Board
LED
Type
4002900001 (a monocular camera)
Calibration
Camera
Distortion
EepromId
ImageFolder
Images
Raw
Rectified
WithOverlay
Link
Target
ModelName
Parameters
Capture
AutoBlackLevel
AutoExposure
AutoFocus
AutoGain
Binning
BlackLevelOffset
BlackLevelOffsetCalibration
Left
Right
Exposure
Focus
Gain
GainBoost
HardwareGamma
ImageBuffer
OverflowPolicy
Size
PixelClock
TargetBrightness
TriggerDelay
Triggered
TriggerMode
IO
Input
Output
Overlay
Font
Angle
Color
Mirror
Horizontal
Vertical
Sensor
Port
Bandwidth
IpAddress
IpSubnetmask
NetworkAdapterIpAddress
NetworkAdapterIpSubnetmask
Type
Size
Temperature
SerialNumber
Status
Available
Calibrated
Open
Overtemperature
Paired
ValidFirmware
ValidIpAddress
Type
160001 (a projector)
EepromId
FirmwareVersion
Application
Bootloader
ModelName
Port
DefaultGateway
DHCP
IpAddress
IpSubnetmask
NetworkAdapterIpAddress
NetworkAdapterIpSubnetmask
Type
SerialNumber
Status
Available
Calibrated
Open
Overtemperature
Paired
ValidFirmware
ValidIpAddress
Temperature
Board
LED
Type
Debug
Destination
Modules
Calibration
Camera
Commands
Locking
Matching
Rendering
StereoCamera
Execute
Default
Command
Parameters
PersistentParameters
Result
ErrorSymbol
ErrorText
Execute
Command
Parameters
Time
...
Images
RenderPointMap
RenderPointMapTexture
RenderView
Links
Hand
Target
Parameters
ComputeDisparityMap
StaticBuffers
MonocularPatternCount
Pattern
GridSize
GridSpacing
PatternCount
RenderPointMap
Scaling
Texture
UseOpenGL
PixelSize
Size
ViewPose
RenderView
ShowCameras
ShowGrid
ShowSurface
Size
ViewPose
SurfaceConnectivity
Threads
UEye
OpenMP
PatternBuffer
All
Filter
ShowPatterns
ShowPatternPoints
Patterns
0
120001 (a stereo camera)
Left
0
...
Right
0
...
4002900001 (a monocular camera)
0
Pattern
GridSize
Thickness
Offset
GridSpacing
Contrast
Brightness
Points
0
...
...
...
PatternCount
StereoPatternCount
Version
Build
Day
Major
Minor
Month
Year
Hash
CodeMeter
Build
Major
Minor
uEye
Build
Major
Minor
Commands
AddPatternBufferView
Parameters
Name
Filter
AdjustExposureAndGain
Parameters
AdjustExposure
AdjustGain
Brightness
Cameras
Exposure
Gain
Break
Calibrate
Parameters
Cameras
PatternCount
StereoCalibrationOnly
Threads
Result
Progress
MonocularCalibration
StereoCalibration
CalibrateHandEye
Parameters
Iterations
Link
PatternPose
Setup
Target
Threads
Tolerance
Transformations
0
1
...
Result
Iterations
Link
PatternPose
PoseError
Progress
Iterations
ReprojectionError
ReprojectionError
CalibrateWorkspace
Parameters
Cameras
Type
PatternPose
DefinedPose
Offset
Target
AlignAxis
Capture
Parameters
Cameras
FinalTrigger
InitialTrigger
Operation
Threads
Timeout
WaitFor
ClearImageBufferOnTrigger
WaitForProjector
Result
120001
PacketsResent
InitialTrigger
Retrieved
FinalTrigger
CaptureEvents
0
Timestamp
Symbol
Message
...
ChainTransformations
Parameters
Transformations
Result
Transformation
ClearImageBuffer
Parameters
Cameras
ClearOverlay
Parameters
Cameras
ShowRectifiedArea
Close
Parameters
Cameras
Threads
CollectPattern
Parameters
Blur
Buffer
Cameras
DecodeData
Direction
DrawAxes
Filter
MarkOnly
Projector
Refinement
ReturnAllPattern
Threads
Result
Stereo
0
Thickness
GridSpacing
GridSize
Offset
Left
Transformation
Contrast
Brightness
Right
Transformation
Contrast
Brightness
1
...
Patterns
ComputeDisparityMap
Parameters
Cameras
MarkFilterRegions
Threads
ComputeImageContrast
Parameters
Cameras
Region
Left
Right
Threads
Result
120001
Contrast
Left
0
1
...
Right
0
1
...
ComputeNormals
Parameters
Cameras
Threads
Radius
ComputePointMap
Parameters
Cameras
Threads
ConvertTransformation
Parameters
Transformation
SplitRotation
Result
Transformation
Transformations
DiscardPatterns
EstimateDisparitySettings
Parameters
Cameras
Threads
Result
120001
MinimumDisparity
NumberOfDisparities
EstimatePatternPose
Parameters
Average
EstimateGridSpacing
Filter
Recalibrate
ReprojectionErrorScale
Threads
Result
Patterns
0
EpipolarError
GridSize
GridSpacing
PatternPose
PoseError
ReprojectionError
1
EpipolarError
GridSize
GridSpacing
PatternPose
PoseError
ReprojectionError
...
EthernetConfiguration
Parameters
Cameras
Configuration
0
Left
DefaultGateway
IpAddress
IpSubnetmask
Method
Right
DefaultGateway
IpAddress
IpSubnetmask
Method
Projector
DefaultGateway
IpAddress
IpSubnetmask
Method
DefaultGateway
IpAddress
IpSubnetmask
Method
1
Left
DefaultGateway
IpAddress
IpSubnetmask
Method
Right
DefaultGateway
IpAddress
IpSubnetmask
Method
Projector
DefaultGateway
IpAddress
IpSubnetmask
Method
DefaultGateway
IpAddress
IpSubnetmask
Method
...
FilterPatternBuffer
Parameters
Filter
FitPrimitive
Primitive Search Parameters
Parameters
Primitive
0 (Plane example)
Type
1 (Sphere example)
Type
Radius
Min
Max
Count
2 (Cylinder example)
Type
Radius
Min
Max
...
Cameras
Normal
Radius
BoundingBox
Min
Max
FailureProbability
InlierFraction
InlierThreshold
Scaling
Iterations
Threads
Result
Primitive
0
1
2
...
GenerateCalibrationPattern
Parameters
Filename
Encoding
Patterns
0
GridSpacing
Thickness
Text
Offset
0
1
...
GetModelInfo
Parameters
Cameras
ModelName
Disparity
Distance
MinimumDisparity
NumberOfDisparities
WorldCoordinates
Result
Blur
Disparity
Distance
FocalLength
Focus
LeftBottom
LeftTop
Pattern
OuterSize
GridSpacing
GridSize
Thickness
PixelPitch
PixelSize
RightBottom
RightTop
Vergence
DisparityAccuracy
GetPatternBuffer
Parameters
Filter
Result
Patterns
GetRawCalibrationData
Parameters
Cameras
Result
Calibration
LoadCalibration
Parameters
Cameras
Calibration
GenerateEmptyCalibration
Result
EepromFormat
LoadImage
Parameters
Filename
ForceGrayscale
Node
LoadUEyeParameterSet
Parameters
Cameras
Filename
MeasureCalibration
Parameters
Direction
Filter
Index
Result
Patterns
0
PatternPose
ReprojectionError
1
PatternPose
ReprojectionError
...
PatternPose
ReprojectionError
Open
Parameters
Cameras
FirmwareUpload
Camera
Projector
LoadCalibration
Threads
PatternBufferInfo
Parameters
Filter
Result
Count
ProjectPattern
Parameters
Cameras
GridSize
GridSpacing
PatternPose
Rectified
Threads
Result
Stereo
0
Pattern
GridSize
GridSpacing
Points
0
0
1
...
1
0
1
...
1
Pattern
GridSize
GridSpacing
Points
0
0
1
...
1
0
1
...
RectifyImages
Parameters
Cameras
Threads
RemovePatternBufferView
Parameters
Name
RenderPointMap
Parameters
Camera
Cameras
Far
FillXYCoordinates
Near
Threads
ZBufferOnly
RenderView
Parameters
Cameras
ColorOffset
ColorRepetitionDistance
PatternPose
Threads
UseStereoTextures
Primitive
Retrieve
Parameters
Cameras
Timeout
Operation
Threads
Result
120001
Retrieved
PacketsResent
CaptureEvents
0
Message
Symbol
Timestamp
...
SaveImage
Parameters
Filename
Node
SaveModel
Parameters
Cameras
Filename
Texture
Threads
SetPatternBuffer
Parameters
Patterns
StoreCalibration
Parameters
Cameras
Force
Calibration
DynamicOffsets
Link
Synchronize
Parameters
Cameras
Nodes
Trigger
Parameters
Cameras
Subset
Threads
ClearImageBufferOnTrigger
WaitForProjector
Result
120001
Triggered
VisualizePatternBuffer
Parameters
Cameras
Filter
Examples
HowTo's
Basic Camera Operations
Opening a Camera and Setting Parameters
Reading/Writing Camera Parameter Files
Capturing Images with Hardware Trigger
Using the Digital Input and Output
Running Cameras Hardware Synchronized
Getting 3D Data
Grabbing 3D Data
Set Z-Range
Optimize Settings for Performance/Quality
Deferred 3D Processing
Multi Camera Setups and Calibrations
Multi Camera Setups
Texturing Point Clouds
Workspace Calibration
Hand-Eye Calibration
Multithreading
Parallel Capturing and Processing
Parallel Usage of Multiple Cameras
API and Command Error Handling
Hardware Specification
Ambient Conditions (all models)
Electronics / GPIO
N10 GPIO Port
N20 GPIO Port
N20 Power Supply
N30/N35 GPIO Port
X30/X36 GPIO Port
N30/N35 Power Supply
X30/X36 Power Supply
Wiring Examples
Cables
N-Series
M8 3-Pin Power Cord
M8 3-Pin Y-Adapter
M8 3-Pin - Hirose Adapter (6 pin)
M8 3-Pin - Hirose Adapter (8 pin)
M8 3-Pin - Binder 712-Series Adapter (7 pin)
M8 3-Pin Extension Cable
M8 3-Pin Cable (open endings)
X-Series
M8 4-Pin Power Cord
Sync Cable: M8 4-Pin - Hirose Adapter (6 pin)
M8 4-Pin Cable (open endings)
Illumination
N10
N20/N30/N35
X30/X36
Eye Safety
Mechanics
N10
N20
N30/N35
X30/X36
Vibration / Shock
Calibration Plates
Cleaning
Disposal
Halcon Interface
Operators
open_framegrabber
close_framegrabber
set_framegrabber_param
get_framegrabber_param
grab_image
grab_data
Acquisition Handle
Executing Commands
Storing JSON structures in files
About
Changelog
Upgrade Notes
License
Third Party Licenses