Basler_UniversalCameraParams::CUniversalCameraParams_Params#

A parameter class containing all parameters as members that are available for Basler camera devices. More…

#include <pylon/_BaslerUniversalCameraParams.h>

Inherits from Basler_UniversalCameraParams::CUniversalCameraParams_Params_v8_0_0

Inherited by Pylon::CDeviceSpecificInstantCameraT< CBaslerUniversalInstantCameraTraits >

Public Attributes#

Detailed Description#

class Basler_UniversalCameraParams::CUniversalCameraParams_Params;

A parameter class containing all parameters as members that are available for Basler camera devices.

The parameter class is used by the Pylon::CBaslerUniversalInstantCamera class. The [ParametrizeCamera_NativeParameterAccess] code sample shows how to access camera parameters via the Pylon::CBaslerUniversalInstantCamera class.

Public Attributes Documentation#

variable AcquisitionAbort#

Pylon::ICommandEx & AcquisitionAbort;

Aborts the acquisition of images - Applies to: CameraLink, GigE, ace 2 CXP, ace 2 GigE, ace 2 USB, boost CoaXPress, dart 2 USB, dart USB and racer 2 CXP.

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.

Visibility: Beginner

Selected by: AcquisitionMode

The feature documentation may provide more information.

variable AcquisitionFrameRateEnable#

Pylon::IBooleanEx & AcquisitionFrameRateEnable;

Enables setting the camera's acquisition frame rate to a specified value - Applies to: CamEmu, CameraLink, GigE, ace 2 CXP, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, dart 2 USB, dart MIPI, dart USB and racer 2 CXP.

Visibility: Beginner

The feature documentation may provide more information.

variable AcquisitionIdle#

Pylon::IBooleanEx & AcquisitionIdle;

A check determines whether the camera is currently idle - Applies to: GigE and ace USB.

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

Visibility: Beginner

The feature documentation may provide more information.

variable AcquisitionMode#

Pylon::IEnumParameterT< AcquisitionModeEnums > & AcquisitionMode;

Sets the image acquisition mode - Applies to: CamEmu, CameraLink, GigE, ace 2 CXP, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, boost V CoaXPress, dart 2 USB, dart MIPI, dart USB, pulse USB and racer 2 CXP.

Visibility: Beginner

Selecting Parameters: AcquisitionAbort, AcquisitionStart and AcquisitionStop

The feature documentation may provide more information.

variable AcquisitionStart#

Pylon::ICommandEx & AcquisitionStart;

Starts the acquisition of images - Applies to: CamEmu, CameraLink, GigE, ace 2 CXP, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, boost V CoaXPress, dart 2 USB, dart MIPI, dart USB, pulse USB and racer 2 CXP.

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.

Visibility: Beginner

Selected by: AcquisitionMode

The feature documentation may provide more information.

variable AcquisitionStatus#

Pylon::IBooleanEx & AcquisitionStatus;

Indicates whether the camera is waiting for trigger signals - Applies to: CamEmu, CameraLink, GigE, ace 2 CXP, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and racer 2 CXP.

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.

Visibility: Expert

Selected by: AcquisitionStatusSelector

The feature documentation may provide more information.

variable AcquisitionStatusSelector#

Pylon::IEnumParameterT< AcquisitionStatusSelectorEnums > & AcquisitionStatusSelector;

Sets the signal whose status you want to check - Applies to: CamEmu, CameraLink, GigE, ace 2 CXP, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and racer 2 CXP.

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

Visibility: Expert

Selecting Parameters: AcquisitionStatus

The feature documentation may provide more information.

variable AcquisitionStop#

Pylon::ICommandEx & AcquisitionStop;

Stops the acquisition of images - Applies to: CamEmu, CameraLink, GigE, ace 2 CXP, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, boost V CoaXPress, dart 2 USB, dart MIPI, dart USB, pulse USB and racer 2 CXP.

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

Visibility: Beginner

Selected by: AcquisitionMode

The feature documentation may provide more information.

variable ExposureAuto#

Pylon::IEnumParameterT< ExposureAutoEnums > & ExposureAuto;

Sets the operation mode of the Exposure Auto auto function - Applies to: CamEmu, CameraLink, GigE, ace 2 CXP, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart MIPI, dart USB and pulse USB.

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.

Visibility: Beginner

The feature documentation may provide more information.

variable ExposureMode#

Pylon::IEnumParameterT< ExposureModeEnums > & ExposureMode;

Sets the exposure mode - Applies to: CamEmu, CameraLink, GigE, ace 2 CXP, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, boost V CoaXPress, dart 2 USB, dart MIPI, dart USB, pulse USB and racer 2 CXP.

Visibility: Beginner

