Skip to content

PLCamera Class#

List of all parameter names available for Basler camera devices

Inheritance Hierarchy#

System.Object
  Basler.Pylon.PLCamera

Properties#

NameDescription
Public propertyStatic memberAcquisitionAbort

Aborts the acquisition of images. If the camera is currently exposing a frame, the camera stops exposing immediately. The readout process, if already started, is aborted. The current frame will be incomplete. Afterwards, image acquisition is switched off.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

Selected by: AcquisitionMode

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionBurstFrameCount

Number of frames to acquire for each Frame Burst Start trigger.

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionFrameCount

Number of frames to acquire for each Acquisition Start trigger.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionFrameRate

Acquisition frame rate of the camera in frames per second.

Applies to: ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionFrameRateAbs

Acquisition frame rate of the camera in frames per second.

Applies to: CamEmu, CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionFrameRateEnable

Enables setting the camera's acquisition frame rate to a specified value.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionFrameRateEnum

Applies to: CameraLink

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionIdle

A check determines whether the camera is currently idle, i.e., not acquiring images.

Applies to: GigE and ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionLineRateAbs

Acquisition line rate of the camera in lines per second.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionMode

Sets the image acquisition mode.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selecting Parameters: AcquisitionAbort, AcquisitionStart, AcquisitionStop

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionStart

Starts the acquisition of images. If the camera is configured for single frame acquisition, it will start the acquisition of one frame. If the camera is configured for continuous frame acquisition, it will start the continuous acquisition of frames.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: AcquisitionMode

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionStartEventStreamChannelIndex

Stream channel index of the Acquisition Start event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionStartEventTimestamp

Timestamp of the Acquisition Start event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionStartOvertriggerEventStreamChannelIndex

Stream channel index of the Acquisition Start Overtrigger event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionStartOvertriggerEventTimestamp

Timestamp of the Acquisition Start Overtrigger event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionStartWaitEventStreamChannelIndex

Stream channel index of the Acquisition Start Wait event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionStartWaitEventTimestamp

Timestamp of the Acquisition Start Wait event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionStatus

Indicates whether the camera is waiting for trigger signals. You should only use this feature if the camera is configured for software triggering. If the camera is configured for hardware triggering, monitor the camera's Trigger Wait signals instead.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Expert

Selected by: AcquisitionStatusSelector

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionStatusSelector

Sets the signal whose status you want to check. Its status can be checked by reading the Acquisition Status parameter value.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Expert

Selecting Parameters: AcquisitionStatus

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionStop

Stops the acquisition of images if a continuous image acquisition is in progress.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: AcquisitionMode

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionWaitEventStreamChannelIndex

Stream channel index of the Acquisition Wait event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAcquisitionWaitEventTimestamp

Timestamp of an Acquisition Wait event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberActionCommandCount

Number of separate action signals supported by the camera. Determines how many action signals the camera can handle in parallel, i.e., how many different action commands can be configured on the camera.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberActionDeviceKey

Device key used to authorize the execution of an action command. If the action device key in the camera and the action device key in the protocol message are identical, the camera will execute the corresponding action.

Applies to: GigE and ace 2 GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberActionGroupKey

Group key used to define a group of cameras on which action commands can be executed.

Applies to: GigE and ace 2 GigE

Visibility: Beginner

Selected by: ActionSelector

The feature documentation may provide more information.

Public propertyStatic memberActionGroupMask

Group mask used to filter out a sub-group of cameras belonging to a group of cameras. The cameras belonging to a sub-group execute an action at the same time. The filtering is done using a logical bitwise AND operation on the group mask number of the action command and the group mask number of a camera. If both binary numbers have at least one common bit set to 1 (i.e., the result of the AND operation is non-zero), the corresponding camera belongs to the sub-group.

Applies to: GigE and ace 2 GigE

Visibility: Beginner

Selected by: ActionSelector

The feature documentation may provide more information.

Public propertyStatic memberActionLateEventStreamChannelIndex

Stream channel index of the Action Late event. An Action Late event is raised when a scheduled action command with a timestamp in the past is received.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberActionLateEventTimestamp

Timestamp of the Action Late event. An Action Late event is raised when a scheduled action command with a timestamp in the past is received.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberActionQueueSize

Number of action commands that can be queued by the camera. The camera will execute them in ascending order of action time. If the queue is full, additional commands will be ignored.

Applies to: ace 2 GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberActionSelector

Action command to be configured.

Applies to: GigE and ace 2 GigE

Visibility: Beginner

Selecting Parameters: ActionGroupKey, ActionGroupMask

The feature documentation may provide more information.

Public propertyStatic memberAutoBacklightCompensation

Backlight compensation factor that allows the camera to compensate for underexposure. This is done by excluding a certain percentage of the brightest pixels in the image from the target average gray value calculations.

Applies to: dart USB and pulse USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberAutoExposureTimeAbsLowerLimit

Lower limit of the Exposure Time parameter when the Exposure Auto auto function is active.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAutoExposureTimeAbsUpperLimit

Upper limit of the Exposure Time parameter when the Exposure Auto auto function is active.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAutoExposureTimeLowerLimit

Lower limit of the Exposure Time parameter when the Exposure Auto auto function is active.

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAutoExposureTimeLowerLimitRaw

Lower limit of the Exposure Time parameter when the Exposure Auto auto function is active (raw value).

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAutoExposureTimeUpperLimit

Upper limit of the Exposure Time parameter when the Exposure Auto auto function is active.

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAutoExposureTimeUpperLimitRaw

Upper limit of the Exposure Time parameter when the Exposure Auto auto function is active (raw value).

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionAOIHeight

Height of the auto function AOI (in pixels).

Applies to: CameraLink and GigE

Visibility: Beginner

Selected by: AutoFunctionAOISelector

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionAOIOffsetX

Horizontal offset of the auto function AOI from the left side of the sensor (in pixels).

Applies to: CameraLink and GigE

Visibility: Beginner

Selected by: AutoFunctionAOISelector

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionAOIOffsetY

Vertical offset of the auto function AOI from the top of the sensor (in pixels).

Applies to: CameraLink and GigE

Visibility: Beginner

Selected by: AutoFunctionAOISelector

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionAOISelector

Sets which auto function AOI can be configured.

Applies to: CameraLink and GigE

Visibility: Beginner

Selecting Parameters: AutoFunctionAOIHeight, AutoFunctionAOIOffsetX, AutoFunctionAOIOffsetY, AutoFunctionAOIUsageIntensity, AutoFunctionAOIUsageRedLightCorrection, AutoFunctionAOIUsageWhiteBalance, AutoFunctionAOIWidth

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionAOIUsageIntensity

Assigns the Gain Auto and the Exposure Auto auto functions to the currently selected auto function AOI. For this parameter, Gain Auto and Exposure Auto are considered as a single auto function named 'Intensity'.

Applies to: CameraLink and GigE

Visibility: Beginner

Selected by: AutoFunctionAOISelector

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionAOIUsageRedLightCorrection

Assigns the Red Light Correction auto function to the currently selected auto function AOI.

Applies to: CameraLink and GigE

Visibility: Beginner

Selected by: AutoFunctionAOISelector

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionAOIUsageTonalRange

Assigns the Tonal Range Auto auto function to the currently selected auto function AOI.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionAOIUsageWhiteBalance

Assigns the Balance White Auto auto function to the currently selected auto function AOI.

Applies to: CameraLink and GigE

Visibility: Beginner

Selected by: AutoFunctionAOISelector

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionAOIUseBrightness

Assigns the Gain Auto and the Exposure Auto auto functions to the currently selected auto function AOI. For this parameter, Gain Auto and Exposure Auto are considered as a single auto function named 'Brightness'.

Applies to: ace USB

Visibility: Invisible

Selected by: AutoFunctionAOISelector

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionAOIUseWhiteBalance

Assigns the Balance White auto function to the currently selected auto function AOI.

Applies to: ace USB

Visibility: Invisible

Selected by: AutoFunctionAOISelector

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionAOIWidth

Width of the auto function AOI (in pixels).

Applies to: CameraLink and GigE

Visibility: Beginner

Selected by: AutoFunctionAOISelector

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionProfile

Sets how gain and exposure time will be balanced when the camera is making automatic adjustments.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionROIHeight

Height of the auto function ROI (in pixels).

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: AutoFunctionROISelector

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionROIHighlight

Highlights the current auto function ROI in the image window. Areas that do not belong to the current ROI appear darker.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

Selected by: AutoFunctionROISelector

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionROIOffsetX

Horizontal offset of the auto function ROI from the left side of the sensor (in pixels).

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: AutoFunctionROISelector

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionROIOffsetY

Vertical offset of the auto function ROI from the top of the sensor (in pixels).

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: AutoFunctionROISelector

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionROISelector

Sets which auto function ROI can be configured.

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selecting Parameters: AutoFunctionROIHeight, AutoFunctionROIHighlight, AutoFunctionROIOffsetX, AutoFunctionROIOffsetY, AutoFunctionROIUseBrightness, AutoFunctionROIUseTonalRange, AutoFunctionROIUseWhiteBalance, AutoFunctionROIWidth

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionROIUseBrightness

Assigns the Gain Auto and the Exposure Auto auto functions to the currently selected auto function ROI. For this parameter, Gain Auto and Exposure Auto are considered as a single auto function named 'Brightness'.

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: AutoFunctionROISelector

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionROIUseTonalRange

Assigns the Tonal Range Auto auto function to the currently selected auto function ROI.

Applies to: ace USB

Visibility: Beginner

Selected by: AutoFunctionROISelector

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionROIUseWhiteBalance

Assigns the Balance White Auto auto function to the currently selected auto function ROI.

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: AutoFunctionROISelector

The feature documentation may provide more information.

Public propertyStatic memberAutoFunctionROIWidth

Width of the auto function ROI (in pixels).

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: AutoFunctionROISelector

The feature documentation may provide more information.

Public propertyStatic memberAutoGainLowerLimit

Lower limit of the Gain parameter when the Gain Auto auto function is active.

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: GainSelector

The feature documentation may provide more information.

Public propertyStatic memberAutoGainRawLowerLimit

Lower limit of the Gain parameter when the Gain Auto auto function is active (raw value).

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAutoGainRawUpperLimit

Upper limit of the Gain parameter when the Gain Auto auto function is active (raw value).

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAutoGainUpperLimit

Upper limit of the Gain parameter when the Gain Auto auto function is active.

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: GainSelector

The feature documentation may provide more information.

Public propertyStatic memberAutoTargetBrightness

Target brightness for the Gain Auto and the Exposure Auto auto functions.

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAutoTargetBrightnessDamping

Brightness adjustment damping factor to be applied. This controls the speed with which pixel gray values are changed when Exposure Auto, Gain Auto, or both are enabled. The lower the damping factor, the faster the target brightness value is reached.

Applies to: dart USB and pulse USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberAutoTargetValue

Target brightness for the Gain Auto and the Exposure Auto auto functions.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAutoTonalRangeAdjustmentSelector

Sets which parts of the tonal range can be adjusted.

Applies to: GigE and ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberAutoTonalRangeModeSelector

Sets the kind of tonal range auto adjustment.

Applies to: GigE and ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAutoTonalRangeTargetBright

Bright target value to be used during automatic tonal range adjustments. When you enable the Tonal Range Auto auto function, the camera sets the Tonal Range Target Bright parameter to this value. Not available if the Auto Tonal Range Mode parameter is set to Color.

Applies to: GigE and ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberAutoTonalRangeTargetDark

Dark target value to be used during automatic tonal range adjustments. When you enable the Tonal Range Auto auto function, the camera sets the Tonal Range Target Dark parameter to this value. Not available if the Auto Tonal Range Mode parameter is set to Color.

Applies to: GigE and ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberAutoTonalRangeThresholdBright

Threshold value from which the Tonal Range Source Bright parameter value is calculated during automatic tonal range adjustments. The parameter is expressed as a percentage of all pixels in the assigned auto function ROI. Example: Assume you set the Auto Tonal Range Threshold Bright parameter to 0.1 and enable the Tonal Range Auto auto function. Now assume that 0.1 % of the pixels in the assigned auto function ROI have a pixel value greater than or equal to 240. The camera automatically detects this, sets the Tonal Range Source Bright parameter to 240, and starts tonal range adjustments.

Applies to: GigE and ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAutoTonalRangeThresholdBrightRaw

Threshold value from which the Tonal Range Source Bright parameter value is calculated during automatic tonal range adjustments. The parameter is expressed as a percentage of all pixels in the assigned auto function ROI. Example: Assume you set the Auto Tonal Range Threshold Bright parameter to 0.1 and enable the Tonal Range Auto auto function. Now assume that 0.1 % of the pixels in the assigned auto function ROI have a pixel value greater than or equal to 240. The camera automatically detects this, sets the Tonal Range Source Bright parameter to 240, and starts tonal range adjustments.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAutoTonalRangeThresholdDark

Threshold value from which the Tonal Range Source Dark parameter value is calculated during automatic tonal range adjustments. The parameter is expressed as a percentage of all pixels in the assigned auto function ROI. Example: Assume you set the Auto Tonal Range Threshold Dark parameter to 0.2 and enable the Tonal Range Auto auto function. Now assume that 0.2 % of the pixels in the assigned auto function ROI have a pixel value lower than or equal to 30. The camera automatically detects this, sets the Tonal Range Source Dark parameter to 30, and starts tonal range adjustments.

Applies to: GigE and ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberAutoTonalRangeThresholdDarkRaw

Threshold value from which the Tonal Range Source Dark parameter value is calculated during automatic tonal range adjustments. The parameter is expressed as a percentage of all pixels in the assigned auto function ROI. Example: Assume you set the Auto Tonal Range Threshold Dark parameter to 0.2 and enable the Tonal Range Auto auto function. Now assume that 0.2 % of the pixels in the assigned auto function ROI have a pixel value lower than or equal to 30. The camera automatically detects this, sets the Tonal Range Source Dark parameter to 30, and starts tonal range adjustments.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBalanceRatio

Balance Ratio value to be applied to the currently selected channel.

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: BalanceRatioSelector

The feature documentation may provide more information.

Public propertyStatic memberBalanceRatioAbs

Balance Ratio value to be applied to the currently selected channel.

Applies to: CameraLink and GigE

Visibility: Beginner

Selected by: BalanceRatioSelector

The feature documentation may provide more information.

Public propertyStatic memberBalanceRatioRaw

Balance Ratio value to be applied to the currently selected channel (raw value).

Applies to: CameraLink and GigE

Visibility: Beginner

Selected by: BalanceRatioSelector

The feature documentation may provide more information.

Public propertyStatic memberBalanceRatioSelector

Sets which color channel can be adjusted when performing manual white balance. All changes to the Balance Ratio parameter will be applied to the selected color channel.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selecting Parameters: BalanceRatio, BalanceRatioAbs, BalanceRatioRaw

The feature documentation may provide more information.

Public propertyStatic memberBalanceWhiteAdjustmentDampingAbs

Balance White adjustment damping factor to be applied. This controls the speed with which the camera adjusts colors when the Balance White Auto auto function is enabled. This can be useful, for example, when objects move into the camera's field of view and the light conditions are changing gradually due to the moving objects.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBalanceWhiteAdjustmentDampingRaw

