About

API

C C++ CLI Python Halcon ROS

Tree Commands Guides Hardware Specification

AddPatternBufferView
- Paramters
  - Name
  - Filter
AdjustExposureAndGain
- Parameters
  - AdjustExposure
  - AdjustGain
  - Brightness
  - Cameras
  - Exposure
  - Gain
  - Apply
- Result
  - Exposure
  - Gain
Break
Calibrate
- Parameters
- Result
  - Progress
    - MonocularCalibration
    - StereoCalibration
CalibrateHandEye
- Parameters
  - Angles
    - 0
      - 0
      - 1
      - ...
    - 1
      - 0
      - 1
      - ...
    - ...
  - Iterations
  - Link
  - Links
    - 0
    - 1
    - ...
  - MeasureCalibration
  - PatternPose
  - Poses
  - Setup
  - Target
  - Threads
  - Tolerance
  - Transformations
    - 0
    - 1
    - ...
  - Fixed
    - Scaling
    - Link
      - Rotation
      - Translation
    - PatternPose
      - Rotation
      - Translation
  - Scaling
- Result
  - Angles
  - Iterations
  - Link
  - PatternPose
  - PoseError
  - Progress
    - Iterations
    - Residual
  - Residual
CalibrateWorkspace
- Paramters
  - Cameras
  - Type
  - PatternPose
  - DefinedPose
  - Offset
  - Target
  - AlignAxis
Capture
- Parameters
- Result
  - 120001
    - PacketsResent
    - InitialTrigger
    - Retrieved
    - FinalTrigger
    - CaptureEvents
      - 0
        
        Timestamp
        
        Symbol
        
        Message
      - ...
- Detail
ChainTransformations
- Parameters
  - Transformations
- Result
  - Transformation
ClearImageBuffer
- Parameters
  - Cameras
ClearImages
- Parameters
  - Cameras
  - DisparityMap
  - Normals
  - PointMap
  - Raw
  - Rectified
ClearOverlay
- Parameters
  - Cameras
  - ShowRectifiedArea
Close
- Parameters
  - Cameras
  - Threads
  - Unsafe
CollectPattern
- Parameters
  - Blur
  - Buffer
  - Cameras
  - DecodeData
  - Direction
  - Downsample
  - DrawAxes
  - Filter
  - HUD
  - IgnoreEnsensoPatternEncoding
  - MarkOnly
  - Projector
  - Refinement
  - ReturnAllPattern
  - ShowObjectPoints
  - Threads
  - UpdateGlobalPatternData
- Result
  - Stereo
    - 0
      - GridSize
      - GridSpacing
      - Offset
      - Thickness
      - Type
      - Left
        
        Transformation
        
        Contrast
        
        Brightness
      - Right
        
        Transformation
        
        Contrast
        
        Brightness
    - 1
    - ...
  - Patterns
  - GlobalPatternDataUpdated
ComputeDisparityMap
- Parameters
  - Cameras
  - CUDA
  - MarkFilterRegions
  - Threads
ComputeImageContrast
- Parameters
  - Cameras
  - Region
    - Left
    - Right
  - Threads
  - UseBufferedPatterns
- Result
  - 120001
    - Contrast
      - Left
        
        0
        
        1
        
        ...
      - Right
        
        0
        
        1
        
        ...
ComputeNormals
- Parameters
  - Cameras
  - CUDA
    - Device
    - Enabled
  - Radius
  - Threads
ComputePointMap
- Parameters
  - Cameras
  - Threads
ComputeTexture
- Parameters
  - Cameras
  - Left
  - Right
  - Threads
ConvertTransformation
- Parameters
  - Transformation
  - SplitRotation
- Result
  - Transformation
  - Transformations
CreateCamera
- Parameters
DeleteCamera
- Parameters
  - Cameras
DiscardPatterns
- Parameters
  - Cameras
EstimateDisparitySettings
- Parameters
  - Cameras
  - Threads
- Result
  - 120001
    - MinimumDisparity
    - NumberOfDisparities
EstimatePatternPose
- Parameters
  - Average
  - EstimateGridSpacing
  - Filter
  - Pose
  - Recalibrate
  - Relative
  - ReprojectionErrorScale
  - Threads
  - Type
- Result
  - Patterns
    - 0
    - ...
EthernetConfiguration
- Parameters
  - Blind
  - Cameras
  - Configuration
    - 0
      - Left
        
        Gateway
        
        IpAddress
        
        IpSubnetMask
        
        Method
      - Right
        
        DefaultGateway
        
        IpAddress
        
        IpSubnetMask
        
        Method
      - Projector
        
        DefaultGateway
        
        IpAddress
        
        IpSubnetMask
        
        Method
      - Gateway
      - IpAddress
      - IpSubnetMask
      - Method
    - 1
      - Left
        
        DefaultGateway
        
        IpAddress
        
        IpSubnetMask
        
        Method
      - Right
        
        DefaultGateway
        
        IpAddress
        
        IpSubnetMask
        
        Method
      - Projector
        
        DefaultGateway
        
        IpAddress
        
        IpSubnetMask
        
        Method
      - DefaultGateway
      - IpAddress
      - IpSubnetMask
      - Method
    - ...
  - MacAddresses
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
      - Index
    - 1
    - 2
    - ...