The feature documentation may provide more information.

variable ExposureOverlapTimeMode#

Pylon::IEnumParameterT< ExposureOverlapTimeModeEnums > & ExposureOverlapTimeMode;

Sets the exposure overlap time mode - Applies to: GigE and ace USB.

Visibility: Expert

The feature documentation may provide more information.

variable ExposureTimeAbs#

Pylon::IFloatEx & ExposureTimeAbs;

Exposure time of the camera in microseconds - Applies to: CamEmu, CameraLink and GigE.

Visibility: Beginner

The feature documentation may provide more information.

variable ExposureTimeBaseAbs#

Pylon::IFloatEx & ExposureTimeBaseAbs;

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.

variable ExposureTimeMode#

Pylon::IEnumParameterT< ExposureTimeModeEnums > & ExposureTimeMode;

Sets the exposure time mode - Applies to: GigE and ace USB.

Visibility: Beginner

The feature documentation may provide more information.

variable ExposureTimeRaw#

Pylon::IIntegerEx & ExposureTimeRaw;

Exposure time of the camera (raw value) - Applies to: CamEmu, CameraLink and GigE.

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.

Visibility: Beginner

The feature documentation may provide more information.

variable ResultingFrameRateAbs#

Pylon::IFloatEx & ResultingFrameRateAbs;

Maximum frame acquisition rate with current camera settings - Applies to: CamEmu, CameraLink and GigE.

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

Visibility: Beginner

The feature documentation may provide more information.

variable SensorReadoutMode#

Pylon::IEnumParameterT< SensorReadoutModeEnums > & SensorReadoutMode;

Sets the sensor readout mode - Applies to: GigE and ace USB.

Visibility: Guru

The feature documentation may provide more information.

variable ShutterMode#

Pylon::IEnumParameterT< ShutterModeEnums > & ShutterMode;

Sets the shutter mode of the camera - Applies to: CameraLink, GigE and ace USB.

Visibility: Beginner

The feature documentation may provide more information.

variable SyncFreeRunTimerEnable#

Pylon::IBooleanEx & SyncFreeRunTimerEnable;

Enables the synchronous free run mode - Applies to: GigE and blaze.

Enables the synchronous free run mode. If enabled, the camera will generate all required frame start or line start trigger signals internally. You don't need to apply frame start or line start trigger signals to the camera.

Visibility: Beginner

The feature documentation may provide more information.

variable SyncFreeRunTimerStartTimeHigh#

Pylon::IIntegerEx & SyncFreeRunTimerStartTimeHigh;

High 32 bits of the synchronous free run trigger start time - Applies to: GigE and blaze.

Visibility: Beginner

The feature documentation may provide more information.

variable SyncFreeRunTimerStartTimeLow#

Pylon::IIntegerEx & SyncFreeRunTimerStartTimeLow;

Low 32 bits of the synchronous free run trigger start time - Applies to: GigE and blaze.

Visibility: Beginner

The feature documentation may provide more information.

variable SyncFreeRunTimerUpdate#

Pylon::ICommandEx & SyncFreeRunTimerUpdate;

Updates synchronous free run settings - Applies to: GigE and blaze.

Visibility: Beginner

The feature documentation may provide more information.

variable TriggerActivation#

Pylon::IEnumParameterT< TriggerActivationEnums > & TriggerActivation;

Sets the type of signal transition that will activate the selected trigger - Applies to: CamEmu, CameraLink, GigE, ace 2 CXP, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, boost V CoaXPress, dart 2 USB, dart MIPI, dart USB, pulse USB and racer 2 CXP.

Visibility: Beginner

Selected by: TriggerSelector

The feature documentation may provide more information.

variable TriggerMode#

Pylon::IEnumParameterT< TriggerModeEnums > & TriggerMode;

Sets the mode for the currently selected trigger - Applies to: CamEmu, CameraLink, GigE, ace 2 CXP, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, boost V CoaXPress, dart 2 USB, dart MIPI, dart USB, pulse USB and racer 2 CXP.

Visibility: Beginner

Selected by: TriggerSelector

The feature documentation may provide more information.

variable TriggerSelector#

Pylon::IEnumParameterT< TriggerSelectorEnums > & TriggerSelector;

Sets the trigger type to be configured - Applies to: CamEmu, CameraLink, GigE, ace 2 CXP, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, boost V CoaXPress, dart 2 USB, dart MIPI, dart USB, pulse USB and racer 2 CXP.

Sets the trigger type to be configured. All changes to the trigger settings will be applied to the selected trigger.

Visibility: Beginner

Selected by: TriggerControlImplementation

