mvIMPACT Acquire SDK C++
Device specific interface layout

Classes and functions that will be available if the device is used in device specific interface layout. More...

Classes

class  AutoControlParameters
 A class to control the automatic control parameters of a device(Device specific interface layout only). More...
 
class  BasicDeviceSettingsWithAOI
 A base class for camera related settings(Device specific interface layout only). More...
 
class  CameraDescriptionBase
 A base class to describe a camera (Device specific interface layout only). More...
 
class  CameraDescriptionCameraLink
 A class to describe a CameraLink® compliant camera(Device specific interface layout only). More...
 
class  CameraDescriptionDigital
 A class to describe a non-standard digital video signal(Device specific interface layout only). More...
 
class  CameraDescriptionDigitalBase
 A base class to describe an arbitrary digital camera signal(Device specific interface layout only). More...
 
class  CameraDescriptionDigitalBase2
 A base class to describe an arbitrary digital camera signal(Device specific interface layout only). More...
 
class  CameraDescriptionManager
 Grants access to camera description objects(Device specific interface layout only). More...
 
class  CameraDescriptionNonStandard
 A class describing non-standard video cameras(Device specific interface layout only). More...
 
class  CameraDescriptionSDI
 A base class to describe a SDI(Serial Digital Interface) camera signal (Device specific interface layout only). More...
 
class  CameraDescriptionStandard
 A class describing analogue standard compliant video cameras(Device specific interface layout only). More...
 
class  CameraDescriptionStandardBase
 An internal base class to describe standard analogue video cameras(Device specific interface layout only). More...
 
class  CameraSettingsBase
 A base class for camera related settings(Device specific interface layout only). More...
 
class  CameraSettingsBlueCOUGAR
 mvBlueCOUGAR related camera settings (Device specific interface layout only). More...
 
class  CameraSettingsBlueDevice
 A base class for camera related settings belonging to the mvBlueXXX-series (Device specific interface layout only). More...
 
class  CameraSettingsBlueFOX
 mvBlueFOX related camera settings(Device specific interface layout only). More...
 
class  CameraSettingsFrameGrabber
 A class to access frame grabber related camera settings(Device specific interface layout only). More...
 
class  CameraSettingsV4L2Device
 mvV4L2 related camera settings(Device specific interface layout only). More...
 
class  CameraSettingsVirtualDevice
 mvVirtualDevice related camera settings(Device specific interface layout only). More...
 
class  Connector
 A class describing how a video signal source(e.g. a camera or image sensor) is connected to a video signal sink(e.g. a frame grabber)(Device specific interface layout only). More...
 
class  DigitalInput
 A class to represent a digital input pin(Device specific interface layout only). More...
 
class  DigitalIOMeasurementControl
 Properties for configuring settings belonging to the digital I/O measurement(Device specific interface layout only). More...
 
class  DigitalOutput
 A class to represent a digital output pin(Device specific interface layout only). More...
 
class  Event
 An interface class to model a internal driver event that the user can wait for(Device specific interface layout only)(deprecated). More...
 
class  EventSubSystem
 An interface class that provides access to all event handling related objects and functions(Device specific interface layout only)(deprecated). More...
 
class  EventWaitResults
 A class containing the result of a wait call for events (Device specific interface layout only)(deprecated). More...
 
class  HDRControl
 A class to control the HDR (High Dynamic Range) parameters of a device (Device specific interface layout only). More...
 
class  HDRKneePoint
 A class to configure a HDR (High Dynamic Range) knee point (Device specific interface layout only). More...
 
class  I2CControl
 Properties for accessing features belonging to the I2C control(Device specific interface layout only). More...
 
class  ImageMemoryManager
 An interface class to access DMA memory related properties(Device specific interface layout only). More...
 
class  InfoBlueCOUGAR
 A more specific class to query information about a mvBlueCOUGAR devices and its driver(Device specific interface layout only). More...
 
class  InfoBlueDevice
 A more specific class to query information about a mvBlueDevice device and its driver(Device specific interface layout only). More...
 
class  InfoBlueFOX
 A more specific class to query information about a mvBlueFOX device and its driver(Device specific interface layout only). More...
 
class  IOSubSystem
 A base class to handle digital inputs and outputs(Device specific interface layout only). More...
 
class  IOSubSystemBlueFOX
 A class to handle the digital inputs and outputs for mvBlueFOX USB cameras(Device specific interface layout only). More...
 
class  IOSubSystemCommon
 A base class to handle the digital inputs and outputs for devices (Device specific interface layout only). More...
 
class  IOSubSystemFrameGrabber
 A class to handle the digital inputs and outputs for frame grabber devices(Device specific interface layout only). More...
 
class  MotorFocusControl
 Properties for configuring settings belonging to the motor focus control (Device specific interface layout only). More...
 
class  OutputSignalGeneratorBlueDevice
 A class to create complex digital output signals(Device specific interface layout only). More...
 
class  OutputSignalGeneratorFrameGrabber
 A class to create complex digital output signals(Device specific interface layout only). More...
 
class  PulseStartConfiguration
 A class to configure the creation of digital signals passed to one or more of the digital outputs of a device(Device specific interface layout only). More...
 
class  RTCtrProgram
 A class to represent real time control programs(Device specific interface layout only). More...
 
class  RTCtrProgramStep
 A class to represent one step of a real time control(RTCtr) program (Device specific interface layout only). More...
 
class  SettingsBlueFOX
 This class provides access to general settings as well as to settings which are unique for the mvBlueFOX(Device specific interface layout only). More...
 
class  SettingsFrameGrabber
 This class provides access to general settings as well as to settings which are unique for frame grabber devices(Device specific interface layout only). More...
 
class  SyncOutput
 A class to represent a sync. output pin(Device specific interface layout only). More...
 
class  SystemBlueFOX
 A class containing mvBlueFOX specific settings to control the overall behaviour of the driver(Device specific interface layout only). More...
 
class  SystemV4L2
 A class containing mvV4L2 specific settings to control the overall behaviour of the driver(Device specific interface layout only). More...
 

Typedefs

typedef EnumPropertyI< TAcquisitionFieldPropertyIAcquisitionField
 Defines a property for values defined by mvIMPACT::acquire::TAcquisitionField. More...
 
typedef EnumPropertyI< TAutoControlModePropertyIAutoControlMode
 Defines a property for values defined by mvIMPACT::acquire::TAutoControlMode. More...
 
typedef EnumPropertyI< TAutoControlSpeedPropertyIAutoControlSpeed
 Defines a property for values defined by mvIMPACT::acquire::TAutoControlSpeed. More...
 
typedef EnumPropertyI< TAutoExposureControlPropertyIAutoExposureControl
 Defines a property for values defined by mvIMPACT::acquire::TAutoExposureControl. More...
 
typedef EnumPropertyI< TAutoGainControlPropertyIAutoGainControl
 Defines a property for values defined by mvIMPACT::acquire::TAutoGainControl. More...
 
typedef EnumPropertyI< TAutoOffsetCalibrationPropertyIAutoOffsetCalibration
 Defines a property for values defined by mvIMPACT::acquire::TAutoOffsetCalibration. More...
 
typedef EnumPropertyI< TBlueFOXDigitalInputThresholdPropertyIBlueFOXDigitalInputThreshold
 Defines a property for values defined by mvIMPACT::acquire::TBlueFOXDigitalInputThreshold. More...
 
typedef EnumPropertyI< TBlueFOXFooterModePropertyIBlueFOXFooterMode
 Defines a property for values defined by mvIMPACT::acquire::TBlueFOXFooterMode. More...
 
typedef EnumPropertyI< TBlueFOXInfoSensorCapabilitiesPropertyIBlueFOXInfoSensorCapabilities
 Defines a property for values defined by mvIMPACT::acquire::TBlueFOXInfoSensorCapabilities. More...
 
typedef EnumPropertyI< TBlueFOXOffsetAutoBlackSpeedPropertyIBlueFOXOffsetAutoBlackSpeed
 Defines a property for values defined by mvIMPACT::acquire::TBlueFOXOffsetAutoBlackSpeed. More...
 
typedef EnumPropertyI< TBlueFOXSensorTimingPropertyIBlueFOXSensorTiming
 Defines a property for values defined by mvIMPACT::acquire::TBlueFOXSensorTiming. More...
 
typedef EnumPropertyI< TBlueFOXTransferSizePropertyIBlueFOXTransferSize
 Defines a property for values defined by mvIMPACT::acquire::TBlueFOXTransferSize. More...
 
typedef EnumPropertyI< TCameraAoiModePropertyICameraAoiMode
 Defines a property for values defined by mvIMPACT::acquire::TCameraAoiMode. More...
 
typedef EnumPropertyI< TCameraBinningModePropertyICameraBinningMode
 Defines a property for values defined by mvIMPACT::acquire::TCameraBinningMode. More...
 
typedef EnumPropertyI< TCameraDataFormatPropertyICameraDataFormat
 Defines a property for values defined by mvIMPACT::acquire::TCameraDataFormat. More...
 
typedef EnumPropertyI< TCameraExposeModePropertyICameraExposeMode
 Defines a property for values defined by mvIMPACT::acquire::TCameraExposeMode. More...
 
typedef EnumPropertyI< TCameraExternalSyncEdgePropertyICameraExternalSyncEdge
 Defines a property for values defined by mvIMPACT::acquire::TCameraExternalSyncEdge. More...
 
typedef EnumPropertyI< TCameraExternalSyncOutputPropertyICameraExternalSyncOutput
 Defines a property for values defined by mvIMPACT::acquire::TCameraExternalSyncOutput. More...
 
typedef EnumPropertyI< TCameraFlashModePropertyICameraFlashMode
 Defines a property for values defined by mvIMPACT::acquire::TCameraFlashMode. More...
 
typedef EnumPropertyI< TCameraFlashTypePropertyICameraFlashType
 Defines a property for values defined by mvIMPACT::acquire::TCameraFlashType. More...
 
typedef EnumPropertyI< TCameraHDRModePropertyICameraHDRMode
 Defines a property for values defined by mvIMPACT::acquire::TCameraHDRMode. More...
 
typedef EnumPropertyI< TCameraInterlacedTypePropertyICameraInterlacedType
 Defines a property for values defined by mvIMPACT::acquire::TCameraInterlacedType. More...
 
typedef EnumPropertyI< TCameraLinkDataValidModePropertyICameraLinkDataValidMode
 Defines a property for values defined by mvIMPACT::acquire::TCameraLinkDataValidMode. More...
 
typedef EnumPropertyI< TCameraPixelClockPropertyICameraPixelClock
 Defines a property for values defined by mvIMPACT::acquire::TCameraPixelClock. More...
 
typedef EnumPropertyI< TCameraScanModePropertyICameraScanMode
 Defines a property for values defined by mvIMPACT::acquire::TCameraScanMode. More...
 
typedef EnumPropertyI< TCameraSerialPortBaudRatePropertyICameraSerialPortBaudRate
 Defines a property for values defined by mvIMPACT::acquire::TCameraSerialPortBaudRate. More...
 
typedef EnumPropertyI< TCameraShutterModePropertyICameraShutterMode
 Defines a property for values defined by mvIMPACT::acquire::TCameraShutterMode. More...
 
typedef EnumPropertyI< TCameraTapsXGeometryPropertyICameraTapsXGeometry
 Defines a property for values defined by mvIMPACT::acquire::TCameraTapsXGeometry. More...
 
typedef EnumPropertyI< TCameraTapsYGeometryPropertyICameraTapsYGeometry
 Defines a property for values defined by mvIMPACT::acquire::TCameraTapsYGeometry. More...
 
typedef EnumPropertyI< TCameraTestModePropertyICameraTestMode
 Defines a property for values defined by mvIMPACT::acquire::TCameraTestMode. More...
 