Flash
- Parameters
  - Cameras
  - FrontLight
  - Glow
  - Projector
GenerateCalibrationPattern
- Parameters
  - Encoding
  - Filename
  - ImageSize
  - Patterns
    - 0
      - GridSpacing
      - Thickness
      - Text
      - Offset
        
        0
        
        1
    - ...
- Result
  - 0
  - ...
GetModelInfo
- Parameters
- Result
  - Blur
  - Disparity
  - Distance
  - FocalLength
  - FocusDistance
  - LeftBottom
  - LeftTop
  - Pattern
  - PixelPitch
  - PixelSize
  - RightBottom
  - RightTop
  - Vergence
  - DisparityAccuracy
GetPatternBuffer
- Parameters
  - Filter
- Result
  - Patterns
GetRawCalibrationData
- Parameters
  - Cameras
- Result
  - Calibration
GetSensorTags
- Parameters
  - Cameras
- Result
  - Left
  - Right
LoadCalibration
- Parameters
- Result
  - EepromFormat
LoadImage
- Parameters
LoadUEyeParameterSet
- Parameters
  - Cameras
  - Filename
MeasureCalibration
- Parameters
- Result
  - Patterns
    - 0
      - PatternPose
      - ReprojectionError
    - 1
      - PatternPose
      - ReprojectionError
    - ...
  - PatternPose
  - ReprojectionError
Open
- Parameters
PatternBufferInfo
- Parameters
  - ConnectedCameras
  - Filter
- Result
  - ConnectedCameras
    - 0
      - 0
      - ...
    - ...
  - Count
  - PatternCount
ProjectPattern
- Parameters
  - Cameras
  - GridSize
  - GridSpacing
  - PatternPose
  - Rectified
  - Threads
- Result
  - Stereo
    - Pattern
      - GridSize
      - GridSpacing
    - Points
      - Left
        
        0
        
        1
        
        ...
      - Right
        
        0
        
        1
        
        ...
  - Corners
    - Pattern
      - GridSize
      - GridSpacing
    - Points
      - Left
        
        0
        
        1
        
        ...
      - Right
        
        0
        
        1
        
        ...
Recalibrate
- Parameters
  - Cameras
  - Filter
- Result
  - Offset
    - Epipolar
    - Vergence
RectifyImages
- Parameters
  - Cameras
  - CUDA
    - Device
    - Enabled
  - Threads
ReducePatternBuffer
- Parameters
  - Count
  - Mode
- Result
  - Reduced
RemovePatternBufferView
- Parameter
  - Name
RenderPointMap
- Parameters
  - Camera
  - Cameras
  - Far
  - FillXYCoordinates
  - Near
  - PixelSize
  - Scaling
  - Size
  - SurfaceConnectivity
  - Texture
  - Threads
  - UseOpenGL
  - ViewPose
  - ZBufferOnly
- Details
  - Error Symbols
  - Rendering Methods
RenderView
- Parameters
  - Cameras
  - Far
  - Near
  - PatternPose
  - Threads
  - PointCloud
  - Primitive
  - ShowCameras
  - ShowGrid
  - ShowSurface
  - ShowUserDefinedModels
  - Size
  - SurfaceConnectivity
  - ViewPose
Retrieve
- Parameters
  - Cameras
  - Timeout
  - Operation
  - Threads
- Result
  - 120001
    - Retrieved
    - PacketsResent
    - CaptureEvents
      - 0
        
        Message
        
        Symbol
        
        Timestamp
      - ...
SaveImage
- Parameters
  - Filename
  - Node
SaveModel
- Parameter
  - Cameras
  - Filename
  - Texture
  - Threads
SetPatternBuffer
- Parameters
  - Patterns
SetStatusLeds
SimulatePhysics
- Parameters
  - ResetClock
  - Time
StoreCalibration
- Parameters
  - Cameras
  - Force
  - Calibration
  - DynamicOffsets
  - Link
Synchronize
- Parameters
  - Cameras
  - Nodes
- Description of Synchronization Procedure
Trigger
- Parameters
- Result
  - 120001
    - Triggered
UpdateFirmware
- Parameters
  - Camera
  - Cameras
  - Filename
  - Projector
VisualizePatternBuffer
- Parameters
  - Cameras
  - Filter

EnsensoSDK - Commands

»
RenderView »
Parameters »
ShowSurface

ShowSurface¶

Overrides the global ShowSurface parameter.

Next Previous

Version

Other Versions