Balance White adjustment damping factor to be applied (raw value). This controls the speed with which the camera adjusts colors when the Balance White Auto auto function is enabled. This can be useful, for example, when objects move into the camera's field of view and the light conditions are changing gradually due to the moving objects.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBalanceWhiteAuto

Sets the operation mode of the Balance White Auto auto function.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBalanceWhiteReset

Resets all white balance adjustments.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBandwidthReserveMode

Sets a predefined bandwidth reserve or enables manual configuration of the bandwidth reserve.

Applies to: ace 2 GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBinningHorizontal

Number of adjacent horizontal pixels to be summed. Their charges will be summed and reported out of the camera as a single pixel.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: BinningSelector

The feature documentation may provide more information.

Public propertyStatic memberBinningHorizontalMode

Sets the binning mode for horizontal binning.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Expert

Selected by: BinningSelector

The feature documentation may provide more information.

Public propertyStatic memberBinningModeHorizontal

Sets the binning mode for horizontal binning.

Applies to: CameraLink

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBinningModeVertical

Sets the binning mode for vertical binning.

Applies to: CameraLink

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBinningSelector

Sets whether sensor or FPGA binning can be configured. To configure binning, use the Binning Horizontal, Binning Vertical, Binning Horizontal Mode, and Binning Vertical Mode parameters.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Expert

Selecting Parameters: BinningHorizontal, BinningHorizontalMode, BinningVertical, BinningVerticalMode

The feature documentation may provide more information.

Public propertyStatic memberBinningVertical

Number of adjacent vertical pixels to be summed. Their charges will be summed and reported out of the camera as a single pixel.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: BinningSelector

The feature documentation may provide more information.

Public propertyStatic memberBinningVerticalMode

Sets the binning mode for vertical binning.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Expert

Selected by: BinningSelector

The feature documentation may provide more information.

Public propertyStatic memberBlackLevel

Black level value to be applied to the currently selected sensor tap.

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: BlackLevelSelector

The feature documentation may provide more information.

Public propertyStatic memberBlackLevelAbs

This value sets the selected black level control as a float value.

Applies to: CameraLink and GigE

Visibility: Beginner

Selected by: BlackLevelSelector

The feature documentation may provide more information.

Public propertyStatic memberBlackLevelRaw

Black level value to be applied to the currently selected sensor tap (raw value).

Applies to: CameraLink and GigE

Visibility: Beginner

Selected by: BlackLevelSelector

The feature documentation may provide more information.

Public propertyStatic memberBlackLevelSelector

Sets which sensor tap can be configured. All changes to the Black Level parameter will be applied to the selected sensor tap.

Applies to: CameraLink, GigE, ace USB, dart USB and pulse USB

Visibility: Beginner

Selecting Parameters: BlackLevel, BlackLevelAbs, BlackLevelRaw

The feature documentation may provide more information.

Public propertyStatic memberBLCSerialFramingError

A serial framing error occurred on reception.

Applies to: GigE and ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBLCSerialParityError

A serial parity error occurred on reception.

Applies to: GigE and ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBLCSerialPortBaudRate

Reports the baud rate of the serial communication module.

Applies to: GigE and ace USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberBLCSerialPortClearErrors

Clears the error flags of the serial communication module.

Applies to: GigE and ace USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberBLCSerialPortParity

Reports the parity bit configuration of the serial communication module.

Applies to: GigE and ace USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberBLCSerialPortReceiveCmd

Reads and removes the front byte value from the serial communication receive queue.

Applies to: GigE and ace USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberBLCSerialPortReceiveValue

Last byte value read from the serial communication receive queue.

Applies to: GigE and ace USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberBLCSerialPortSource

Sets the signal source for the serial communication module.

Applies to: GigE and ace USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberBLCSerialPortStopBits

Reports the number of stop bits used by the serial communication module.

Applies to: GigE and ace USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberBLCSerialPortTransmitCmd

Writes the current byte value to the transmit queue.

Applies to: GigE and ace USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberBLCSerialPortTransmitValue

Byte value to be written to the transmit queue.

Applies to: GigE and ace USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberBLCSerialReceiveQueueStatus

Reports the status of the serial communication receive queue.

Applies to: GigE and ace USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberBLCSerialTransmitQueueStatus

Reports the status of the serial communication transmit queue.

Applies to: GigE and ace USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberBslAcquisitionBurstMode

Sets the burst mode.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslAcquisitionStopMode

Sets whether Acquisition Stop commands abort exposure.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslBlackLevelCompensationMode

Configures black level compensation.

Applies to: boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslBrightness

Adjusting the brightness lightens or darkens the entire image.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslBrightnessRaw

Adjusting the brightness lightens or darkens the entire image.

Applies to: GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslCenterX

Centers the image horizontally.

Applies to: CamEmu, ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslCenterY

Centers the image vertically.

Applies to: CamEmu, ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslChunkAutoBrightnessStatus

Indicates the status of the target brightness adjustments performed by the Exposure Auto and Gain Auto auto functions.

Applies to: ace 2 GigE, ace 2 USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslChunkTimestampSelector

Sets which information should be included in the Chunk Timestamp Value chunk.

Applies to: ace 2 GigE, ace 2 USB and dart 2 USB

Visibility: Expert

Selecting Parameters: BslChunkTimestampValue

The feature documentation may provide more information.

Public propertyStatic memberBslChunkTimestampValue

Value of the timestamp when the image was acquired.

Applies to: ace 2 GigE, ace 2 USB and dart 2 USB

Visibility: Expert

Selected by: BslChunkTimestampSelector

The feature documentation may provide more information.

Public propertyStatic memberBslColorAdjustmentEnable

Enables color adjustment.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslColorAdjustmentHue

Hue adjustment value to be applied to the currently selected color channel.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

Selected by: BslColorAdjustmentSelector

The feature documentation may provide more information.

Public propertyStatic memberBslColorAdjustmentSaturation

Saturation adjustment value to be applied to the currently selected color channel.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

Selected by: BslColorAdjustmentSelector

The feature documentation may provide more information.

Public propertyStatic memberBslColorAdjustmentSelector

Sets which color in your images will be adjusted.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

Selecting Parameters: BslColorAdjustmentHue, BslColorAdjustmentSaturation

The feature documentation may provide more information.

Public propertyStatic memberBslColorSpace

Sets the color space for image acquisitions. Note that the gamma correction value also influences the perception of brightness in the resulting images.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslColorSpaceMode

Sets the color space for image acquisitions. Note that the gamma correction value also influences the perception of brightness in the resulting images.

Applies to: dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslContrast

Adjusting the contrast increases the difference between light and dark areas in the image.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslContrastMode

Sets the contrast mode.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslContrastRaw

Adjusting the contrast increases the difference between light and dark areas in the image.

Applies to: GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslDefectPixelCorrectionMode

Pixels that have a significantly higher or lower intensity value than the neighboring pixels are called outlier pixels. This feature identifies them and adjusts their intensity value.

Applies to: dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslDeviceLinkCurrentThroughput

Actual bandwidth (in bytes per second) that the camera will use to transmit image data and chunk data with the current camera settings.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslEffectiveExposureTime

Current exposure time of the camera in microseconds.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberBslErrorPresent

Indicates whether an internal error occured on the device. If an error occured, you can use the Error Report Next command to determine the error code.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberBslErrorReportNext

Retrieves the next error code from the device. To check the error code, get the value of the Error Report Value parameter.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberBslErrorReportValue

Error code indicating the cause of the internal error. If there are multiple errors, execute the Error Report Next command to retrieve the next error code. A parameter value of 0 means that there are no more error codes to retrieve.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberBslExposureStartDelay

Exposure start delay with current settings.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslExposureTimeMode

Sets the exposure time mode.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslHue

Adjusting the hue shifts the colors of the image. This can be useful, e.g., to correct minor color shifts or to create false-color images.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslHueRaw

Adjusting the hue shifts the colors of the image. This can be useful, e.g., to correct minor color shifts or to create false-color images.

Applies to: GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslHueValue

Adjusting the hue shifts the colors of the image. This can be useful, e.g., to correct minor color shifts or to create false-color images.

Applies to: dart USB and pulse USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslImageCompressionLastRatio

Ratio between the compressed payload size and the uncompressed payload size of the last acquired image.

Applies to: ace 2 GigE and ace 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslImageCompressionLastSize

Compressed payload size of the last acquired image in bytes.

Applies to: ace 2 GigE and ace 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslImageCompressionRatio

Maximum ratio between the payload size of compressed and uncompressed images. For example, if you set this parameter to 70, the camera will try to compress the payload of images to 70 % or less of the original size. Note that if the camera can't achieve compression with the specified Image Compression Ratio and Image Compression Rate Option settings, frames will be skipped.

Applies to: ace 2 GigE and ace 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslImmediateTriggerMode

Enables the Immediate Trigger mode. If this mode is enabled, exposure starts immediately after triggering, but changes to image parameters become effective with a short delay, i.e., after one or more images have been acquired.

Applies to: dart USB and pulse USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslInputFilterTime

Time period in which the camera evaluates all changes and durations of logical states of the input signal. During evaluation, the camera calculates the mean value over time and applies a threshold function to the result to reconstruct the digital signal. This removes noise, interference, etc. as well as signal pulses shorter than the filter time.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Expert

Selected by: LineSelector

The feature documentation may provide more information.

Public propertyStatic memberBslInputHoldOffTime

Time period in which the camera doesn't accept any further trigger signals or signal changes after receiving an input trigger signal. This is useful if you want to avoid false triggering caused by multiple trigger signals arriving in quick succession (contact bounce).

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Expert

Selected by: LineSelector

The feature documentation may provide more information.

Public propertyStatic memberBslLightControlEnumerateDevices

Searches for light devices connected to your camera.

Applies to: GigE and ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslLightControlErrorStatus

Indicates whether any of the light devices are currently experiencing problems.

Applies to: GigE and ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslLightControlMode

Enables/disables the light control features.

Applies to: GigE and ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslLightControlSource

Sets which line is used to control the light features.

Applies to: GigE and ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslLightControlStatus

Indicates the current state of the light control mode.

Applies to: GigE and ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslLightDeviceBrightness

Brightness of the light in percent of total brightness available. Setting this parameter to 100 % means that the light device draws the maximum current as specified by the Light Device Max Current parameter.

Applies to: GigE and ace USB

Visibility: Expert

Selected by: BslLightDeviceSelector

The feature documentation may provide more information.

Public propertyStatic memberBslLightDeviceBrightnessRaw

Brightness of the light in percent of total brightness available (raw value). Setting this parameter to 100 % means that the light device draws the maximum current as specified by the the Light Device Max Current parameter.

Applies to: GigE

Visibility: Expert

Selected by: BslLightDeviceSelector

The feature documentation may provide more information.

Public propertyStatic memberBslLightDeviceChangeID

Changes the ID of the currently selected light device. The new ID will be assigned immediately.

Applies to: GigE and ace USB

Visibility: Expert

Selected by: BslLightDeviceSelector

The feature documentation may provide more information.

Public propertyStatic memberBslLightDeviceClearLastError

Clears the last light device error.

Applies to: GigE and ace USB

Visibility: Expert

Selected by: BslLightDeviceSelector

The feature documentation may provide more information.

Public propertyStatic memberBslLightDeviceFirmwareVersion

Version of the light device's firmware.

Applies to: GigE and ace USB

Visibility: Expert

Selected by: BslLightDeviceSelector

The feature documentation may provide more information.

Public propertyStatic memberBslLightDeviceLastError

Indicates the last light device error.

Applies to: GigE and ace USB

Visibility: Expert

Selected by: BslLightDeviceSelector

The feature documentation may provide more information.

Public propertyStatic memberBslLightDeviceMaxCurrent

Maximum current that the light device is going to use. The value should not exceed the power rating of the device. To change the setting, the Light Device Operation Mode parameter must be set to Off.

Applies to: GigE and ace USB

Visibility: Expert

Selected by: BslLightDeviceSelector

The feature documentation may provide more information.

Public propertyStatic memberBslLightDeviceMaxCurrentRaw

Maximum current that the light device is going to use (raw value). The value should not exceed the power rating of the device. To change the setting, the Light Device Operation Mode parameter must be set to Off.

Applies to: GigE

Visibility: Expert

Selected by: BslLightDeviceSelector

The feature documentation may provide more information.

Public propertyStatic memberBslLightDeviceOperationMode

Sets the operation mode of the light device.

Applies to: GigE and ace USB

Visibility: Expert

Selected by: BslLightDeviceSelector

The feature documentation may provide more information.

Public propertyStatic memberBslLightDeviceSelector

Sets which light device can be configured. To populate the list, use the Light Control Enumerate Devices command first. All subsequent parameter changes in this category will be applied to the device selected here.

Applies to: GigE and ace USB

Visibility: Expert

Selecting Parameters: BslLightDeviceBrightness, BslLightDeviceBrightnessRaw, BslLightDeviceChangeID, BslLightDeviceClearLastError, BslLightDeviceFirmwareVersion, BslLightDeviceLastError, BslLightDeviceMaxCurrent, BslLightDeviceMaxCurrentRaw, BslLightDeviceOperationMode, BslLightDeviceStrobeDuration, BslLightDeviceStrobeDurationRaw, BslLightDeviceStrobeMode

The feature documentation may provide more information.

Public propertyStatic memberBslLightDeviceStrobeDuration

Duration of the individual strobe pulses. The maximum value is 655 350 microseconds.

Applies to: GigE and ace USB

Visibility: Expert

Selected by: BslLightDeviceSelector

The feature documentation may provide more information.

Public propertyStatic memberBslLightDeviceStrobeDurationRaw

Duration of the individual strobe pulses (raw value). The maximum value is 655 350 microseconds.

Applies to: GigE

Visibility: Expert

Selected by: BslLightDeviceSelector

The feature documentation may provide more information.

Public propertyStatic memberBslLightDeviceStrobeMode

Sets the strobe mode of the light device.

Applies to: GigE and ace USB

Visibility: Expert

Selected by: BslLightDeviceSelector

The feature documentation may provide more information.

Public propertyStatic memberBslLightSourcePreset

Sets the light source preset. The colors in the image will be corrected so that they are appropriate for the selected light source.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslLightSourcePresetFeatureEnable

Enables adjustment of the feature specified by the Light Source Preset Feature Selector parameter.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Expert

Selected by: BslLightSourcePresetFeatureSelector

The feature documentation may provide more information.

Public propertyStatic memberBslLightSourcePresetFeatureSelector

Sets which features the camera adjusts when you select a light source preset. By default, the camera adjust all features.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Expert

Selecting Parameters: BslLightSourcePresetFeatureEnable

The feature documentation may provide more information.

Public propertyStatic memberBslLineConnection

Sets the connection signal for the currently selected line.

Applies to: dart 2 USB

Visibility: Expert

Selected by: LineSelector

The feature documentation may provide more information.

Public propertyStatic memberBslLineOverloadStatus

Indicates whether a GPIO line is overloaded, i.e., not powered correctly. A value of true (1) means that the GPIO line is overloaded.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

Selected by: LineSelector

The feature documentation may provide more information.

Public propertyStatic memberBslMultipleROIColumnOffset

Horizontal offset of the currently selected column.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

Selected by: BslMultipleROIColumnSelector

The feature documentation may provide more information.

Public propertyStatic memberBslMultipleROIColumnSelector

Sets which column can be configured.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

Selecting Parameters: BslMultipleROIColumnOffset, BslMultipleROIColumnSize

The feature documentation may provide more information.

Public propertyStatic memberBslMultipleROIColumnsEnable