typedef EnumPropertyI< TCameraTriggerModePropertyICameraTriggerMode
 Defines a property for values defined by mvIMPACT::acquire::TCameraTriggerMode. More...
 
typedef EnumPropertyI< TCameraTriggerSourcePropertyICameraTriggerSource
 Defines a property for values defined by mvIMPACT::acquire::TCameraTriggerSource. More...
 
typedef EnumPropertyI< TClampModePropertyIClampMode
 Defines a property for values defined by mvIMPACT::acquire::TClampMode. More...
 
typedef EnumPropertyI< TDeviceAdvancedOptionsPropertyIDeviceAdvancedOptions
 Defines a property for values defined by mvIMPACT::acquire::TDeviceAdvancedOptions. More...
 
typedef EnumPropertyI< TDeviceDigitalOutputModePropertyIDeviceDigitalOutputMode
 Defines a property for values defined by mvIMPACT::acquire::TDeviceDigitalOutputMode. More...
 
typedef EnumPropertyI< TDeviceEventModePropertyIDeviceEventMode
 Defines a property for values defined by mvIMPACT::acquire::TDeviceEventMode. More...
 
typedef EnumPropertyI< TDeviceEventTypePropertyIDeviceEventType
 Defines a property for values defined by mvIMPACT::acquire::TDeviceEventType. More...
 
typedef EnumPropertyI< TDeviceImageTriggerPropertyIDeviceImageTrigger
 Defines a property for values defined by mvIMPACT::acquire::TDeviceImageTrigger. More...
 
typedef EnumPropertyI< TDevicePowerModePropertyIDevicePowerMode
 Defines a property for values defined by mvIMPACT::acquire::TDevicePowerMode. More...
 
typedef EnumPropertyI< TDeviceScanRateModePropertyIDeviceScanRateMode
 Defines a property for values defined by mvIMPACT::acquire::TDeviceScanRateMode. More...
 
typedef EnumPropertyI< TDeviceSignalOutputStartEventPropertyIDeviceSignalOutputStartEvent
 Defines a property for values defined by mvIMPACT::acquire::TDeviceSignalOutputStartEvent. More...
 
typedef EnumPropertyI< TDeviceSyncOutModePropertyIDeviceSyncOutMode
 Defines a property for values defined by mvIMPACT::acquire::TDeviceSyncOutMode. More...
 
typedef EnumPropertyI< TDeviceTriggerInterfacePropertyIDeviceTriggerInterface
 Defines a property for values defined by mvIMPACT::acquire::TDeviceTriggerInterface. More...
 
typedef EnumPropertyI< TDeviceTriggerModePropertyIDeviceTriggerMode
 Defines a property for values defined by mvIMPACT::acquire::TDeviceTriggerMode. More...
 
typedef EnumPropertyI< TDigIOStatePropertyIDigIOState
 Defines a property for values defined by mvIMPACT::acquire::TDigIOState. More...
 
typedef EnumPropertyI< TDigitalIOMeasurementModePropertyIDigitalIOMeasurementMode
 Defines a property for values defined by mvIMPACT::acquire::TDigitalIOMeasurementMode. More...
 
typedef EnumPropertyI< TDigitalIOMeasurementSourcePropertyIDigitalIOMeasurementSource
 Defines a property for values defined by mvIMPACT::acquire::TDigitalIOMeasurementSource. More...
 
typedef EnumPropertyI< TDigitalOutputControlModePropertyIDigitalOutputControlMode
 Defines a property for values defined by mvIMPACT::acquire::TDigitalOutputControlMode. More...
 
typedef EnumPropertyI< TDigitalSignalPropertyIDigitalSignal
 Defines a property for values defined by mvIMPACT::acquire::TDigitalSignal. More...
 
typedef EnumPropertyI< TFieldGateModePropertyIFieldGateMode
 Defines a property for values defined by mvIMPACT::acquire::TFieldGateMode. More...
 
typedef EnumPropertyI< TI2COperationModePropertyII2COperationMode
 Defines a property for values defined by mvIMPACT::acquire::TI2COperationMode. More...
 
typedef EnumPropertyI< TI2COperationStatusPropertyII2COperationStatus
 Defines a property for values defined by mvIMPACT::acquire::TI2COperationStatus. More...
 
typedef EnumPropertyI< TInfoSensorColorModePropertyIInfoSensorColorMode
 Defines a property for values defined by mvIMPACT::acquire::TInfoSensorColorMode. More...
 
typedef EnumPropertyI< TInfoSensorTypePropertyIInfoSensorType
 Defines a property for values defined by mvIMPACT::acquire::TInfoSensorType. More...
 
typedef EnumPropertyI< TInterlacedModePropertyIInterlacedMode
 Defines a property for values defined by mvIMPACT::acquire::TInterlacedMode. More...
 
typedef EnumPropertyI< TLineCounterPropertyILineCounter
 Defines a property for values defined by mvIMPACT::acquire::TLineCounter. More...
 
typedef EnumPropertyI< TMemoryManagerModePropertyIMemoryManagerMode
 Defines a property for values defined by mvIMPACT::acquire::TMemoryManagerMode. More...
 
typedef EnumPropertyI< TMemoryManagerPoolModePropertyIMemoryManagerPoolMode
 Defines a property for values defined by mvIMPACT::acquire::TMemoryManagerPoolMode. More...
 
typedef EnumPropertyI< TOnBoardMemoryModePropertyIOnBoardMemoryMode
 Defines a property for values defined by mvIMPACT::acquire::TOnBoardMemoryMode. More...
 
typedef EnumPropertyI< TPulseStartTriggerPropertyIPulseStartTrigger
 Defines a property for values defined by mvIMPACT::acquire::TPulseStartTrigger. More...
 
typedef EnumPropertyI< TRTCtrlModesPropertyIRTCtrlModes
 Defines a property for values defined by mvIMPACT::acquire::TRTCtrlModes. More...
 
typedef EnumPropertyI< TRTProgOpCodesPropertyIRTProgOpCodes
 Defines a property for values defined by mvIMPACT::acquire::TRTProgOpCodes. More...
 
typedef EnumPropertyI< TScanClockPropertyIScanClock
 Defines a property for values defined by mvIMPACT::acquire::TScanClock. More...
 
typedef EnumPropertyI< TScanStandardPropertyIScanStandard
 Defines a property for values defined by mvIMPACT::acquire::TScanStandard. More...
 
typedef EnumPropertyI< TTriggerMomentPropertyITriggerMoment
 Defines a property for values defined by mvIMPACT::acquire::TTriggerMoment. More...
 
typedef EnumPropertyI< TVideoStandardPropertyIVideoStandard
 Defines a property for values defined by mvIMPACT::acquire::TVideoStandard. More...
 
typedef EnumPropertyI< TVirtualDeviceImageTypePropertyIVirtualDeviceImageType
 Defines a property for values defined by mvIMPACT::acquire::TVirtualDeviceImageType. More...
 
typedef EnumPropertyI< TVirtualDeviceTestModePropertyIVirtualDeviceTestMode
 Defines a property for values defined by mvIMPACT::acquire::TVirtualDeviceTestMode. More...
 
typedef SystemSettings SystemBlueCOUGAR
 deprecated. Use the class mvIMPACT::acquire::SystemSettings instead(Device specific interface layout only). More...
 
typedef std::vector< std::pair< std::string, TDigitalSignal > > TDigitalSignalTranslationDict
 

Enumerations

enum  TAcquisitionField {
  afAuto = 0,
  afOdd = 1,
  afEven = 2,
  afAny = afOdd | afEven
}
 Defines which field triggers the start of the acquisition. More...
 
enum  TAutoControlMode {
  acmStandard,
  acmDeviceSpecific
}
 Defines valid auto control modes. More...
 
enum  TAutoControlSpeed {
  acsSlow = 0,
  acsMedium,
  acsFast,
  acsUserDefined
}
 Defines valid auto-control speed modes. More...
 
enum  TAutoExposureControl {
  aecOff = 0,
  aecOn
}
 Defines valid AEC( Automatic Exposure Control ) modes. More...
 
enum  TAutoGainControl {
  agcOff = 0,
  agcOn
}
 Defines valid AGC( Automatic Gain Control ) modes. More...
 
enum  TAutoOffsetCalibration {
  aocOff = 0,
  aocOn
}
 Defines valid offset calibration modes. More...
 
enum  TBlueFOXDigitalInputThreshold {
  bfdit2V = 2,
  bfdit10V = 10
}
 Defines valid thresholds( in Volt ) for the digital inputs of the mvBlueFOX cameras. More...
 
enum  TBlueFOXFooterMode {
  bffmOff = 0,
  bffm64B = 64,
  bffm512B = 512
}
 Defines the footer mode of the mvBlueFOX. More...
 
enum  TBlueFOXInfoSensorCapabilities {
  bfiscNone = 0x00000,
  bfiscExposure = 0x00001,
  bfiscExposureAuto = 0x00002,
  bfiscGain = 0x00004,
  bfiscGainAuto = 0x00008,
  bfiscOffset = 0x00010,
  bfiscOffsetAuto = 0x00020,
  bfiscBinning = 0x00040,
  bfiscTrigger = 0x00080,
  bfiscFlash = 0x00100,
  bfiscLineTrigger = 0x00200,
  bfiscShadingCorrection = 0x00400,
  bfiscOverlappedExposure = 0x00800,
  bfiscFrameDelay = 0x01000,
  bfiscLineDelay = 0x02000,
  bfiscAutoControlAOI = 0x04000,
  bfiscAutoControlSpeed = 0x08000,
  bfiscAutoControlDelay = 0x10000,
  bfiscTemperatureSensor = 0x20000
}
 Defines valid image sensor capabilities. More...
 
enum  TBlueFOXOffsetAutoBlackSpeed {
  bfoablFastest = 0,
  bfoablVeryFast = 1,
  bfoablFast = 2,
  bfoablMedium = 3,
  bfoablSlow = 4,
  bfoablVerySlow = 6,
  bfoablSlowest = 7
}
 Defines Offset Auto Calibration Controller Speed. More...
 
enum  TBlueFOXSensorTiming {
  bfstStandard = 0,
  bfstFastLineSkip = 1,
  bfstLowSmearLineSkip = 2
}
 Sensor timing options. More...
 
enum  TBlueFOXTransferSize {
  bfts16KB = 16 * 1024,
  bfts32KB = 32 * 1024,
  bfts64KB = 64 * 1024,
  bfts128KB = 128 * 1024,
  bfts256KB = 256 * 1024,
  bfts512KB = 512 * 1024,
  bfts1024KB = 1024 * 1024,
  bfts2048KB = 2048 * 1024
}
 Defines the block size used for the USB transfer of the mvBlueFOX. More...
 
enum  TCameraAoiMode {
  camFull = 0,
  camUser
}
 Defines the camera Aoi modes. More...
 
enum  TCameraBinningMode {
  cbmOff = 0x0,
  cbmBinningH = 0x1,
  cbmBinningV = 0x2,
  cbmBinningHV = cbmBinningH | cbmBinningV,
  cbmBinning3H = 0x10,
  cbmBinning3V = 0x20,
  cbmBinning3H3V = cbmBinning3H | cbmBinning3V,
  cbmBinningHAvg = 0x101,
  cbmBinningVAvg = 0x102,
  cbmBinningHVAvg = cbmBinningHAvg | cbmBinningVAvg,
  cbmBinning3HAvg = 0x110,
  cbmBinning3VAvg = 0x120,
  cbmBinning3H3VAvg = cbmBinning3HAvg | cbmBinning3VAvg,
  cbmDroppingH = 0x1001,
  cbmDroppingV = 0x1002,
  cbmDroppingHV = cbmDroppingH | cbmDroppingV,
  cbmDropping3H = 0x1010,
  cbmDropping3V = 0x1020,
  cbmDropping3H3V = cbmDropping3H | cbmDropping3V
}
 Defines valid binning modes for the camera. More...
 