Selecting Parameters: TriggerActivation, TriggerDelay, TriggerDelayAbs, TriggerDelayLineTriggerCount, TriggerDelaySource, TriggerMode, TriggerPartialClosingFrame, TriggerSoftware and TriggerSource

The feature documentation may provide more information.

variable TriggerSoftware#

Pylon::ICommandEx & TriggerSoftware;

Generates a software trigger signal - Applies to: CamEmu, CameraLink, GigE, ace 2 CXP, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, boost V CoaXPress, dart 2 USB, dart MIPI, dart USB, pulse USB and racer 2 CXP.

Generates a software trigger signal. The software trigger signal will be used if the Trigger Source parameter is set to Trigger Software.

Visibility: Beginner

Selected by: TriggerSelector

The feature documentation may provide more information.

variable TriggerSource#

Pylon::IEnumParameterT< TriggerSourceEnums > & TriggerSource;

Sets the source signal for the selected trigger - Applies to: CamEmu, CameraLink, GigE, ace 2 CXP, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, boost V CoaXPress, dart 2 USB, dart MIPI, dart USB, pulse USB and racer 2 CXP.

Visibility: Beginner

Selected by: TriggerSelector

The feature documentation may provide more information.

variable AcquisitionBurstFrameCount#

Pylon::IIntegerEx & AcquisitionBurstFrameCount;

Number of frames to acquire for each Frame Burst Start trigger - Applies to: ace 2 CXP, ace 2 GigE, ace 2 USB, ace USB, boost CoaXPress, dart 2 USB, dart USB and racer 2 CXP.

Visibility: Beginner

The feature documentation may provide more information.

variable AcquisitionFrameRate#

Pylon::IFloatEx & AcquisitionFrameRate;

Acquisition frame rate of the camera in frames per second - Applies to: CamEmu, ace 2 CXP, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, boost V CoaXPress, dart 2 USB, dart MIPI, dart USB, pulse USB and racer 2 CXP.

Visibility: Beginner

The feature documentation may provide more information.

variable BslAcquisitionBurstMode#

Pylon::IEnumParameterT< BslAcquisitionBurstModeEnums > & BslAcquisitionBurstMode;

Sets the burst mode - Applies to: ace 2 CXP, ace 2 GigE, ace 2 USB, boost CoaXPress, dart 2 USB, dart USB and racer 2 CXP.

Visibility: Beginner

The feature documentation may provide more information.

variable BslAcquisitionStopMode#

Pylon::IEnumParameterT< BslAcquisitionStopModeEnums > & BslAcquisitionStopMode;

Sets whether Acquisition Stop commands abort exposure - Applies to: ace 2 CXP, ace 2 GigE, ace 2 USB, boost CoaXPress, dart 2 USB, dart USB and racer 2 CXP.

Visibility: Expert

The feature documentation may provide more information.

variable BslEffectiveExposureTime#

Pylon::IFloatEx & BslEffectiveExposureTime;

Current exposure time of the camera in microseconds - Applies to: ace 2 CXP, ace 2 GigE, ace 2 USB, boost CoaXPress, dart USB and racer 2 CXP.

Visibility: Guru

The feature documentation may provide more information.

variable BslExposureStartDelay#

Pylon::IFloatEx & BslExposureStartDelay;

Exposure start delay with current settings - Applies to: ace 2 CXP, ace 2 GigE, ace 2 USB, boost CoaXPress, dart 2 USB, dart USB and racer 2 CXP.

Visibility: Beginner

The feature documentation may provide more information.

variable BslExposureTimeMode#

Pylon::IEnumParameterT< BslExposureTimeModeEnums > & BslExposureTimeMode;

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.

variable BslFlashWindowDelay#

Pylon::IFloatEx & BslFlashWindowDelay;

Indicates the delay between the start of exposure and the start of the flash window in microseconds - Applies to: ace 2 CXP, ace 2 GigE, ace 2 USB, boost CoaXPress and dart USB.

Visibility: Expert

The feature documentation may provide more information.

variable BslFlashWindowDuration#

Pylon::IFloatEx & BslFlashWindowDuration;

Indicates the width of the flash window in microseconds - Applies to: ace 2 CXP, ace 2 GigE, ace 2 USB, boost CoaXPress and dart USB.

Visibility: Expert

The feature documentation may provide more information.

variable BslImmediateTriggerMode#

Pylon::IEnumParameterT< BslImmediateTriggerModeEnums > & BslImmediateTriggerMode;

Enables the Immediate Trigger mode - Applies to: dart USB and pulse USB.

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.

Visibility: Expert

The feature documentation may provide more information.

variable BslResultingAcquisitionFrameRate#

Pylon::IFloatEx & BslResultingAcquisitionFrameRate;