Enables or disables the ability to define multiple regions in horizontal direction. When disabled, the width and horizontal offset of all regions is defined by the Width and Offset X parameters, and the Multiple ROI Column Offset and Multiple ROI Column Size parameter values are ignored.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslMultipleROIColumnSize

Width of the currently selected column.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

Selected by: BslMultipleROIColumnSelector

The feature documentation may provide more information.

Public propertyStatic memberBslMultipleROIRowOffset

Vertical offset of the currently selected row.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

Selected by: BslMultipleROIRowSelector

The feature documentation may provide more information.

Public propertyStatic memberBslMultipleROIRowSelector

Sets which row can be configured.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

Selecting Parameters: BslMultipleROIRowOffset, BslMultipleROIRowSize

The feature documentation may provide more information.

Public propertyStatic memberBslMultipleROIRowsEnable

Enables or disables the ability to define multiple regions in vertical direction. When disabled, the height and vertical offset of all regions is defined by the Height and Offset Y parameters, and the Multiple ROI Row Offset and Multiple ROI Row Size parameter values are ignored.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslMultipleROIRowSize

Height of the currently selected row.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

Selected by: BslMultipleROIRowSelector

The feature documentation may provide more information.

Public propertyStatic memberBslNoiseReduction

Amount of noise reduction to be applied. The higher the value, the less chroma noise will be visible in your images. However, very high values may result in image information loss.

Applies to: ace 2 GigE, ace 2 USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslPeriodicSignalDelay

Delay to be applied to the periodic signal in microseconds.

Applies to: ace 2 GigE

Visibility: Expert

Selected by: BslPeriodicSignalSelector

The feature documentation may provide more information.

Public propertyStatic memberBslPeriodicSignalPeriod

Length of the periodic signal in microseconds.

Applies to: ace 2 GigE

Visibility: Expert

Selected by: BslPeriodicSignalSelector

The feature documentation may provide more information.

Public propertyStatic memberBslPeriodicSignalSelector

Sets the periodic signal channel to be configured.

Applies to: ace 2 GigE

Visibility: Expert

Selecting Parameters: BslPeriodicSignalDelay, BslPeriodicSignalPeriod, BslPeriodicSignalSource

The feature documentation may provide more information.

Public propertyStatic memberBslPeriodicSignalSource

Sets the source for synchronizing the periodic signal.

Applies to: ace 2 GigE

Visibility: Expert

Selected by: BslPeriodicSignalSelector

The feature documentation may provide more information.

Public propertyStatic memberBslPtpDelayMechanism

Indicates the PTP delay mechanism.

Applies to: ace 2 GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslPtpManagementEnable

Enables PTP management.

Applies to: ace 2 GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslPtpNetworkMode

Sets the mode for PTP network communication.

Applies to: ace 2 GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslPtpPriority1

Value indicating the priority of the device when determining the master clock. The network device with the lowest Priority 1 setting is the master clock.

Applies to: ace 2 GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslPtpProfile

Sets the default PTP profile.

Applies to: ace 2 GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslPtpTwoStep

Configures a two-step clock if enabled or a one-step clock if disabled.

Applies to: ace 2 GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslPtpUcPortAddr

Unicast port address.

Applies to: ace 2 GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslPtpUcPortAddrIndex

Unicast port address index.

Applies to: ace 2 GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslResultingAcquisitionFrameRate

Maximum number of frames that can be acquired per second with current camera settings. In High Speed burst mode, this value is usually higher than the Resulting Transfer Frame Rate parameter value.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslResultingFrameBurstRate

Maximum number of bursts per second with current camera settings.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslResultingTransferFrameRate

Maximum number of frames that can be transferred per second with current camera settings. This value indicates the peak frame rate to be expected at the camera's output. In High Speed burst mode, this value is usually lower than the Resulting Acquisition Frame Rate parameter value.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslSaturation

Adjusting the saturation changes the colorfulness (intensity) of the colors. A higher saturation, for example, makes colors easier to distinguish.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSaturationRaw

Adjusting the saturation changes the colorfulness (intensity) of the colors. A higher saturation, for example, makes colors easier to distinguish.

Applies to: GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSaturationValue

Adjusting the saturation changes the colorfulness (intensity) of the colors. A higher saturation, for example, makes colors easier to distinguish.

Applies to: dart USB and pulse USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslScalingFactor

Scaling factor to be applied to all images. Scaling is performed using the Pixel Beyond feature.

Applies to: ace 2 GigE, ace 2 USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSensorBitDepth

Sets the bit depth of the image sensor's data output. You can set the sensor bit depth independently of the pixel format used if the Sensor Bit Depth Mode parameter is set to Manual. If that parameter is set to Auto, the sensor bit depth is adjusted automatically depending on the pixel format used.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSensorBitDepthMode

Sets the sensor bit depth mode.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSensorOff

Switches the sensor power off.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSensorOn

Switches the sensor power on.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSensorStandby

Puts the sensor in standby mode. In standby mode, power consumption is reduced significantly, which results in a lower camera temperature. Certain parameters can only be configured when the sensor is in standby mode.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSensorState

Returns the current power state of the sensor.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSerialBaudRate

Sets the baud rate used in serial communication.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSerialNumberOfDataBits

Sets the number of data bits used in serial communication.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSerialNumberOfStopBits

Sets the number of stop bits used in serial communication.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSerialParity

Sets which kind of parity check is performed.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSerialReceive

Initiates a receiving transaction from the serial input buffer. When the transaction has been completed, the Serial Transfer Length parameter indicates the number of valid data units received.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSerialRxBreak

Indicates the incoming break signal status.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSerialRxBreakReset

Resets the incoming break status.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSerialRxFifoOverflow

Indicates the overflow status of the receiving FIFO.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSerialRxParityError

Indicates the parity error status of the receiving FIFO.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSerialRxSource

Sets the source of the Rx serial input.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSerialRxStopBitError

Indicates the stop bit error status of the receiving FIFO.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSerialTransferBuffer

Buffer that holds Rx or Tx transfer data in the controller domain. Data is displayed in hexadecimal notation. Transfer starts with the leftmost data.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSerialTransferLength

Effective number of serial frames in a Rx or Tx data transfer. The maximum number of data frames is 16.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSerialTransmit

Initiates a transmitting transaction to the serial output buffer. Set the correct transfer length before you issue a transmit command.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSerialTxBreak

Signals a break to a receiver connected to the camera, or terminates the break. If this parameter is set to true, a serial break is signaled by setting the serial output to low level (space). If this parameter is set to false, the serial output is reset to high (mark).

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSerialTxFifoEmpty

Indicates whether the transmitting FIFO is empty.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSerialTxFifoOverflow

Indicates whether the transmitting FIFO has overflown.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslSharpnessEnhancement

Sharpening value to be applied. The higher the sharpness, the more distinct the image subject's contours will be. However, very high values may result in image information loss.

Applies to: ace 2 GigE, ace 2 USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslTemperatureMax

Indicates the maximum temperature the camera reached during operation.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslTemperatureStatus

Indicates the temperature state.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslTemperatureStatusErrorCount

Indicates how often the temperature state changed to Error.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslTransferBitDepth

Sets the bit depth used for internal image processing. Lowering the transfer bit depth increases the frame rate, but image quality may degrade.

Applies to: boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslTransferBitDepthMode

Sets the transfer bit depth mode.

Applies to: boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslTwiBitrate

Sets the bit rate for TWI communication.

Applies to: dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslTwiPullSclLow

Pulls SCL low, which is rarely needed. When SCL is pulled low, TWI communication isn't possible.

Applies to: dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslTwiPullSdaLow

Pulls SDA low, which is rarely needed. When SDA is pulled low, TWI communication isn't possible.

Applies to: dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslTwiRead

Triggers a read transfer.

Applies to: dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslTwiTargetAddress

Address of the target device.

Applies to: dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslTwiTransferBuffer

Buffer that holds data to be written or data that was read.

Applies to: dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslTwiTransferLength

Number of bytes to be transferred from or to the transfer buffer.

Applies to: dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslTwiTransferStatus

Indicates the status of an accepted read or write transfer.

Applies to: dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslTwiUpdateTransferStatus

Triggers an update of the transfer status.

Applies to: dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslTwiWrite

Triggers a write transfer.

Applies to: dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberBslUSBPowerSource

Indicates how power is supplied to the device.

Applies to: ace 2 USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberBslUSBSpeedMode

Indicates the speed mode of the USB port.

Applies to: ace 2 USB, ace USB, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslVignettingCorrectionLoad

Loads the vignetting correction data from the camera's file system and applies them to the camera.

Applies to: boost CoaXPress

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberBslVignettingCorrectionMode

Enables the vignetting correction. This feature allows you to remove vignetting artifacts from your images. To do this, you first have to create vignetting correction data. For more information, see the Basler Product Documentation.

Applies to: boost CoaXPress

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberCameraOperationMode

Sets the camera operation mode.

Applies to: ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberCenterX

Centers the image horizontally.

Applies to: CameraLink, GigE and ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberCenterY

Centers the image vertically.

Applies to: CameraLink, GigE and ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkCounterSelector

Sets which counter to retrieve chunk data from.

Applies to: ace 2 GigE, ace 2 USB, ace USB and dart 2 USB

Visibility: Expert

Selecting Parameters: ChunkCounterValue

The feature documentation may provide more information.

Public propertyStatic memberChunkCounterValue

Value of the selected chunk counter.

Applies to: ace 2 GigE, ace 2 USB, ace USB and dart 2 USB

Visibility: Beginner

Selected by: ChunkCounterSelector

The feature documentation may provide more information.

Public propertyStatic memberChunkDynamicRangeMax

Maximum possible pixel value in the acquired image.

Applies to: GigE and ace 2 GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkDynamicRangeMin

Minimum possible pixel value in the acquired image.

Applies to: GigE and ace 2 GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkEnable

Includes the currently selected chunk in the payload data.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB and dart 2 USB

Visibility: Beginner

Selected by: ChunkSelector

The feature documentation may provide more information.

Public propertyStatic memberChunkExposureTime

Exposure time used to acquire the image.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkFramecounter

Value of the Frame counter when the image was acquired.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkFrameID

Unique identifier of the current frame. The frame ID starts at 0 and keeps incrementing by 1 for each exposed image until the camera is powered off. The maximum value is 2^48.

Applies to: ace 2 GigE, ace 2 USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberChunkFramesPerTriggerCounter

Value of the Frames per Trigger counter when the image was acquired.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkFrameTriggerCounter

Value of the Frame Trigger counter when the image was acquired.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkFrameTriggerIgnoredCounter

Value of the Frame Trigger Ignored counter when the image was acquired.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkGain

Gain used during image acquisition.

Applies to: ace 2 GigE, ace 2 USB, ace USB and dart 2 USB

Visibility: Beginner

Selected by: ChunkGainSelector

The feature documentation may provide more information.

Public propertyStatic memberChunkGainAll

Gain All value of the acquired image.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkGainSelector

Sets which gain channel to retrieve chunk data from.

Applies to: ace USB

Visibility: Expert

Selecting Parameters: ChunkGain

The feature documentation may provide more information.

Public propertyStatic memberChunkHeight

AOI height of the acquired image.

Applies to: GigE and ace 2 GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkInputStatusAtLineTriggerBitsPerLine

Number of bits per line used for the Input Status At Line Trigger parameter.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkInputStatusAtLineTriggerIndex

Index number used for the Input Status At Line Trigger parameter. The index number can be used to get the state of the camera's input lines when a specific line was acquired. For example, if you want to know the state of the camera's input lines when line 30 was acquired, set the index to 30, then retrieve the value of Status Index parameter.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkInputStatusAtLineTriggerValue

Value indicating the status of the camera's input lines when a specific line was acquired. The information is stored in a 4-bit value (bit 0 = input line 1 state, bit 1 = input line 2 state etc.). For more information, see the Status Index parameter documentation.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkLineStatusAll

Bit field that indicates the status of all of the camera's input and output lines when the image was acquired.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkLineTriggerCounter

Value of the Line Trigger counter when the image was acquired.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkLineTriggerEndToEndCounter

Value of the Line Trigger End to End counter when the image was acquired.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkLineTriggerIgnoredCounter

Value of the Line Trigger Ignored counter when the image was acquired.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkModeActive

Enables the chunk mode.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkOffsetX

X offset of the AOI of the acquired image.

Applies to: GigE and ace 2 GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkOffsetY

Y offset of the AOI of the acquired image.

Applies to: GigE and ace 2 GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkPayloadCRC16

CRC checksum of the acquired image. The checksum is calculated using all of the image data and all of the appended chunks except for the checksum itself.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkPixelFormat

Indicates the pixel format of the acquired image.

Applies to: GigE and ace 2 GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkSelector

Sets which chunk can be enabled. The chunk can be enabled using the Chunk Enable parameter.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB and dart 2 USB

Visibility: Beginner

Selecting Parameters: ChunkEnable

The feature documentation may provide more information.

Public propertyStatic memberChunkSequencerSetActive

Index of the active sequencer set.

Applies to: ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkSequenceSetIndex

Sequence set index number related to the acquired image.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkShaftEncoderCounter

Value of the Shaft Encoder counter when the image was acquired.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkStride

Number of bytes of data between the beginning of one line in the acquired image and the beginning of the next line in the acquired image.

Applies to: GigE and ace 2 GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkTimestamp

Value of the timestamp when the image was acquired.

Applies to: GigE and ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkTriggerinputcounter

Value of the Trigger Input counter when the image was acquired.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkVirtLineStatusAll

Status of all of the camera's virtual input and output lines when the image was acquired.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberChunkWidth

Width of the AOI of the acquired image.

Applies to: GigE and ace 2 GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberClConfiguration

Sets the configuration type. The configuration type determines the amount of data that can be transmitted.

Applies to: CameraLink

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberClearLastError

Clears the last error. If a previous error exists, the previous error can still be retrieved.

Applies to: CameraLink, GigE and blaze

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberClInterLineDelayAbs

Delay (in microseconds) between the end of transmission of one line and the start of transmission of the next line. This value will be adjusted automatically to the nearest multiple of the currently selected pixel clock. The line valid signal (LVAL) remains low while the delay is in force. The default value of the parameter is the minimum inter-line delay.

Applies to: CameraLink

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberClInterLineDelayRaw

Delay between the end of transmission of one line and the start of transmission of the next line (raw value). This value will be adjusted automatically to the nearest multiple of the currently selected pixel clock. The line valid signal (LVAL) remains low while the delay is in force. The default value of the parameter is the minimum inter-line delay.

Applies to: CameraLink

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberClPixelClock

Sets the pixel clock used in the communication with the frame grabber. The pixel clock speed determines the rate at which pixel data will be transmitted from the camera to the frame grabber.

Applies to: CameraLink

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberClPixelClockAbs

Pixel clock used in the communication with the frame grabber in Hz.

Applies to: CameraLink

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberClSerialPortBaudRate

Sets the serial port baud rate.

Applies to: CameraLink

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberClTapGeometry

Sets the tap geometry. The tap geometry uniquely describes the geometrical properties characterizing the different taps of a multi-tap camera.

Applies to: CameraLink

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberClTimeSlots

Sets the number of time slots.

Applies to: CameraLink

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberColorAdjustmentEnable

Enables color adjustment.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberColorAdjustmentHue

Hue adjustment value to be applied to the currently selected color channel.

Applies to: CameraLink, GigE and ace USB

Visibility: Expert

Selected by: ColorAdjustmentSelector