enum  TCameraExposeMode {
  cemStandard = 0,
  cemOverlapped,
  cemNoShutter
}
 Defines recognized camera sensor expose modes. More...
 
enum  TCameraExternalSyncEdge {
  ceseNo = 0,
  ceseFallingEdge = 1,
  ceseRisingEdge = 2
}
 Some grabbers are able to get the video signal and sync signals ( HD-IN, VD-IN ) on separate lines. The user can define this for non standard cameras. More...
 
enum  TCameraExternalSyncOutput {
  cesoAuto = 0,
  cesoRed = 1,
  cesoGreen = 2,
  cesoBlue = 3,
  cesoExtern = 4
}
 Some grabbers are able to get the video signal and the sync signal on different input pins. The user can select this for non standard cameras. More...
 
enum  TCameraFlashMode {
  cfmOff = 0,
  cfmDigout0 = 0x1,
  cfmDigout1 = 0x2
}
 Defines valid camera flash modes. More...
 
enum  TCameraFlashType {
  cftStandard = 0,
  cftRollingShutterFlash = 1,
  cftVSync = 2
}
 Defines valid camera flash control types. More...
 
enum  TCameraHDRMode {
  cHDRmFixed0 = 0,
  cHDRmFixed1 = 1,
  cHDRmFixed2 = 2,
  cHDRmFixed3 = 3,
  cHDRmFixed4 = 4,
  cHDRmFixed5 = 5,
  cHDRmFixed6 = 6,
  cHDRmUser = 100
}
 Defines valid camera High Dynamic Range modes. More...
 
enum  TCameraInterlacedType {
  citNone,
  citInterlaced,
  citInvertedInterlaced
}
 Defines how the camera transmits its video signal. More...
 
enum  TCameraLinkDataValidMode {
  cldvmActive = 0,
  cldvmInactive
}
 Defines how the camera transmits the DVAL signal defined in the CameraLink® standard. More...
 
enum  TCameraPixelClock {
  cpcStandard = 0,
  cpcHighSpeed = 1,
  cpc6000KHz = 6000,
  cpc8000KHz = 8000,
  cpc10000KHz = 10000,
  cpc12000KHz = 12000,
  cpc13500KHz = 13500,
  cpc20000KHz = 20000,
  cpc24000KHz = 24000,
  cpc24540KHz = 24540,
  cpc27000KHz = 27000,
  cpc32000KHz = 32000,
  cpc37600KHz = 37600,
  cpc40000KHz = 40000,
  cpc50000KHz = 50000,
  cpc57600KHz = 57600
}
 Defines valid camera pixel frequencies. More...
 
enum  TCameraScanMode {
  csmArea = 0,
  csmLine
}
 Defines valid scan modes for the a camera. More...
 
enum  TCameraSerialPortBaudRate {
  cspbr9600 = 9600,
  cspbr19200 = 19200,
  cspbr38400 = 38400,
  cspbr57600 = 57600,
  cspbr115200 = 115200,
  cspbr230400 = 230400,
  cspbr460800 = 460800,
  cspbr921600 = 921600
}
 Defines valid baud rates for serial port communication between frame grabber and camera. More...
 
enum  TCameraShutterMode {
  csmFrameShutter = 0,
  csmElectronicRollingShutter,
  csmGlobalResetRelease,
  csmFrameShutterWithFastCenterReadout
}
 Defines recognized camera sensor shutter modes. More...
 
enum  TCameraTapsXGeometry {
  cltxg1X = 0,
  cltxg1X2 = 1,
  cltxg2X = 2,
  cltxg2XE = 3,
  cltxg2XM = 4,
  cltxg1X3 = 5,
  cltxg3X = 6,
  cltxg1X4 = 7,
  cltxg4X = 8,
  cltxg2X2 = 9,
  cltxg2X2E = 10,
  cltxg2X2M = 11,
  cltxg4XE = 12,
  cltxg1X8 = 13,
  cltxg8X = 14,
  cltxg4X2 = 15,
  cltxg4X2E = 16
}
 Multitap cameras can transmit data in different ways. This enum can be used to define how the camera transmits a line of pixels. More...
 
enum  TCameraTapsYGeometry {
  cltyg1Y = 0,
  cltyg1Y2 = 1,
  cltyg2YE = 2
}
 Multi-tap cameras can transmit data in different ways. This enumeration can be used to define how the camera transmits the lines of pixels. More...
 
enum  TCameraTestMode {
  ctmOff = 0,
  ctmGreyRamp = 1,
  ctmMovingColor = 2,
  ctmWBTest = 3
}
 Defines valid transmission modes for the camera. More...
 
enum  TCameraTriggerMode {
  ctmContinuous = 0,
  ctmOnDemand,
  ctmOnLowLevel,
  ctmOnHighLevel,
  ctmOnFallingEdge,
  ctmOnRisingEdge,
  ctmOnHighExpose,
  ctmOnLowExpose,
  ctmOnAnyEdge,
  ctmFramerateControlled
}
 Defines valid camera sensor trigger modes. More...
 
enum  TCameraTriggerSource {
  ctsDigIn0 = 0,
  ctsDigIn1,
  ctsRTCtrl,
  ctsDigOut0,
  ctsDigOut1,
  ctsDigOut2,
  ctsDigOut3
}
 Defined valid camera sensor trigger source values. More...
 
enum  TClampMode {
  ecmAuto,
  ecmUser
}
 Clamp signal means, that an AC coupled video signal is clamped on the porch to get a signal transfer with less noise and independent from the d.c. voltage portion. More...
 
enum  TDeviceAdvancedOptions {
  daoOff = 0,
  daoLowLight = 0x1,
  daoEmbeddedImageInfo = 0x2,
  daoImageAverage = 0x4,
  daoPipelinedGainExposeControl = 0x8,
  daoOnDemandTriggerPreShot = 0x10,
  daoLowFrameRateOptimization = 0x20,
  daoEnablePerChannelOffsetCorrection = 0x40,
  daoUseRawSensorGain = 0x80,
  daoTriggerSensorColumnCalibration = 0x100
}
 Defines valid advanced options. More...
 
enum  TDeviceDigitalOutputMode {
  ddomManual = 0,
  ddomPulse,
  ddomUser,
  ddomExposureActive,
  ddomDigitalSignalPassThrough,
  ddomDigitalSignalPassThroughInv,
  ddomInternalVD,
  ddomRealTimeController,
  ddomExposureAndAcquisitionActive,
  ddomTemperatureOutOfRange
}
 Defines grabber specific digital output modes. More...
 
enum  TDeviceImageTrigger {
  ditImmediately = 0,
  ditAfterDigOutSignals
}
 Defines acquisition start event if using pulse sequences. More...
 
enum  TDevicePowerMode {
  dpmOn,
  dpmOff
}
 Defines the power mode for this device. More...
 
enum  TDeviceScanRateMode {
  dsrmAuto,
  dsrmUser
}
 Defines valid device scan rate mode. More...
 
enum  TDeviceSignalOutputStartEvent {
  dsoseFrame,
  dsoseTrigger,
  dsoseFrameAfterTrigger,
  dsoseSyncInRisingEdge,
  dsoseSyncInFallingEdge,
  dsoseSyncInPassThrough,
  dsoseSyncInPassThroughInv,
  dsosePeriodically,
  dsoseTriggerInPassThrough,
  dsoseTriggerInPassThroughInv,
  dsoseFVALPassThrough,
  dsoseFVALPassThroughInv,
  dsoseFVALRisingEdge
}
 Defines valid moments to start the signal generation on the digital outputs. More...
 
enum  TDeviceSyncOutMode {
  dsomOff = 0,
  dsomNonInterlaced,
  dsomInterlaced
}
 Valid sync. signal output modes for frame grabbers. More...
 
enum  TDeviceTriggerInterface {
  dtiStandard = 0,
  dtiAdvanced
}
 Defines which trigger interface is currently active for the device. More...
 
enum  TDeviceTriggerMode {
  dtmOff = 0,
  dtmOn,
  dtmFallingEdge,
  dtmRisingEdge,
  dtmPeriodically,
  dtmOnDemand,
  dtmStartRisingStopFalling,
  dtmStartFallingStopRising,
  dtmLevelHigh,
  dtmLevelLow
}
 Valid trigger modes for frame grabber boards. More...
 
enum  TDeviceTriggerOverlap {
  dtoOff,
  dtoReadOut,
  dtoPreviousFrame
}
 Specifies the type trigger overlap permitted with the previous frame. More...
 
enum  TDigIOState {
  digioOff = 0,
  digioOn = 1,
  digioIgnore = 2,
  digioKeep = 3
}
 Defines valid digital I/O states. More...
 
enum  TDigitalIOMeasurementMode {
  diommFrequency_Hz_10ms = 0,
  diommFrequency_Hz_100ms
}
 Defines valid IO Measurement Modes. More...
 
enum  TDigitalIOMeasurementSource {
  diomsInput0 = 0,
  diomsInput1 = 1,
  diomsInput2 = 2,
  diomsInput3 = 3
}
 Defines valid IO Measurement Sources. More...
 
enum  TDigitalOutputControlMode {
  docmSoftware = 0,
  docmRTC
}
 Defines valid ways to create signals on a digital output. More...
 
enum  TDigitalSignal {
  dsNone = 0x00000000,
  dsSignal1 = 0x00000001,
  dsSignal2 = 0x00000002,
  dsSignal3 = 0x00000004,
  dsSignal4 = 0x00000008,
  dsSignal5 = 0x00000010,
  dsSignal6 = 0x00000020,
  dsSignal7 = 0x00000040,
  dsSignal8 = 0x00000080,
  dsSignal9 = 0x00000100,
  dsSignal10 = 0x00000200,
  dsSignal11 = 0x00000400,
  dsSignal12 = 0x00000800,
  dsSignal13 = 0x00001000,
  dsSignal14 = 0x00002000,
  dsSignal15 = 0x00004000,
  dsSignal16 = 0x00008000
}
 Defines valid digital source signal constants that can be used to configure a devices behaviour in certain digital I/O related modes. More...
 
enum  TFieldGateMode {
  efmAuto,
  efmUser
}
 The fieldgate is used to detect the field ( odd or even ) for interlaced video signals. More...
 
enum  TI2COperationMode {
  I2ComRead = 0,
  I2ComWrite
}
 Valid I2C operation modes. More...
 
enum  TI2COperationStatus {
  I2CosSuccess = 0,
  I2CosFailure,
  I2CosInvalidDeviceAddress,
  I2CosInvalidDeviceSubAddress,
  I2CosTooMuchData,
  I2CosNotEnoughData
}
 Valid I2C operation status values. More...
 
enum  TInfoSensorColorMode {
  iscmUnknown = 0,
  iscmMono,
  iscmBayer,
  iscmColor,
  iscmNIR
}
 Defines the type of camera sensor. More...
 
enum  TInfoSensorColorPattern {
  iscpGreenRed,
  iscpRedGreen,
  iscpBlueGreen,
  iscpGreenBlue,
  iscpUnknown
}
 Defines the bayer pattern of the sensor. More...
 
enum  TInfoSensorType {
  istUnknown = 0,
  istCCD = 0x1,
  istCMOS = 0x2
}
 Defines the type of camera sensor. More...
 
enum  TInterlacedMode {
  imOn = 0,
  imOff = 1
}
 Defines how to handle interlaced image data. More...
 
enum  TLineCounter {
  lcOff = 0,
  lcOn = 1
}
 Currently available for mvTITAN/mvGAMMA-CL. More...
 
enum  TOnBoardMemoryMode {
  obmmDefault,
  obmmUser
}
 Defines valid modes for the handling of the device' on board memory (if available) More...
 