Maximum number of frames that can be acquired per second with current camera settings - Applies to: ace 2 CXP, ace 2 GigE, ace 2 USB, boost CoaXPress, dart 2 USB, dart USB and racer 2 CXP.

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.

Visibility: Beginner

The feature documentation may provide more information.

variable BslResultingFrameBurstRate#

Pylon::IFloatEx & BslResultingFrameBurstRate;

Maximum number of bursts per second with current camera settings - Applies to: ace 2 CXP, ace 2 GigE, ace 2 USB, boost CoaXPress, dart 2 USB and dart USB.

Visibility: Beginner

The feature documentation may provide more information.

variable BslResultingTransferFrameRate#

Pylon::IFloatEx & BslResultingTransferFrameRate;

Maximum number of frames that can be transferred per second with current camera settings - Applies to: ace 2 CXP, ace 2 GigE, ace 2 USB, boost CoaXPress, dart 2 USB, dart USB and racer 2 CXP.

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.

Visibility: Beginner

The feature documentation may provide more information.

variable BslSensorBitDepth#

Pylon::IEnumParameterT< BslSensorBitDepthEnums > & BslSensorBitDepth;

Sets the bit depth of the image sensor's data output - Applies to: ace 2 CXP, ace 2 GigE, ace 2 USB, boost CoaXPress, dart 2 USB, dart USB and racer 2 CXP.

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.

Visibility: Expert

The feature documentation may provide more information.

variable BslSensorBitDepthMode#

Pylon::IEnumParameterT< BslSensorBitDepthModeEnums > & BslSensorBitDepthMode;

Sets the sensor bit depth mode - Applies to: ace 2 CXP, ace 2 GigE, ace 2 USB, boost CoaXPress, dart 2 USB, dart USB and racer 2 CXP.

Visibility: Expert

The feature documentation may provide more information.

variable BslSensorOff#

Pylon::ICommandEx & BslSensorOff;

Switches the sensor power off - Applies to: ace 2 CXP, ace 2 GigE, ace 2 USB, boost CoaXPress, dart USB and racer 2 CXP.

Visibility: Expert

The feature documentation may provide more information.

variable BslSensorOn#

Pylon::ICommandEx & BslSensorOn;

Switches the sensor power on - Applies to: ace 2 CXP, ace 2 GigE, ace 2 USB, boost CoaXPress, dart USB and racer 2 CXP.

Visibility: Expert

The feature documentation may provide more information.

variable BslSensorStandby#

Pylon::ICommandEx & BslSensorStandby;

Puts the sensor in standby mode - Applies to: ace 2 CXP, ace 2 GigE, ace 2 USB, boost CoaXPress, dart USB and racer 2 CXP.

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.

Visibility: Expert

The feature documentation may provide more information.

variable BslSensorState#

Pylon::IEnumParameterT< BslSensorStateEnums > & BslSensorState;

Returns the current power state of the sensor - Applies to: ace 2 CXP, ace 2 GigE, ace 2 USB, boost CoaXPress, dart 2 USB, dart USB and racer 2 CXP.

Visibility: Expert

The feature documentation may provide more information.

variable BslTransferBitDepth#

Pylon::IEnumParameterT< BslTransferBitDepthEnums > & BslTransferBitDepth;

Sets the bit depth used for internal image processing - Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress.

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

Visibility: Expert

The feature documentation may provide more information.

variable BslTransferBitDepthMode#

Pylon::IEnumParameterT< BslTransferBitDepthModeEnums > & BslTransferBitDepthMode;

Sets the transfer bit depth mode - Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress.

Visibility: Expert

The feature documentation may provide more information.

variable ExposureOverlapTimeMax#

Pylon::IFloatEx & ExposureOverlapTimeMax;

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.

variable ExposureTime#

Pylon::IFloatEx & ExposureTime;

Exposure time of the camera in microseconds - Applies to: CamEmu, ace 2 CXP, ace 2 GigE, ace 2 USB, ace USB, blaze, boost CoaXPress, boost V CoaXPress, dart 2 USB, dart MIPI, dart USB, pulse USB and racer 2 CXP.

Visibility: Beginner

Selected by: ExposureTimeSelector

The feature documentation may provide more information.

variable ExposureTimeSelector#

Pylon::IEnumParameterT< ExposureTimeSelectorEnums > & ExposureTimeSelector;

Sets which component the Exposure Time parameter value applies to - Applies to: ace 2 CXP.

Visibility: Beginner

Selecting Parameters: ExposureTime

The feature documentation may provide more information.

variable FrameDuration#

Pylon::IIntegerEx & FrameDuration;

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.

variable OverlapMode#

Pylon::IEnumParameterT< OverlapModeEnums > & OverlapMode;