The feature documentation may provide more information.

Public propertyStatic memberColorAdjustmentHueRaw

Hue adjustment value to be applied to the currently selected color channel (raw value).

Applies to: CameraLink and GigE

Visibility: Expert

Selected by: ColorAdjustmentSelector

The feature documentation may provide more information.

Public propertyStatic memberColorAdjustmentReset

Allows you to restore the color adjustment settings that were in force before the settings were last changed.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberColorAdjustmentSaturation

Saturation adjustment value to be applied to the currently selected color channel.

Applies to: CameraLink, GigE and ace USB

Visibility: Expert

Selected by: ColorAdjustmentSelector

The feature documentation may provide more information.

Public propertyStatic memberColorAdjustmentSaturationRaw

Saturation adjustment value to be applied to the currently selected color channel (raw value).

Applies to: CameraLink and GigE

Visibility: Expert

Selected by: ColorAdjustmentSelector

The feature documentation may provide more information.

Public propertyStatic memberColorAdjustmentSelector

Sets which color in your images will be adjusted.

Applies to: CameraLink, GigE and ace USB

Visibility: Expert

Selecting Parameters: ColorAdjustmentHue, ColorAdjustmentHueRaw, ColorAdjustmentSaturation, ColorAdjustmentSaturationRaw

The feature documentation may provide more information.

Public propertyStatic memberColorOverexposureCompensationAOIEnable

Enables color overexposure compensation.

Applies to: CameraLink and GigE

Visibility: Beginner

Selected by: ColorOverexposureCompensationAOISelector

The feature documentation may provide more information.

Public propertyStatic memberColorOverexposureCompensationAOIFactor

Sets the color overexposure compensation factor controlling the extent of compensation for the selected C.O.C. AOI.

Applies to: CameraLink and GigE

Visibility: Guru

Selected by: ColorOverexposureCompensationAOISelector

The feature documentation may provide more information.

Public propertyStatic memberColorOverexposureCompensationAOIFactorRaw

Sets the raw value for the color overexposure compensation factor.

Applies to: CameraLink and GigE

Visibility: Guru

Selected by: ColorOverexposureCompensationAOISelector

The feature documentation may provide more information.

Public propertyStatic memberColorOverexposureCompensationAOIHeight

Sets the height for the selected Color Overexposure Compensation AOI.

Applies to: CameraLink and GigE

Visibility: Guru

Selected by: ColorOverexposureCompensationAOISelector

The feature documentation may provide more information.

Public propertyStatic memberColorOverexposureCompensationAOIOffsetX

Sets the horizontal offset for the selected Color Overexposure Compensation AOI.

Applies to: CameraLink and GigE

Visibility: Guru

Selected by: ColorOverexposureCompensationAOISelector

The feature documentation may provide more information.

Public propertyStatic memberColorOverexposureCompensationAOIOffsetY

Sets the vertical offset for the selected Color Overexposure Compensation AOI.

Applies to: CameraLink and GigE

Visibility: Guru

Selected by: ColorOverexposureCompensationAOISelector

The feature documentation may provide more information.

Public propertyStatic memberColorOverexposureCompensationAOISelector

Selcts the area of interest where color overexposure compensation will be performed.

Applies to: CameraLink and GigE

Visibility: Guru

Selecting Parameters: ColorOverexposureCompensationAOIEnable, ColorOverexposureCompensationAOIFactor, ColorOverexposureCompensationAOIFactorRaw, ColorOverexposureCompensationAOIHeight, ColorOverexposureCompensationAOIOffsetX, ColorOverexposureCompensationAOIOffsetY, ColorOverexposureCompensationAOIWidth

The feature documentation may provide more information.

Public propertyStatic memberColorOverexposureCompensationAOIWidth

Sets the width for the selected Color Overexposure Compensation AOI.

Applies to: CameraLink and GigE

Visibility: Guru

Selected by: ColorOverexposureCompensationAOISelector

The feature documentation may provide more information.

Public propertyStatic memberColorSpace

Sets the color space for image acquisitions. Note that the gamma correction value also influences the perception of brightness in the resulting images.

Applies to: ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberColorTransformationEnable

Enables color transformation.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Expert

Selected by: ColorTransformationSelector

The feature documentation may provide more information.

Public propertyStatic memberColorTransformationMatrixFactor

Extent to which the color matrix influences the color values. If set to 0, the matrix is effectively disabled.

Applies to: CameraLink and GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberColorTransformationMatrixFactorRaw

Extent to which the color matrix influences the color values (raw value). If set to 0, the matrix is effectively disabled.

Applies to: CameraLink and GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberColorTransformationSelector

Sets which type of color transformation will be performed.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB and boost CoaXPress

Visibility: Expert

Selecting Parameters: ColorTransformationEnable, ColorTransformationValue, ColorTransformationValueSelector, LightSourceSelector

The feature documentation may provide more information.

Public propertyStatic memberColorTransformationValue

Transformation value for the selected element in the color transformation matrix.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB and boost CoaXPress

Visibility: Expert

Selected by: ColorTransformationSelector, ColorTransformationValueSelector

The feature documentation may provide more information.

Public propertyStatic memberColorTransformationValueRaw

Transformation value for the selected element in the color transformation matrix (raw value).

Applies to: CameraLink and GigE

Visibility: Guru

Selected by: ColorTransformationValueSelector

The feature documentation may provide more information.

Public propertyStatic memberColorTransformationValueSelector

Sets which element will be entered in the color transformation matrix. Depending on the camera model, some elements in the color transformation matrix may be preset and can't be changed.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB and boost CoaXPress

Visibility: Expert

Selected by: ColorTransformationSelector

Selecting Parameters: ColorTransformationValue, ColorTransformationValueRaw

The feature documentation may provide more information.

Public propertyStatic memberComponentEnable

Controls if the selected component streaming is active.

Applies to: blaze

Visibility: Beginner

Selected by: ComponentSelector

The feature documentation may provide more information.

Public propertyStatic memberComponentSelector

Selects a component to activate/deactivate its data streaming.

Applies to: blaze

Visibility: Beginner

Selecting Parameters: ComponentEnable, PixelFormat

The feature documentation may provide more information.

Public propertyStatic memberConfidenceThreshold

Pixels have to exceed the confidence value specified here in order to be taken into account for the distance measurement. The threshold value is based on the gray values of the confidence map.

Applies to: blaze

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberCounterDuration

Number of times a sequencer set is used before the Counter End event is generated.

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Expert

Selected by: CounterSelector

The feature documentation may provide more information.

Public propertyStatic memberCounterEventActivation

Sets the type of signal transition that the counter will count.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Expert

Selected by: CounterSelector

The feature documentation may provide more information.

Public propertyStatic memberCounterEventSource

Sets which event increases the currently selected counter.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

Selected by: CounterSelector

The feature documentation may provide more information.

Public propertyStatic memberCounterReset

Immediately resets the selected counter. The counter starts counting again immediately after the reset.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

Selected by: CounterSelector

The feature documentation may provide more information.

Public propertyStatic memberCounterResetActivation

Sets which type of signal transition will reset the counter.

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

Selected by: CounterSelector

The feature documentation may provide more information.

Public propertyStatic memberCounterResetSource

Sets which source signal will reset the currently selected counter.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

Selected by: CounterSelector

The feature documentation may provide more information.

Public propertyStatic memberCounterSelector

Sets which counter can be configured. All changes to the counter settings will be applied to the selected counter.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

Selecting Parameters: CounterDuration, CounterEventActivation, CounterEventSource, CounterReset, CounterResetActivation, CounterResetSource, CounterStatus, CounterTriggerActivation, CounterTriggerSource, CounterValue

The feature documentation may provide more information.

Public propertyStatic memberCounterStatus

Returns the current status of the counter.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Expert

Selected by: CounterSelector

The feature documentation may provide more information.

Public propertyStatic memberCounterTriggerActivation

Sets the type of signal transition that will start the counter.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Expert

Selected by: CounterSelector

The feature documentation may provide more information.

Public propertyStatic memberCounterTriggerSource

Sets the signal used to start the selected counter. If you start a counter, it will not necessarily start counting. If and when the counter counts, depends on the Counter Event Source parameter value.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Expert

Selected by: CounterSelector

The feature documentation may provide more information.

Public propertyStatic memberCounterValue

Current value of the counter.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Expert

Selected by: CounterSelector

The feature documentation may provide more information.

Public propertyStatic memberCriticalTemperature

Indicates whether the critical temperature has been reached.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberCriticalTemperatureEventStreamChannelIndex

Stream channel index of the Critical Temperature event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberCriticalTemperatureEventTimestamp

Timestamp of the Critical Temperature event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberCxpConnectionSelector

Sets the CoaXPress physical connection to control.

Applies to: boost CoaXPress

Visibility: Expert

Selecting Parameters: CxpConnectionTestErrorCount, CxpConnectionTestMode, CxpErrorCounterSelector, CxpSendReceiveSelector

The feature documentation may provide more information.

Public propertyStatic memberCxpConnectionTestErrorCount

Number of test packet connection errors received by the device on the connection selected by the Connection Selector parameter.

Applies to: boost CoaXPress

Visibility: Expert

Selected by: CxpConnectionSelector

The feature documentation may provide more information.

Public propertyStatic memberCxpConnectionTestMode

Sets the test mode for an individual physical connection of the device.

Applies to: boost CoaXPress

Visibility: Expert

Selected by: CxpConnectionSelector

The feature documentation may provide more information.

Public propertyStatic memberCxpConnectionTestPacketCount

Number of test packets received by the device on the connection selected by the Cxp Connection Selector parameter.

Applies to: boost CoaXPress

Visibility: Expert

Selected by: CxpSendReceiveSelector

The feature documentation may provide more information.

Public propertyStatic memberCxpErrorCounterReset

Resets the selected CoaXPress error counter.

Applies to: boost CoaXPress

Visibility: Expert

Selected by: CxpErrorCounterSelector

The feature documentation may provide more information.

Public propertyStatic memberCxpErrorCounterSelector

Sets which CoaXPress error counter to read or reset.

Applies to: boost CoaXPress

Visibility: Expert

Selected by: CxpConnectionSelector

Selecting Parameters: CxpErrorCounterReset, CxpErrorCounterStatus, CxpErrorCounterValue

The feature documentation may provide more information.

Public propertyStatic memberCxpErrorCounterStatus

Indicates the current status of the selected CoaXPress error counter.

Applies to: boost CoaXPress

Visibility: Expert

Selected by: CxpErrorCounterSelector

The feature documentation may provide more information.

Public propertyStatic memberCxpErrorCounterValue

Current value of the selected CoaXPress error counter.

Applies to: boost CoaXPress

Visibility: Expert

Selected by: CxpErrorCounterSelector

The feature documentation may provide more information.

Public propertyStatic memberCxpLinkConfiguration

Sets the link configuration.

Applies to: boost CoaXPress

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberCxpLinkConfigurationPreferred

Sets the link configuration that allows the device to operate in its default mode.

Applies to: boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberCxpLinkConfigurationStatus

Indicates the link configuration used by the device.

Applies to: boost CoaXPress

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberCxpSendReceiveSelector

Sets whether the send or the receive features can be configured.

Applies to: boost CoaXPress

Visibility: Expert

Selected by: CxpConnectionSelector

Selecting Parameters: CxpConnectionTestPacketCount

The feature documentation may provide more information.

Public propertyStatic memberDecimationHorizontal

Horizontal decimation factor. This specifies the extent of horizontal sub-sampling of the acquired frame, i.e., it defines how many pixel columns are left out of transmission. This has the net effect of reducing the horizontal resolution (width) of the image by the specified decimation factor. A value of 1 means that the camera performs no horizontal decimation.

Applies to: CameraLink, GigE and ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDecimationVertical

Vertical decimation factor. This specifies the extent of vertical sub-sampling of the acquired frame, i.e., it defines how many rows are left out of transmission. This has the net effect of reducing the vertical resolution (height) of the image by the specified decimation factor. A value of 1 means that the camera performs no vertical decimation.

Applies to: CameraLink, GigE and ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDefectPixelCorrectionMode

Identifies pixels that have a significantly greater or lesser intensity value than its neighboring pixels (outlier pixels) and adjusts their intensity value.

Applies to: dart USB and pulse USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberDemosaicingMode

Sets the demosaicing mode.

Applies to: GigE and ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDepthMax

The Minimum Depth and the Maximum Depth parameters together define the desired three-dimensional ROI. In the point cloud display, points outside the ROI will be ignored. When using the Mono16 or RGB8 pixel formats, points in front of the ROI receive the minimum distance value, while points beyond the ROI receive the maximum distance value.

Applies to: blaze

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDepthMin

The Minimum Depth and the Maximum Depth parameters together define the desired three-dimensional ROI. In the point cloud display, points outside the ROI will be ignored. When using the Mono16 or RGB8 pixel formats, points in front of the ROI receive the minimum distance value, while points beyond the ROI receive the maximum distance value.

Applies to: blaze

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceCharacterSet

Indicates the character set used by the strings of the device's bootstrap registers.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberDeviceColorPipelineVersion

Version of the color modifications applied to images.

Applies to: GigE and ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceEventChannelCount

Indicates the number of event channels supported by the device.

Applies to: blaze

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberDeviceFamilyName

Identifier of the product family of the device.

Applies to: ace 2 GigE, ace 2 USB, blaze, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceFeaturePersistenceEnd

Disables feature streaming on the device. Feature streaming allows you to save camera settings outside of the device.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberDeviceFeaturePersistenceStart

Enables feature streaming on the device. Feature streaming allows you to save camera settings outside of the device.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberDeviceFirmwareVersion

Version of the camera's firmware.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceGenCPVersionMajor

Major version of the GenCP protocol supported by the device.

Applies to: ace 2 USB and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceGenCPVersionMinor

Minor version of the GenCP protocol supported by the device.

Applies to: ace 2 USB and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceID

ID of the camera.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceIndicatorMode

Sets the behavior of the camera's status LED.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress, dart 2 USB and dart USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberDeviceLinkConnectionCount

Returns the number of physical connection of the device used by a particular Link.

Applies to: blaze

Visibility: Beginner

Selected by: DeviceLinkSelector

The feature documentation may provide more information.

Public propertyStatic memberDeviceLinkCurrentThroughput

Actual bandwidth (in bytes per second) that the camera will use to transmit image data and chunk data with the current camera settings.

Applies to: ace USB

Visibility: Expert

Selected by: DeviceLinkSelector

The feature documentation may provide more information.

Public propertyStatic memberDeviceLinkSelector

Device link to be configured.

Applies to: ace USB, blaze, dart USB and pulse USB

Visibility: Beginner

Selecting Parameters: DeviceLinkConnectionCount, DeviceLinkCurrentThroughput, DeviceLinkSpeed, DeviceLinkThroughputLimit, DeviceLinkThroughputLimitMode

The feature documentation may provide more information.

Public propertyStatic memberDeviceLinkSpeed

Speed of transmission negotiated on the selected link.

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Expert

Selected by: DeviceLinkSelector

The feature documentation may provide more information.

Public propertyStatic memberDeviceLinkThroughputLimit

Bandwidth limit for data transmission (in bytes per second).

Applies to: ace 2 GigE, ace 2 USB, ace USB, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: DeviceLinkSelector

The feature documentation may provide more information.

Public propertyStatic memberDeviceLinkThroughputLimitMode

Enables/disables the device link throughput limit. If disabled, the bandwidth used is determined by the settings of various other parameters, e.g., exposure time or frame rate.