enum  TPulseStartTrigger {
  pstDigitalSignal = 0,
  pstPeriodically,
  pstRotaryDecoder
}
 Defines valid pulse start trigger values. More...
 
enum  TRTCtrlModes {
  rtctrlModeStop,
  rtctrlModeRun,
  rtctrlModeRunRestart
}
 Defines valid RTCtrl Modes. More...
 
enum  TRTProgOpCodes {
  rtctrlProgNop,
  rtctrlProgSetDigout,
  rtctrlProgWaitDigin,
  rtctrlProgWaitClocks,
  rtctrlProgJumpLoc,
  rtctrlProgTriggerSet,
  rtctrlProgTriggerReset,
  rtctrlProgExposeSet,
  rtctrlProgExposeReset,
  rtctrlProgFrameNrReset,
  rtctrlProgJumpLocOnZero,
  rtctrlProgJumpLocOnNotZero,
  rtctrlProgRegisterSet,
  rtctrlProgRegisterAdd,
  rtctrlProgRegisterSub
}
 Defines valid RTProg OpCodes. More...
 
enum  TScanClock {
  scAuto,
  scAnalogue,
  scDigital
}
 Analogue grabbers generate its scan clock on different ways. More...
 
enum  TScanStandard {
  ssITU601,
  ssSquare,
  ssUser
}
 Defines valid scan modes for standard cameras. More...
 
enum  TTriggerMoment {
  tmOnFallingEdge = 0,
  tmOnRisingEdge
}
 Defines a trigger moment for a digital signal. More...
 
enum  TVirtualDeviceImageType {
  vditNone = 0x00000000,
  vditBMP = 0x000000001,
  vditPGM = 0x000000002,
  vditPNG = 0x000000004,
  vditJPG = 0x000000008,
  vditTIFF = 0x000000010,
  vditALL = vditBMP | vditPGM | vditPNG | vditJPG | vditTIFF
}
 Defines valid image types used when capturing data from a certain directory. More...
 
enum  TVirtualDeviceTestMode {
  vdtmMovingRGBx888PackedImage,
  vdtmMovingRGB888PackedImage,
  vdtmMovingRGBx888PlanarImage,
  vdtmMovingMonoRamp,
  vdtmMovingYUV422PackedRamp,
  vdtmMovingYUV422PlanarRamp,
  vdtmMovingRGB101010PackedImage,
  vdtmMovingRGB121212PackedImage,
  vdtmMovingRGB141414PackedImage,
  vdtmMovingRGB161616PackedImage,
  vdtmMovingBayerDataRamp,
  vdtmBayerWhiteBalanceTestImage,
  vdtmImageDirectory,
  vdtmLeakyPixelTestImageMono8Bayer,
  vdtmMovingYUV422_UYVYPackedRamp,
  vdtmHorizontalMonoRamp,
  vdtmVerticalMonoRamp,
  vdtmMovingVerticalMonoRamp,
  vdtmHorizontalMono12Packed_V2Ramp,
  vdtmMovingBGR888PackedImage,
  vdtmMovingYUV444PackedRamp,
  vdtmMovingYUV444_UYVPackedRamp,
  vdtmMovingBGRPacked_V2Image,
  vdtmEmptyMonoBuffer,
  vdtmHorizontalMono12Packed_V1Ramp,
  vdtmHorizontalBayer12Packed_V1Ramp,
  vdtmHorizontalBayer12Packed_V2Ramp,
  vdtmMovingYUV411_UYYVYY_PackedRamp,
  vdtmMovingRGB888PlanarImage,
  vdtmHotAndColdPixelTestImageBayer,
  vdtmHotAndColdPixelTestImageRGB888Packed
}
 Defines valid test modes for virtual devices. More...
 

Detailed Description

Classes and functions that will be available if the device is used in device specific interface layout.

This group contains classes and functions that will be available if the device is used in mvIMPACT::acquire::dilDeviceSpecific interface layout.

Typedef Documentation

◆ PropertyIAcquisitionField

◆ PropertyIAutoControlMode

◆ PropertyIAutoControlSpeed

◆ PropertyIAutoExposureControl

◆ PropertyIAutoGainControl

◆ PropertyIAutoOffsetCalibration

◆ PropertyIBlueFOXDigitalInputThreshold

◆ PropertyIBlueFOXFooterMode

◆ PropertyIBlueFOXInfoSensorCapabilities

◆ PropertyIBlueFOXOffsetAutoBlackSpeed

◆ PropertyIBlueFOXSensorTiming

◆ PropertyIBlueFOXTransferSize

◆ PropertyICameraAoiMode

Defines a property for values defined by mvIMPACT::acquire::TCameraAoiMode.

◆ PropertyICameraBinningMode

◆ PropertyICameraDataFormat

◆ PropertyICameraExposeMode

◆ PropertyICameraExternalSyncEdge

◆ PropertyICameraExternalSyncOutput

◆ PropertyICameraFlashMode

◆ PropertyICameraFlashType

◆ PropertyICameraHDRMode

Defines a property for values defined by mvIMPACT::acquire::TCameraHDRMode.

◆ PropertyICameraInterlacedType

◆ PropertyICameraLinkDataValidMode

◆ PropertyICameraPixelClock

◆ PropertyICameraScanMode

◆ PropertyICameraSerialPortBaudRate

◆ PropertyICameraShutterMode

◆ PropertyICameraTapsXGeometry

◆ PropertyICameraTapsYGeometry

◆ PropertyICameraTestMode

◆ PropertyICameraTriggerMode

◆ PropertyICameraTriggerSource

◆ PropertyIClampMode

Defines a property for values defined by mvIMPACT::acquire::TClampMode.

◆ PropertyIDeviceAdvancedOptions

◆ PropertyIDeviceDigitalOutputMode

◆ PropertyIDeviceEventMode

◆ PropertyIDeviceEventType

◆ PropertyIDeviceImageTrigger

◆ PropertyIDevicePowerMode

◆ PropertyIDeviceScanRateMode

◆ PropertyIDeviceSignalOutputStartEvent

◆ PropertyIDeviceSyncOutMode

◆ PropertyIDeviceTriggerInterface

◆ PropertyIDeviceTriggerMode

◆ PropertyIDigIOState

Defines a property for values defined by mvIMPACT::acquire::TDigIOState.

◆ PropertyIDigitalIOMeasurementMode

◆ PropertyIDigitalIOMeasurementSource

◆ PropertyIDigitalOutputControlMode

◆ PropertyIDigitalSignal

Defines a property for values defined by mvIMPACT::acquire::TDigitalSignal.

◆ PropertyIFieldGateMode

Defines a property for values defined by mvIMPACT::acquire::TFieldGateMode.

◆ PropertyII2COperationMode

◆ PropertyII2COperationStatus

◆ PropertyIInfoSensorColorMode

◆ PropertyIInfoSensorType

◆ PropertyIInterlacedMode

◆ PropertyILineCounter

Defines a property for values defined by mvIMPACT::acquire::TLineCounter.

◆ PropertyIMemoryManagerMode

◆ PropertyIMemoryManagerPoolMode

◆ PropertyIOnBoardMemoryMode

◆ PropertyIPulseStartTrigger

◆ PropertyIRTCtrlModes

Defines a property for values defined by mvIMPACT::acquire::TRTCtrlModes.

◆ PropertyIRTProgOpCodes

Defines a property for values defined by mvIMPACT::acquire::TRTProgOpCodes.

◆ PropertyIScanClock

Defines a property for values defined by mvIMPACT::acquire::TScanClock.

◆ PropertyIScanStandard

Defines a property for values defined by mvIMPACT::acquire::TScanStandard.

◆ PropertyITriggerMoment

Defines a property for values defined by mvIMPACT::acquire::TTriggerMoment.

◆ PropertyIVideoStandard

Defines a property for values defined by mvIMPACT::acquire::TVideoStandard.

◆ PropertyIVirtualDeviceImageType

◆ PropertyIVirtualDeviceTestMode

◆ SystemBlueCOUGAR

deprecated. Use the class mvIMPACT::acquire::SystemSettings instead(Device specific interface layout only).

Deprecated:
This class has been declared deprecated and might not be available in future releases. All features of this class are now available in mvIMPACT::acquire::SystemSettings as well, so please use this class instead.
Note
This class will only be available if mvIMPACT::acquire::Device::interfaceLayout is set to mvIMPACT::acquire::dilDeviceSpecific before the device is opened.

◆ TDigitalSignalTranslationDict

typedef std::vector<std::pair<std::string, TDigitalSignal> > TDigitalSignalTranslationDict

Enumeration Type Documentation

◆ TAcquisitionField

Defines which field triggers the start of the acquisition.

Enumerator
afAuto 

Controlled by the camera parameter.

afOdd 

Only odd fields will be digitised.

afEven 

Only even fields will be digitised.

afAny 

Odd and even fields will be digitised.

◆ TAutoControlMode

Defines valid auto control modes.

Enumerator
acmStandard 

The standard auto control mode.

acmDeviceSpecific 

A device specific auto control mode.

mvBlueFOX specific: For mvBlueFOX devices of type 202b and 202d the operation in device specific AEC/AGC mode is limited in (non continuous)triggered-modes. AEC/AGC only works while the trigger signal is active. As these sensor types only support the trigger modes mvIMPACT::acquire::ctmOnHighLevel and mvIMPACT::acquire::ctmOnLowLevel 'active' means that the required signal level for that mode(either high or low) is present.

When this signal level is no longer present AEC/AGC will stop working and gain and exposure will be set to a static value. This is due to a limitation of the sensor chip. Effectively this means that for single frame triggering requiring short active pulses AEC/AGC is not possible.

◆ TAutoControlSpeed

Defines valid auto-control speed modes.

Auto control speed modes define the time in which the controller tries to adapt its parameters to reach the desired result.

Enumerator
acsSlow 

The controller will converge slowly to the desired value.

acsMedium 

The controller will converge to the desired value at medium speed.

acsFast 

The controller will converge fast to the desired value.

acsUserDefined 

In this mode the user can control the behaviour of the closed loop(control circuit).

◆ TAutoExposureControl

Defines valid AEC( Automatic Exposure Control ) modes.

Enumerator
aecOff 

AEC is switched off.

aecOn 

AEC is switched on.

◆ TAutoGainControl

Defines valid AGC( Automatic Gain Control ) modes.

Enumerator
agcOff 

AGC is switched off.

agcOn 

AGC is switched on.

◆ TAutoOffsetCalibration

Defines valid offset calibration modes.

Enumerator
aocOff 

The automatic offset calibration is switched off.

In this mode the offset can be adjusted manually.

aocOn 

The automatic offset calibration is switched on.

◆ TBlueFOXDigitalInputThreshold

Defines valid thresholds( in Volt ) for the digital inputs of the mvBlueFOX cameras.

Enumerator
bfdit2V 

This input is assumed as logic '1' when the voltage applied to the input lies above about 2 Volts.

bfdit10V 

This input is assumed as logic '1' when the voltage applied to the input lies above about 10 Volts.

◆ TBlueFOXFooterMode

Defines the footer mode of the mvBlueFOX.

Enumerator
bffmOff 

No footer.

bffm64B 

A 64 Byte footer (standard).

bffm512B 

A long 512 Byte footer.

◆ TBlueFOXInfoSensorCapabilities

Defines valid image sensor capabilities.

These enums may be 'ored' together.

Enumerator
bfiscNone 

A dummy constant to indicate, that this device does not have any capabilities defined by other constants belonging to this enumeration.

bfiscExposure 

The exposure time can be controlled by an application.

bfiscExposureAuto 

This sensor can automatically control the exposure time.

bfiscGain 

The gain can be controlled by an application.

bfiscGainAuto 

This sensor can automatically control the gain.

bfiscOffset 

The offset can be controlled by an application.

bfiscOffsetAuto 

This sensor can automatically control the offset.