Applies to: ace 2 GigE, ace 2 USB, ace USB, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: DeviceLinkSelector

The feature documentation may provide more information.

Public propertyStatic memberDeviceManifestPrimaryURL

First URL to the GenICam XML device description file of the selected manifest entry.

Applies to: ace 2 GigE and boost CoaXPress

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberDeviceManifestSchemaMajorVersion

Major version number of the schema file of the selected manifest entry.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberDeviceManifestSchemaMinorVersion

Minor version number of the schema file of the selected manifest entry.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberDeviceManifestXMLMajorVersion

Major version number of the GenICam XML file of the selected manifest entry.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberDeviceManifestXMLMinorVersion

Minor version number of the GenICam XML file of the selected manifest entry.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberDeviceManifestXMLSubMinorVersion

Subminor version number of the GenICam XML file of the selected manifest entry.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberDeviceManufacturerInfo

Additional information from the vendor about the camera.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceModelName

Name of the camera model.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceRegistersEndianness

Endianness of the registers of the device.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberDeviceRegistersStreamingEnd

Announces the end of feature streaming.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberDeviceRegistersStreamingStart

Prepares the camera for feature streaming.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberDeviceReset

Immediately resets and restarts the camera.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceScanType

Indicates the scan type of the camera's sensor (area or line scan).

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceSerialNumber

Serial number of the camera.

Applies to: ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceSFNCVersionMajor

Major version number of the Standard Features Naming Convention (SFNC) specification that the camera is compatible with.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceSFNCVersionMinor

Minor version number of the Standard Features Naming Convention (SFNC) specification that the camera is compatible with.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceSFNCVersionSubMinor

Subminor version number of the Standard Features Naming Convention (SFNC) specification that the camera is compatible with.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceStreamChannelCount

Indicates the number of streaming channels supported by the device.

Applies to: blaze

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberDeviceTapGeometry

Sets the tap geometry. The tap geometry uniquely describes the geometrical properties characterizing the different taps of a multi-tap camera.

Applies to: boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberDeviceTemperature

Temperature at the selected location in the camera (in degrees centigrade). The temperature is measured at the location specified by the Device Temperature Selector parameter.

Applies to: ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress and dart 2 USB

Visibility: Expert

Selected by: DeviceTemperatureSelector

The feature documentation may provide more information.

Public propertyStatic memberDeviceTemperatureSelector

Sets the location in the camera where the temperature will be measured. The temperature can be retrieved using the Device Temperature parameter.

Applies to: ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress and dart 2 USB

Visibility: Expert

Selecting Parameters: DeviceTemperature

The feature documentation may provide more information.

Public propertyStatic memberDeviceTLType

Indicates the type of the device's transport layer.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceTLVersionMajor

Major version number of the device's transport layer.

Applies to: ace 2 GigE, ace 2 USB, blaze, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceTLVersionMinor

Minor version number of the device's transport layer.

Applies to: ace 2 GigE, ace 2 USB, blaze, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceTLVersionSubMinor

Subminor version number of the device's transport layer.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceType

Returns the device type.

Applies to: blaze

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberDeviceUserID

User-settable ID of the camera.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceVendorName

Name of the camera vendor.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDeviceVersion

Version of the camera.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberDigitalShift

Digital shift allows you to multiply the pixel values in an image. This increases the brightness of the image. If the parameter is set to zero, digital shift is disabled.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberEnableBurstAcquisition

Enables Burst Acquisition. If enabled, the maximum frame rate only depends on the sensor timing and the timing of the trigger sequence. The image transfer rate out of the camera has no influence on the frame rate.

Applies to: CameraLink and GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberEventActionLate

Unique identifier of the Action Late event. Use this parameter to get notified when the event occurs.

Applies to: ace 2 GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventActionLateTimestamp

Timestamp of the Action Late event. An Action Late event is raised when a scheduled action command with a timestamp in the past is received.

Applies to: ace 2 GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventCriticalTemperature

Unique identifier of the Critical Temperature event. Use this parameter to get notified when the event occurs.

Applies to: ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberEventCriticalTemperatureTimestamp

Timestamp of the Critical Temperature event.

Applies to: ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberEventExposureEnd

Unique identifier of the Exposure End event. Use this parameter to get notified when the event occurs.

Applies to: ace 2 GigE, ace 2 USB, ace USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventExposureEndFrameID

Frame ID of the Exposure End event.

Applies to: ace 2 GigE, ace 2 USB, ace USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventExposureEndTimestamp

Timestamp of the Exposure End event.

Applies to: ace 2 GigE, ace 2 USB, ace USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventFrameBufferOverrun

Unique identifier of the Frame Buffer Overrun event.

Applies to: ace 2 GigE and ace 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventFrameBufferOverrunTimestamp

Timestamp of the Frame Buffer Overrun event.

Applies to: ace 2 GigE and ace 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventFrameBurstStart

Unique identifier of the Frame Burst Start event. Use this parameter to get notified when the event occurs.

Applies to: ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventFrameBurstStartFrameID

Frame ID of the Frame Burst Start event.

Applies to: ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventFrameBurstStartOvertrigger

Unique identifier of the Frame Burst Start Overtrigger event. Use this parameter to get notified when the event occurs.

Applies to: ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventFrameBurstStartOvertriggerFrameID

Frame ID of the Frame Burst Start Overtrigger event.

Applies to: ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventFrameBurstStartOvertriggerTimestamp

Timestamp of the Frame Burst Start Overtrigger event.

Applies to: ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventFrameBurstStartTimestamp

Timestamp of the Frame Burst Start event.

Applies to: ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventFrameBurstStartWait

Unique identifier of the Frame Burst Start Wait event. Use this parameter to get notified when the event occurs.

Applies to: ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberEventFrameBurstStartWaitTimestamp

Timestamp of the Frame Burst Start Wait event.

Applies to: ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberEventFrameStart

Unique identifier of the Frame Start event. Use this parameter to get notified when the event occurs.

Applies to: ace 2 GigE, ace 2 USB, ace USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventFrameStartFrameID

Frame ID of the Frame Start event.

Applies to: ace 2 GigE, ace 2 USB, ace USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventFrameStartOvertrigger

Unique identifier of the Frame Start Overtrigger event. Use this parameter to get notified when the event occurs.

Applies to: ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventFrameStartOvertriggerFrameID

Frame ID of the Frame Start Overtrigger event.

Applies to: ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventFrameStartOvertriggerTimestamp

Timestamp of the Frame Start Overtrigger event.

Applies to: ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventFrameStartTimestamp

Timestamp of the Frame Start event.

Applies to: ace 2 GigE, ace 2 USB, ace USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventFrameStartWait

Unique identifier of the Frame Start Wait event. Use this parameter to get notified when the event occurs.

Applies to: ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberEventFrameStartWaitTimestamp

Timestamp of the Frame Start Wait event.

Applies to: ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberEventFrameTriggerMissed

Unique identifier of the Frame Trigger Missed event. Use this parameter to get notified when the event occurs.

Applies to: ace 2 GigE, ace 2 USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventFrameTriggerMissedTimestamp

Timestamp of the Frame Trigger Missed event.

Applies to: ace 2 GigE, ace 2 USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventNotification

Enables event notifications for the currently selected event. The event can selected using the Event Selector parameter.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB and dart 2 USB

Visibility: Beginner

Selected by: EventSelector

The feature documentation may provide more information.

Public propertyStatic memberEventOverrun

Unique identifier of the Event Overrun event. Use this parameter to get notified when the event occurs.

Applies to: ace 2 GigE, ace 2 USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventOverrunEventFrameID

Frame ID of the Event Overrun event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberEventOverrunEventStreamChannelIndex

Stream channel index of the Event Overrun event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberEventOverrunEventTimestamp

Timestamp of the Event Overrun event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberEventOverrunTimestamp

Timestamp of the Event Overrun event.

Applies to: ace 2 GigE, ace 2 USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventOverTemperature

Unique identifier of the Over Temperature event. Use this parameter to get notified when the event occurs.

Applies to: ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberEventOverTemperatureTimestamp

Timestamp of the Over Temperature event.

Applies to: ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberEventSelector

Sets the event notification to be enabled. The notification can be enabled using the Event Notification parameter.

Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB and dart 2 USB

Visibility: Beginner

Selecting Parameters: EventNotification

The feature documentation may provide more information.

Public propertyStatic memberEventTemperatureStatusChanged

Unique identifier of the Temperature Status Changed event. Use this parameter to get notified when the event occurs.

Applies to: ace 2 GigE, ace 2 USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventTemperatureStatusChangedStatus

New temperature status that applies after the Temperature Status Changed event was raised.

Applies to: ace 2 GigE, ace 2 USB and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberEventTemperatureStatusChangedTimestamp

Timestamp of the Temperature Status Changed event.

Applies to: ace 2 GigE, ace 2 USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventTest

Unique identifier of the Test event. Use this parameter to get notified when the event occurs.

Applies to: ace 2 GigE, ace 2 USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberEventTestTimestamp

Timestamp of the test event.

Applies to: ace 2 GigE, ace 2 USB and dart 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberExpertFeatureAccessKey

Key for making the selected expert feature available.

Applies to: CameraLink, GigE and ace USB

Visibility: Guru

Selected by: ExpertFeatureAccessSelector

The feature documentation may provide more information.

Public propertyStatic memberExpertFeatureAccessSelector

Sets the expert feature to be made available. All changes will be applied to the selected feature.

Applies to: CameraLink, GigE and ace USB

Visibility: Guru

Selecting Parameters: ExpertFeatureAccessKey, ExpertFeatureEnable

The feature documentation may provide more information.

Public propertyStatic memberExpertFeatureEnable

Enables the currently selected expert feature.

Applies to: CameraLink, GigE and ace USB

Visibility: Guru

Selected by: ExpertFeatureAccessSelector

The feature documentation may provide more information.

Public propertyStatic memberExposureAuto

Sets the operation mode of the Exposure Auto auto function. The Exposure Auto auto function automatically adjusts the exposure time within set limits until a target brightness value has been reached.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberExposureEndEventFrameID

Frame ID of the Exposure End event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberExposureEndEventStreamChannelIndex

Stream channel index of the Exposure End event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberExposureEndEventTimestamp

Timestamp of the Exposure End event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberExposureMode

Sets the exposure mode.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberExposureOverlapTimeMax

Maximum overlap of the sensor exposure with sensor readout in Trigger Width exposure mode (in microseconds).

Applies to: ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberExposureOverlapTimeMaxAbs

Maximum overlap of the sensor exposure with sensor readout in Trigger Width exposure mode (in microseconds).

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberExposureOverlapTimeMaxRaw

Maximum overlap of the sensor exposure with sensor readout in Trigger Width exposure mode (raw value).

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberExposureOverlapTimeMode

Sets the exposure overlap time mode.

Applies to: GigE and ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberExposureStartDelayAbs

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberExposureStartDelayRaw

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberExposureTime

Exposure time of the camera in microseconds.

Applies to: ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberExposureTimeAbs

Exposure time of the camera in microseconds.

Applies to: CamEmu, CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberExposureTimeBaseAbs

Timebase (in microseconds) that the camera uses when the exposure time is specified using the Exposure Time (Raw) parameter.

Applies to: CamEmu, CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberExposureTimeBaseAbsEnable

Enables the use of the exposure timebase.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberExposureTimeMode

Sets the exposure time mode.

Applies to: GigE and ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberExposureTimeRaw

Exposure time of the camera (raw value). The actual exposure time equals the current Exposure Time (Raw) value multiplied with the current Exposure Timebase value.

Applies to: CamEmu, CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberFastMode

The fast mode can be used to achieve the maximum frame rate, but this reduces image quality and measurement accuracy.

Applies to: blaze

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberFeatureSet

Sets the default GenICam XML file. If the camera has multiple GenICam XML files, this parameter determines which of them is accessible to non-manifest-aware software.

Applies to: CameraLink and GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberFieldOutputMode

Selects the mode to output the fields.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberFileAccessBuffer

Access buffer for file operations. Basler advises against using this parameter. Use the appropriate feature for file access operations instead.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Guru

Selected by: FileSelector

The feature documentation may provide more information.

Public propertyStatic memberFileAccessLength

Number of bytes read from the file into the file access buffer or written to the file from the file access buffer. Basler advises against using this parameter. Use the appropriate feature for file access operations instead.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Guru

Selected by: FileOperationSelector, FileSelector

The feature documentation may provide more information.

Public propertyStatic memberFileAccessOffset

Number of bytes after which FileAccessLength bytes are read from the file into the file access buffer or are written to the file from the file access buffer. Basler advises against using this parameter. Use the appropriate feature for file access operations instead.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Guru

Selected by: FileOperationSelector, FileSelector

The feature documentation may provide more information.

Public propertyStatic memberFileOpenMode

Sets the access mode in which a file is opened in the camera. Basler advises against using this parameter. Use the appropriate feature for file access operations instead.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

Selected by: FileSelector

The feature documentation may provide more information.

Public propertyStatic memberFileOperationExecute

Executes the operation selected by File Operation Selector parameter. Basler advises against using this parameter. Use the appropriate feature for file access operations instead.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Guru

Selected by: FileOperationSelector, FileSelector

The feature documentation may provide more information.

Public propertyStatic memberFileOperationResult

File operation result. Basler advises against using this parameter. Use the appropriate feature for file access operations instead.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Guru

Selected by: FileOperationSelector, FileSelector

The feature documentation may provide more information.

Public propertyStatic memberFileOperationSelector

Sets the target operation for the currently selected file. Basler advises against using this parameter. Use the appropriate feature for file access operations instead.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Guru

Selected by: FileSelector

Selecting Parameters: FileAccessLength, FileAccessOffset, FileOperationExecute, FileOperationResult, FileOperationStatus

The feature documentation may provide more information.

Public propertyStatic memberFileOperationStatus

Indicates the file operation execution status. Basler advises against using this parameter. Use the appropriate feature for file access operations instead.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Guru

Selected by: FileOperationSelector, FileSelector

The feature documentation may provide more information.

Public propertyStatic memberFileSelector

Sets the target file in the camera. Basler advises against using this parameter. Use the appropriate feature for file access operations instead.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Guru

Selecting Parameters: FileAccessBuffer, FileAccessLength, FileAccessOffset, FileOpenMode, FileOperationExecute, FileOperationResult, FileOperationSelector, FileOperationStatus, FileSize

The feature documentation may provide more information.

Public propertyStatic memberFileSize

Size of the currently selected file in bytes. Basler advises against using this parameter. Use the appropriate feature for file access operations instead.

Applies to: CameraLink, GigE and ace USB

Visibility: Guru

Selected by: FileSelector

The feature documentation may provide more information.

Public propertyStatic memberFilterSpatial

The spatial noise filter uses the values of neighboring pixels to filter out noise in an image. It is based on the raw data of the image.

Applies to: blaze

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberFilterStrength

Strength of the temporal filter. The higher the value, the further back the memory of the filter reaches. High values can cause motion artifacts, while low values reduce the efficacy of the filter.

Applies to: blaze

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberFilterTemporal

The temporal noise filter uses the values of the same pixel at different points in time to filter out noise in an image. It is based on the depth data of the image.

Applies to: blaze

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberForceFailedBuffer

Marks the next buffer as a failed buffer.

Applies to: CamEmu

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberForceFailedBufferCount

Number of failed buffers to generate.

Applies to: CamEmu

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberFrameDuration

Total time required for exposing and reading out all subframes from the sensor.

Applies to: blaze

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberFrameStartEventStreamChannelIndex

Stream channel index of the Frame Start event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberFrameStartEventTimestamp

Timestamp of the Frame Start event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberFrameStartOvertriggerEventStreamChannelIndex

Stream channel index of the Frame Start Overtrigger event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberFrameStartOvertriggerEventTimestamp

Timestamp of the Frame Start Overtrigger event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberFrameStartWaitEventStreamChannelIndex

Stream channel index of the Frame Start Wait event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberFrameStartWaitEventTimestamp

Timestamp of the Frame Start Wait event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberFrameTimeoutAbs

Frame timeout in microseconds. If the timeout expires before a frame acquisition is complete, a partial frame will be delivered.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberFrameTimeoutEnable

Enables the frame timeout.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberFrameTimeoutEventStreamChannelIndex

Stream channel index of the Frame Timeout event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberFrameTimeoutEventTimestamp

Timestamp of the Frame Timeout event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberFrameWaitEventStreamChannelIndex

Stream channel index of the Frame Wait event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberFrameWaitEventTimestamp

Timestamp of the Frame Wait event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberFrequencyConverterInputSource

Sets the input source for the frequency converter module.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberFrequencyConverterMultiplier

Multiplication factor to be applied to the input signal frequency. The multiplication factor allows the generation of signals at higher frequencies.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberFrequencyConverterPostDivider

Post-divider value to decrease input signal frequency. Determines the frequency with which input signals received from the multiplier sub-module are passed on.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberFrequencyConverterPreDivider

Pre-divider value to decrease signal frequency. Determines the frequency with which input signals are passed to the multiplier sub-module.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberFrequencyConverterPreventOvertrigger

Enables overtriggering protection. This ensures that the multiplier sub-module doesn't generate too many signals within a certain amount of time.

Applies to: CameraLink and GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberFrequencyConverterSignalAlignment

Sets the signal transition relationships between the signals received from the pre-divider sub-module and the signals generated by the multiplier sub-module.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberGain

Value of the currently selected gain in dB.

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: GainSelector

The feature documentation may provide more information.

Public propertyStatic memberGainAbs

Sets the 'absolute' value of the selected gain control. The 'absolute' value is a float value that sets the selected gain control in dB.

Applies to: CameraLink and GigE

Visibility: Beginner

Selected by: GainSelector

The feature documentation may provide more information.

Public propertyStatic memberGainAuto

Sets the operation mode of the Gain Auto auto function. The Gain Auto auto function automatically adjusts the gain within set limits until a target brightness value has been reached.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: GainSelector

The feature documentation may provide more information.

Public propertyStatic memberGainRaw

Value of the currently selected gain (raw value).

Applies to: CamEmu, CameraLink and GigE

Visibility: Beginner

Selected by: GainSelector

The feature documentation may provide more information.

Public propertyStatic memberGainSelector

Sets the gain type to be adjusted. All changes to the Gain parameter will be applied to the selected gain type.

Applies to: CameraLink, GigE, ace USB, dart USB and pulse USB

Visibility: Beginner

Selecting Parameters: AutoGainLowerLimit, AutoGainUpperLimit, Gain, GainAbs, GainAuto, GainRaw

The feature documentation may provide more information.

Public propertyStatic memberGamma

Gamma correction to be applied. Gamma correction allows you to optimize the brightness of acquired images for display on a monitor.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberGammaCorrection

A nonlinear operation to lighten the dark regions of the image.

Applies to: blaze

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberGammaEnable

Enables gamma correction.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberGammaSelector

Sets the type of gamma to be applied.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberGenDCStreamingMode

Controls the device's streaming format.

Applies to: blaze

Visibility: Invisible

The feature documentation may provide more information.

Public propertyStatic memberGenDCStreamingStatus

Returns whether the current device data streaming format is GenDC. This value is conditioned by the GenDCStreamingMode.

Applies to: blaze

Visibility: Invisible

The feature documentation may provide more information.

Public propertyStatic memberGevCCP

Sets the control channel privilege.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevCurrentDefaultGateway

Current default gateway of the selected network interface.

Applies to: GigE and blaze

Visibility: Beginner

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevCurrentIPAddress

Current IP address of the selected network interface.

Applies to: GigE and blaze

Visibility: Beginner

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevCurrentIPConfiguration

Current IP configuration of the selected network interface, e.g., fixed IP, DHCP, or auto IP.

Applies to: GigE

Visibility: Guru

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevCurrentIPConfigurationDHCP

Controls whether the DHCP IP configuration scheme is activated on the given logical link.

Applies to: blaze

Visibility: Beginner

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevCurrentIPConfigurationLLA

Controls whether the Link Local Address IP configuration scheme is activated on the given logical link.

Applies to: blaze

Visibility: Beginner

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevCurrentIPConfigurationPersistentIP

Controls whether the PersistentIP configuration scheme is activated on the given logical link.

Applies to: blaze

Visibility: Beginner

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevCurrentSubnetMask

Current subnet mask of the selected network interface.

Applies to: GigE and blaze

Visibility: Beginner

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevDeviceModeCharacterSet

Character set used by all strings of the bootstrap registers (1 = UTF8).

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevDeviceModeIsBigEndian

Indicates whether the bootstrap register is in big-endian format.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevFirstURL

First URL reference to the GenICam XML file.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevGVSPExtendedIDMode

Sets the Extended ID mode for GVSP (64-bit block ID, 32-bit packet ID). This bit can't be reset if the stream channels do not support the standard ID mode.

Applies to: GigE

Visibility: Expert

Selected by: GevStreamChannelSelector

The feature documentation may provide more information.

Public propertyStatic memberGevHeartbeatTimeout

Heartbeat timeout in milliseconds.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevIEEE1588

Enables the IEEE 1588 V2 Precision Time Protocol for the timestamp register. Only available if the IEEE1588_support bit of the GVCP Capability register is set. When PTP is enabled, the Timestamp Control register can't be used to reset the timestamp. When PTP is enabled or disabled, the value of Timestamp Tick Frequency and Timestamp Value registers may change to reflect the new time domain.

Applies to: GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberGevIEEE1588ClockId

Latched IEEE 1588 clock ID of the camera. (The clock ID must first be latched using the IEEE 1588 Latch command.) The clock ID is an array of eight octets which is displayed as a hexadecimal number. Leading zeros are omitted.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevIEEE1588DataSetLatch

Latches the current IEEE 1588-related values of the camera.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberGevIEEE1588OffsetFromMaster

Latched offset from the IEEE 1588 master clock in nanoseconds. (The offset must first be latched using the IEEE 1588 Latch command.)

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevIEEE1588ParentClockId

Latched IEEE 1588 parent clock ID of the camera. (The parent clock ID must first be latched using the IEEE 1588 Latch command.) The parent clock ID is the clock ID of the current master clock. A clock ID is an array of eight octets which is displayed as a hexadecimal number. Leading zeros are omitted.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevIEEE1588Status

Indicates the state of the IEEE 1588 clock. Values of this field must match the IEEE 1588 PTP port state enumeration (INITIALIZING, FAULTY, DISABLED, LISTENING, PRE_MASTER, MASTER, PASSIVE, UNCALIBRATED, SLAVE).

Applies to: GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberGevIEEE1588StatusLatched

Indicates the latched state of the IEEE 1588 clock. (The state must first be latched using the IEEE 1588 Latch command.) The state is indicated by values 1 to 9, corresponding to the states INITIALIZING, FAULTY, DISABLED, LISTENING, PRE_MASTER, MASTER, PASSIVE, UNCALIBRATED, and SLAVE.

Applies to: GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberGevInterfaceSelector

Sets the physical network interface to be configured. All changes to the network interface settings will be applied to the selected interface.

Applies to: GigE

Visibility: Guru

Selecting Parameters: GevCurrentDefaultGateway, GevCurrentIPAddress, GevCurrentIPConfiguration, GevCurrentSubnetMask, GevLinkCrossover, GevLinkFullDuplex, GevLinkMaster, GevLinkSpeed, GevMACAddress, GevPersistentDefaultGateway, GevPersistentIPAddress, GevPersistentSubnetMask, GevSupportedIPConfigurationDHCP, GevSupportedIPConfigurationLLA, GevSupportedIPConfigurationPersistentIP, GevSupportedOptionalLegacy16BitBlockID

The feature documentation may provide more information.

Public propertyStatic memberGevLinkCrossover

Indicates the state of medium-dependent interface crossover (MDIX) for the selected network interface.

Applies to: GigE

Visibility: Guru

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevLinkFullDuplex

Indicates whether the selected network interface operates in full-duplex mode.

Applies to: GigE

Visibility: Guru

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevLinkMaster

Indicates whether the selected network interface is the clock master.

Applies to: GigE

Visibility: Guru

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevLinkSpeed

Connection speed in Mbps of the selected network interface.

Applies to: GigE

Visibility: Guru

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevMACAddress

MAC address of the selected network interface.

Applies to: GigE and blaze

Visibility: Beginner

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevMessageChannelCount

Number of message channels supported by the camera.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevNumberOfInterfaces

Number of network interfaces of the camera.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevPersistentDefaultGateway

Fixed default gateway of the selected network interface (if fixed IP addressing is supported by the camera and enabled).

Applies to: GigE and blaze

Visibility: Beginner

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevPersistentIPAddress

Fixed IP address of the selected network interface (if fixed IP addressing is supported by the camera and enabled).

Applies to: GigE and blaze

Visibility: Beginner

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevPersistentSubnetMask

Fixed subnet mask of the selected network interface (if fixed IP addressing is supported by the camera and enabled).

Applies to: GigE and blaze

Visibility: Beginner

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevPTPDiagnosticsQueueRxEvntMaxNumElements

This is a read only element. Maximum number of elements in RX event message queue. (The value must first be latched using the IEEE 1588 Latch command.)

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevPTPDiagnosticsQueueRxEvntPushNumFailure

This is a read only element. Number of push failures in RX event message queue. (The value must first be latched using the IEEE 1588 Latch command.)

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevPTPDiagnosticsQueueRxGnrlMaxNumElements

This is a read only element. Maximum number of elements in RX general message queue. (The value must first be latched using the IEEE 1588 Latch command.)

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevPTPDiagnosticsQueueRxGnrlPushNumFailure

This is a read only element. Number of push failures in RX general message queue. (The value must first be latched using the IEEE 1588 Latch command.)

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevPTPDiagnosticsQueueSendNumFailure

This is a read only element. Number of send failures. (The value must first be latched using the IEEE 1588 Latch command.)

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevSCBWA

Base bandwidth in bytes per second that will be used by the camera to transmit image and chunk feature data and to handle resends and control data transmissions.

Applies to: GigE

Visibility: Expert

Selected by: GevStreamChannelSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSCBWR

Percentage of the Ethernet bandwidth assigned to the camera to be held in reserve for packet resends and for the transmission of control data between the camera and the host computer. The setting is expressed as a percentage of the Bandwidth Assigned parameter. For example, if the Bandwidth Assigned parameter indicates that 30 MBytes/s have been assigned to the camera and the Bandwidth Reserve parameter is set to 5 %, the bandwidth reserve will be 1.5 MBytes/s.

Applies to: GigE and ace 2 GigE

Visibility: Expert

Selected by: GevStreamChannelSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSCBWRA

Multiplier for the Bandwidth Reserve parameter. The multiplier is used to establish an extra pool of reserved bandwidth that can be used if an unusually large burst of packet resends is needed.

Applies to: GigE and ace 2 GigE

Visibility: Expert

Selected by: GevStreamChannelSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSCDA

Destination address of the selected stream channel. The destination can be a unicast or a multicast address.

Applies to: GigE

Visibility: Guru

Selected by: GevStreamChannelSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSCDCT

Actual bandwidth (in bytes per second) that the camera will use to transmit image data and chunk data with the current settings for AOI, chunk features, and pixel format.

Applies to: GigE

Visibility: Expert

Selected by: GevStreamChannelSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSCDMT

Maximum amount of data (in bytes per second) that the camera can generate with its current settings under ideal conditions, i.e., unlimited bandwidth and no packet resends.

Applies to: GigE

Visibility: Expert

Selected by: GevStreamChannelSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSCFJM

Maximum amount of time (in ticks) that the next frame transmission could be delayed due to a burst of resends. If the Bandwidth Reserve Accumulation parameter is set to a high value, the camera can experience periods where there is a large burst of data resends. This burst of resends will delay the start of transmission of the next acquired image.

Applies to: GigE

Visibility: Expert

Selected by: GevStreamChannelSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSCFTD

Frame transmission delay on the selected stream channel (in ticks). This value sets a delay before transmitting the acquired image.

Applies to: GigE and ace 2 GigE

Visibility: Expert

Selected by: GevStreamChannelSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSCPD

Delay between the transmission of each packet on the selected stream channel. The delay is measured in ticks.

Applies to: GigE and ace 2 GigE

Visibility: Beginner

Selected by: GevStreamChannelSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSCPHostPort

Destination port of the selected stream channel.

Applies to: GigE

Visibility: Guru

Selected by: GevStreamChannelSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSCPInterfaceIndex

Index of the network interface to be used.

Applies to: GigE

Visibility: Guru

Selected by: GevStreamChannelSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSCPSBigEndian

Indicates the endianness of multi-byte pixel data for this stream. True equals big-endian.

Applies to: GigE

Visibility: Guru

Selected by: GevStreamChannelSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSCPSDoNotFragment

Disables IP fragmentation of packets on the stream channel. This bit is copied into the 'do not fragment' bit of the IP header of each stream packet.

Applies to: GigE

Visibility: Guru

Selected by: GevStreamChannelSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSCPSFireTestPacket

Sends a GigE Vision streaming test packet. If this bit is set and the stream channel is a transmitter, the transmitter will send one test packet of the size specified by the Packet Size parameter. The 'do not fragment' bit of the IP header must be set for this test packet (see the SCPS Do Not Fragment parameter documentation).

Applies to: GigE

Visibility: Guru

Selected by: GevStreamChannelSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSCPSPacketSize

Packet size in bytes on the selected stream channel. Excludes data leader and data trailer. (The last packet may be smaller because the packet size is not necessarily a multiple of the block size of the stream channel.)

Applies to: GigE, ace 2 GigE and blaze

Visibility: Beginner

Selected by: GevStreamChannelSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSecondURL

Second URL reference to the GenICam XML file.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevStreamChannelCount

Number of stream channels supported by the camera.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevStreamChannelSelector

Sets the stream channels to be configured. All changes to the stream channel settings will be applied to the selected stream channel.

Applies to: GigE

Visibility: Guru

Selecting Parameters: GevGVSPExtendedIDMode, GevSCBWA, GevSCBWR, GevSCBWRA, GevSCDA, GevSCDCT, GevSCDMT, GevSCFJM, GevSCFTD, GevSCPD, GevSCPHostPort, GevSCPInterfaceIndex, GevSCPSBigEndian, GevSCPSDoNotFragment, GevSCPSFireTestPacket, GevSCPSPacketSize

The feature documentation may provide more information.

Public propertyStatic memberGevSupportedIEEE1588

Indicates whether the IEEE 1588 V2 Precision Time Protocol (PTP) is supported.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevSupportedIPConfigurationDHCP

Indicates whether the selected network interface supports DHCP IP addressing.

Applies to: GigE