bfiscBinning 

This sensor supports binning.

bfiscTrigger 

This sensor supports triggered acquisition.

bfiscFlash 

This sensor can output the 'exposure active' signal(e.g. to control a flash).

bfiscLineTrigger 

This sensor supports line triggered acquisition.

bfiscShadingCorrection 

This sensor can perform shading correction.

bfiscOverlappedExposure 

This sensor supports overlapped exposure.

bfiscFrameDelay 

This sensor supports frame delay.

bfiscLineDelay 

This sensor supports line delay.

bfiscAutoControlAOI 

This sensor supports to define an AOI for the AGC/AEC/AOC(Auto Offset Control) features.

bfiscAutoControlSpeed 

This sensor supports to define the control speed for the AGC/AEC/AOC(Auto Offset Control) features.

bfiscAutoControlDelay 

This sensor supports to define a delay for the AGC/AEC/AOC(Auto Offset Control) features.

bfiscTemperatureSensor 

This sensor supports a temperature sensor within the imager.

◆ TBlueFOXOffsetAutoBlackSpeed

Defines Offset Auto Calibration Controller Speed.

These are relative values, that might result in a different behaviour depending on the sensor type used.

Enumerator
bfoablFastest 

Fastest Setting.

bfoablVeryFast 

Very fast Setting.

bfoablFast 

Fast Setting.

bfoablMedium 

Medium Setting.

bfoablSlow 

Slow Setting.

bfoablVerySlow 

Very slow Setting.

bfoablSlowest 

Slowest Setting.

◆ TBlueFOXSensorTiming

Sensor timing options.

Enumerator
bfstStandard 

Standard Timing.

bfstFastLineSkip 

Fast line skip timing.

In this mode a faster line skip timing will be used. This will result in a higher frame rate in partial scan mode, but might affect the image quality.

Note
This mode is not available for every mvBlueFOX camera.
bfstLowSmearLineSkip 

This mode is not available for every mvBlueFOX camera.

◆ TBlueFOXTransferSize

Defines the block size used for the USB transfer of the mvBlueFOX.

Enumerator
bfts16KB 

16KB blocks.

bfts32KB 

32KB blocks.

bfts64KB 

64KB blocks.

bfts128KB 

128KB blocks.

bfts256KB 

256KB blocks.

bfts512KB 

512KB blocks.

bfts1024KB 

1024KB blocks.

bfts2048KB 

2048KB blocks.

◆ TCameraAoiMode

Defines the camera Aoi modes.

Enumerator
camFull 

Use the complete AOI window defined by the hardware or input data (sensor, camera).

camUser 

Use a user defined AOI window.

◆ TCameraBinningMode

Defines valid binning modes for the camera.

Note
Binning might be available for color sensors that do not support color binning. This will result in incorrect color information when the data is converted from a Bayer sensor. However under some circumstances this feature might be useful (e.g. when taking image in a very dark surrounding or at night where almost no color information will be contained in the image anyway thus resulting in useful images again). Therefore this feature has deliberately left available.

Enumerator
cbmOff 

No Binning.

cbmBinningH 

Horizontal Binning (combines 2 adjacent columns).

cbmBinningV 

Vertical Binning (combines 2 adjacent rows).

cbmBinningHV 

Combines mvIMPACT::acquire::cbmBinningH and mvIMPACT::acquire::cbmBinningV.

cbmBinning3H 

Horizontal Binning (combines 4 adjacent columns).

cbmBinning3V 

Vertical Binning (combines 4 adjacent rows).

cbmBinning3H3V 

Combines mvIMPACT::acquire::cbmBinning3H and mvIMPACT::acquire::cbmBinning3V.

cbmBinningHAvg 

Horizontal Binning with average (combines 2 adjacent columns and averages the result).

cbmBinningVAvg 

Vertical Binning with average (combines 2 adjacent rows and averages the result).

cbmBinningHVAvg 

Combines mvIMPACT::acquire::cbmBinningH and mvIMPACT::acquire::cbmBinningV.

cbmBinning3HAvg 

Horizontal Binning with average (combines 4 adjacent columns and averages the result).

cbmBinning3VAvg 

Vertical Binning with average (combines 4 adjacent rows and averages the result).

cbmBinning3H3VAvg 

Combines mvIMPACT::acquire::cbmBinning3H and mvIMPACT::acquire::cbmBinning3V.

cbmDroppingH 

Horizontal Dropping (drops every second column).

cbmDroppingV 

Vertical Dropping (drops every second row).

cbmDroppingHV 

Combines mvIMPACT::acquire::cbmDroppingH and mvIMPACT::acquire::cbmDroppingV.

cbmDropping3H 

Horizontal Dropping (drops 3 adjacent columns out of 4).

cbmDropping3V 

Vertical Binning (drops 3 adjacent rows out of 4).

cbmDropping3H3V 

Combines mvIMPACT::acquire::cbmDropping3H and mvIMPACT::acquire::cbmDropping3V.

◆ TCameraExposeMode

Defines recognized camera sensor expose modes.

Enumerator
cemStandard 

Standard sequential mode.

In this mode the sensor first is exposed and then afterwards the image readout is performed.

cemOverlapped 

Overlapped mode, expose during image readout.

This only affects the behaviour of the acquisition in mvIMPACT::acquire::TCameraTriggerMode is set to mvIMPACT::acquire::ctmContinuous.

In this mode the flash output should NOT be used. In any case the flash output will NOT work like in mvIMPACT::acquire::cemStandard but only a short pulse will be sent to the output.

cemNoShutter 

'No shutter' mode, switch off exposure control.

This only affects the behaviour of the acquisition in mvIMPACT::acquire::TCameraTriggerMode is set to mvIMPACT::acquire::ctmContinuous. In this case the shutter of the camera is never closed. Thus the exposure time in this mode is equal to the reciprocal value of the current frame rate.

◆ TCameraExternalSyncEdge

Some grabbers are able to get the video signal and sync signals ( HD-IN, VD-IN ) on separate lines. The user can define this for non standard cameras.

Enumerator
ceseNo 
ceseFallingEdge 
ceseRisingEdge 

◆ TCameraExternalSyncOutput

Some grabbers are able to get the video signal and the sync signal on different input pins. The user can select this for non standard cameras.

Enumerator
cesoAuto 
cesoRed 
cesoGreen 
cesoBlue 
cesoExtern 

◆ TCameraFlashMode

Defines valid camera flash modes.

These enumeration values may be 'ored' together.

Enumerator
cfmOff 

Do not use the cameras flash output.

cfmDigout0 

Output 0 will be active during the exposure period.

cfmDigout1 

Output 1 will be active during the exposure period.

◆ TCameraFlashType

Defines valid camera flash control types.

Enumerator
cftStandard 

Flash signal is on while the shutter is open on a frame shutter sensor or during the complete exposure period of a rolling shutter sensor.

cftRollingShutterFlash 

Flash signal is only on during the time all lines of a rolling shutter sensor are exposed.

This time is always smaller or equal to the time defined by mvIMPACT::acquire::cftStandard.

cftVSync 

Flash signal is derived from the sensors internal VSync (Frame-sync. signal).

The specific timing of this signal is hardware dependent. The signal can be used to synchronise a master camera with a flash or another camera with a rolling shutter sensor.

◆ TCameraHDRMode

Defines valid camera High Dynamic Range modes.

Enumerator
cHDRmFixed0 

Fixed HDR parameter set 0.

cHDRmFixed1 

Fixed HDR parameter set 1.

cHDRmFixed2 

Fixed HDR parameter set 2.

cHDRmFixed3 

Fixed HDR parameter set 3.

cHDRmFixed4 

Fixed HDR parameter set 4.

cHDRmFixed5 

Fixed HDR parameter set 5.

cHDRmFixed6 

Fixed HDR parameter set 6.

cHDRmUser 

User specific HDR mode, controlled by additional parameters.

◆ TCameraInterlacedType

Defines how the camera transmits its video signal.

Enumerator
citNone 

The video signal is transmitted non interlaced, meaning that a complete image is transferred without interruption.

citInterlaced 

The video signal is transferred interlaced.

Here the camera transmits the video signal in two consecutive frames that form a complete image. The first frame contains all the even lines (0, 2, 4, ... ) of the image, while the second frame contains all odd lines of the image.

citInvertedInterlaced 

The video signal is transferred interlaced with the two frames in reversed order.

Here the camera transmits the video signal in two consecutive frames that form a complete image. The first frame contains all the odd lines (0, 2, 4, ... ) of the image, while the second frame contains all even lines of the image.

◆ TCameraLinkDataValidMode

Defines how the camera transmits the DVAL signal defined in the CameraLink® standard.

Enumerator
cldvmActive 

The camera transmits a data valid (DVAL) signal, that should be evaluated by the frame grabber.

cldvmInactive 

The camera does not transmit a data valid (DVAL) signal, that should be evaluated by the frame grabber.

◆ TCameraPixelClock

Defines valid camera pixel frequencies.

Enumerator
cpcStandard 

Standard sensor clocking.

This is a legacy mode used by some devices only.

cpcHighSpeed 

High speed sensor clocking.

This is a legacy mode used by some devices only.

cpc6000KHz 

6 MHz pixel clock.

cpc8000KHz 

8 MHz pixel clock.

cpc10000KHz 

10 MHz pixel clock.

cpc12000KHz 

12 MHz pixel clock.

cpc13500KHz 

13.5 MHz pixel clock.

cpc20000KHz 

20 MHz pixel clock.

cpc24000KHz 

24 MHz pixel clock.

cpc24540KHz 

24.54 MHz pixel clock.

cpc27000KHz 

27 MHz pixel clock.

cpc32000KHz 

32 MHz pixel clock.

cpc37600KHz 

37.6 MHz pixel clock.

cpc40000KHz 

40 MHz pixel clock.

cpc50000KHz 

50 MHz pixel clock.

cpc57600KHz 

57.6 MHz pixel clock.

◆ TCameraScanMode

Defines valid scan modes for the a camera.

Enumerator
csmArea 

The connected camera is an area scan camera.

csmLine 

The connected camera is an line scan camera.

◆ TCameraSerialPortBaudRate

Defines valid baud rates for serial port communication between frame grabber and camera.

Enumerator
cspbr9600 

9600 baud

cspbr19200 

19200 baud

cspbr38400 

38400 baud

cspbr57600 

57600 baud

cspbr115200 

115200 baud

cspbr230400 

230400 baud

cspbr460800 

460800 baud

cspbr921600 

921600 baud

◆ TCameraShutterMode

Defines recognized camera sensor shutter modes.

Enumerator
csmFrameShutter 

Standard Frame-Shutter mode.

Start and stop of integration occurs at the same time for all pixels

csmElectronicRollingShutter 

Electronic rolling shutter mode (ERS)

Start and stop of integration occurs on a line by line base. Integration time is the same for all lines bit timing is slightly different

csmGlobalResetRelease 

Global reset release shutter (GRR)

Start of integration occurs at the same time for all pixels. End of integration happens on a line per line base like with ERS. This is only useful with special lighting or an mechanical extra shutter

csmFrameShutterWithFastCenterReadout 

Start and stop of integration will happen at the same time for all pixels. Uses optimization for fast centered Readout.

◆ TCameraTapsXGeometry

Multitap cameras can transmit data in different ways. This enum can be used to define how the camera transmits a line of pixels.

Enumerator
cltxg1X 

One tap. Pixels are transmitted from left to right.

cltxg1X2 

Two taps. Pixels are transmitted from left to right.

Adjacent pixels are transmitted with one pixel clock.

clock cyclePixel from Tap 1Pixel from Tap 2
112
234
.........
W/2W-1W
cltxg2X 

Two taps. Sorting of data needed.

The first tap will transmit the first half of each line, the second tap will transmit the second half of each line. Both taps will transmit pixels from left to right.

clock cyclePixel from Tap 1Pixel from Tap 2
11W/2+1
22W/2+2
.........
W/2W/2W
cltxg2XE 

Two taps. Sorting of data needed.

The first tap will transmit the first half of each line from left to right, the second tap will transmit the second half of the line from right to left.

clock cyclePixel from Tap 1Pixel from Tap 2
11W
22W-1
.........
W/2W/2W/2+1
cltxg2XM 

Two taps. Sorting of data needed.

The first tap will transmit the first half of each line from right to left, the second tap will transmit the second half of the line from left to right.

clock cyclePixel from Tap 1Pixel from Tap 2
1W/2W/2+1
2W/2-1W/2+2
.........
W/21W
cltxg1X3 

Three taps. Pixels are transmitted from left to right.

Adjacent pixels are transmitted with one pixel clock.

clock cyclePixel from Tap 1Pixel from Tap 2Pixel from Tap 3
1123
2456
............
W/3W-2W-1W
cltxg3X 

Three taps. Each tap will transmit one third of each line, pixel are transmitted from left to right. Sorting of data needed.

The first tap will transmit the first third of each line, the second tap will transmit the second third and the third tap will transmit the last third of each line from left to right.

clock cyclePixel from Tap 1Pixel from Tap 2Pixel from Tap 3
11W/3+12W/3+1
22W/3+22W/3+2
............
W/3W/32W/3W
cltxg1X4 

Four taps. Pixels are transmitted from left to right.

Adjacent pixels are transmitted with one pixel clock.

clock cyclePixel from Tap 1Pixel from Tap 2Pixel from Tap 3Pixel from Tap 4
11234
25678
...............
W/4W-3W-2W-1W
cltxg4X 

Four taps. Each tap will transmit one fourth of each line, pixel are transmitted from left to right. Sorting of data needed.

The first tap will transmit the first quarter of each line, the second tap will transmit the second quarter etc.

clock cyclePixel from Tap 1Pixel from Tap 2Pixel from Tap 3Pixel from Tap 4
11W/4+12W/4+13W/4+1
22W/4+22W/4+23W/4+2
...............
W/4W/42W/43W/4W
cltxg2X2 

Four taps. The first two taps will transmit the first half of the line, while the second two taps will transmit the second half of the line. Sorting of data needed.

Both tap pairs will transmit their data from left to right.

clock cyclePixel from Tap 1Pixel from Tap 2Pixel from Tap 3Pixel from Tap 4
112W/2+1W/2+2
234W/2+3W/2+4
...............
W/4W/2-1W/2W-1W
cltxg2X2E 

Four taps. The first two taps will transmit the first half of the line, while the second two taps will transmit the second half of the line. Sorting of data needed.

The first tap pair will transmit the data from left to right, while the second pair of taps will transfer the data from right to left.

clock cyclePixel from Tap 1Pixel from Tap 2Pixel from Tap 3Pixel from Tap 4
112W-1W
234W-3W-2
...............
W/4W/2-1W/2W/2+1W/2+2
cltxg2X2M 

Four taps. The first two taps will transmit the first half of the line, while the second two taps will transmit the second half of the line. Sorting of data needed.

The first tap pair will transmit the data from right to left, while the second pair of taps will transfer the data from left to right.

clock cyclePixel from Tap 1Pixel from Tap 2Pixel from Tap 3Pixel from Tap 4
1W/2-1W/2W/2+1W/2+2
2W/2-3W/2-2W/2+3W/2+4
...............
W/412W-1W
cltxg4XE 

Four taps. Each tap will transmit one quarter of the image. Sorting of data needed.

The first two taps will transmit the data from left to right, while the second two taps will transfer the data from right to left.

clock cyclePixel from Tap 1Pixel from Tap 2Pixel from Tap 3Pixel from Tap 4
11W/4+13W/4W
22W/4+23W/4-1W-1
...............
W/4W/4W/2W/2+13W/4+1
cltxg1X8 

Eight taps. Pixels are transmitted from left to right.

Adjacent pixels are transmitted with one pixel clock.

clock cyclePixel from Tap 1Pixel from Tap 2Pixel from Tap 3Pixel from Tap 4Pixel from Tap 5Pixel from Tap 6Pixel from Tap 7Pixel from Tap 8
112345678
2910111213141516
...........................
W/8W-7W-6W-5W-4W-3W-2W-1W
cltxg8X 

Eight taps. Each tap will transmit one eighth of each line, pixel are transmitted from left to right. Sorting of data needed.

The first tap will transmit the first eighth of each line, the second tap will transmit the second eighth etc.

clock cyclePixel from Tap 1Pixel from Tap 2Pixel from Tap 3Pixel from Tap 4Pixel from Tap 5Pixel from Tap 6Pixel from Tap 7Pixel from Tap 8
11W/8+12W/8+13W/8+14W/8+15W/8+16W/8+17W/8+1
22W/8+22W/8+23W/8+24W/8+25W/8+26W/8+27W/8+2
...........................
W/8W/82W/83W/84W/85W/86W/87W/8W
cltxg4X2 

Eight taps. Every two taps will transmit one quarter of the line. Sorting of data needed.

All tap pairs will transmit their data from left to right.

clock cyclePixel from Tap 1Pixel from Tap 2Pixel from Tap 3Pixel from Tap 4Pixel from Tap 5Pixel from Tap 6Pixel from Tap 7Pixel from Tap 8
112W/4+1W/4+2W/2+1W/2+23W/4+13W/4+2
234W/4+3W/4+4W/2+3W/2+43W/4+33W/4+4
...........................
W/8W/4-1W/4W/2-1W/23W/4-13W/4W-1W
cltxg4X2E 

Eight taps. Every two taps will transmit one quarter of the line. Sorting of data needed.

Taps 1 to 4 will transmit the data from left to right, while taps 5 to 8 will transmit the data from right to left.

clock cyclePixel from Tap 1Pixel from Tap 2Pixel from Tap 3Pixel from Tap 4Pixel from Tap 5Pixel from Tap 6Pixel from Tap 7Pixel from Tap 8
112W/4+1W/4+23W/4-13W/4W-1W
234W/4+3W/4+43W/4-33W/4-2W-3W-2
...........................
W/8W/4-1W/4W/2-1W/2W/2+1W/2+23W/4+13W/4+2
Since
2.4.0

◆ TCameraTapsYGeometry

Multi-tap cameras can transmit data in different ways. This enumeration can be used to define how the camera transmits the lines of pixels.

Enumerator
cltyg1Y 

Lines from top to bottom.

cltyg1Y2 

Two neighbouring lines are transmitted during one FVAL.

cltyg2YE 

One line from top and one line from bottom are transmitted during one FVAL.

◆ TCameraTestMode

Defines valid transmission modes for the camera.

Enumerator
ctmOff 

The 'normal' camera image will be transmitted.

ctmGreyRamp 

A grey gradient will be transmitted by the camera.

ctmMovingColor 

A color test image with some moving components in it will be displayed.

ctmWBTest 

A raw white Bayer image will be transmitted.

◆ TCameraTriggerMode

Defines valid camera sensor trigger modes.

Enumerator
ctmContinuous 

Don't wait for trigger. In this mode the camera continuously exposes images with the current settings.

However images are not transferred to the host system automatically in this mode, so NO CPU load or whatsoever is produced in this mode when the driver isn't asked for images by the user.

This mode is recommended for most applications and will be available for every image sensor.

When the user requests an image the image AFTER the next frame start will be returned. In applications that need fast but NOT continuous image transfer the mvIMPACT::acquire::ctmOnDemand therefore might be more interesting.

ctmOnDemand 

Start frame expose when the software asks for an image.

Here without image requests by the user the image sensor will not expose images. An exposure and image transmission will start immediately after at least one images has been requested by the user.

When e.g. a camera in free running mode captures 30 images per sec. and the user needs an image every 40 ms (25 fps) this mode might be more suitable then mvIMPACT::acquire::ctmContinuous as in the continuous mode when asking for an image every 40 ms the user might need to wait for the next frame start which at 30 Hz in the worst case would result in a capture time of (1/30Hz)*2 = 66.6 ms when an image start has just been missed. In mvIMPACT::acquire::ctmOnDemand however the image exposure will be started immediately after the request reaches the camera thus no delay will be introduced.

Note
In applications where the capture time can be disregarded because either the transfer time is much higher or the capture frequency is very low the difference between the mvIMPACT::acquire::ctmOnDemand and the mvIMPACT::acquire::ctmContinuous can be disregarded as well. However in this case mvIMPACT::acquire::ctmContinuous is recommended as this mode will be available for every sensor type and is more universal.
ctmOnLowLevel 

Start the exposure of a frame when the trigger input is below the trigger threshold.

Each time an image is requested and the trigger signal is below the trigger threshold a image will be captured.

ctmOnHighLevel 

Start the exposure of a frame when the trigger input is above the trigger threshold.

Each time an image is requested and the trigger signal is above the trigger threshold a image will be captured.

ctmOnFallingEdge 

Start the exposure of a frame when the trigger input level changes from high to low.

ctmOnRisingEdge 

Start the exposure of a frame when the trigger input level changes from low to high.

ctmOnHighExpose 

Start frame expose when the trigger input level rises above the trigger threshold and expose while the trigger input level remains above this threshold.

ctmOnLowExpose 

Start frame expose when the trigger input level falls below the trigger threshold and expose while the trigger input level remains below this threshold.

ctmOnAnyEdge 

Start the exposure of a frame when the trigger input level changes from high to low or from low to high.

ctmFramerateControlled 

Start the exposure of a frame when the trigger input level changes from high to low or from low to high.

This mode is behaves like ctmContinuous but allows the FPS-Rate to be controlled directly.

◆ TCameraTriggerSource

Defined valid camera sensor trigger source values.

Enumerator
ctsDigIn0 

Uses digital input 0 as the source for the trigger signal.

ctsDigIn1 

Use digital input 1 as the source for the trigger signal.

ctsRTCtrl 

Use real time controller (RTCtrl) as the source for the trigger signal.

ctsDigOut0 

Uses digital output 0 as the source for the trigger signal (this allows a SW controlled trigger (or exposure)).

ctsDigOut1 

Uses digital output 1 as the source for the trigger signal (this allows a SW controlled trigger (or exposure)).

ctsDigOut2 

Uses digital output 2 as the source for the trigger signal (this allows a SW controlled trigger (or exposure)).

ctsDigOut3 

Uses digital output 3 as the source for the trigger signal (this allows a SW controlled trigger (or exposure)).

◆ TClampMode

enum TClampMode

Clamp signal means, that an AC coupled video signal is clamped on the porch to get a signal transfer with less noise and independent from the d.c. voltage portion.

The clamp pulse width is always 0.5 micro sec.

Enumerator
ecmAuto 

Clamp pulse starts at 80 % of ActiveVideoAoi/X .

ecmUser 

The user can set the clamp start time in micro sec. after the falling edge of the video signals' VSync.

◆ TDeviceAdvancedOptions

Defines valid advanced options.

These enums may be 'ored' together.

Enumerator
daoOff 

No advanced option selected.

daoLowLight 

Put camera in low light mode.

This is a special feature offered by some sensors. Typically this will enable an additional analogue gain that will increase both the luminance and the noise of the resulting image. This feature can not be configured any further and there also is no additional information available on this topic.

daoEmbeddedImageInfo 

Embed sensor specific info into the image readout buffer.

daoImageAverage 

Calculate the average intensity value of the image and return as part of the request.

daoPipelinedGainExposeControl 

Enable pipelined Gain/Exposure control.

This will result in a changed exposure or gain value becoming active not with the next frame but the one after that. Changing Gain/Exposure will be faster in pipelined Gain/Exposure control mode.

Since
2.1.3
daoOnDemandTriggerPreShot 