Visibility: Guru

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSupportedIPConfigurationLLA

Indicates whether the selected network interface supports auto IP addressing (also known as LLA).

Applies to: GigE

Visibility: Guru

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSupportedIPConfigurationPersistentIP

Indicates whether the selected network interface supports fixed IP addressing (also known as persistent IP addressing).

Applies to: GigE

Visibility: Guru

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevSupportedOptionalCommandsConcatenation

Indicates whether multiple operations in a single message are supported.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevSupportedOptionalCommandsEVENT

Indicates whether EVENT_CMD and EVENT_ACK are supported.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevSupportedOptionalCommandsEVENTDATA

Indicates whether EVENTDATA_CMD and EVENTDATA_ACK are supported.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevSupportedOptionalCommandsPACKETRESEND

Indicates whether PACKETRESEND_CMD is supported.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevSupportedOptionalCommandsWRITEMEM

Indicates whether WRITEMEM_CMD and WRITEMEM_ACK are supported.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevSupportedOptionalLegacy16BitBlockID

Indicates whether this GVSP transmitter or receiver can support a 16-bit block ID.

Applies to: GigE

Visibility: Guru

Selected by: GevInterfaceSelector

The feature documentation may provide more information.

Public propertyStatic memberGevTimestampControlLatch

Latches the current timestamp value of the camera.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevTimestampControlLatchReset

Resets the timestamp control latch.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevTimestampControlReset

Resets the timestamp value of the camera.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevTimestampTickFrequency

Number of timestamp clock ticks in 1 second.

Applies to: GigE, ace 2 GigE and blaze

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberGevTimestampValue

Latched value of the timestamp. (The timestamp must first be latched using the Timestamp Control Latch command.)

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevVersionMajor

Major version number of the GigE Vision specification supported by this camera.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGevVersionMinor

Minor version number of the GigE Vision specification supported by this camera.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberGrayValueAdjustmentDampingAbs

Gray value adjustment damping factor to be applied. This controls the speed with which pixel gray values are changed when Exposure Auto, Gain Auto, or both are enabled. This can be useful, for example, when objects move into the camera's field of view and the light conditions are changing gradually due to the moving objects.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberGrayValueAdjustmentDampingRaw

Gray value adjustment damping factor (raw value) to be applied. This controls the speed with which pixel gray values are changed when Exposure Auto, Gain Auto, or both are enabled. This can be useful, for example, when objects move into the camera's field of view and the light conditions are changing gradually due to the moving objects.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberHeight

Height of the camera's region of interest (area of interest) in pixels. Depending on the camera model, the parameter can be set in different increments.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberHeightMax

Maximum height of the region of interest (area of interest) in pixels. The value takes into account any features that may limit the maximum height, e.g., binning.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberImage1StreamID

Stream ID of the first image stream.

Applies to: boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberImageCompressionMode

Sets the image compression mode of the camera. The available image compression modes depend on the selected pixel format.

Applies to: ace 2 GigE and ace 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberImageCompressionRateOption

Configures the selected compression mechanism. The available options depend on the selected pixel format and the image compression mode.

Applies to: ace 2 GigE and ace 2 USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberImageFileMode

Enables loading files from disk for image acquisition.

Applies to: CamEmu

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberImageFilename

Enter the name of an image filename in a format supported by pylon or the path to a directory containing image files.

Applies to: CamEmu

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberIntensityCalculation

Sets the method for calculating the intensity data.

Applies to: blaze

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberInterlacedIntegrationMode

Selects the Interlaced Integration Mode.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberLastError

Indicates the last error code in the memory. To delete the last error code from the list of error codes, use the Clear Last Error command.

Applies to: CameraLink, GigE and blaze

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberLateActionEventStreamChannelIndex

Stream channel index of the Action Late event. An Action Late event is raised when a scheduled action command with a timestamp in the past is received.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberLateActionEventTimestamp

Timestamp of the Action Late event. An Action Late event is raised when a scheduled action command with a timestamp in the past is received.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberLegacyBinningVertical

Sets whether vertical binning is used.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberLightSourcePreset

Sets the light source preset. The colors in the image will be corrected so that they are appropriate for the selected light source.

Applies to: ace USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberLightSourceSelector

Sets the type of light source for which color transformation will be performed.

Applies to: CameraLink and GigE

Visibility: Expert

Selected by: ColorTransformationSelector

The feature documentation may provide more information.

Public propertyStatic memberLine1RisingEdgeEventStreamChannelIndex

Stream channel index of the Line 1 Rising Edge event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberLine1RisingEdgeEventTimestamp

Timestamp of the Line 1 Rising Edge event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberLine2RisingEdgeEventStreamChannelIndex

Stream channel index of the Line 2 Rising Edge event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberLine2RisingEdgeEventTimestamp

Timestamp of the Line 2 Rising Edge event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberLine3RisingEdgeEventStreamChannelIndex

Stream channel index of the Line 3 Rising Edge event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberLine3RisingEdgeEventTimestamp

Timestamp of the Line 3 Rising Edge event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberLine4RisingEdgeEventStreamChannelIndex

Stream channel index of the Line 4 Rising Edge event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberLine4RisingEdgeEventTimestamp

Timestamp of the Line 4 Rising Edge event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberLineDebouncerTime

Line debouncer time in microseconds. The Line Debouncer allows you to filter out invalid hardware signals by specifying a minimum signal length.

Applies to: ace USB and dart USB

Visibility: Beginner

Selected by: LineSelector

The feature documentation may provide more information.

Public propertyStatic memberLineDebouncerTimeAbs

Line debouncer time in microseconds. The Line Debouncer allows you to filter out invalid hardware signals by specifying a minimum signal length.

Applies to: CameraLink and GigE

Visibility: Beginner

Selected by: LineSelector

The feature documentation may provide more information.

Public propertyStatic memberLineFormat

Indicates the electrical configuration of the currently selected line.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB and dart USB

Visibility: Beginner

Selected by: LineSelector

The feature documentation may provide more information.

Public propertyStatic memberLineInverter

Enables the signal inverter function for the currently selected input or output line.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB and dart USB

Visibility: Beginner

Selected by: LineSelector

The feature documentation may provide more information.

Public propertyStatic memberLineLogic

Indicates the line logic of the currently selected line.

Applies to: CameraLink, GigE and ace USB

Visibility: Beginner

Selected by: LineSelector

The feature documentation may provide more information.

Public propertyStatic memberLineMinimumOutputPulseWidth

Minimum signal width of an output signal (in microseconds).

Applies to: ace USB

Visibility: Beginner

Selected by: LineSelector

The feature documentation may provide more information.

Public propertyStatic memberLineMode

Sets the mode for the selected line. This controls whether the physical line is used to input or output a signal.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB and dart USB

Visibility: Beginner

Selected by: LineSelector

The feature documentation may provide more information.

Public propertyStatic memberLineOverloadReset

This command resets the overload status of the selected line. If the overload condition is still fulfilled, the overload status will be set again immediately.

Applies to: ace USB

Visibility: Beginner

Selected by: LineSelector

The feature documentation may provide more information.

Public propertyStatic memberLineOverloadStatus

Indicates whether an overload condition has been detected on the selected line.

Applies to: ace USB

Visibility: Beginner

Selected by: LineSelector

The feature documentation may provide more information.

Public propertyStatic memberLinePitch

Number of bytes separating the starting pixels of two consecutive lines. This feature is useful if you want to align your image data to fixed-size groups of digits, e.g., to 4-byte (32-bit) or 8-byte (64-bit) words. Data alignment can improve performance.

Applies to: ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberLinePitchEnable

Enables the alignment of output image data to multiples of 4 bytes.

Applies to: ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberLineSelector

Sets the I/O line to be configured. All changes to the line settings will be applied to the selected line.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB and dart USB

Visibility: Beginner

Selecting Parameters: BslInputFilterTime, BslInputHoldOffTime, BslLineConnection, BslLineOverloadStatus, LineDebouncerTime, LineDebouncerTimeAbs, LineFormat, LineInverter, LineLogic, LineMinimumOutputPulseWidth, LineMode, LineOverloadReset, LineOverloadStatus, LineSource, LineStatus, LineTermination, MinOutPulseWidthAbs

The feature documentation may provide more information.

Public propertyStatic memberLineSource

Sets the source signal for the currently selected line. The currently selected line must be an output line.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB and dart USB

Visibility: Beginner

Selected by: LineSelector

The feature documentation may provide more information.

Public propertyStatic memberLineStartOvertriggerEventStreamChannelIndex

Stream channel index of the Line Start Overtrigger event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberLineStartOvertriggerEventTimestamp

Timestamp of the Line Start Overtrigger event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberLineStatus

Indicates the current logical state of the selected line.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB and dart USB

Visibility: Beginner

Selected by: LineSelector

The feature documentation may provide more information.

Public propertyStatic memberLineStatusAll

Single bit field indicating the current logical state of all available line signals at time of polling.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB and dart USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberLineTermination

Enables the termination resistor of the selected input line.

Applies to: CameraLink and GigE

Visibility: Beginner

Selected by: LineSelector

The feature documentation may provide more information.

Public propertyStatic memberLUTEnable

Enables the selected lookup table (LUT).

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB and boost CoaXPress

Visibility: Beginner

Selected by: LUTSelector

The feature documentation may provide more information.

Public propertyStatic memberLUTIndex

Pixel value to be replaced with the LUT Value pixel value.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB and boost CoaXPress

Visibility: Beginner

Selected by: LUTSelector

Selecting Parameters: LUTValue

The feature documentation may provide more information.

Public propertyStatic memberLUTSelector

Sets the lookup table (LUT) to be configured. All changes to the LUT settings will be applied to the selected LUT.

Applies to: CameraLink, GigE and ace USB

Visibility: Beginner

Selecting Parameters: LUTEnable, LUTIndex, LUTValue, LUTValueAll

The feature documentation may provide more information.

Public propertyStatic memberLUTValue

New pixel value to replace the LUT Index pixel value.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB and boost CoaXPress

Visibility: Beginner

Selected by: LUTIndex, LUTSelector

The feature documentation may provide more information.

Public propertyStatic memberLUTValueAll

A single register that lets you access all LUT entries. In many cases, this is faster than repeatedly changing individual entries in the LUT.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB and boost CoaXPress

Visibility: Beginner

Selected by: LUTSelector

The feature documentation may provide more information.

Public propertyStatic memberMinOutPulseWidthAbs

Minimum signal width of an output signal (in microseconds).

Applies to: CameraLink and GigE

Visibility: Beginner

Selected by: LineSelector

The feature documentation may provide more information.

Public propertyStatic memberMultiCameraChannel

Operating channel of the camera. In multi-camera setups, use a different channel on each camera. This ensures that the cameras are operating at different frequencies and their light sources will not interfere with the other cameras' light sources.

Applies to: blaze

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberNoiseReduction

Amount of noise reduction to be applied. The higher the value, the less chroma noise will be visible in your images. However, excessively high values may result in image information loss.

Applies to: ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberNoiseReductionAbs

Amount of noise reduction to be applied. The higher the value, the less chroma noise will be visible in your images. However, excessively high values may result in image information loss.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberNoiseReductionRaw

Amount of noise reduction to be applied (raw value). The higher the value, the less chroma noise will be visible in your images. However, excessively high values may result in image information loss.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberNumberOfActionSignals

Number of separate action signals supported by the camera. Determines how many action signals the camera can handle in parallel, i.e., how many different action commands can be configured on the camera.

Applies to: GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberOffsetX

Horizontal offset from the left side of the sensor to the region of interest (area of interest) (in pixels).

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberOffsetY

Vertical offset from the top of the sensor to the region of interest (area of interest) (in pixels).

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberOperatingMode

Sets the operating mode of the camera. The choice you make here, affects the working range of the camera, i.e., the Minimum Working Range and Maximum Working Range parameters. If the operating mode is changed, the exposure time is set to the recommended default value.

Applies to: blaze

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberOutlierRemoval

Removes pixels that differ significantly from their local environment.

Applies to: blaze

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberOverlapMode

Configures overlapping exposure and image readout.

Applies to: dart USB and pulse USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberOverTemperature

Indicates whether an over temperature state has been detected.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberOverTemperatureEventStreamChannelIndex

Stream channel index of the Over Temperature event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberOverTemperatureEventTimestamp

Timestamp of the Over Temperature event.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberParameterSelector

Sets the parameter whose factory limits can be removed. The factory limits can be removed using the Remove Limits parameter.

Applies to: CameraLink and GigE

Visibility: Guru

Selecting Parameters: RemoveLimits

The feature documentation may provide more information.

Public propertyStatic memberPayloadFinalTransfer1Size

For information only. May be required when contacting Basler support.

Applies to: dart USB and pulse USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberPayloadFinalTransfer2Size

For information only. May be required when contacting Basler support.

Applies to: dart USB and pulse USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberPayloadSize

Size of the payload in bytes. This is the total number of bytes sent in the payload.

Applies to: CamEmu, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberPayloadTransferBlockDelay

This parameter is required when using the sequencer.

Applies to: ace USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberPayloadTransferCount

For information only. May be required when contacting Basler support.

Applies to: dart USB and pulse USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberPayloadTransferSize

For information only. May be required when contacting Basler support.

Applies to: dart USB and pulse USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberPgiMode

Enables Basler PGI image optimizations.

Applies to: GigE and ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberPixelCoding

Sets the color coding of the pixels in the acquired images

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberPixelColorFilter

Indicates the alignment of the camera's Bayer filter to the pixels in the acquired images.

Applies to: CameraLink, GigE, ace USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberPixelDynamicRangeMax

Maximum possible pixel value that can be transferred from the camera.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberPixelDynamicRangeMin

Minimum possible pixel value that can be transferred from the camera.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberPixelFormat

Sets the format of the pixel data transmitted by the camera. The available pixel formats depend on the camera model and whether the camera is monochrome or color.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

Selected by: ComponentSelector

The feature documentation may provide more information.

Public propertyStatic memberPixelFormatLegacy

Enables legacy GVSP pixel format encoding to ensure compatibility with older camera models.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberPixelSize

Indicates the depth of the pixel values in the image (in bits per pixel). The potential values depend on the pixel format setting.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberPrelines

This value sets the number of prelines.

Applies to: CameraLink and GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberProcessedRawEnable

Enables the output of color-improved raw image data. If enabled, color transformation and color adjustment will be applied to Bayer pixel formats.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberPtpClockAccuracy

Indicates the expected accuracy of the PTP device clock when it is or becomes the grandmaster.

Applies to: ace 2 GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberPtpClockID

Returns the latched clock ID of the PTP device.

Applies to: ace 2 GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberPtpDataSetLatch

Latches the current values from the device's PTP clock data set.

Applies to: ace 2 GigE and blaze

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberPtpEnable

Enables the Precision Time Protocol (PTP).

Applies to: ace 2 GigE and blaze

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberPtpGrandmasterClockID

Returns the latched grandmaster clock ID of the PTP device.

Applies to: ace 2 GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberPtpOffsetFromMaster

Returns the latched offset from the PTP master clock in nanoseconds.

Applies to: ace 2 GigE and blaze

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberPtpParentClockID

Returns the latched parent clock ID of the PTP device.

Applies to: ace 2 GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberPtpServoStatus

Returns the latched state of the clock servo.

Applies to: ace 2 GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberPtpStatus

Returns the latched state of the PTP clock.

Applies to: ace 2 GigE and blaze

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberReadoutTime

Time required for reading out each subframe from the sensor.