Enable on demand trigger pre-shot option.

This will trigger an internal image capture cycle on the sensor prior to the user requested frame. Can be used to remove variations in image quality when working with unstable frame rates.

Since
2.5.0
daoLowFrameRateOptimization 

Enable low frame rate optimization.

This will result in a much reduced variation in the offset signal when changing the sensor frame rate or running the sensor at low frame rates. The offset will change slightly if switched on and the signal response is slightly reduced.

daoEnablePerChannelOffsetCorrection 

Enable per channel offset correction.

Allow per channel offset correction in non auto offset mode for sensors with a Bayer (RGGB) based analog path. The per channel offset value will be added to the master offset (Offset_pc).

daoUseRawSensorGain 

Enable raw sensor gain.

Use mathematical correct gain for sensor setting. Thus increasing the gain by 6 dB will actually result in a factor of 2. However with this option enabled the gain range will include values so low that the pixel saturation charge will be with in ADC digitizer range thus an over-saturated image will contain pixels that do NOT contain the maximum value for the given pixel format.

Since
2.5.6
daoTriggerSensorColumnCalibration 

Trigger sensor column correction.

When switched on this triggers a single column correction calibration process when requesting an image. To do it again switch it off and on again. This should be done while no acquisition is running. Changing gain or AOI could make such a recalibration necessary.

◆ TDeviceDigitalOutputMode

Defines grabber specific digital output modes.

Enumerator
ddomManual 

The digital output can be switched manually.

ddomPulse 

A single pulse will be generated on the digital output.

ddomUser 

A user defined signal will be generated on the digital output.

ddomExposureActive 

The digital output will change its state during the active exposure period of the image sensor and will switch back to its initial state again once the exposure period is over.

ddomDigitalSignalPassThrough 

A signal connected to a digital input is passed through to this digital output.

ddomDigitalSignalPassThroughInv 

A signal connected to a digital input is inverted and passed to this digital output.

ddomInternalVD 

An internal VD sync. signal will be passed to this digital output.

In case of a camera this e.g. might be the cameras internal VD signal. This then can be used to synchronize two or more cameras.

ddomRealTimeController 

The digital output is controlled by a Real Time Controller.

ddomExposureAndAcquisitionActive 

When there is at least one outstanding request the digital output will change its state during the active exposure period of the image sensor and will switch back to its initial state again once the exposure period is over.

ddomTemperatureOutOfRange 

Will change the state whenever the device temperature moves in or out of defined limits(subject to change!).

◆ TDeviceImageTrigger

Defines acquisition start event if using pulse sequences.

Enumerator
ditImmediately 

Acquisition starts with trigger event as fast as possible.

ditAfterDigOutSignals 

Acquisition starts after all defined signals have been generated on the digital outputs.

◆ TDevicePowerMode

Defines the power mode for this device.

Enumerator
dpmOn 

This device is switched on.

dpmOff 

This device is switched off.

This might save a considerable amount of energy if the device isn't needed for a certain amount of time.

◆ TDeviceScanRateMode

Defines valid device scan rate mode.

Enumerator
dsrmAuto 

Auto, scan rate of camera used.

dsrmUser 

User, scan rate must be set manually.

◆ TDeviceSignalOutputStartEvent

Defines valid moments to start the signal generation on the digital outputs.

Enumerator
dsoseFrame 

The signal generation on the digital outputs starts with the next frame start signal ( e.g.: VSync ).

dsoseTrigger 

The signal generation on the digital outputs starts with the event defined in setting->camera->trigger.

dsoseFrameAfterTrigger 

The signal generation on the digital outputs starts with next frame signal after the event defined in setting->camera->trigger.

dsoseSyncInRisingEdge 

The signal generation on the digital outputs starts with the rising edge of SyncIn - signal. CameraLink® only!!!

dsoseSyncInFallingEdge 

The signal generation on the digital outputs starts with the falling edge of SyncIn - signal. CameraLink® only!!!

dsoseSyncInPassThrough 

The SyncIn - signal is passed to the selected digital output. CameraLink® only!!!

dsoseSyncInPassThroughInv 

The SyncIn - signal is inverted and passed to the selected digital output. CameraLink® only!!!

dsosePeriodically 

The signal generation on the digital outputs starts periodically. CameraLink® only!!!

dsoseTriggerInPassThrough 

The TriggerIn - signal is passed to the selected digital output. CameraLink® only!!!

dsoseTriggerInPassThroughInv 

The TriggerIn - signal is inverted and passed to the selected digital output. CameraLink® only!!!

dsoseFVALPassThrough 

The FVAL - signal is passed to the selected digital output. CameraLink® only!!!

dsoseFVALPassThroughInv 

The FVAL - signal is inverted and passed to the selected digital output. CameraLink® only!!!

dsoseFVALRisingEdge 

The signal generation on the digital outputs starts with the rising edge of FVAL - signal. CameraLink® only!!!

◆ TDeviceSyncOutMode

Valid sync. signal output modes for frame grabbers.

Currently only mvTITAN-RGB boards support this feature.

Enumerator
dsomOff 

Sync. signals off.

dsomNonInterlaced 

A non interlaced HD-out/VD-out signal is generated.

dsomInterlaced 

A interlaced HD-out/VD-out signal is generated.

◆ TDeviceTriggerInterface

Defines which trigger interface is currently active for the device.

A device might offer different views on the properties that can be used to configure trigger signals and events.

Enumerator
dtiStandard 

The standard trigger interface.

When this trigger interface is used, the configuration of an external trigger signal can be done very easy. However more complex scenarios might not be possible using this view on the trigger configuration.

dtiAdvanced 

The advanced view on the trigger interface.

When this view on the interface is selected, all features offered by the device regarding the creation of trigger events will be visible. So more complex configurations are possible but more knowledge about the hardware is required as well.

◆ TDeviceTriggerMode

Valid trigger modes for frame grabber boards.

Enumerator
dtmOff 

Trigger off.

dtmOn 

Trigger on.

dtmFallingEdge 

Trigger on falling edge of an external signal.

dtmRisingEdge 

Trigger on rising edge of an external signal.

dtmPeriodically 

Timer is used to simulate trigger.

dtmOnDemand 

Request simulates trigger.

dtmStartRisingStopFalling 

Line scan mode: Acquisition starts with rising edge and stops with falling edge of trigger ( mvTITAN/mvGAMMA-CL only )

dtmStartFallingStopRising 

Line scan mode: Acquisition starts with falling edge and stops with rising edge of trigger ( mvTITAN/mvGAMMA-CL only )

dtmLevelHigh 

Trigger valid as long as the level of the source signal is high.

dtmLevelLow 

Trigger valid as long as the level of the source signal is low.

◆ TDeviceTriggerOverlap

Specifies the type trigger overlap permitted with the previous frame.

This defines when a valid trigger will be accepted (or latched) for a new frame.

Enumerator
dtoOff 

No trigger overlap is permitted.

dtoReadOut 

Trigger is accepted immediately after the exposure period.

dtoPreviousFrame 

Trigger is accepted at any time during the capture of the previous frame.

◆ TDigIOState

Defines valid digital I/O states.

Enumerator
digioOff 

Digital I/O is in 'logic 0' state.

digioOn 

Digital I/O is in 'logic 1' state.

digioIgnore 

Digital Input is in 'ignore' state.

digioKeep 

Digital Output is kept in unchanged state.

◆ TDigitalIOMeasurementMode

Defines valid IO Measurement Modes.

The shorter the gate time the faster results will be available. However a shorter gate time will also result in a less accurate measurement.

Enumerator
diommFrequency_Hz_10ms 

Measure frequency with a 10 ms gate time.

diommFrequency_Hz_100ms 

Measure frequency with a 100 ms gate time.

◆ TDigitalIOMeasurementSource

Defines valid IO Measurement Sources.

This will define where the actual measurement will take place.

Enumerator
diomsInput0 

Measurement will be done on digital input 0.

diomsInput1 

Measurement will be done on digital input 1.

diomsInput2 

Measurement will be done on digital input 2.

diomsInput3 

Measurement will be done on digital input 3.

◆ TDigitalOutputControlMode

Defines valid ways to create signals on a digital output.

Enumerator
docmSoftware 

The digital output signal is generated by the on-board processor.

docmRTC 

The digital output signal is generated by a Real Time Controller that is part of the used hardware device.

◆ TDigitalSignal

Defines valid digital source signal constants that can be used to configure a devices behaviour in certain digital I/O related modes.

As these parameters are highly device dependent, no direct name like dsTriggerJ8/12 are defined here. However when the translation dictionary for a property with this type is queried, the string representation for the enumeration value will contain a more descriptive name for the digital signal.

Enumerator
dsNone 

A dummy value to delete a mask or signal configuration.

dsSignal1 

A constant for digital signal 1.

dsSignal2 

A constant for digital signal 2.

dsSignal3 

A constant for digital signal 3.

dsSignal4 

A constant for digital signal 4.

dsSignal5 

A constant for digital signal 5.

dsSignal6 

A constant for digital signal 6.

dsSignal7 

A constant for digital signal 7.

dsSignal8 

A constant for digital signal 8.

dsSignal9 

A constant for digital signal 9.

dsSignal10 

A constant for digital signal 10.

dsSignal11 

A constant for digital signal 11.

dsSignal12 

A constant for digital signal 12.

dsSignal13 

A constant for digital signal 13.

dsSignal14 

A constant for digital signal 14.

dsSignal15 

A constant for digital signal 15.

dsSignal16 

A constant for digital signal 16.

◆ TFieldGateMode

The fieldgate is used to detect the field ( odd or even ) for interlaced video signals.

Enumerator
efmAuto 

Fieldgate starts at 1/3 of a line and ends at 2/3 of a line.

efmUser 

FieldGateStart and FieldGateWidth can be set in pixels.

◆ TI2COperationMode

Valid I2C operation modes.

Enumerator
I2ComRead 

Selects I2C read access.

I2ComWrite 

Selects I2C write access.

◆ TI2COperationStatus

Valid I2C operation status values.

Enumerator
I2CosSuccess 

The last I2C operation was successful.

I2CosFailure 

The last I2C operation did fail. The log-file might contain additional information.

I2CosInvalidDeviceAddress 

During the execution of the last I2C operation an invalid device address was specified.

I2CosInvalidDeviceSubAddress 

During the execution of the last I2C operation an invalid device sub-address was specified.

This can either be caused by an invalid address or by an invalid address width.

I2CosTooMuchData 

During the execution of the last I2C operation too much data was either requested or sent.

I2CosNotEnoughData 

During the execution of the last I2C operation the amount of data requested or sent was too small.

◆ TInfoSensorColorMode

Defines the type of camera sensor.

Enumerator
iscmUnknown 

This is an unknown type of sensor.

iscmMono 

This is a mono sensor.

iscmBayer 

This is a Bayer color sensor.

iscmColor 

This is a color sensor.

iscmNIR 

This is a sensor sensitive in the near IF spectrum only.

◆ TInfoSensorColorPattern

Defines the bayer pattern of the sensor.

Enumerator
iscpGreenRed 

This sensor starts to transmit a green pixel from a green and red line.

The raw image therefore is structured like this:

GRGRGRGRGRGRG etc.
BGBGBGBGBGBGB etc.
GRGRGRGRGRGRG etc.
etc.

iscpRedGreen 

This sensor starts to transmit a red pixel from a green and red line.

The raw image therefore is structured like this:

RGRGRGRGRGRGR etc.
GBGBGBGBGBGBG etc.
RGRGRGRGRGRGR etc.
etc.

iscpBlueGreen 

This sensor starts to transmit a green pixel from a green and blue line.

The raw image therefore is structured like this:

GBGBGBGBGBGBG etc.
RGRGRGRGRGRGR etc.
GBGBGBGBGBGBG etc.
etc.

iscpGreenBlue 