Applies to: blaze

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberReadoutTimeAbs

Sensor readout time with current settings.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberRemoveLimits

Removes the factory-set limit of the selected parameter. If the factory limits are removed, a wider range of parameter values is available and only subect to technical restrictions. Choosing parameter values outside of the factory limits may affect image quality.

Applies to: CameraLink and GigE

Visibility: Guru

Selected by: ParameterSelector

The feature documentation may provide more information.

Public propertyStatic memberRemoveParameterLimit

Removes the factory-set limit of the selected parameter. If the factory limits are removed, a wider range of parameter values is available and only subect to technical restrictions. Choosing parameter values outside of the factory limits may affect image quality.

Applies to: ace USB

Visibility: Guru

Selected by: RemoveParameterLimitSelector

The feature documentation may provide more information.

Public propertyStatic memberRemoveParameterLimitSelector

Sets the parameter whose factory limits can be removed. The factory limits can be removed using the Remove Limits parameter.

Applies to: ace USB

Visibility: Guru

Selecting Parameters: RemoveParameterLimit

The feature documentation may provide more information.

Public propertyStatic memberResetTime

Time during which the sensor is reset before the next subframe is acquired.

Applies to: blaze

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberResultingFramePeriodAbs

Maximum frame acquisition period with current camera settings (in microseconds).

Applies to: CameraLink and GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberResultingFrameRate

Maximum frame acquisition rate with current camera settings (in frames per second).

Applies to: ace USB, boost CoaXPress, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberResultingFrameRateAbs

Maximum frame acquisition rate with current camera settings (in frames per second).

Applies to: CamEmu, CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberResultingLinePeriodAbs

Maximum line acquisition period with current camera settings (in microseconds).

Applies to: CameraLink and GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberResultingLineRateAbs

Maximum line acquisition rate with current camera settings (in frames per second).

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberReverseX

Enables horizontal mirroring of the image. The pixel values of every line in a captured image will be swapped along the line's center. You can use the ROI feature when using the Reverse X feature. The position of the ROI relative to the sensor remains the same.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberReverseY

Enables vertical mirroring of the image. The pixel values of every column in a captured image will be swapped along the column's center. You can use the ROI feature when using the Reverse Y feature. The position of the ROI relative to the sensor remains the same.

Applies to: CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberROIZoneMode

Enables or disables the currently selected ROI zone.

Applies to: GigE and ace USB

Visibility: Expert

Selected by: ROIZoneSelector

The feature documentation may provide more information.

Public propertyStatic memberROIZoneOffset

Vertical offset of the currently selected ROI zone.

Applies to: GigE and ace USB

Visibility: Expert

Selected by: ROIZoneSelector

The feature documentation may provide more information.

Public propertyStatic memberROIZoneSelector

Sets the ROI zone that can be configured.

Applies to: GigE and ace USB

Visibility: Expert

Selecting Parameters: ROIZoneMode, ROIZoneOffset, ROIZoneSize

The feature documentation may provide more information.

Public propertyStatic memberROIZoneSize

Height of the currently selected ROI zone.

Applies to: GigE and ace USB

Visibility: Expert

Selected by: ROIZoneSelector

The feature documentation may provide more information.

Public propertyStatic memberScalingHorizontal

Horizontal scaling factor.

Applies to: ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberScalingHorizontalAbs

Horizontal scaling factor.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberScalingVertical

Vertical scaling factor.

Applies to: ace USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberScalingVerticalAbs

Vertical scaling factor.

Applies to: GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberScan3dAxisMax

Maximum valid transmitted coordinate value of the selected Axis.

Applies to: blaze

Visibility: Expert

Selected by: Scan3dCoordinateSelector

The feature documentation may provide more information.

Public propertyStatic memberScan3dAxisMin

Minimum valid transmitted coordinate value of the selected Axis.

Applies to: blaze

Visibility: Expert

Selected by: Scan3dCoordinateSelector

The feature documentation may provide more information.

Public propertyStatic memberScan3dCalibrationOffset

This parameter allows you to adjust the internal camera calibration. The offset specified by Scan3dCalibrationOffset is added to the radial distances the camera measures. The camera transforms the radial distances into x, y, z coordinates in a Cartesian coordinate system whose origin lies in the camera's optical center. The Scan3dCalibrationOffset parameter can be used to manually correct a temperature-dependent drift. Note: Since Scan3dCalibrationOffset is added to the radial distances, it can't be used to translate the origin of the coordinate system, i.e., it can't be used to add a constant offset to the z coordinate. Specifically, you should not use it in an attempt to shift the origin of the camera's coordinate system from the optical center to the front of the camera housing. Trying to do so will result in measurement errors causing planar surfaces to appear curved.

Applies to: blaze

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberScan3dCoordinateOffset

Offset when transforming a pixel from relative coordinates to world coordinates.

Applies to: blaze

Visibility: Expert

Selected by: Scan3dCoordinateSelector

The feature documentation may provide more information.

Public propertyStatic memberScan3dCoordinateScale

Scale factor when transforming a pixel from relative coordinates to world coordinates.

Applies to: blaze

Visibility: Expert

Selected by: Scan3dCoordinateSelector

The feature documentation may provide more information.

Public propertyStatic memberScan3dCoordinateSelector

Selects the individual coordinates in the vectors for 3D information/transformation.

Applies to: blaze

Visibility: Expert

Selecting Parameters: Scan3dAxisMax, Scan3dAxisMin, Scan3dCoordinateOffset, Scan3dCoordinateScale, Scan3dInvalidDataFlag, Scan3dInvalidDataValue

The feature documentation may provide more information.

Public propertyStatic memberScan3dCoordinateSystem

Specifies the Coordinate system to use for the device.

Applies to: blaze

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberScan3dCoordinateSystemReference

Defines coordinate system reference location.

Applies to: blaze

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberScan3dDistanceUnit

Specifies the unit used when delivering (calibrated) distance data.

Applies to: blaze

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberScan3dFocalLength

Returns the focal length of the camera in pixel. The focal length depends on the selected region. The value of this feature takes into account horizontal binning, decimation, or any other function changing the image resolution.

Applies to: blaze

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberScan3dInvalidDataFlag

Enables the definition of a non-valid flag value in the data stream. Note that the confidence output is an alternate recommended way to identify non-valid pixels. Using an Scan3dInvalidDataValue may give processing penalties due to special handling.

Applies to: blaze

Visibility: Expert

Selected by: Scan3dCoordinateSelector

The feature documentation may provide more information.

Public propertyStatic memberScan3dInvalidDataValue

Value which identifies a non-valid pixel if Scan3dInvalidDataFlag is enabled.

Applies to: blaze

Visibility: Expert

Selected by: Scan3dCoordinateSelector

The feature documentation may provide more information.

Public propertyStatic memberScan3dOutputMode

Controls the Calibration and data organization of the device and the coordinates transmitted.

Applies to: blaze

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberScan3dPrincipalPointU

Returns the value of the horizontal position of the principal point, relative to the region origin, i.e. OffsetX. The value of this feature takes into account horizontal binning, decimation, or any other function changing the image resolution.

Applies to: blaze

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberScan3dPrincipalPointV

Returns the value of the vertical position of the principal point, relative to the region origin, i.e. OffsetY. The value of this feature takes into account vertical binning, decimation, or any other function changing the image resolution.

Applies to: blaze

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberSensorBitDepth

Amount of data bits the sensor produces for one sample.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberSensorDigitizationTaps

This feature represents the number of digitized samples output simultaneously by the camera A/D conversion stage.

Applies to: CameraLink and GigE

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberSensorHeight

Height of the camera's sensor in pixels.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberSensorPixelHeight

Physical size (pitch) in the y direction of a photo sensitive pixel unit.

Applies to: blaze

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberSensorPixelWidth

Physical size (pitch) in the x direction of a photo sensitive pixel unit.

Applies to: blaze

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberSensorPosition

Distance between the sensor plane and the front of the housing. This value can be used to calculate the distance between the optical center and the front of the housing.

Applies to: blaze

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberSensorReadoutMode

Sets the sensor readout mode.

Applies to: GigE and ace USB

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberSensorReadoutTime

Sensor readout time with current settings.

Applies to: ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress and dart 2 USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberSensorShutterMode

Sets the shutter mode of the camera.

Applies to: ace 2 GigE, ace 2 USB, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberSensorWidth

Width of the camera's sensor in pixels.

Applies to: CamEmu, CameraLink, GigE, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart USB and pulse USB

Visibility: Beginner

The feature documentation may provide more information.

Public propertyStatic memberSequenceAddressBitSelector

Sets which bit of the sequence set address can be assigned to an input line. An input line can be set as the control source for this bit using the Address Bit Source parameter.

Applies to: CameraLink and GigE

Visibility: Guru

Selecting Parameters: SequenceAddressBitSource

The feature documentation may provide more information.

Public propertyStatic memberSequenceAddressBitSource

Sets an input line as the control source for the currently selected sequence set address bit. The bit can be selected using the Address Bit Selector parameter.

Applies to: CameraLink and GigE

Visibility: Guru

Selected by: SequenceAddressBitSelector

The feature documentation may provide more information.

Public propertyStatic memberSequenceAdvanceMode

Sets the sequence set advance mode.

Applies to: CameraLink and GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberSequenceAsyncAdvance

Enables asynchronous advance from one sequence set to the next. The advance is asynchronous to the camera's frame trigger. Only available in Controlled sequence advance mode.

Applies to: CameraLink and GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberSequenceAsyncRestart

Enables asynchronous restart of the sequence set sequence, starting with the sequence set that has the lowest index number. The restart is asynchronous to the camera's frame trigger. Only available in Auto and Controlled sequence advance mode.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberSequenceConfigurationMode

Sets whether the sequencer can be configured.

Applies to: GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberSequenceControlSelector

Sets whether sequence advance or sequence restart can be configured. A control source must be chosen using the Sequence Control Source parameter.

Applies to: CameraLink and GigE

Visibility: Guru

Selecting Parameters: SequenceControlSource

The feature documentation may provide more information.

Public propertyStatic memberSequenceControlSource

Sets the source for sequence control.

Applies to: CameraLink and GigE

Visibility: Guru

Selected by: SequenceControlSelector

The feature documentation may provide more information.

Public propertyStatic memberSequenceCurrentSet

Current sequence set.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberSequenceEnable

Enables the sequencer.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberSequencerConfigurationMode

Sets whether the sequencer can be configured.

Applies to: ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberSequencerMode

Sets whether the sequencer can be used for image acquisition.

Applies to: ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberSequencerPathSelector

Sets which path can be configured. By configuring multiple paths, you can define different conditions and settings for sequencer set advance. For example, you can define that the camera should advance to set 0 when a trigger signal on Line 1 is received, and advance to set 3 when a trigger signal on Line 2 is received.

Applies to: ace USB

Visibility: Expert

Selected by: SequencerSetSelector

Selecting Parameters: SequencerSetNext, SequencerTriggerActivation, SequencerTriggerSource

The feature documentation may provide more information.

Public propertyStatic memberSequencerSetActive

Index number of the current sequencer set, i.e., of the sequencer set that will be used for image acquisition.

Applies to: ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberSequencerSetLoad

Loads the parameter values of the currently selected sequencer set for configuration.

Applies to: ace USB

Visibility: Expert

Selected by: SequencerSetSelector

The feature documentation may provide more information.

Public propertyStatic memberSequencerSetNext

Next sequencer set that the sequencer will advance to when the configured trigger signal is received.

Applies to: ace USB

Visibility: Expert

Selected by: SequencerPathSelector, SequencerSetSelector

The feature documentation may provide more information.

Public propertyStatic memberSequencerSetSave

Saves the sequencer parameter values in the currently selected sequencer set.

Applies to: ace USB

Visibility: Expert

Selected by: SequencerSetSelector

The feature documentation may provide more information.

Public propertyStatic memberSequencerSetSelector

The sequencer set to be configured. Sequencer sets are identified by their sequencer set index numbers.

Applies to: ace USB

Visibility: Expert

Selecting Parameters: SequencerPathSelector, SequencerSetLoad, SequencerSetNext, SequencerSetSave, SequencerTriggerActivation, SequencerTriggerSource

The feature documentation may provide more information.

Public propertyStatic memberSequencerSetStart

First sequencer set to be used after the Sequencer Mode parameter is set to On.

Applies to: ace USB

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberSequencerTriggerActivation

Sets the logical state that makes the sequencer advance to the next set.

Applies to: ace USB

Visibility: Expert

Selected by: SequencerPathSelector, SequencerSetSelector

The feature documentation may provide more information.

Public propertyStatic memberSequencerTriggerSource

Sets the source signal to be used to advance to the next set.

Applies to: ace USB

Visibility: Expert

Selected by: SequencerPathSelector, SequencerSetSelector

The feature documentation may provide more information.

Public propertyStatic memberSequenceSetExecutions

Number of consecutive executions per sequence cycle of the selected sequence set. Only available in Auto sequence advance mode.

Applies to: CameraLink and GigE

Visibility: Guru

The feature documentation may provide more information.

Public propertyStatic memberSequenceSetIndex

This number uniquely identifies a sequence set.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberSequenceSetLoad

Loads the parameter values of the currently selected sequence set for configuration.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberSequenceSetStore

Stores the sequencer parameter values in the currently selected sequence set.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberSequenceSetTotalNumber

Total number of sequence sets in the sequence.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberShadingEnable

Enables the selected shading correction type.

Applies to: CameraLink and GigE

Visibility: Beginner

Selected by: ShadingSelector

The feature documentation may provide more information.

Public propertyStatic memberShadingSelector

Sets the kind of shading correction.

Applies to: CameraLink and GigE

Visibility: Beginner

Selecting Parameters: ShadingEnable, ShadingSetDefaultSelector, ShadingSetSelector

The feature documentation may provide more information.

Public propertyStatic memberShadingSetActivate

This command copies the selected shading set from the camera's non-volatile memory into the volatile memory. If shading correction is enabled, it will be performed using the shading set in the volatile memory.

Applies to: CameraLink and GigE

Visibility: Expert

Selected by: ShadingSetSelector

The feature documentation may provide more information.

Public propertyStatic memberShadingSetCreate

Enables/disables shading set creation.

Applies to: CameraLink and GigE

Visibility: Expert

Selected by: ShadingSetSelector

The feature documentation may provide more information.

Public propertyStatic memberShadingSetDefaultSelector

Sets the shading set that will be loaded into the volatile memory during camera start.

Applies to: CameraLink and GigE

Visibility: Expert

Selected by: ShadingSelector

The feature documentation may provide more information.

Public propertyStatic memberShadingSetSelector

Sets which shading set can be enabled or created.

Applies to: CameraLink and GigE

Visibility: Expert

Selected by: ShadingSelector

Selecting Parameters: ShadingSetActivate, ShadingSetCreate

The feature documentation may provide more information.

Public propertyStatic memberShadingStatus

Indicates error statuses related to shading correction.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberShaftEncoderModuleCounter

Current value of the tick counter of the shaft encoder module.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberShaftEncoderModuleCounterMax

Maximum value of the tick counter of the shaft encoder module. If the tick counter is incrementing and reaches the maximum, it will roll over to 0. If the tick counter is decrementing and reaches 0, it will roll back to the specified maximum value.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic memberShaftEncoderModuleCounterMode

Sets the counting mode of the tick counter of the shaft encoder module.

Applies to: CameraLink and GigE

Visibility: Expert

The feature documentation may provide more information.

Public propertyStatic member