This sensor starts to transmit a blue pixel from a green and blue line.

The raw image therefore is structured like this:

BGBGBGBGBGBGB etc.
GRGRGRGRGRGRG etc.
BGBGBGBGBGBGB etc.
etc.

iscpUnknown 

Nothing is known about the way the sensor transmits data.

◆ TInfoSensorType

Defines the type of camera sensor.

Enumerator
istUnknown 

This is an unknown type of sensor.

istCCD 

This is a CCD sensor.

istCMOS 

This is a CMOS sensor.

◆ TInterlacedMode

Defines how to handle interlaced image data.

Image data might be transmitted as fields. These later can either be combined back into a full frame or can be handled individually.

Enumerator
imOn 

Enable the interlaced function.

The device will re-construct the interlaced data into a full frame. InvInterlaced/Interlaced is controlled by the camera parameter.

imOff 

Disable the interlaced function.

◆ TLineCounter

Currently available for mvTITAN/mvGAMMA-CL.

If mvIMPACT::acquire::lcOn is used mvIMPACT::acquire::Request::infoLineCounter will contain the overall line count.

mvTITAN/mvGAMMA-CL: The counter is implemented in the hardware. All incoming lines will be counted. A detected signal on the trigger input will reset the counter. In addition to the result the line count will be encoded in bit 0 of the first 32 Words (2-byte) of every line (watermark).

To decode the line counter from a line of image data something like this is needed(pseudo-code):

unsigned integer getWatermark( pointer pData )
{
unsigned integer result = 0
do
{
result = result OR ( pData[i multiplied by 2] AND 0x1 ) shift_left_by(i)
i + 1
} while( i < 32 )
return result
}
Enumerator
lcOff 

Disables line counter.

lcOn 

Enables line counter.

◆ TOnBoardMemoryMode

Defines valid modes for the handling of the device' on board memory (if available)

Enumerator
obmmDefault 

The device will work with reasonable default values.

This option will be the right choice for most of the user.

obmmUser 

The user can define how the on board memory of the device will be used.

This is for advanced user only and will not be necessary in most of the cases.

◆ TPulseStartTrigger

Defines valid pulse start trigger values.

Enumerator
pstDigitalSignal 

Changes on one or more digital inputs will trigger the output of the pulse or pulse sequence.

pstPeriodically 

The output of a pulse or pulse sequence will be done periodically.

pstRotaryDecoder 

The output of a rotary decoder will trigger the output of the pulse or pulse sequence.

◆ TRTCtrlModes

Defines valid RTCtrl Modes.

Enumerator
rtctrlModeStop 

RTC switched off and editable.

rtctrlModeRun 

RTC switched on and NOT editable.

rtctrlModeRunRestart 

RTC switched on and restart after changes.

◆ TRTProgOpCodes

Defines valid RTProg OpCodes.

Enumerator
rtctrlProgNop 

Do nothing.

rtctrlProgSetDigout 

Set digital outputs.

rtctrlProgWaitDigin 

Wait for digital inputs.

rtctrlProgWaitClocks 

Wait for n clocks.

rtctrlProgJumpLoc 

Jump to location.

rtctrlProgTriggerSet 

Set internal trigger signal of the sensor controller.

rtctrlProgTriggerReset 

Reset internal trigger signal of the sensor controller.

rtctrlProgExposeSet 

Set internal expose signal of the sensor controller.

rtctrlProgExposeReset 

Reset internal expose signal of the sensor controller.

rtctrlProgFrameNrReset 

Reset internal sensor frame counter.

rtctrlProgJumpLocOnZero 

Jump to location if a certain register contains zero.

rtctrlProgJumpLocOnNotZero 

Jump to location if a certain register differs from zero.

rtctrlProgRegisterSet 

Set a registers value.

rtctrlProgRegisterAdd 

Add a constant value to a register.

rtctrlProgRegisterSub 

Subtract a constant value from a register.

◆ TScanClock

enum TScanClock

Analogue grabbers generate its scan clock on different ways.

Enumerator
scAuto 

The cameras clock signal is used.

If the property pixelClockOutput in the camera description is either set to mvIMPACT::acquire::ceseFallingEdge or mvIMPACT::acquire::ceseRisingEdge. Otherwise mvIMPACT::acquire::scAnalogue is used for mvTITAN-RGB and mvTITAN-G1 devices and mvIMPACT::acquire::scDigital for mvGAMMA-G devices. Other devices currently do not support this feature.

scAnalogue 

The scan clock is generated by genlocking on horizontal sync.(HD) signal.

ADVANTAGES:

  • very small jitter (typically around some 100 pico seconds) -> suitable for high pixel clock (>20Mhz)
  • for matching HD freq. values (with respect to the signal send by the camera) this will produce results almost as good as when working with an external clock signal(less scan artifacts)

DISADVANTAGES:

  • slow reaction time -> not suitable for fast channel switching
  • not suitable for signals with a pixel clock below 12 MHz
scDigital 

The scan clock is generated digitally.

ADVANTAGE:

  • locked after a single line, therefore this mode is very useful for fast channel switching

DISADVANTAGE:

  • bigger jitter as the analogue mode(<10ns), therefore not suitable for cameras with a pixel clock higher then about 20Mhz

◆ TScanStandard

Defines valid scan modes for standard cameras.

Enumerator
ssITU601 

720 x 576 Pixels for 50 Hz standard cameras, 720 x 480 Pixels for 60 Hz standard cameras

ssSquare 

768 x 576 Pixels for 50 Hz standard cameras, 640 x 480 Pixels for 60 Hz standard cameras

ssUser 

The user can define scan rate and camera AOI.

◆ TTriggerMoment

Defines a trigger moment for a digital signal.

This can e.g. be the moment a signal connected to a device changes it state or reaches a certain state.

Enumerator
tmOnFallingEdge 

A falling edge will trigger the event.

tmOnRisingEdge 

A rising edge will trigger the event.

◆ TVirtualDeviceImageType

Defines valid image types used when capturing data from a certain directory.

These enums may be 'ored' together.

Enumerator
vditNone 

Will capture none of the recognized image formats.

vditBMP 

Will capture BMP files.

vditPGM 

Will capture PGM files.

vditPNG 

Will capture PNG files.

Note
This requires the FreeImage (see http://freeimage.sourceforge.net/) library being present on the target system. See Use Cases section of the mvVirtualDriver for details.
Since
2.11.9
vditJPG 

Will capture JPG files.

Note
This requires the FreeImage (see http://freeimage.sourceforge.net/) library being present on the target system. See Use Cases section of the mvVirtualDriver for details.
Since
2.11.9
vditTIFF 

Will capture TIFF files.

Note
This requires the FreeImage (see http://freeimage.sourceforge.net/) library being present on the target system. See Use Cases section of the mvVirtualDriver for details.
Since
2.11.9
vditALL 

Will capture all supported image formats.

◆ TVirtualDeviceTestMode

Defines valid test modes for virtual devices.

Enumerator
vdtmMovingRGBx888PackedImage 

Will generate a moving test pattern with pixel format mvIMPACT::acquire::ibpfRGBx888Packed.

vdtmMovingRGB888PackedImage 

Will generate a moving test pattern with pixel format mvIMPACT::acquire::ibpfRGB888Packed.

vdtmMovingRGBx888PlanarImage 

Will generate a moving test pattern with pixel format mvIMPACT::acquire::ibpfRGBx888Planar.

vdtmMovingMonoRamp 

Will generate a moving horizontal test pattern with a mono pixel format.

vdtmMovingYUV422PackedRamp 

Will generate a moving test pattern with pixel format mvIMPACT::acquire::ibpfYUV422Packed or mvIMPACT::acquire::ibpfYUV422_10Packed depending on the value of the 'ChannelBitDepth' property.

vdtmMovingYUV422PlanarRamp 

Will generate a moving test pattern with pixel format mvIMPACT::acquire::ibpfYUV422Planar.

vdtmMovingRGB101010PackedImage 

Will generate a moving test pattern with pixel format mvIMPACT::acquire::ibpfRGB101010Packed.

vdtmMovingRGB121212PackedImage 

Will generate a moving test pattern with pixel format mvIMPACT::acquire::ibpfRGB121212Packed.

vdtmMovingRGB141414PackedImage 

Will generate a moving test pattern with pixel format mvIMPACT::acquire::ibpfRGB141414Packed.

vdtmMovingRGB161616PackedImage 

Will generate a moving test pattern with pixel format mvIMPACT::acquire::ibpfRGB161616Packed.

vdtmMovingBayerDataRamp 

Will generate a moving Bayer test pattern.

vdtmBayerWhiteBalanceTestImage 

Will generate a still Bayer test pattern that can be used for white balancing.

vdtmImageDirectory 

Will capture images from a user supplied directory.

vdtmLeakyPixelTestImageMono8Bayer 

Will generate a still 8 bit Bayer test pattern for leaky pixel calibration.

vdtmMovingYUV422_UYVYPackedRamp 

Will generate a moving test pattern with pixel format mvIMPACT::acquire::ibpfYUV422_UYVYPacked or mvIMPACT::acquire::ibpfYUV422_UYVY_10Packed depending on the value of the 'ChannelBitDepth' property.

vdtmHorizontalMonoRamp 

Will generate a horizontal mono ramp.

vdtmVerticalMonoRamp 

Will generate a vertical mono ramp.

vdtmMovingVerticalMonoRamp 

Will generate a moving vertical mono ramp.

vdtmHorizontalMono12Packed_V2Ramp 

Will generate a horizontal mono ramp with pixel format mvIMPACT::acquire::ibpfMono12Packed_V2.

vdtmMovingBGR888PackedImage 

Will generate a moving test pattern with pixel format mvIMPACT::acquire::ibpfBGR888Packed.

vdtmMovingYUV444PackedRamp 

Will generate a moving test pattern with pixel format mvIMPACT::acquire::ibpfYUV444Packed or mvIMPACT::acquire::ibpfYUV444_10Packed depending on the value of the 'ChannelBitDepth' property.

vdtmMovingYUV444_UYVPackedRamp 

Will generate a moving test pattern with pixel format mvIMPACT::acquire::ibpfYUV444_UYVPacked or mvIMPACT::acquire::ibpfYUV444_UYV_10Packed depending on the value of the 'ChannelBitDepth' property.

vdtmMovingBGRPacked_V2Image 

Will generate a moving test pattern with pixel format mvIMPACT::acquire::ibpfBGR101010Packed_V2.

vdtmEmptyMonoBuffer 

Will just allocate but not initialize a mono buffer.

vdtmHorizontalMono12Packed_V1Ramp 

Will generate a horizontal mono ramp with pixel format mvIMPACT::acquire::ibpfMono12Packed_V1.

Since
2.5.0
vdtmHorizontalBayer12Packed_V1Ramp 

Will generate a horizontal Bayer ramp with pixel format mvIMPACT::acquire::ibpfMono12Packed_V1.

Since
2.5.2
vdtmHorizontalBayer12Packed_V2Ramp 

Will generate a horizontal Bayer ramp with pixel format mvIMPACT::acquire::ibpfMono12Packed_V2.

Since
2.5.2
vdtmMovingYUV411_UYYVYY_PackedRamp 

Will generate a moving test pattern with pixel format mvIMPACT::acquire::ibpfYUV411_UYYVYY_Packed.

Since
2.13.0
vdtmMovingRGB888PlanarImage 

Will generate a moving test pattern with pixel format mvIMPACT::acquire::ibpfRGB888Planar.

Since
2.17.0
vdtmHotAndColdPixelTestImageBayer 

Will generate a still Bayer test pattern for hot and cold pixel calibration.

Since
2.31.0
vdtmHotAndColdPixelTestImageRGB888Packed 

Will generate a still RGB8 test pattern for hot and cold pixel calibration.

Since
2.33.0