mvIMPACT::acquire Namespace Reference


Namespaces

namespace  GenICam

Classes

class  ImpactAcquireException
 An base class for exceptions generated by this module. More...
class  EDeviceManager
 A base class for device manager related exceptions. More...
class  EPropertyHandling
 A base class for exceptions related to the property module. More...
class  EComponent
 A base class for mvIMPACT::acquire::Component object related exceptions from the property module. More...
class  ENotAList
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_NOT_A_LIST error. More...
class  ENotAProperty
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_NOT_A_PROPERTY error. More...
class  ENotAMethod
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_NOT_A_METHOD error. More...
class  ENoReadRights
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_NO_READ_RIGHTS error. More...
class  ENoWriteRights
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_NO_WRITE_RIGHTS error. More...
class  ENoModifySizeRights
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_NO_MODIFY_SIZE_RIGHTS error. More...
class  EIncompatibleComponents
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_INCOMPATIBLE_COMPONENTS error. More...
class  ENoUserAllocatedMemory
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_NO_USER_ALLOCATED_MEMORY error. More...
class  EProperty
 A base class for mvIMPACT::acquire::Property related exceptions from the property module. More...
class  EInvalidValue
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_INVALID_PROP_VALUE error. More...
class  EValIDOutOfBounds
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_PROP_VAL_ID_OUT_OF_BOUNDS error. More...
class  ETranslationTableCorrupted
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_PROP_TRANSLATION_TABLE_CORRUPTED error. More...
class  ETranslationTableNotDefined
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_PROP_TRANSLATION_TABLE_NOT_DEFINED error. More...
class  EInvalidValueType
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_INVALID_PROP_VALUE_TYPE error. More...
class  EValTooLarge
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_PROP_VAL_TOO_LARGE error. More...
class  EValTooSmall
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_PROP_VAL_TOO_SMALL error. More...
class  EValidationFailed
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_PROP_VALIDATION_FAILED error. More...
class  EPropertyList
 A base class for component list related exceptions from the property module. More...
class  EComponentNotFound
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_COMPONENT_NOT_FOUND error. More...
class  EListEntryOccupied
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_LIST_ENTRY_OCCUPIED error. More...
class  EComponentIDInvalid
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_COMPONENT_ID_INVALID error. More...
class  EInvalidListID
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_LIST_ID_INVALID error. More...
class  ECantAccessData
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_LIST_CANT_ACCESS_DATA error. More...
class  ECantRegisterComponent
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_CANT_REGISTER_COMPONENT error. More...
class  EMethod
 A base class for mvIMPACT::acquire::Method object related exceptions from the property module. More...
class  EMethodPtrInvalid
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_METHOD_PTR_INVALID error. More...
class  EInvalidParameterList
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_METHOD_INVALID_PARAM_LIST error. More...
class  EUnsupportedParameter
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_UNSUPPORTED_PARAMETER error. More...
class  ESizeMismatch
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_SIZE_MISMATCH error. More...
class  EImplementationMissing
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_IMPLEMENTATION_MISSING error. More...
class  EInvalidInputParameter
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_INVALID_INPUT_PARAMETER error. More...
class  EInputBufferTooSmall
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_INPUT_BUFFER_TOO_SMALL error. More...
class  EWrongParamCount
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_WRONG_PARAM_COUNT error. More...
class  EUnsupportedOperation
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_UNSUPPORTED_OPERATION error. More...
class  ECantSerializeData
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_CANT_SERIALIZE_DATA error. More...
class  EInvalidFileContent
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_INVALID_FILE_CONTENT error. More...
class  ECantAllocateNewList
 An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_CANT_ALLOCATE_LIST error. More...
class  ExceptionFactory
 A factory class to raise mvIMPACT acquire related exceptions. More...
class  ComponentAccess
 A base class to implement access to internal driver objects. More...
class  Component
 A base class to implement access to internal driver components. More...
class  ComponentCallback
 A simple helper class to wrap the creation of a callback object. More...
class  ComponentLocatorBase
 A base class to locate components within the driver. More...
class  ComponentLocator
 A class to locate components within the driver. More...
class  ComponentIterator
 A class to iterate over component lists. More...
class  ComponentList
 A class to provide access to component lists. More...
class  Method
 A class to call arbitrary driver functions. More...
class  Property
 A base class for properties. More...
class  EnumPropertyF
 A template class to represent float properties and enumerated float properties. More...
class  EnumPropertyI
 A template class to represent 32 bit integer properties and 32 bit enumerated integer properties. More...
class  EnumPropertyI64
 A template class to represent 64 bit integer properties and enumerated 64 bit integer properties. More...
class  PropertyPtr
 A class to represent pointer properties. More...
class  PropertyS
 A class to represent string properties. More...
class  UserDataEntry
 A helper class that represents one entry in the devices non-volatile memory (if available). More...
class  UserData
 A helper class to work with the device specific non-volatile memory(if available). More...
class  Device
 This class and its functions represent an actual device detected by this interface in the current system. More...
class  DeviceManager
 Grants access to devices that can be operated by this software interface. More...
class  DeviceComponentLocator
 A class to locate components within the driver. More...
class  ImageBufferDesc
 A wrapper class to handle mvIMPACT::acquire::ImageBuffer structures. More...
class  Request
 Contains information about a captured image. More...
class  ComponentCollection
 A base class for sets of properties, that can be modified by the user. More...
class  ImageRequestControl
 A helper class to control the way an image request will be processed. More...
class  RequestFactory
 A default request factory. More...
class  FunctionInterface
 The function interface to devices supported by this interface. More...
class  InfoBase
 A base class to access various general information about the device and its driver. More...
class  Info
 A class to query various general information about the device, its driver and other information. More...
class  BasicDeviceSettings
 A base class for essential device related settings. More...
class  TriggerControl
 A class to configure the behaviour of trigger signals. More...
class  ImageDestination
 Properties to define the result images format. More...
class  WhiteBalanceSettings
 Properties for adjusting the colors during a Bayer conversion. More...
class  GainOffsetKneeChannelParameters
 Properties for configuring settings belonging to a certain channel of the GainOffsetKnee filter. More...
class  LUTParameters
 Properties for configuring settings belonging to a certain LUT(LookUp Table) to be applied to a captured image. More...
class  MirrorParameters
 Properties for configuring settings belonging to the mirror filter that processes a certain channel of a captured image. More...
class  ImageProcessing
 Base class for image processing related properties. More...
class  StatisticsBase
 Contains basic statistical information. More...
class  Statistics
 Contains statistical information. More...
class  SystemBase
 A base class for accessing settings that control the overall behaviour of a device driver. More...
class  SystemSettings
 A class for accessing general settings that control the overall behaviour of a device driver. More...
class  InfoBlueDevice
 A more specific class to query information about a mvBlueDevice device and its driver(Device specific interface layout only). More...
class  InfoBlueCOUGAR
 A more specific class to query information about a mvBlueCOUGAR or mvBlueLYNX-M7 device and its driver(Device specific interface layout only). More...
class  DigitalInput
 A class to represent a digital input pin(Device specific interface layout only). More...
class  DigitalOutput
 A class to represent a digital output pin(Device specific interface layout only). More...
class  SyncOutput
 A class to represent a sync. output pin(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  RTCtrProgram
 A class to represent real time control programs(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  EventWaitResults
 A class containing the result of a wait call for events (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  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  IOSubSystem
 A base class to handle digital inputs and outputs(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  OutputSignalGeneratorBlueDevice
 A class to create complex digital output signals(Device specific interface layout only). More...
class  IOSubSystemBlueCOUGAR
 A class to handle the digital inputs and outputs of a mvBlueCOUGAR of mvBlueLYNX-M7 device(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  CameraSettingsBase
 A base class for camera related settings(Device specific interface layout only). More...
class  AutoControlParameters
 A class to control the automatic control parameters of a device(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  HDRKneePoint
 A class to configure a HDR(High Dynamic Range knee point (Device specific interface layout only). More...
class  HDRControl
 A class to control the HDR(High Dynamic Range) parameters of a device (Device specific interface layout only). More...
class  CameraSettingsBlueCOUGAR
 mvBlueCOUGAR and mvBlueLYNX-M7 related camera settings (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  FullSettingsBase
 A base class that provides access to the most common settings for a device(Device specific interface layout only). More...
struct  ChannelData
 A structure for image buffer channel specific data. More...
struct  ImageBuffer
 Fully describes a captured image. More...
struct  EventData
 A structure containing information about an event that has been reported by the device driver and has been successfully waited for(deprecated). More...

Typedefs

typedef EnumPropertyF< double > PropertyF
 A type for floating point properties.
typedef EnumPropertyI
< TAcquisitionField > 		PropertyIAcquisitionField
 Defines a property for values defined by mvIMPACT::acquire::TAcquisitionField.
typedef EnumPropertyI
< TAcquisitionMode > 		PropertyIAcquisitionMode
 Defines a property for values defined by mvIMPACT::acquire::TAcquisitionMode.
typedef EnumPropertyI
< TAcquisitionStartStopBehaviour > 		PropertyIAcquisitionStartStopBehaviour
 Defines a property for values defined by mvIMPACT::acquire::TAcquisitionStartStopBehaviour.
typedef EnumPropertyI< TAoiMode > PropertyIAoiMode
 Defines a property for values defined by mvIMPACT::acquire::TAoiMode.
typedef EnumPropertyI
< TAutoControlSpeed > 		PropertyIAutoControlSpeed
 Defines a property for values defined by mvIMPACT::acquire::TAutoControlSpeed.
typedef EnumPropertyI
< TAutoControlMode > 		PropertyIAutoControlMode
 Defines a property for values defined by mvIMPACT::acquire::TAutoControlMode.
typedef EnumPropertyI
< TAutoExposureControl > 		PropertyIAutoExposureControl
 Defines a property for values defined by mvIMPACT::acquire::TAutoExposureControl.
typedef EnumPropertyI
< TAutoGainControl > 		PropertyIAutoGainControl
 Defines a property for values defined by mvIMPACT::acquire::TAutoGainControl.
typedef EnumPropertyI
< TAutoOffsetCalibration > 		PropertyIAutoOffsetCalibration
 Defines a property for values defined by mvIMPACT::acquire::TAutoOffsetCalibration.
typedef EnumPropertyI
< TBayerConversionMode > 		PropertyIBayerConversionMode
 Defines a property for values defined by mvIMPACT::acquire::TBayerConversionMode.
typedef EnumPropertyI
< TBayerMosaicParity > 		PropertyIBayerMosaicParity
 Defines a property for values defined by mvIMPACT::acquire::TBayerMosaicParity.
typedef EnumPropertyI
< TBayerWhiteBalanceResult > 		PropertyIBayerWhiteBalanceResult
 Defines a property for values defined by mvIMPACT::acquire::TBayerWhiteBalanceResult.
typedef EnumPropertyI< TBoolean > PropertyIBoolean
 Defines a property for values defined by mvIMPACT::acquire::TBoolean.
typedef EnumPropertyI
< TCameraAoiMode > 		PropertyICameraAoiMode
 Defines a property for values defined by mvIMPACT::acquire::TCameraAoiMode.
typedef EnumPropertyI
< TCameraBinningMode > 		PropertyICameraBinningMode
 Defines a property for values defined by mvIMPACT::acquire::TCameraBinningMode.
typedef EnumPropertyI
< TCameraExposeMode > 		PropertyICameraExposeMode
 Defines a property for values defined by mvIMPACT::acquire::TCameraExposeMode.
typedef EnumPropertyI
< TCameraFlashMode > 		PropertyICameraFlashMode
 Defines a property for values defined by mvIMPACT::acquire::TCameraFlashMode.
typedef EnumPropertyI
< TCameraFlashType > 		PropertyICameraFlashType
 Defines a property for values defined by mvIMPACT::acquire::TCameraFlashType.
typedef EnumPropertyI
< TCameraOutput > 		PropertyICameraOutput
 Defines a property for values defined by mvIMPACT::acquire::TCameraOutput.
typedef EnumPropertyI
< TCameraPixelClock > 		PropertyICameraPixelClock
 Defines a property for values defined by mvIMPACT::acquire::TCameraPixelClock.
typedef EnumPropertyI
< TCameraTriggerMode > 		PropertyICameraTriggerMode
 Defines a property for values defined by mvIMPACT::acquire::TCameraTriggerMode.
typedef EnumPropertyI
< TCameraTestMode > 		PropertyICameraTestMode
 Defines a property for values defined by mvIMPACT::acquire::TCameraTestMode.
typedef EnumPropertyI
< TCameraSerialPortBaudRate > 		PropertyICameraSerialPortBaudRate
 Defines a property for values defined by mvIMPACT::acquire::TCameraSerialPortBaudRate.
typedef EnumPropertyI
< TCameraTriggerSource > 		PropertyICameraTriggerSource
 Defines a property for values defined by mvIMPACT::acquire::TCameraTriggerSource.
typedef EnumPropertyI
< TChannelSplitMode > 		PropertyIChannelSplitMode
 Defines a property for values defined by mvIMPACT::acquire::TChannelSplitMode.
typedef EnumPropertyI
< TColorProcessingMode > 		PropertyIColorProcessingMode
 Defines a property for values defined by mvIMPACT::acquire::TColorProcessingMode.
typedef EnumPropertyI
< TDarkCurrentFilterMode > 		PropertyIDarkCurrentFilterMode
 Defines a property for values defined by mvIMPACT::acquire::TDarkCurrentFilterMode.
typedef EnumPropertyI
< TDefectivePixelsFilterMode > 		PropertyIDefectivePixelsFilterMode
 Defines a property for values defined by mvIMPACT::acquire::TDefectivePixelsFilterMode.
typedef EnumPropertyI
< TDeviceAccessMode > 		PropertyIDeviceAccessMode
 Defines a property for values defined by mvIMPACT::acquire::TDeviceAccessMode.
typedef EnumPropertyI
< TDeviceAdvancedOptions > 		PropertyIDeviceAdvancedOptions
 Defines a property for values defined by mvIMPACT::acquire::TDeviceAdvancedOptions.
typedef EnumPropertyI
< TDeviceCapability > 		PropertyIDeviceCapability
 Defines a property for values defined by mvIMPACT::acquire::TDeviceCapability.
typedef EnumPropertyI
< TDeviceClass > 		PropertyIDeviceClass
 Defines a property for values defined by mvIMPACT::acquire::TDeviceClass.
typedef EnumPropertyI
< TDeviceEventMode > 		PropertyIDeviceEventMode
 Defines a property for values defined by mvIMPACT::acquire::TDeviceEventMode.
typedef EnumPropertyI
< TDeviceEventType > 		PropertyIDeviceEventType
 Defines a property for values defined by mvIMPACT::acquire::TDeviceEventType.
typedef EnumPropertyI
< TDeviceInterfaceLayout > 		PropertyIDeviceInterfaceLayout
 Defines a property for values defined by mvIMPACT::acquire::TDeviceInterfaceLayout.
typedef EnumPropertyI
< TDeviceLoadSettings > 		PropertyIDeviceLoadSettings
 Defines a property for values defined by mvIMPACT::acquire::TDeviceLoadSettings.
typedef EnumPropertyI
< TDeviceState > 		PropertyIDeviceState
 Defines a property for values defined by mvIMPACT::acquire::TDeviceState.
typedef EnumPropertyI
< TDeviceTriggerInterface > 		PropertyIDeviceTriggerInterface
 Defines a property for values defined by mvIMPACT::acquire::TDeviceTriggerInterface.
typedef EnumPropertyI
< TDigIOState > 		PropertyIDigIOState
 Defines a property for values defined by mvIMPACT::acquire::TDigIOState.
typedef EnumPropertyI
< TFlatFieldFilterMode > 		PropertyIFlatFieldFilterMode
 Defines a property for values defined by mvIMPACT::acquire::TFlatFieldFilterMode.
typedef EnumPropertyI
< THWUpdateResult > 		PropertyIHWUpdateResult
 Defines a property for values defined by mvIMPACT::acquire::THWUpdateResult.
typedef EnumPropertyI
< TI2COperationMode > 		PropertyII2COperationMode
 Defines a property for values defined by mvIMPACT::acquire::TI2COperationMode.
typedef EnumPropertyI
< TI2COperationStatus > 		PropertyII2COperationStatus
 Defines a property for values defined by mvIMPACT::acquire::TI2COperationStatus.
typedef EnumPropertyI
< TImageBufferPixelFormat > 		PropertyIImageBufferPixelFormat
 Defines a property for values defined by mvIMPACT::acquire::TImageBufferPixelFormat.
typedef EnumPropertyI
< TImageDestinationPixelFormat > 		PropertyIImageDestinationPixelFormat
 Defines a property for values defined by mvIMPACT::acquire::TImageDestinationPixelFormat.
typedef EnumPropertyI
< TImageProcessingFilter > 		PropertyIImageProcessingFilter
 Defines a property for values defined by mvIMPACT::acquire::TImageProcessingFilter.
typedef EnumPropertyI
< TRequestImageMemoryMode > 		PropertyIRequestImageMemoryMode
 Defines a property for values defined by mvIMPACT::acquire::TRequestImageMemoryMode.
typedef EnumPropertyI
< TImageRequestControlMode > 		PropertyIImageRequestControlMode
 Defines a property for values defined by mvIMPACT::acquire::TImageRequestControlMode.
typedef EnumPropertyI
< TInfoSensorColorMode > 		PropertyIInfoSensorColorMode
 Defines a property for values defined by mvIMPACT::acquire::TInfoSensorColorMode.
typedef EnumPropertyI
< TInfoSensorType > 		PropertyIInfoSensorType
 Defines a property for values defined by mvIMPACT::acquire::TInfoSensorType.
typedef EnumPropertyI
< TInterlacedMode > 		PropertyIInterlacedMode
 Defines a property for values defined by mvIMPACT::acquire::TInterlacedMode.
typedef EnumPropertyI
< TLUTGammaMode > 		PropertyILUTGammaMode
 Defines a property for values defined by mvIMPACT::acquire::TLUTGammaMode.
typedef EnumPropertyI
< TLUTImplementation > 		PropertyILUTImplementation
 Defines a property for values defined by mvIMPACT::acquire::TLUTImplementation.
typedef EnumPropertyI
< TLUTInterpolationMode > 		PropertyILUTInterpolationMode
 Defines a property for values defined by mvIMPACT::acquire::TLUTInterpolationMode.
typedef EnumPropertyI
< TLUTMapping > 		PropertyILUTMapping
 Defines a property for values defined by mvIMPACT::acquire::TLUTMapping.
typedef EnumPropertyI< TLUTMode > PropertyILUTMode
 Defines a property for values defined by mvIMPACT::acquire::TLUTMode.
typedef EnumPropertyI
< TMemoryManagerMode > 		PropertyIMemoryManagerMode
 Defines a property for values defined by mvIMPACT::acquire::TMemoryManagerMode.
typedef EnumPropertyI
< TMemoryManagerPoolMode > 		PropertyIMemoryManagerPoolMode
 Defines a property for values defined by mvIMPACT::acquire::TMemoryManagerPoolMode.
typedef EnumPropertyI
< TMirrorMode > 		PropertyIMirrorMode
 Defines a property for values defined by mvIMPACT::acquire::TMirrorMode.
typedef EnumPropertyI
< TMirrorOperationMode > 		PropertyIMirrorOperationMode
 Defines a property for values defined by mvIMPACT::acquire::TMirrorOperationMode.
typedef EnumPropertyI
< TPulseStartTrigger > 		PropertyIPulseStartTrigger
 Defines a property for values defined by mvIMPACT::acquire::TPulseStartTrigger.
typedef EnumPropertyI
< TRequestResult > 		PropertyIRequestResult
 Defines a property for values defined by mvIMPACT::acquire::TRequestResult.
typedef EnumPropertyI
< TRequestState > 		PropertyIRequestState
 Defines a property for values defined by mvIMPACT::acquire::TRequestState.
typedef EnumPropertyI
< TRTCtrlModes > 		PropertyIRTCtrlModes
 Defines a property for values defined by mvIMPACT::acquire::TRTCtrlModes.
typedef EnumPropertyI
< TRTProgOpCodes > 		PropertyIRTProgOpCodes
 Defines a property for values defined by mvIMPACT::acquire::TRTProgOpCodes.
typedef EnumPropertyI
< TScalerMode > 		PropertyIScalerMode
 Defines a property for values defined by mvIMPACT::acquire::TScalerMode.
typedef EnumPropertyI
< TScalerInterpolationMode > 		PropertyIScalerInterpolationMode
 Defines a property for values defined by mvIMPACT::acquire::TScalerInterpolationMode.
typedef EnumPropertyI
< TThreadPriority > 		PropertyIThreadPriority
 Defines a property for values defined by mvIMPACT::acquire::TThreadPriority.
typedef EnumPropertyI
< TTriggerMoment > 		PropertyITriggerMoment
 Defines a property for values defined by mvIMPACT::acquire::TTriggerMoment.
typedef EnumPropertyI
< TUserDataAccessRight > 		PropertyIUserDataAccessRight
 Defines a property for values defined by mvIMPACT::acquire::TUserDataAccessRight.
typedef EnumPropertyI
< TUserDataReconnectBehaviour > 		PropertyIUserDataReconnectBehaviour
 Defines a property for values defined by mvIMPACT::acquire::TUserDataReconnectBehaviour.
typedef EnumPropertyI
< TWhiteBalanceCalibrationMode > 		PropertyIWhiteBalanceCalibrationMode
 Defines a property for values defined by mvIMPACT::acquire::TWhiteBalanceCalibrationMode.
typedef EnumPropertyI
< TWhiteBalanceParameter > 		PropertyIWhiteBalanceParameter
 Defines a property for values defined by mvIMPACT::acquire::TWhiteBalanceParameter.
typedef EnumPropertyI< int > PropertyI
 A type for integer properties.
typedef EnumPropertyI64
< int64_type > 		PropertyI64
 Provided for convenience only. This type represents a standard 64 bit integer property type.
typedef SystemSettings SystemBlueCOUGAR
 deprecated. Use the class mvIMPACT::acquire::SystemSettings instead(Device specific interface layout only).
typedef int HDEV
 A type for handles bound to a certain device.
typedef int HDRV
 A type for handles bound to an interface of a certain device.
typedef int HLIST
 A type for handles bound to an object list.
typedef int HOBJ
 A type for handles bound to an unspecified object.
typedef void * CallbackHandle
 A type to create a unique identifier for a callback.

Enumerations

enum  TPropertyLimits {
  plMaxValue = PROP_MAX_VAL,
  plMinValue = PROP_MIN_VAL,
  plStepWidth = PROP_STEP_WIDTH
}
 Defines valid limits which can be queried for a mvIMPACT::acquire::Property object. More...
enum  TDeviceListType {
  dltUndefined = dmltUndefined,
  dltSetting = dmltSetting,
  dltRequest = dmltRequest,
  dltRequestCtrl = dmltRequestCtrl,
  dltInfo = dmltInfo,
  dltStatistics = dmltStatistics,
  dltSystemSettings = dmltSystemSettings,
  dltIOSubSystem = dmltIOSubSystem,
  dltRTCtr = dmltRTCtr,
  dltCameraDescriptions = dmltCameraDescriptions,
  dltDeviceSpecificData = dmltDeviceSpecificData,
  dltEventSubSystemSettings = dmltEventSubSystemSettings,
  dltEventSubSystemResults = dmltEventSubSystemResults,
  dltImageMemoryManager = dmltImageMemoryManager,
  dltLast = dltPseudoLast - 1
}
 Defines valid interface list types, which can be located using an instance of mvIMPACT::acquire::DeviceComponentLocator. More...
enum  TImageRequestParam {
  irpPixelFormat = 0,
  irpResult = 1,
  irpState = 2,
  irpCameraOutputUsed = 3
}
 Defines valid image request parameters. More...
enum  TImpactBufferFlag {
  ibfNone = 0x0,
  ibfUseRequestMemory = 0x1,
  ibfRecycleBufHandle = 0x2
}
 Flags to define the way an mvIMPACT buffer are created and handled. More...
enum  TAcquisitionField {
  afAuto = 0,
  afOdd = 1,
  afEven = 2,
  afAny = afOdd | afEven
}
 Defines which field triggers the start of the acquisition. More...
enum  TAcquisitionMode {
  amContinuous = 1,
  amMultiFrame = 2,
  amSingleFrame = 3
}
 Defines valid acquisition modes. More...
enum  TAcquisitionStartStopBehaviour {
  assbDefault,
  assbUser
}
 Defines valid modes for acquisition start/stop behaviour. More...
enum  TAoiMode {
  amCentered = 0,
  amFull,
  amUseAoi
}
 Defines valid Area Of Interest modes. More...
enum  TAutoControlSpeed {
  acsSlow = 0,
  acsMedium,
  acsFast,
  acsUserDefined
}
 Defines valid AutoControlSpeed modes. More...
enum  TAutoControlMode {
  acmStandard,
  acmDeviceSpecific
}
 Defines valid auto control 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  TBayerConversionMode {
  bcmLinearInterpolation,
  bcmAdaptiveEdgeSensing,
  bcmAuto
}
 Defines the bayer conversion algorithm to use. More...
enum  TBayerMosaicParity {
  bmpUndefined = -1,
  bmpGR,
  bmpRG,
  bmpBG,
  bmpGB
}
 Defines valid bayer formats. More...
enum  TBayerWhiteBalanceResult {
  bwbrUnknown = 0,
  bwbrOK = 1,
  bwbrErrorUnknown = 2,
  bwbrErrorTooDark = 3,
  bwbrErrorTooBright = 4
}
 Defines valid results of a white balance calibration. More...
enum  TBoolean {
  bFalse = 0,
  bTrue = 1
}
 Defines a Boolean value type. 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  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  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  TCameraShutterMode {
  csmFrameShutter = 0,
  csmElectronicRollingShutter,
  csmGlobalResetRelease,
  csmFrameShutterWithFastCenterReadout
}
 Defines recognized camera sensor shutter modes. 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
}
 Sensor trigger source. More...
enum  TChannelSplitMode {
  csmVertical,
  csmHorizontal,
  csmExtractSingle
}
 Defines valid modes for channel split filters. More...
enum  TColorProcessingMode {
  cpmAuto = 0,
  cpmRaw,
  cpmBayer,
  cpmBayerToMono,
  cpmRawToPlanes
}
 Defines the color processing mode. More...
enum  TDarkCurrentFilterMode {
  dcfmOff = 0,
  dcfmOn,
  dcfmCalibrateDarkCurrent
}
 Defines valid modes for the dark current filter. More...
enum  TDefectivePixelsFilterMode {
  dpfmOff = 0,
  dpfm3x1Average,
  dpfm3x3Median,
  dpfmResetCalibration,
  dpfmCalibrateLeakyPixel,
  dpfmCalibrateColdPixel
}
 Defines valid modes for defective pixels filter. More...
enum  TDeviceAccessMode {
  damUnknown,
  damNone,
  damRead,
  damControl,
  damExclusive
}
 Defines valid device access modes. More...
enum  TDeviceAdvancedOptions {
  daoOff = 0,
  daoLowLight = 0x1,
  daoEmbeddedImageInfo = 0x2,
  daoImageAverage = 0x4
}
 Defines valid advanced options. More...
enum  TDeviceCapability {
  dcNone = 0x0,
  dcHotplugable = 0x1,
  dcSelectableVideoInputs = 0x2,
  dcNonVolatileUserMemory = 0x4,
  dcCameraDescriptionSupport = 0x8,
  dcEventSupport = 0x10
}
 Defines valid device capabilities. More...
enum  TDeviceClass {
  dcGeneric,
  dcCamera,
  dcIntelligentCamera,
  dcFrameGrabber
}
 Defines valid generic device classes. More...
enum  TDeviceDigitalOutputMode {
  ddomManual = 0,
  ddomPulse,
  ddomUser,
  ddomExposureActive,
  ddomDigitalSignalPassThrough,
  ddomDigitalSignalPassThroughInv,
  ddomInternalVD,
  ddomRealTimeController,
  ddomExposureAndAcquisitionActive,
  ddomTemperatureOutOfRange
}
 Defines grabber specific digital output modes. More...
enum  TDeviceEventMode {
  demIgnore,
  demNotify
}
 Defines valid event states. More...
enum  TDeviceEventType {
  detNone = 0,
  detPnPArrival = 0x1,
  detPnPRemoval = 0x2,
  detFrameStart = 0x4,
  detHistogramReady = 0x8,
  detAll = detPnPArrival | detPnPRemoval | detFrameStart | detHistogramReady
}
 Defines valid device event types. More...
enum  TDeviceInterfaceLayout {
  dilGeneric,
  dilDeviceSpecific,
  dilGenICam
}
 Defines valid interface layouts for the device. More...
enum  TDeviceLoadSettings {
  dlsAuto = 0,
  dlsNoLoad
}
 Defines valid modes for the loading of settings during initialisation. More...
enum  TDeviceState {
  dsAbsent = 0,
  dsPresent,
  dsInitializing,
  dsUnreachable,
  dsPowerDown
}
 Defines valid Device states. More...
enum  TDeviceTriggerInterface {
  dtiStandard = 0,
  dtiAdvanced
}
 Defines which trigger interface is currently active for the device. 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  TDMR_ERROR {
  DMR_NO_ERROR = 0,
  DMR_DEV_NOT_FOUND = -2100,
  DMR_INIT_FAILED = -2101,
  DMR_DRV_ALREADY_IN_USE = -2102,
  DMR_DEV_CANNOT_OPEN = -2103,
  DMR_NOT_INITIALIZED = -2104,
  DMR_DRV_CANNOT_OPEN = -2105,
  DMR_DEV_REQUEST_QUEUE_EMPTY = -2106,
  DMR_DEV_REQUEST_CREATION_FAILED = -2107,
  DMR_INVALID_PARAMETER = -2108,
  DMR_EXPORTED_SYMBOL_NOT_FOUND = -2109,
  DEV_UNKNOWN_ERROR = -2110,
  DEV_HANDLE_INVALID = -2111,
  DEV_INPUT_PARAM_INVALID = -2112,
  DEV_WRONG_INPUT_PARAM_COUNT = -2113,
  DEV_CREATE_SETTING_FAILED = -2114,
  DEV_REQUEST_CANT_BE_UNLOCKED = -2115,
  DEV_INVALID_REQUEST_NUMBER = -2116,
  DEV_LOCKED_REQUEST_IN_QUEUE = -2117,
  DEV_NO_FREE_REQUEST_AVAILABLE = -2118,
  DEV_WAIT_FOR_REQUEST_FAILED = -2119,
  DEV_UNSUPPORTED_PARAMETER = -2120,
  DEV_INVALID_RTC_NUMBER = -2121,
  DMR_INTERNAL_ERROR = -2122,
  DMR_INPUT_BUFFER_TOO_SMALL = -2123,
  DEV_INTERNAL_ERROR = -2124,
  DMR_LIBRARY_NOT_FOUND = -2125,
  DMR_FUNCTION_NOT_IMPLEMENTED = -2126,
  DMR_FEATURE_NOT_AVAILABLE = -2127,
  DMR_EXECUTION_PROHIBITED = -2128,
  DMR_FILE_NOT_FOUND = -2129,
  DMR_INVALID_LICENCE = -2130,
  DEV_SENSOR_TYPE_ERROR = -2131,
  DMR_CAMERA_DESCRIPTION_INVALID = -2132,
  DMR_NEWER_LIBRARY_REQUIRED = -2133,
  DMR_TIMEOUT = -2134,
  DMR_WAIT_ABANDONED = -2135,
  DMR_EXECUTION_FAILED = -2136,
  DEV_REQUEST_ALREADY_IN_USE = -2137,
  DEV_REQUEST_BUFFER_INVALID = -2138,
  DEV_REQUEST_BUFFER_MISALIGNED = -2139,
  DEV_ACCESS_DENIED = -2140,
  DMR_PRELOAD_CHECK_FAILED = -2141,
  DMR_CAMERA_DESCRIPTION_INVALID_PARAMETER = -2142,
  DMR_FILE_ACCESS_ERROR = -2143,
  DMR_INVALID_QUEUE_SELECTION = -2144,
  DMR_LAST_VALID_ERROR_CODE = -2199
}
 Errors reported by the device manager. More...
enum  TFlatFieldFilterMode {
  fffmOff = 0,
  fffmOn,
  fffmCalibrateFlatField
}
 Defines valid modes for the flat field filter. More...
enum  THWUpdateResult {
  urNoUpdatePerformed = 0,
  urUpdateFW,
  urUpdateFWError,
  urDevAlreadyInUse,
  urUpdateFWOK,
  urSetDevID,
  urSetDevIDError,
  urSetDevIDInvalidID,
  urSetDevIDOK,
  urSetUserDataSizeError,
  urSetUserDataWriteError,
  urSetUserDataWriteOK,
  urGetUserDataReadError,
  urVerifyFWError,
  urVerifyFWOK
}
 Defines valid Device HW update results. 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  TImageBufferPixelFormat {
  ibpfRaw = 0,
  ibpfMono8 = 1,
  ibpfMono16 = 2,
  ibpfRGBx888Packed = 3,
  ibpfYUV422Packed = 4,
  ibpfRGBx888Planar = 5,
  ibpfMono10 = 6,
  ibpfMono12 = 7,
  ibpfMono14 = 8,
  ibpfRGB888Packed = 9,
  ibpfYUV444Planar = 10,
  ibpfMono32 = 11,
  ibpfYUV422Planar = 12,
  ibpfRGB101010Packed = 13,
  ibpfRGB121212Packed = 14,
  ibpfRGB141414Packed = 15,
  ibpfRGB161616Packed = 16,
  ibpfYUV422_UYVYPacked = 17,
  ibpfMono12Packed_V2 = 18,
  ibpfYUV422_10Packed = 20,
  ibpfYUV422_UYVY_10Packed = 21,
  ibpfBGR888Packed = 22,
  ibpfBGR101010Packed_V2 = 23,
  ibpfYUV444_UYVPacked = 24,
  ibpfYUV444_UYV_10Packed = 25,
  ibpfYUV444Packed = 26,
  ibpfYUV444_10Packed = 27,
  ibpfAuto = -1
}
 Valid image buffer pixel formats. More...
enum  TImageDestinationPixelFormat {
  idpfAuto = 0,
  idpfRaw = 1,
  idpfMono8 = 2,
  idpfRGBx888Packed = 3,
  idpfYUV422Packed = 4,
  idpfRGBx888Planar = 5,
  idpfMono10 = 6,
  idpfMono12 = 7,
  idpfMono14 = 8,
  idpfMono16 = 9,
  idpfRGB888Packed = 10,
  idpfYUV422Planar = 13,
  idpfRGB101010Packed = 14,
  idpfRGB121212Packed = 15,
  idpfRGB141414Packed = 16,
  idpfRGB161616Packed = 17,
  idpfYUV422_UYVYPacked = 18,
  idpfMono12Packed_V2 = 19,
  idpfYUV422_10Packed = 20,
  idpfYUV422_UYVY_10Packed = 21,
  idpfBGR888Packed = 22,
  idpfBGR101010Packed_V2 = 23,
  idpfYUV444_UYVPacked = 24,
  idpfYUV444_UYV_10Packed = 25,
  idpfYUV444Packed = 26,
  idpfYUV444_10Packed = 27
}
 Defines the pixel format of the result image. More...
enum  TImageProcessingFilter {
  ipfOff = 0,
  ipfSharpen
}
 Defines valid filters which can be applied to the captured image before it is transferred to the user. More...
enum  TImageRequestControlMode {
  ircmManual,
  ircmLive,
  ircmCounting,
  ircmTrial,
  ircmUpdateBufferLayout
}
 Defines the behaviour of an mvIMPACT::acquire::ImageRequestControl. More...
enum  TImageResultConfiguration {
  ircOff = 0,
  ircOn
}
 Defines Image Result Configuration. 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  TLUTGammaMode {
  LUTgmStandard,
  LUTgmLinearStart
}
 Defines valid LUT(LookUp Table) gamma modes. More...
enum  TLUTImplementation {
  LUTiHardware,
  LUTiSoftware
}
 Defines valid LUT(LookUp Table) implementations. More...
enum  TLUTInterpolationMode {
  LUTimThreshold,
  LUTimLinear,
  LUTimCubic
}
 Defines valid LUT(LookUp Table) interpolation modes. More...
enum  TLUTMapping {
  LUTm8To8 = ( 8 << 16 ) | 8,
  LUTm10To8 = ( 10 << 16 ) | 8,
  LUTm10To10 = ( 10 << 16 ) | 10,
  LUTm12To10 = ( 12 << 16 ) | 10,
  LUTm12To12 = ( 12 << 16 ) | 12
}
 Defines valid LUT(LookUp Table) mapping modes. More...
enum  TLUTMode {
  LUTmInterpolated,
  LUTmGamma,
  LUTmDirect
}
 Defines valid LUT(LookUp Table) modes. More...
enum  TMemoryManagerMode {
  mmmAuto = 0,
  mmmPool = 1
}
 Defines valid modes to operate the memory manager in. More...
enum  TMemoryManagerPoolMode {
  mmpmOff = 0,
  mmpmFixed = 1,
  mmpmAuto = 2
}
 Defines the pool mode of memory manager. More...
enum  TMirrorMode {
  mmOff = 0,
  mmTopDown = 0x1,
  mmLeftRight = 0x2,
  mmTopDownAndLeftRight = mmTopDown | mmLeftRight
}
 Defines valid mirror modes. More...
enum  TMirrorOperationMode {
  momGlobal,
  momChannelBased
}
 Defines valid mirror operation modes. More...
enum  TPulseStartTrigger {
  pstDigitalSignal = 0,
  pstPeriodically,
  pstRotaryDecoder
}
enum  TRequestImageMemoryMode {
  rimmAuto,
  rimmUser
}
 Defines valid image modes for request objects. More...
enum  TRequestResult {
  rrOK = 0,
  rrTimeout = 1,
  rrError = 2,
  rrRequestAborted = 3,
  rrFrameIncomplete = 4,
  rrDeviceAccessLost = 5,
  rrInconsistentBufferContent = 6,
  rrFrameCorrupt = 7,
  rrUnprocessibleRequest = 0x80000000,
  rrNoBufferAvailable = rrUnprocessibleRequest | 1,
  rrNotEnoughMemory = rrUnprocessibleRequest | 2,
  rrCameraNotSupported = rrUnprocessibleRequest | 5
}
 Defines valid result of an image request. More...
enum  TRequestState {
  rsIdle,
  rsWaiting,
  rsCapturing,
  rsReady,
  rsBeingConfigured
}
 Defines the current state of this mvIMPACT::acquire::Request. 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  TScalerInterpolationMode {
  simNearestNeighbor,
  simLinear,
  simCubic
}
 Defines valid scaler interpolation modes. More...
enum  TScalerMode {
  smOff,
  smOn
}
 Defines valid scaler modes. More...
enum  TThreadPriority {
  tpIdle,
  tpLowest,
  tpBelowNormal,
  tpNormal,
  tpAboveNormal,
  tpHighest,
  tpTimeCritical
}
 Defines valid thread priorities. More...
enum  TTriggerMoment {
  tmOnFallingEdge = 0,
  tmOnRisingEdge
}
 Defines a trigger moment for a digital signal. More...
enum  TUserDataAccessRight {
  udarRead = 0x1,
  udarWrite = 0x2,
  udarRW = udarRead | udarWrite,
  udarPassword = 0x4,
  udarFull = udarRW | udarPassword
}
 Defines valid flags for controlling the user access rights to the user data that can be stored in the devices non-volatile memory. More...
enum  TUserDataReconnectBehaviour {
  udrbKeepCachedData,
  udrbUpdateFromDeviceData
}
 Defined valid values for the behaviour of the user data when a device has been disconnected and reconnected within a running process. More...
enum  TVideoStandard {
  vsCCIR,
  vsRS170,
  vsPALBGH,
  vsNTSCM,
  vsSDI480i,
  vsSDI576i,
  vsSDI720p,
  vsSDI1080i,
  vsSDI1080p
}
 Defines valid video standards that might be supported by a video capture device. More...
enum  TWhiteBalanceCalibrationMode {
  wbcmOff = 0,
  wbcmNextFrame,
  wbcmContinuous
}
 Defines valid white balance calibration modes. More...
enum  TWhiteBalanceParameter {
  wbpTungsten = 0,
  wbpHalogen,
  wbpFluorescent,
  wbpDayLight,
  wbpPhotoFlash,
  wbpBlueSky,
  wbpUser1,
  wbpUser2,
  wbpUser3,
  wbpUser4
}
 Defines valid parameter sets selectable via the WhiteBalance property. More...
enum  TCallbackType {
  ctOnChanged = 0,
  ctOnReadData = 1,
  ctOnWriteData = 2
}
 Defines the type of callback to register. More...
enum  TComponentFlag {
  cfUndefined = 0x0,
  cfReadAccess = 0x1,
  cfWriteAccess = 0x2,
  cfRWAccess = cfReadAccess | cfWriteAccess,
  cfFixedSize = 0x4,
  cfUserAllocatedMemory = 0x8,
  cfInvisible = 0x10,
  cfAllowValueCombinations = 0x20,
  cfShouldBeDisplayedAsList = 0x40,
  cfDisallowSerialize = 0x80,
  cfAlwaysForceClone = 0x100,
  cfNotAvailable = 0x200,
  cfNotImplemented = 0x400,
  cfContainsBinaryData = 0x800,
  cfShouldBeDisplayedAsEnumeration = 0x1000
}
 Flags defining access rights and other component properties. More...
enum  TValueType {
  vtInt = 0x1,
  vtFloat,
  vtPtr,
  vtString,
  vtInt64
}
 Allowed values types for property objects. More...
enum  TComponentType {
  ctProp = 0x00010000,
  ctList = 0x00020000,
  ctMeth = 0x00040000,
  ctPropInt = ctProp | vtInt,
  ctPropFloat = ctProp | vtFloat,
  ctPropString = ctProp | vtString,
  ctPropPtr = ctProp | vtPtr,
  ctPropInt64 = ctProp | vtInt64
}
 Allowed components handled by this module. More...
enum  TComponentVisibility {
  cvBeginner = 0,
  cvExpert = 1,
  cvGuru = 2,
  cvInvisible = 3
}
enum  TPROPHANDLING_ERROR {
  PROPHANDLING_NO_ERROR = 0,
  PROPHANDLING_NOT_A_LIST = -2000,
  PROPHANDLING_NOT_A_PROPERTY = -2001,
  PROPHANDLING_NOT_A_METHOD = -2002,
  PROPHANDLING_NO_READ_RIGHTS = -2003,
  PROPHANDLING_NO_WRITE_RIGHTS = -2004,
  PROPHANDLING_NO_MODIFY_SIZE_RIGHTS = -2005,
  PROPHANDLING_INCOMPATIBLE_COMPONENTS = -2006,
  PROPHANDLING_NO_USER_ALLOCATED_MEMORY = -2007,
  PROPHANDLING_UNSUPPORTED_PARAMETER = -2008,
  PROPHANDLING_SIZE_MISMATCH = -2009,
  PROPHANDLING_IMPLEMENTATION_MISSING = -2010,
  PROPHANDLING_ACCESSTOKEN_CREATION_FAILED = -2011,
  PROPHANDLING_INVALID_PROP_VALUE = -2012,
  PROPHANDLING_PROP_TRANSLATION_TABLE_CORRUPTED = -2013,
  PROPHANDLING_PROP_VAL_ID_OUT_OF_BOUNDS = -2014,
  PROPHANDLING_PROP_TRANSLATION_TABLE_NOT_DEFINED = -2015,
  PROPHANDLING_INVALID_PROP_VALUE_TYPE = -2016,
  PROPHANDLING_PROP_VAL_TOO_LARGE = -2017,
  PROPHANDLING_PROP_VAL_TOO_SMALL = -2018,
  PROPHANDLING_COMPONENT_NOT_FOUND = -2019,
  PROPHANDLING_LIST_ID_INVALID = -2020,
  PROPHANDLING_COMPONENT_ID_INVALID = -2021,
  PROPHANDLING_LIST_ENTRY_OCCUPIED = -2022,
  PROPHANDLING_COMPONENT_HAS_OWNER_ALREADY = -2023,
  PROPHANDLING_COMPONENT_ALREADY_REGISTERED = -2024,
  PROPHANDLING_LIST_CANT_ACCESS_DATA = -2025,
  PROPHANDLING_METHOD_PTR_INVALID = -2026,
  PROPHANDLING_METHOD_INVALID_PARAM_LIST = -2027,
  PROPHANDLING_SWIG_ERROR = -2028,
  PROPHANDLING_INVALID_INPUT_PARAMETER = -2029,
  PROPHANDLING_COMPONENT_NO_CALLBACK_REGISTERED = -2030,
  PROPHANDLING_INPUT_BUFFER_TOO_SMALL = -2031,
  PROPHANDLING_WRONG_PARAM_COUNT = -2032,
  PROPHANDLING_UNSUPPORTED_OPERATION = -2033,
  PROPHANDLING_CANT_SERIALIZE_DATA = -2034,
  PROPHANDLING_INVALID_FILE_CONTENT = -2035,
  PROPHANDLING_CANT_ALLOCATE_LIST = -2036,
  PROPHANDLING_CANT_REGISTER_COMPONENT = -2037,
  PROPHANDLING_PROP_VALIDATION_FAILED = -2038,
  PROPHANDLING_LAST_VALID_ERROR_CODE = -2099
}
 Errorcodes of the module handling everything related to properties. More...
enum  TStorageFlag {
  sfDefault = 0x0,
  sfNative = 0x1,
  sfRaw = 0x2,
  sfVolatile = 0x4,
  sfProcessPropTranslationDict = 0x8,
  sfCreateMissingEntries = 0x10,
  sfProcessReadOnlyComponents = 0x20,
  sfIgnorePropData = 0x40,
  sfProcessDocString = 0x80,
  sfProcessPropConstantsDict = 0x100,
  sfProcessInheritance = 0x200,
  sfIgnoreBasicData = 0x400,
  sfIgnoreInvisible = 0x800,
  sfFile = 0x1000,
  sfProcessDisplayName = 0x2000
}
 Defines the way component lists are imported and exported. More...
enum  TScope {
  sGlobal = 0,
  sUser = 1
}
 Defines the scope for data import/export operations. More...

Variables

struct
mvIMPACT::acquire::ChannelData 		ATTR_PACK
 A structure for image buffer channel specific data.
const int INVALID_ID = -1
 A constant to check for a invalid ID returned from the property handling module.
const int END_OF_LIST = -1
 A constant defining that a new component will be inserted at the end of a list when it's registered.
const unsigned int smIgnoreLists = 0x2
 When set lists are not taken into account during a search.
const unsigned int smIgnoreMethods = 0x4
 When set method objects are not taken into account during a search.
const unsigned int smIgnoreProperties = 0x8
 When set property objects are not taken into account during a search.

Typedef Documentation

typedef void* CallbackHandle

A type to create a unique identifier for a callback.

typedef int HDEV

A type for handles bound to a certain device.

typedef int HDRV

A type for handles bound to an interface of a certain device.

typedef int HLIST

A type for handles bound to an object list.

typedef int HOBJ

A type for handles bound to an unspecified object.

Enumeration Type Documentation

enum 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.

enum TAcquisitionMode

Defines valid acquisition modes.

Note:
This feature might change in future releases! Use it with care and be ready to change your code later.
Enumerator:
amContinuous  Continuous mode. This is the recommended mode when image data shall either be transferred constantly or when working with an externally triggered setup.
amMultiFrame  In this mode AcquisitionFrameCount images will transferred by the device.

When AcquisitionFrameCount have been send by the device, it will automatically stop to send more data

amSingleFrame  In this mode the device always will always just send a single image when a data stream is started.

This mode can be interesting, when the devices acquisition parameters change from image to image or when a lot of devices will be operated in the same system an bandwidth resources are limited.

enum TAcquisitionStartStopBehaviour

Defines valid modes for acquisition start/stop behaviour.

Enumerator:
assbDefault  The default behaviour for acquisition start and stop.

Most devices will only support this mode. When this mode is selected, the device driver will try to start and stop the transfer of data from the device automatically. Internally this will happen while image requests are being processed

assbUser  The user can control the start and stop of the data transfer from the device.

In this mode, queing of image request buffers and the actual streaming of data from the device is de-coupled. This can sometimes be favourable compared to the default behaviour e.g. when dealing with device drivers that do not accept new buffers while the acquisition engine is running. Also when working at very high frame rates, pre-queueing some buffer before starting the actual data transfer can help to avoid capture queue underruns and thus data loss.

enum TAoiMode

Defines valid Area Of Interest modes.

Enumerator:
amCentered  Use a small centred window for image processing.

In this mode, a device and processing function dependent window in the middle of the AOI captured from the device will be used for the processing function.

Example:

  • Assume a device that can deliver 640 x 480 pixels.
  • The user selects to capture an rectangular AOI starting at 100/100 with a width of 200*200

Now in the centered AOI mode a processing function will use a window smaller than the AOI in the middle of the user defined AOI. This e.g. could be a rectangle starting at 150/150 with a width of 100*100.

                       640
            |--------------------------------|
            |    100                         |
            | 100|-----------------|         |
            |    |   150           |         |
            |    |150|--------|    |         |
            |    |   |        |100 |200      |480
            |    |   |--------|    |         |
            |    |      100        |         |
            |    |-----------------|         |
            |           200                  |
            |                                |
            |--------------------------------|
amFull  Use the complete image for image processing.
amUseAoi  Use a user defined AOI window for image processing.

enum TAutoControlMode

Defines valid auto control modes.

Enumerator:
acmStandard  The standard auto control mode.
acmDeviceSpecific  A device specific auto control mode.

enum TAutoControlSpeed

Defines valid AutoControlSpeed modes.

Auto control speed modes define the time in which the controller tries to adapt it's 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).

enum TAutoExposureControl

Defines valid AEC( Automatic Exposure Control ) modes.

Enumerator:
aecOff  AEC is switched off.
aecOn  AEC is switched on.

enum TAutoGainControl

Defines valid AGC( Automatic Gain Control ) modes.

Enumerator:
agcOff  AGC is switched off.
agcOn  AGC is switched on.

enum 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.

enum TBayerConversionMode

Defines the bayer conversion algorithm to use.

Enumerator:
bcmLinearInterpolation  Linear interpolation.

This mode is fast but produces a larger amount of artefacts. Especially sharp edges will appear slightly blurred in the resulting image.

bcmAdaptiveEdgeSensing  Adaptive edge sensing.

This mode requires more CPU time then linear interpolation, but the resulting image more closely matches the original scene. Edges will be reconstructed with higher accuracy.

bcmAuto  Auto.

This mode automatically sets the Bayer conversion algorithm according to the format property of the camera description.

enum TBayerMosaicParity

Defines valid bayer formats.

Enumerator:
bmpUndefined  It is not known whether the buffer or image contains raw Bayer data or the buffer or image does NOT contain raw Bayer data.
bmpGR  The buffer or image starts with a green-red line starting with a green pixel.
bmpRG  The buffer or image starts with a green-red line starting with a red pixel.
bmpBG  The buffer or image starts with a green-blue line starting with a blue pixel.
bmpGB  The buffer or image starts with a green-blue line starting with a green pixel.

enum TBayerWhiteBalanceResult

Defines valid results of a white balance calibration.

Enumerator:
bwbrUnknown  No white balance calibration has been performed since start up.
bwbrOK  The white balance calibration has been performed successfully for the selected setting.
bwbrErrorUnknown  An unknown error occurred during the white balance calibration for the selected setting.
bwbrErrorTooDark  The previous white balance calibration failed because the reference image used for the calibration was too dark.
bwbrErrorTooBright  The previous white balance calibration failed because the reference image used for the calibration was too bright.

enum TBoolean

Defines a Boolean value type.

Enumerator:
bFalse  Off, false or logical low.
bTrue  On, true or logical high.

enum TCallbackType

Defines the type of callback to register.

Enumerator:
ctOnChanged  Execute callback whenever this component has been modified.
ctOnReadData  Executed when a properties value is read. The callback is executed before the value is returned to the user. This allows i.e. a driver to determine the value for this property only if the user is interested in in it's data.
ctOnWriteData  Executed when a properties value is written. The callback is executed before the value is actually assigned. This allows i.e. a driver to validate if this is a valid value for the property.

enum TCameraAoiMode

Defines the camera Aoi modes.

Enumerator:
camFull  Use the complete AOI window defined by the hardware (sensor, camera).
camUser  Use a user defined AOI window.

enum TCameraBinningMode

Defines valid binning modes for the camera.

Note:
Binning might be available for colour sensors that do not support colour binning. This will result in incorrect colour 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 colour information will be contained in the image anyway thus resulting in useful images again). Therefore this feature has deliberately left available.

Binning_modes.png
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.

enum 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 send 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.

enum 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.

enum 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(Framesync. 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.

enum 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.

enum 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.

enum 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.

enum 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.

enum 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 optimisation for fast centered Readout.

enum 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.

enum 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 ctmContinuousbut allowes the FPS-Rate to be controlled directly

enum TCameraTriggerSource

Sensor trigger source.

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)).

enum TChannelSplitMode

Defines valid modes for channel split filters.

Enumerator:
csmVertical  The channels will be re-arranged one after the other thus the resulting image will have the same width but 'channel count' times more lines then the input image.
csmHorizontal  The channels will be re-arranged next to each other thus the resulting image will have the same height but 'channel count' times more pixels per line.
csmExtractSingle  Only one selectable channel will be extracted and forwarded.

enum TColorProcessingMode

Defines the color processing mode.

Enumerator:
cpmAuto  The driver decides (depending on the connected camera) what kind of colour processing has to be applied.
cpmRaw  No colour processing will be performed.
cpmBayer  A Bayer colour conversion will be applied before the image is transferred to the user.
cpmBayerToMono  A Bayer to mono conversion will be applied before the image is transferred to the user.
cpmRawToPlanes  No colour processing will be performed but the packed raw Bayer data will be re-arranged within the buffer.

In the resulting image the top left quarter of the image will contain the red pixels, the top right quarter the blue pixels, the lower left quarter the green pixels from the red line and the lower right quarter the green pixels from the blue line:

            // w: width, h: height
            R(0, 0)          R(0, 1), ...          R(0, (w-1)/2)          B(0, 0)          B(0, 1), ...          B(0, (w-1)/2)
            R(1, 0)          R(1, 1), ...          R(1, (w-1)/2)          B(1, 0)          B(1, 1), ...          B(1, (w-1)/2)
                      .
                      .
                      .
            R((h-1/2), 0)    R((h-1/2), 1), ...    R((h-1/2), (w-1)/2)    B((h-1/2), 0)    B((h-1/2), 1), ...    B((h-1/2), (w-1)/2)
            G(R)(0, 0)       G(R)(0, 1), ...       G(R)(0, (w-1)/2)       G(B)(0, 0)       G(B)(0, 1), ...       G(B)(0, (w-1)/2)
            G(R)(1, 0)       G(R)(1, 1), ...       G(R)(1, (w-1)/2)       G(B)(1, 0)       G(B)(1, 1), ...       G(B)(1, (w-1)/2)
                      .
                      .
                      .
            G(R)((h-1/2), 0) G(R)((h-1/2), 1), ... G(R)((h-1/2), (w-1)/2) G(B)((h-1/2), 0) G(B)((h-1/2), 1), ... G(B)((h-1/2), (w-1)/2)

enum TComponentFlag

Flags defining access rights and other component properties.

Flags defining access rights and other component properties

Enumerator:
cfUndefined  This is used to define an inconsistent/invalid flag.

This e.g. can be used as a return value for a function, that could not calculate a valid flag mask.

cfReadAccess  This component can be accessed for reading.

If this flag is set this component can be accessed for reading. This involves reading a properties data, reading a component lists elements reading the size of a component list and so on.

cfWriteAccess  This component can be accessed for writing.

If this flag is set this component can be accessed for writing or modifying it's data. This involves writing values to a property, adding components to a list and so on.

cfRWAccess  This component can be accessed for both reading and writing.

This just combines mvIMPACT::acquire::cfReadAccess and mvIMPACT::acquire::cfWriteAccess

cfFixedSize  This components element count can be modified.

If this flag is set this components element count can't be modified. For a list this would mean, that the number of elements stored in this list can't be modified. For a property this means, that the number of values stored in the property can't be modified.

cfUserAllocatedMemory  The component uses memory managed by the caller.

If this flag is set this component uses user allocated memory for data storage (only implemented for properties). If this is the case the property behaves slightly different:

  • cloning still uses the same memory for property values instead of making it's own copy of the values
  • a string property can't be assigned using other types like int or float.
  • if a property is not mvIMPACT::acquire::cfFixedSize and is assigned a different number of values no check for sufficient memory is performed and NO new memory is allocated.
  • the memory used by the property is never free, moved or modified in size by the property. At all times the user is responsible for this.

Note:
If this flag is specified for a component, which is not a property, it will have no effect on the behaviour of the component.
cfInvisible  The component is shadowed by other settings currently if set.

This flag is used to specify that this component currently has no effect on the behaviour of the system. This flag is just meant as a hint for the user. The property module itself does NOT use this flag for anything.

cfAllowValueCombinations  Allows combinations of translation dictionary entry as valid values.

If this flag is set for a property that defines a translation dictionary not only values, which are registered in the translation dictionary are allowed values for this property, but also values logical OR-ed together with values from the translation dictionary (these obviously can't be set as strings).

A property defines two entries ("one", 1) and ("two", 2) then 1 | 2 = 3 will be a valid value as well, but "three" obviously won't.

In a GUI application a property specifying this flag should be displayed as a set of check-box controls (one for each dictionary entry) or something similar.

Note:
If this flag is specified for a component, which is not a property, it will have no effect on the behaviour of the component. Only integer properties can use this feature
cfShouldBeDisplayedAsList  Informs a displaying GUI that this component should be displayed as a list.

This flag e.g. can be set for an array property to inform a displaying GUI, that this property is best displayed as a list with a entry for each element. This flag is just meant as a hint for the user. The property module itself does NOT use this flag for anything.

cfDisallowSerialize  If set this component or derived components can't be stored as external data.
cfAlwaysForceClone  If set this component is always cloned completely.

This results in the component being completely independent from it's parent no matter whether it has been built while deriving or cloning a list and thus the components within this list and it's sub-lists.

This will change the behaviour to that effect that changing the parent component will no longer affect the 'derived' component. However this allows to define different default values, constants and translation dictionaries for properties within an inheritance hierarchy.

Note:
This feature is currently only supported for components of type mvIMPACT::acquire::ctPropInt, mvIMPACT::acquire::ctPropInt64 and mvIMPACT::acquire::ctPropFloat.
cfNotAvailable  If set, this component is currently not available due to the setting of another feature.

In this case this feature can't be written to nor can it be read.

cfNotImplemented  If set, this feature has been defined, but so far has not been implemented.
cfContainsBinaryData  Specifies a property, which contains binary data.

This flag is used to specify a property that contains data in binary format

cfShouldBeDisplayedAsEnumeration  Informs a displaying GUI that this component should be displayed as an enumeration(e.g. with a combo box).

This flag e.g. can be set for a property to inform a displaying GUI, that this property is best displayed as a combo box or something similar. This flag is just meant as a hint for the user. The property module itself does NOT use this flag for anything.

enum TComponentType

Allowed components handled by this module.

This module can handle the types listed in this enumeration only.

Enumerator:
ctProp  A property type.

This type will never occur in a real world application. It's just used to build up the other types. Properties can be used to store user specific data in a structured way.

ctList  A list object.

Lists can contain other components like lists, methods and properties. Thus lists can be used to build up hierarchical structures of different components.

ctMeth  A method object.

Method objects provide the possibility to organise functions in lists.

ctPropInt  Defines a property for 32 bit integer values.
ctPropFloat  Defines a property for floating point values.
ctPropString  Defines a property for string values.
ctPropPtr  Defines a property for pointer values.
ctPropInt64  Defines a property for 64 bit integer values.

enum TComponentVisibility

Enumerator:
cvBeginner  Defines a feature that should be visible for all users via the GUI and API. This is the default visibility if no visibility has been specified for a particular component.
cvExpert  Defines a feature that requires a more in-depth knowledge of the functionality. This is the preferred visibility level for all advanced features.
cvGuru  Defines an advanced feature that if not configured correctly might result in unexpected behaviour.
cvInvisible  Defines a feature that should not be displayed in a GUI but is still accessible via API function calls.

enum TDarkCurrentFilterMode

Defines valid modes for the dark current filter.

Enumerator:
dcfmOff  This filter is switched off.
dcfmOn  This filter is switched on.
dcfmCalibrateDarkCurrent  The next frame will be taken for dark current adjustment.

enum TDefectivePixelsFilterMode

Defines valid modes for defective pixels filter.

Enumerator:
dpfmOff  This filter is switched off.
dpfm3x1Average  The filter is active, detected defective pixels will be replaced with the average value from the left and right neighbour pixel.
dpfm3x3Median  The filter is active, detected defective pixels will be replaced with the median value calculated from the nearest neighbours (3x3).
dpfmResetCalibration  reset the calibration, delete all internal lists.
dpfmCalibrateLeakyPixel  Detect defective leaky pixels within the next frame captured.

These are pixels that produce a higher read out value than average when the sensor is not exposed.

dpfmCalibrateColdPixel  Detect defective cold pixels within the next frame captured.

These are pixels that produce a lower read out code than average when the sensor is exposed to light.

enum TDeviceAccessMode

Defines valid device access modes.

Enumerator:
damUnknown  Unknown device access mode.
damNone  No access to the device.
damRead  Requested or obtained read access to the device.

Properties can be read but can't be changed.

damControl  Requested or obtained control access to the device.

Properties can be read and changed, other applications might establish read access.

damExclusive  Requested or obtained exclusive access to the device.

Properties can be read and changed, other applications can't establish access to the device.

enum TDeviceAdvancedOptions

Defines valid advanced options.

These enums may be 'ored' together.

Enumerator:
daoOff  No advanced option selected.
daoLowLight  Put camera in low light mode.
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.

enum TDeviceCapability

Defines valid device capabilities.

Values of these enum type may be 'OR'ed together.

Enumerator:
dcNone  A dummy constant to indicate, that this device does not have any capabilities defined by other constants belonging to this enumeration.
dcHotplugable  This is a device that supports hot plugging.
dcSelectableVideoInputs  This is a device, that has more then one video input channel.
dcNonVolatileUserMemory  This device has non volatile memory, the user can write to and read from.
dcCameraDescriptionSupport  This device supports camera descriptions.

This is a feature mainly interesting for frame grabbers.

dcEventSupport  This device supports events.

enum TDeviceClass

Defines valid generic device classes.

Enumerator:
dcGeneric  A generic device.
dcCamera  A plain camera device.
dcIntelligentCamera  An intelligent camera device.
dcFrameGrabber  A frame grabber device.

enum 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!).

enum TDeviceEventMode

Defines valid event states.

A driver might offer to inform the user about certain events that occur at runtime. This e.g. might be unplugging the device if it's PnP compliant or the detection of a digital input change.

Enumerator:
demIgnore  This event won't be signalled in this state even if the underlying event has been noticed by the device driver.
demNotify  This event will be notified whenever the underlying event has been detected by the device driver.

enum TDeviceEventType

Defines valid device event types.

Note:
Not every device will support every event.
Enumerator:
detNone  A dummy constant to specify no event where an event type must be specified.
detPnPArrival  An event of this type will be signalled (if desired) each time a hotplug compliant device recognized by the mvIMPACT acquire device manager has been connected to the system(deprecated).

Note:
This event has been declared deprecated. An application should register a callback to the state property instead.
detPnPRemoval  An event of this type will be signalled (if desired) each time a hotplug compliant device recognized by the mvIMPACT acquire device manager has been disconnected to the system(deprecated).

Note:
This event has been declared deprecated. An application should register a callback to the state property instead.
detFrameStart  An event of this type will be signalled (if desired) each time the start of a new image has been detected by the device.

Note:
This is currently only supported by mvTITAN/mvGAMMA devices.
detHistogramReady  An event of this type will be signalled (if desired) each time the the histogram is calculated.

Note:
This is currently only supported by OEM devices.
detAll  A combination of all event types, which can be used as a mask.

enum TDeviceInterfaceLayout

Defines valid interface layouts for the device.

The device interface layout defines what kind of features will be available after the device driver has been opened and where these features will be located.

Enumerator:
dilGeneric  A generic interface layout shall be used(deprecated).

This interface layout might be available when a third party hardware is (or claims to be) compliant with a certain standard and the used device driver also implements this standard. The main purpose of this interface layout is to grant access to third party devices without having in-depth information about the device.

As an example a device might be GenICam compliant and the device driver also implements access to a GenICam™ layer via a certain transport layer protocol driver (e.g. GigE Vision™). In that case any third party device that is compliant with these standards can be operated using the generic interface layout.

This interface layout has been declared deprecated. Please use mvIMPACT::acquire::dilGenICam instead.

See also:
Working with the GenICam™ interface
dilDeviceSpecific  A device specific interface shall be used.

For most devices supported by this user API this will be the only layout available. In this interface layout also most of the features will have the same name and location for every device even if a device is operated using another device driver. However this interface layout requires the driver to have detailed information about the underlying hardware, thus it will not be available for third party hardware, that can be used with this device driver.

dilGenICam  A GenICam™ like interface layout shall be used.

This interface layout will be available when a device is (or claims to be) compliant with a the GenICam™ standard, thus provides a GenICam™ compliant XML interface description. This also applies for third party devices, which can be used with the GenICam GenTL Producer of mvIMPACT Acquire.

This interface layout will allow to access third party devices as well.

See also:
Working with the GenICam™ interface

enum TDeviceLoadSettings

Defines valid modes for the loading of settings during initialisation.

Whenever a mvIMPACT::acquire::Device is initialised this enumeration type defines the mode the mvIMPACT::acquire::Device tries to restore settings from a previously stored session.

Enumerator:
dlsAuto  Tries to load settings automatically following an internal procedure.

The load cycle at initialisation time is like this:

            look for a setting for this particular device (via serial number)
            if not found
              look for a setting for this device type (via string in property 'Product' )
              if not found
                look for a setting for this device family (via string in property 'Family' )
                if not found
                  use the default settings

Under Linux® the current directory will be searched for files named <serialNumber>.xml, <productString>.xml and <familyString.xml> while under Windows® the registry will be searched for keys with these names. This only happens once (when the device is opened)

dlsNoLoad  No stored settings will be loaded at start-up. The device will be initialized with the drivers default values.

enum TDeviceState

Defines valid Device states.

Enumerator:
dsAbsent  The mvIMPACT::acquire::Device has been unplugged.

The mvIMPACT::acquire::Device has present been since the mvIMPACT::acquire::DeviceManager has been initialised, but has been unplugged now and the driver has detected the unplugging of the device. Automatic detection of unplugging events is only possible for devices that support plug and play, other device drivers will only check if a device is still present if an application triggered this check.

dsPresent  The mvIMPACT::acquire::Device is currently connected and initialised.
dsInitializing  The mvIMPACT::acquire::Device is connected and is currently initialising.
dsUnreachable  This device is recognized, but can't be accessed currently.

This e.g. can be the case, if this is a device connected via a network and the device does not respond to one of the recognized network protocols or if another client is already connected to this device and the device does not support multiple clients.

dsPowerDown  This device is present, but currently switched into a low power consumption mode.

enum 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. This allows to configure everything, but requires more knowledge about the hardware.

enum 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.

enum 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.

enum TDMR_ERROR

Errors reported by the device manager.

These are errors which might occur in connection with the device manager itself or while working with the single devices.

Enumerator:
DMR_NO_ERROR  The function call was executed successfully.
DMR_DEV_NOT_FOUND  the specified device can't be found.

This error occurs either if an invalid device ID has been passed to the device manager or if the caller tried to close a device which currently isn't initialised.

DMR_INIT_FAILED  The device manager couldn't be initialised.

This is an internal error.

DMR_DRV_ALREADY_IN_USE  The device is already in use.

This error will occur if this or another process has initialized this device already and an application tries to open the device once more.

DMR_DEV_CANNOT_OPEN  The specified device couldn't be initialised.
DMR_NOT_INITIALIZED  The device manager or another module hasn't been initialised properly.

This error occurs if the user tries e.g. to close the device manager without having initialised it before or if a library used internally has not been initialised properly.

DMR_DRV_CANNOT_OPEN  A device could not be initialised.

In this case the log-file will contain detailed information about the source of the problem.

DMR_DEV_REQUEST_QUEUE_EMPTY  The devices request queue is empty.

This error e.g. occurs if the user waits for an image request to become available at a result queue without having send an image request to the device before.

It might also arise when trying to trigger an image with a software trigger mechanism before the acquisition engine has been completely started. In this case a small delay and then again calling the software trigger function will succeed.

DMR_DEV_REQUEST_CREATION_FAILED  A request object couldn't be created.

The creation of a request object failed. This might e.g. happen, if the system runs extremely low on memory.

DMR_INVALID_PARAMETER  An invalid parameter has been passed to a function.

This might e.g. happen if a function requiring a pointer to a structure has been passed an unassigned pointer or if a value has been passed, that is either too large or too small in that context.

DMR_EXPORTED_SYMBOL_NOT_FOUND  One or more symbols needed in a detected driver library couldn't be resolved.

In most cases this is an error handled internally. So the user will not receive this error code as a result of a call to an API function. However when the user tries to get access to an IMPACT buffer type while the needed IMPACT Base libraries are not installed on the target system this error code also might be returned to the user.

DEV_UNKNOWN_ERROR  An unknown error occurred while processing a user called driver function.
DEV_HANDLE_INVALID  A driver function has been called with an invalid device handle.
DEV_INPUT_PARAM_INVALID  A driver function has been called but one or more of the input parameters are invalid.

There are several possible reasons for this error:

  • an unassigned pointer has been passed to a function, that requires a valid pointer
  • one or more of the passed parameters are of an incorrect type
  • one or more parameters contain an invalid value (e.g. a filename that points to a file that can't be found, a value, that is larger or smaller than the allowed values.
DEV_WRONG_INPUT_PARAM_COUNT  A function has been called with an invalid number of input parameters.
DEV_CREATE_SETTING_FAILED  The creation of a setting failed.

This can either happen, when a setting with the same name as the one the user tried to create already exists or if the system can't allocate memory for the new setting.

DEV_REQUEST_CANT_BE_UNLOCKED  The unlock for a mvIMPACT::acquire::Request object failed.

This might happen, if the mvIMPACT::acquire::Request is not locked at the time of calling the unlock function. It either has been unlocked by the user already or this request has never been locked as the request so far has not been used to capture image data into its buffer. Another reason for this error might be that the user tries to unlock a request that is currently processed by the device driver.

DEV_INVALID_REQUEST_NUMBER  The number for the mvIMPACT::acquire::Request object is invalid.

The max. number for a mvIMPACT::acquire::Request object is the value of the property RequestCount in the SystemBase list - 1.

DEV_LOCKED_REQUEST_IN_QUEUE  A Request that hasn't been unlocked has been passed back to the driver.

This error might occur if the user requested an image from the driver but hasn't unlocked the mvIMPACT::acquire::Request that will be used for this new image.

DEV_NO_FREE_REQUEST_AVAILABLE  The user requested a new image, but no free mvIMPACT::acquire::Request object is available to process this request.
DEV_WAIT_FOR_REQUEST_FAILED  The wait for a request failed.

This might have several reasons:

  • the user waited for an image, but no image has been requested before.
  • the user waited for a requested image, but the image is still not ready(e.g. because of a short timeout and a long exposure time).
  • a triggered image has been requested but no trigger signal has been detected within the wait period.
  • a plug and play device(e.g. an USB device) has been unplugged an therefore can't deliver images anymore. In this case the 'state' property should be checked to find out if the device is still present or not.
DEV_UNSUPPORTED_PARAMETER  The user tried to get/set a parameter, which is not supported by this device.
DEV_INVALID_RTC_NUMBER  The requested real time controller is not available for this device.
DMR_INTERNAL_ERROR  Some kind of internal error occurred.

More information can be found in the *.log-file or the debug output.

DMR_INPUT_BUFFER_TOO_SMALL  The user allocated input buffer is to small to accommodate the result.
DEV_INTERNAL_ERROR  Some kind of internal error occurred in the device driver.

More information can be found in the *.log-file or the debug output.

DMR_LIBRARY_NOT_FOUND  One or more needed libraries are not installed on the system.
DMR_FUNCTION_NOT_IMPLEMENTED  The called function is not available for this device.
DMR_FEATURE_NOT_AVAILABLE  The feature in question is not available for this device or driver.

More information can be found in the *.log-file or the debug output.

DMR_EXECUTION_PROHIBITED  The user is not permitted to perform the requested operation.

This e.g. might happen if the user tried to delete user data without specifying the required password.

DMR_FILE_NOT_FOUND  The specified file can't be found.

This might e.g. happen if the current working directory doesn't contain the file specified.

DMR_INVALID_LICENCE  The licence doesn't match the device it has been assigned to.

When e.g. upgrading a device feature each licence file is bound to a certain device. If the device this file has been assigned to has a different serial number then the one used to create the licence this error will occur.

DEV_SENSOR_TYPE_ERROR  There is no sensor found or the found sensor type is wrong or not supported.
DMR_CAMERA_DESCRIPTION_INVALID  A function call was associated with a camera description, that is invalid.

One possible reason might be, that the camera description has been deleted(driver closed?).

DMR_NEWER_LIBRARY_REQUIRED  A suitable driver library to work with the device manager has been detected, but it is too old to work with this version of the mvDeviceManager library.

This might happen if two different drivers have been installed on the target system and one introduces a newer version of the device manager that is not compatible with the older driver installed on the system. In this case this error message will be written into the log-file together with the name of the library that is considered to be too old.

The latest drivers will always be available online under www.matrix-vision.de. There will always be an updated version of the library considered to be too old for download from here.

DMR_TIMEOUT  A general timeout occurred.

This is the typical result of functions that wait for some condition to be met with a timeout among their parameters.

DMR_WAIT_ABANDONED  A wait operation has been aborted.

This e.g. might occur if the user waited for some message to be returned by the driver and the device driver has been closed within another thread. In order to inform the user that this waiting operation terminated in an unusual wait, DMR_WAIT_ABANDONED will be returned then.

DMR_EXECUTION_FAILED  The execution of a method object failed.

More information can be found in the log-file.

DEV_REQUEST_ALREADY_IN_USE  This request is currently used by the driver.

This error may occur if the user tries to send a certain request object to the driver by a call to the corresponding image request function.

DEV_REQUEST_BUFFER_INVALID  A request has been configured to use a user supplied buffer, but the buffer pointer associated with the request is invalid.
DEV_REQUEST_BUFFER_MISALIGNED  A request has been configured to use a user supplied buffer, but the buffer pointer associated with the request has an incorrect alignment.

Certain devices need aligned memory to perform efficiently thus when a user supplied buffer shall be used to capture data into this buffer must follow these alignment constraints

DEV_ACCESS_DENIED  The requested access to a device could not be granted.

This might e.g. happen if an application tries to access a device exclusively that is already open in another process. This could also happen if a network device has already been opened with control access from another system and the current system also tries to establish control access to the device.

DMR_PRELOAD_CHECK_FAILED  A preload condition for loading a device driver failed.

Certain device drivers may depend on certain changes applied to the system in order to operate correctly. E.g. a device driver might need a certain environment variable to exist. When the device manager tries to load a device driver it performs some basic checks to detect problems like this. When one of these checks fails the device manager will not try to load the device driver and an error message will be written to the selected log outputs.

DMR_CAMERA_DESCRIPTION_INVALID_PARAMETER  One or more of the camera descriptions parameters are invalid for the grabber it is used with.

There are multiple reasons for this error code. Detailed information can be found in the *.log-file.

POSSIBLE CAUSES:

  • The TapsXGeometry or TapsYGeometry parameter of the selected camera description cannot be used with a user defined AOI.
  • A scan standard has been selected, that is not supported by this device.
  • An invalid scan rate has been selected.
  • ...

This error code will be returned by frame grabbers only.

DMR_FILE_ACCESS_ERROR  A general error returned whenever there has been a problem with accessing a file.

There can be multiple reasons for this error and a detailed error message will be send to the log-output whenever this error code is returned.

POSSIBLE CAUSES:

  • The driver tried to modify a file, for which it has no write access
  • The driver tried to read from a file, for which it has no read access
  • ...
DMR_INVALID_QUEUE_SELECTION  An error returned when the user application attempts to operate on an invalid queue.
DMR_LAST_VALID_ERROR_CODE  Defines the last valid error code value for device and device manager related errors.

enum TFlatFieldFilterMode

Defines valid modes for the flat field filter.

Enumerator:
fffmOff  The filter is switched off.
fffmOn  The filter is switched on.
fffmCalibrateFlatField  The next frame will be taken as flat field.

enum THWUpdateResult

Defines valid Device HW update results.

This defines valid result e.g. of a user executed firmware update.

Enumerator:
urNoUpdatePerformed  No update has been performed for this mvIMPACT::acquire::Device.

No update has been performed in the current process since this device driver has been loaded in the current process address space.

urUpdateFW  The mvIMPACT::acquire::Device is currently updating firmware.
urUpdateFWError  The mvIMPACT::acquire::Device indicates an error during updating firmware.
urDevAlreadyInUse  The requested update couldn't be performed as the device is already in use.

If another (or even the same) process uses the device, this hardware update can't be performed. To perform the requested update this device needs to be closed.

urUpdateFWOK  The mvIMPACT::acquire::Device indicates that the firmware has been updated successfully.
urSetDevID  The mvIMPACT::acquire::Device is currently setting device ID.
urSetDevIDError  The mvIMPACT::acquire::Device signalled an error when setting device ID.
urSetDevIDInvalidID  An invalid device ID has been specified.

Valid device ID lie within 0 and 250 including the upper and lower limit.

urSetDevIDOK  The mvIMPACT::acquire::Device has successfully been assigned a new ID.
urSetUserDataSizeError  Size Error in writing User Data to mvIMPACT::acquire::Device .
urSetUserDataWriteError  Write Error in writing User Data to mvIMPACT::acquire::Device .
urSetUserDataWriteOK  Writing user data to mvIMPACT::acquire::Device was successful.
urGetUserDataReadError  Reading user data from an mvIMPACT::acquire::Device failed.
urVerifyFWError  The mvIMPACT::acquire::Device indicates an error during verifying firmware.
urVerifyFWOK  The mvIMPACT::acquire::Device indicates that the firmware has been verified successfully.

enum TI2COperationMode

Valid I2C operation modes.

Enumerator:
I2ComRead  Selects I2C read access.
I2ComWrite  Selects I2C write access.

enum 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.

enum TImageBufferPixelFormat

Valid image buffer pixel formats.

Enumerator:
ibpfRaw  An unprocessed block of data.
ibpfMono8  A single channel 8 bit per pixel format.
ibpfMono16  A single channel 16 bit per pixel format.
ibpfRGBx888Packed  A three channel RGB image with 32 bit per pixel containing one fill byte per pixel.

This is an interleaved pixel format suitable for most display functions. The data is stored pixel-wise. The memory layout of the pixel data is like this:

            4 bytes             4 bytes             etc.
            B(1) G(1) R(1) A(1) B(2) G(2) R(2) A(2) etc.
            .......................................
                                B(n) G(n) R(n) A(n)

So the first byte in memory is the first pixels blue component. ImageBuffer::vpData will therefore point to B(1) when using a byte pointer.

ibpfYUV422Packed  This is a YUV422 packed image with 32 bit for a pair of pixels.

This format uses 2:1 horizontal downsampling, which means that the Y component is sampled at each pixel, while U(Cb) and V(Cr) components are sampled every 2 pixels in horizontal direction. If each component takes 8 bits, the pair of pixels requires 32 bits.

Two consecutive pixels (32 bit, 0xaabbccdd ) contain 8 bit luminance of pixel 1(aa), 8 bit chrominance blue of pixel 1 and 2(bb), 8 bit luminance of pixel 2(cc) and finally 8 bit chrominance red of pixels 1 and 2(dd).

Thus in memory the data will be stored like this:

            4 bytes                   4 bytes                         etc.
            Y(1) Cb(1,2) Y(2) Cr(1,2) Y(3)   Cb(3,4)   Y(4) Cr(3,4)   etc.
            ..........................Y(n-1) Cb(n-1,n) Y(n) Cr(n-1,n)

So the first byte in memory is the first pixels luminance component. ImageBuffer::vpData will therefore point to Y(1) when using a byte pointer.

ibpfRGBx888Planar  The image will be transferred as an RGB image in planar format.

This is a format best suitable for most image processing functions. The image will be converted into four planes(a plane for each color component and one alpha plane).

            R(1) R(2) R(3) R(4) etc.
            ...................
            .............. R(n)
            G(1) G(2) G(3) G(4) etc.
            ...................
            .............. G(n)
            B(1) B(2) B(3) B(4) etc.
            ...................
            .............. B(n)
            A(1) A(2) A(3) A(4) etc.
            ...................
            .............. A(n)

So the first byte in memory is the first pixels red component. ImageBuffer::vpData will therefore point to R(1) when using a byte pointer.

ibpfMono10  A single channel 10 bit per pixel format.

Each pixel in this format consumes 2 bytes of memory. The lower 10 bit of this 2 bytes will contain valid data.

ibpfMono12  A single channel 12 bit per pixel format.

Each pixel in this format consumes 2 bytes of memory. The lower 12 bit of this 2 bytes will contain valid data.

ibpfMono14  A single channel 14 bit per pixel format.

Each pixel in this format consumes 2 bytes of memory. The lower 14 bit of this 2 bytes will contain valid data.

ibpfRGB888Packed  The image will be transferred as an RGB image with 24 bit per pixel.

This is an interleaved pixel format suitable for most display and processing functions. The data is stored pixel-wise:

            3 bytes        3 bytes        3 bytes      etc.
            B(1)G(1)R(1)   B(2)G(2)R(2)   B(3)G(3)R(3) etc.
            ..........................................
            ...........................   B(n)G(n)R(n)

So the first byte in memory is the first pixels blue component. ImageBuffer::vpData will therefore point to B(1) when using a byte pointer.

ibpfYUV444Planar  This is a YUV444 planar image with 24 bit per pixels.

A planar YUV format. In memory the data will be stored plane-wise like this:

            Y(1)    Y(2)    Y(3)    Y(4) etc.
            ............................
            ..............  Y(n-1)  Y(n)
            Cr(1)   Cr(2)   Cr(3)   Cr(4) etc.
            ............................
            ..............  Cr(n-1) Cr(n)
            Cb(1)   Cb(2)   Cb(3)   Cb(4) etc.
            ............................
            .............   Cb(n-1) Cb(n)

So the first byte in memory is the first pixels luminance component. ImageBuffer::vpData will therefore point to Y(1) when using a byte pointer.

ibpfMono32  A single channel 32 bit per pixel format.
ibpfYUV422Planar  This is a YUV422 planar image with 32 bit for a pair of pixels.

This format uses 2:1 horizontal downsampling, which means that the Y component is sampled at each pixel, while U(Cb) and V(Cr) components are sampled every 2 pixels in horizontal direction. If each component takes 8 bits, the pair of pixels requires 32 bits.

In memory the data will be stored like this:

            Y(1)    Y(2)    Y(3)    Y(4) etc.
            ............................
            ..............  Y(n-1)  Y(n)
            Cr(1,2) Cr(3,4) etc.
            ...............
            ....... Cr(n/2)
            Cb(1,2) Cb(3,4) etc.
            ...............
            ....... Cb(n/2)

Thus the Y planes size in bytes equals the sum of the 2 other planes.

So the first byte in memory is the first pixels luminance component. ImageBuffer::vpData will therefore point to Y(1) when using a byte pointer.

ibpfRGB101010Packed  The image will be transferred as an RGB image with 30 bit of usable data per pixel.

This is an interleaved pixel format with 2 bytes per colour component. The data is stored pixel-wise:

            6 bytes        6 bytes        6 bytes      etc.
            B(1)G(1)R(1)   B(2)G(2)R(2)   B(3)G(3)R(3) etc.
            ..........................................
            ...........................   B(n)G(n)R(n)

The data of each colour component will be LSB aligned, thus the 6 MSB of each 16 bit will not contain valid data.

So the first 2 bytes in memory are the first pixels blue component. ImageBuffer::vpData will therefore point to B(1) when using a 16 bit pointer.

ibpfRGB121212Packed  The image will be transferred as an RGB image with 36 bit of usable data per pixel.

This is an interleaved pixel format with 2 bytes per colour component. The data is stored pixel-wise:

            6 bytes        6 bytes        6 bytes      etc.
            B(1)G(1)R(1)   B(2)G(2)R(2)   B(3)G(3)R(3) etc.
            ..........................................
            ...........................   B(n)G(n)R(n)

The data of each colour component will be LSB aligned, thus the 4 MSB of each 16 bit will not contain valid data.

So the first 2 bytes in memory are the first pixels blue component. ImageBuffer::vpData will therefore point to B(1) when using a 16 bit pointer.

ibpfRGB141414Packed  The image will be transferred as an RGB image with 42 bit of usable data per pixel.

This is an interleaved pixel format with 2 bytes per colour component. The data is stored pixel-wise:

            6 bytes        6 bytes        6 bytes      etc.
            B(1)G(1)R(1)   B(2)G(2)R(2)   B(3)G(3)R(3) etc.
            ..........................................
            ...........................   B(n)G(n)R(n)

The data of each colour component will be LSB aligned, thus the 2 MSB of each 16 bit will not contain valid data.

So the first 2 bytes in memory are the first pixels blue component. ImageBuffer::vpData will therefore point to B(1) when using a 16 bit pointer.

ibpfRGB161616Packed  The image will be transferred as an RGB image with 48 bit of usable data per pixel.

This is an interleaved pixel format with 2 bytes per colour component. The data is stored pixel-wise:

            6 bytes        6 bytes        6 bytes      etc.
            B(1)G(1)R(1)   B(2)G(2)R(2)   B(3)G(3)R(3) etc.
            ..........................................
            ...........................   B(n)G(n)R(n)

The data of each colour component will be LSB aligned.

So the first 2 bytes in memory are the first pixels blue component. ImageBuffer::vpData will therefore point to B(1) when using a 16 bit pointer.

ibpfYUV422_UYVYPacked  This is a YUV422 packed image with 32 bit for a pair of pixels.

This format uses 2:1 horizontal downsampling, which means that the Y component is sampled at each pixel, while U(Cb) and V(Cr) components are sampled every 2 pixels in horizontal direction. If each component takes 8 bits, the pair of pixels requires 32 bits.

Two consecutive pixels (32 bit, 0xaabbccdd ) will contain 8 bit chrominance blue of pixel 1 and 2(aa), 8 bit luminance of pixel 1(bb), 8 bit chrominance red of pixel 1 and 2 (cc) and finally 8 bit luminance of pixel 2(dd).

Thus in memory the data will be stored like this:

            4 bytes                   4 bytes                         etc.
            Cb(1,2) Y(1) Cr(1,2) Y(2) Cb(3,4)   Y(3)   Cr(3,4)   Y(4)    etc.
            ..........................Cb(n-1,n) Y(n-1) Cr(n-1,n) Y(n)

So the first byte in memory is the first pixels Cb component. ImageBuffer::vpData will therefore point to Cb(1,2) when using a byte pointer.

ibpfMono12Packed_V2  A single channel 12 bit per pixel packed format.

This format will use 3 bytes to store 2 12 bit pixel. Every 3 bytes will use the following layout in memory:

            3 bytes                                               3 bytes                                               etc.
            bits 11..4(1) bits 3..0(1) bits 3..0(2) bits 11..4(2) bits 11..4(3) bits 3..0(3) bits 3..0(4) bits 11..4(4) etc.

Note:
When the width is not divisible by 2 the line pitch of buffer can't be used to calculate line start offsets in a buffer. In that case something like this can be used to access a certain pixel:
Show C++ code
ibpfYUV422_10Packed  This is a YUV422 packed image with 64 bit for a pair of pixels.

This format uses 2:1 horizontal downsampling, which means that the Y component is sampled at each pixel, while U(Cb) and V(Cr) components are sampled every 2 pixels in horizontal direction. If each component takes 16 bits, the pair of pixels requires 64 bits.

Two consecutive pixels (64 bit, 0xaaaabbbbccccdddd ) contain 10 bit luminance of pixel 1(aaaa), 10 bit chrominance blue of pixel 1 and 2(bbbb), 10 bit luminance of pixel 2(cccc) and finally 10 bit chrominance red of pixels 1 and 2(dddd). The upper 6 bits of each component will be 0.

Thus in memory the data will be stored like this:

            8 bytes                   8 bytes                         etc.
            Y(1) Cb(1,2) Y(2) Cr(1,2) Y(3)   Cb(3,4)   Y(4) Cr(3,4)   etc.
            ..........................Y(n-1) Cb(n-1,n) Y(n) Cr(n-1,n)

So the first 2 bytes in memory are the first pixels luminance component. ImageBuffer::vpData will therefore point to Y(1) when using a 16 bit pointer.

ibpfYUV422_UYVY_10Packed  This is a YUV422 packed image with 64 bit for a pair of pixels.

This format uses 2:1 horizontal downsampling, which means that the Y component is sampled at each pixel, while U(Cb) and V(Cr) components are sampled every 2 pixels in horizontal direction. If each component takes 16 bits, the pair of pixels requires 64 bits.

Two consecutive pixels (64 bit, 0xaaaabbbbccccdddd ) will contain 10 bit chrominance blue of pixel 1 and 2(aaaa), 10 bit luminance of pixel 1(bbbb), 10 bit chrominance red of pixel 1 and 2 (cccc) and finally 10 bit luminance of pixel 2(dddd). The upper 6 bits of each component will be 0.

Thus in memory the data will be stored like this:

            8 bytes                   8 bytes                         etc.
            Cb(1,2) Y(1) Cr(1,2) Y(2) Cb(3,4)   Y(3)   Cr(3,4)   Y(4)    etc.
            ..........................Cb(n-1,n) Y(n-1) Cr(n-1,n) Y(n)

So the first 2 bytes in memory are the first pixels luminance component. ImageBuffer::vpData will therefore point to Cb(1,2) when using a 16 bit pointer.

ibpfBGR888Packed  The image will be transferred as an RGB image with 24 bit per pixel.

This is an interleaved pixel format suitable for most processing functions. Most blit/display function however will expect ibpfRGB888Packed. The data is stored pixel-wise:

            3 bytes        3 bytes        3 bytes      etc.
            R(1)G(1)B(1)   R(2)G(2)B(2)   R(3)G(3)B(3) etc.
            ..........................................
            ...........................   R(n)G(n)B(n)

So the first byte in memory is the first pixels red component. ImageBuffer::vpData will therefore point to R(1) when using a byte pointer.

ibpfBGR101010Packed_V2  A 10 bit per colour component RGB packed format.

This format will use 4 bytes to store one 10 bit per colour component RGB pixel. The following memory layout is used for each pixel:

            byte 0   | byte 1   | byte 2   | byte 3   |
            0      7 | 890....5 | 6..90..3 | 4    9xx |
            RRRRRRRR | RRGGGGGG | GGGGBBBB | BBBBBB   |

Note:
Access to a certain pixel can e.g. be implemented like this:
Show C++ code
ibpfYUV444_UYVPacked  The image will be transferred as an YUV image with 24 bit per pixel.

This is an interleaved pixel format.

The data is stored pixel-wise:

            3 bytes        3 bytes        3 bytes      etc.
            Cb(1)Y(1)Cr(1) Cb(2)Y(2)Cr(2) Cb(3)Y(3)Cr(3) etc.
            ..........................................
            ...........................   Cb(n)Y(n)Cr(n)

So the first byte in memory is the first pixels Cb component. ImageBuffer::vpData will therefore point to Cb(1) when using a byte pointer.

ibpfYUV444_UYV_10Packed  The image will be transferred as an YUV image with 30 bit of usable data per pixel.

This is an interleaved pixel format with 2 bytes per colour component. The data is stored pixel-wise:

            6 bytes        6 bytes        6 bytes      etc.
            Cb(1)Y(1)Cr(1) Cb(2)Y(2)Cr(2) Cb(3)Y(3)Cr(3) etc.
            ..........................................
            ...........................   Cb(n)Y(n)Cr(n)

The data of each color component will be LSB aligned, thus the 6 MSB of each 16 bit will not contain valid data.

So the first byte in memory is the first pixels Cb component. ImageBuffer::vpData will therefore point to Cb(1) when using a 16 bit pointer.

ibpfYUV444Packed  The image will be transferred as an YUV image with 24 bit per pixel.

This is an interleaved pixel format.

The data is stored pixel-wise:

            3 bytes        3 bytes        3 bytes      etc.
            Y(1)Cb(1)Cr(1) Y(2)Cb(2)Cr(2) Y(3)Cb(3)Cr(3) etc.
            ..........................................
            ...........................   Y(n)Cb(n)Cr(n)

So the first byte in memory is the first pixels luminance component. ImageBuffer::vpData will therefore point to Y(1) when using a byte pointer.

ibpfYUV444_10Packed  The image will be transferred as an YUV image with 30 bit of usable data per pixel.

This is an interleaved pixel format with 2 bytes per color component. The data is stored pixel-wise:

            6 bytes        6 bytes        6 bytes      etc.
            Y(1)Cb(1)Cr(1) Y(2)Cb(2)Cr(2) Y(3)Cb(3)Cr(3) etc.
            ..........................................
            ...........................   Y(n)Cb(n)Cr(n)

The data of each color component will be LSB aligned, thus the 6 MSB of each 16 bit will not contain valid data.

So the first byte in memory is the first pixels luminance component. ImageBuffer::vpData will therefore point to Y(1) when using a 16 bit pointer.

ibpfAuto  The driver will decide which format will be used.

enum TImageDestinationPixelFormat

Defines the pixel format of the result image.

Enumerator:
idpfAuto  The driver will decide which destination format will be used.
idpfRaw  The image will be transferred as an unprocessed block of data.
idpfMono8  The image will be transferred as a mono channel 8 bit per pixel image.
idpfRGBx888Packed  The image will be transferred as an RGB image with 32 bit per pixel containing one fill byte per pixel.

This is an interleaved pixel format suitable for most display functions. The data is stored pixel-wise. When accessed 4-byte wise the data layout in memory can be interpreted like this (starting with the MSB):

            4 bytes             4 bytes             etc.
            B(1) G(1) R(1) A(1) B(2) G(2) R(2) A(2) etc.
            .......................................
                                B(n) G(n) R(n) A(n)

So the first byte in memory is the first pixels blue component. ImageBuffer::vpData will therefore point to B(1) when using a byte pointer.

idpfYUV422Packed  This is a YUV422 packed image with 32 bit for a pair of pixels.

This format uses 2:1 horizontal downsampling, which means that the Y component is sampled at each pixel, while U(Cb) and V(Cr) components are sampled every 2 pixels in horizontal direction. If each component takes 8 bits, the pair of pixels requires 32 bits.

Two consecutive pixels (32 bit, 0xaabbccdd ) contain 8 bit luminance of pixel 1(aa), 8 bit chrominance blue of pixel 1 and 2(bb), 8 bit luminance of pixel 2(cc) and finally 8 bit chrominance red of pixels 1 and 2(dd).

Thus in memory the data will be stored like this:

            4 bytes                   4 bytes                         etc.
            Y(1) Cb(1,2) Y(2) Cr(1,2) Y(3)   Cb(3,4)   Y(4) Cr(3,4)   etc.
            ..........................Y(n-1) Cb(n-1,n) Y(n) Cr(n-1,n)

So the first byte in memory is the first pixels luminance component. ImageBuffer::vpData will therefore point to Y(1) when using a byte pointer.

idpfRGBx888Planar  The image will be transferred as an RGB image in planar format.

This is a format best suitable for most image processing functions. The image will be converted into four planes(a plane for each color component and one alpha plane).

            R(1) R(2) R(3) R(4) etc.
            ...................
            .............. R(n)
            G(1) G(2) G(3) G(4) etc.
            ...................
            .............. G(n)
            B(1) B(2) B(3) B(4) etc.
            ...................
            .............. B(n)
            A(1) A(2) A(3) A(4) etc.
            ...................
            .............. A(n)

So the first byte in memory is the first pixels red component. ImageBuffer::vpData will therefore point to R(1) when using a byte pointer.

idpfMono10  The image will be transferred as a mono channel 10 bit per pixel image.

Each pixel in this format consumes 2 bytes of memory. The lower 10 bit of this 2 bytes will contain valid data.

idpfMono12  The image will be transferred as a mono channel 12 bit per pixel image.

Each pixel in this format consumes 2 bytes of memory. The lower 12 bit of this 2 bytes will contain valid data.

idpfMono14  The image will be transferred as a mono channel 14 bit per pixel image.

Each pixel in this format consumes 2 bytes of memory. The lower 14 bit of this 2 bytes will contain valid data.

idpfMono16  The image will be transferred as a mono channel 16 bit per pixel image.
idpfRGB888Packed  The image will be transferred as an RGB image with 24 bit per pixel.

This is an interleaved pixel format suitable for most display and processing functions. The data is stored pixel-wise:

            3 bytes        3 bytes        3 bytes      etc.
            B(1)G(1)R(1)   B(2)G(2)R(2)   B(3)G(3)R(3) etc.
            ..........................................
            ...........................   B(n)G(n)R(n)

So the first byte in memory is the first pixels blue component. ImageBuffer::vpData will therefore point to B(1) when using a byte pointer.

idpfYUV422Planar  The image will be transferred as a YUV422 image with 16 bit per pixel.

This format uses 2:1 horizontal downsampling, which means that the Y component is sampled at each pixel, while U(Cb) and V(Cr) components are sampled every 2 pixels in horizontal direction. If each component takes 8 bits, the pair of pixels requires 32 bits.

In memory the data will be stored like this:

            Y(1)    Y(2)    Y(3)    Y(4) etc.
            ............................
            ..............  Y(n-1)  Y(n)
            Cr(1,2) Cr(3,4) etc.
            ...............
            ....... Cr(n/2)
            Cb(1,2) Cb(3,4) etc.
            ...............
            ....... Cb(n/2)

Thus the Y planes size in bytes equals the sum of the 2 other planes.

So the first byte in memory is the first pixels luminance component. ImageBuffer::vpData will therefore point to Y(1) when using a byte pointer.

idpfRGB101010Packed  The image will be transferred as an RGB image with 30 bit of usable data per pixel.

This is an interleaved pixel format with 2 bytes per colour component. The data is stored pixel-wise:

            6 bytes        6 bytes        6 bytes      etc.
            B(1)G(1)R(1)   B(2)G(2)R(2)   B(3)G(3)R(3) etc.
            ..........................................
            ...........................   B(n)G(n)R(n)

The data of each colour component will be LSB aligned, thus the 6 MSB of each 16 bit will not contain valid data.

So the first byte in memory is the first pixels blue component. ImageBuffer::vpData will therefore point to B(1) when using a 16 bit pointer.

idpfRGB121212Packed  The image will be transferred as an RGB image with 36 bit of usable data per pixel.

This is an interleaved pixel format with 2 bytes per colour component. The data is stored pixel-wise:

            6 bytes        6 bytes        6 bytes      etc.
            B(1)G(1)R(1)   B(2)G(2)R(2)   B(3)G(3)R(3) etc.
            ..........................................
            ...........................   B(n)G(n)R(n)

The data of each colour component will be LSB aligned, thus the 4 MSB of each 16 bit will not contain valid data.

So the first byte in memory is the first pixels blue component. ImageBuffer::vpData will therefore point to B(1) when using a 16 bit pointer.

idpfRGB141414Packed  The image will be transferred as an RGB image with 42 bit of usable data per pixel.

This is an interleaved pixel format with 2 bytes per colour component. The data is stored pixel-wise:

            6 bytes        6 bytes        6 bytes      etc.
            B(1)G(1)R(1)   B(2)G(2)R(2)   B(3)G(3)R(3) etc.
            ..........................................
            ...........................   B(n)G(n)R(n)

The data of each colour component will be LSB aligned, thus the 2 MSB of each 16 bit will not contain valid data.

So the first byte in memory is the first pixels blue component. ImageBuffer::vpData will therefore point to B(1) when using a 16 bit pointer.

idpfRGB161616Packed  The image will be transferred as an RGB image with 48 bit of usable data per pixel.

This is an interleaved pixel format with 2 bytes per colour component. The data is stored pixel-wise:

            6 bytes        6 bytes        6 bytes      etc.
            B(1)G(1)R(1)   B(2)G(2)R(2)   B(3)G(3)R(3) etc.
            ..........................................
            ...........................   B(n)G(n)R(n)

The data of each colour component will be LSB aligned.

So the first byte in memory is the first pixels blue component. ImageBuffer::vpData will therefore point to B(1) when using a 16 bit pointer.

idpfYUV422_UYVYPacked  This is a YUV422 packed image with 32 bit for a pair of pixels.

This format uses 2:1 horizontal downsampling, which means that the Y component is sampled at each pixel, while U(Cb) and V(Cr) components are sampled every 2 pixels in horizontal direction. If each component takes 8 bits, the pair of pixels requires 32 bits.

Two consecutive pixels (32 bit, 0xaabbccdd ) will contain 8 bit chrominance blue of pixel 1 and 2(aa), 8 bit luminance of pixel 1(bb), 8 bit chrominance red of pixel 1 and 2 (cc) and finally 8 bit luminance of pixel 2(dd).

Thus in memory the data will be stored like this:

            4 bytes                   4 bytes                         etc.
            Cb(1,2) Y(1) Cr(1,2) Y(2) Cb(3,4)   Y(3)   Cr(3,4)   Y(4)    etc.
            ..........................Cb(n-1,n) Y(n-1) Cr(n-1,n) Y(n)

So the first byte in memory is the first pixels Cb component. ImageBuffer::vpData will therefore point to Cb(1,2) when using a byte pointer.

idpfMono12Packed_V2  A single channel 12 bit per pixel packed format.

This format will use 3 bytes to store 2 12 bit pixel. Every 3 bytes will use the following layout in memory:

            3 bytes                                               3 bytes                                               etc.
            bits 11..4(1) bits 3..0(1) bits 3..0(2) bits 11..4(2) bits 11..4(3) bits 3..0(3) bits 3..0(4) bits 11..4(4) etc.

Note:
When the width is not divisible by 2 the line pitch of buffer can't be used to calculate line start offsets in a buffer. In that case something like this can be used to access a certain pixel:
Show C++ code
idpfYUV422_10Packed  This is a YUV422 packed image with 64 bit for a pair of pixels.

This format uses 2:1 horizontal downsampling, which means that the Y component is sampled at each pixel, while U(Cb) and V(Cr) components are sampled every 2 pixels in horizontal direction. If each component takes 16 bits, the pair of pixels requires 64 bits.

Two consecutive pixels (64 bit, 0xaaaabbbbccccdddd ) contain 10 bit luminance of pixel 1(aaaa), 10 bit chrominance blue of pixel 1 and 2(bbbb), 10 bit luminance of pixel 2(cccc) and finally 10 bit chrominance red of pixels 1 and 2(dddd). The upper 6 bits of each component will be 0.

Thus in memory the data will be stored like this:

            8 bytes                   8 bytes                         etc.
            Y(1) Cb(1,2) Y(2) Cr(1,2) Y(3)   Cb(3,4)   Y(4) Cr(3,4)   etc.
            ..........................Y(n-1) Cb(n-1,n) Y(n) Cr(n-1,n)

So the first 2 bytes in memory are the first pixels luminance component. ImageBuffer::vpData will therefore point to Y(1) when using a 16 bit pointer.

idpfYUV422_UYVY_10Packed  This is a YUV422 packed image with 64 bit for a pair of pixels.

This format uses 2:1 horizontal downsampling, which means that the Y component is sampled at each pixel, while U(Cb) and V(Cr) components are sampled every 2 pixels in horizontal direction. If each component takes 16 bits, the pair of pixels requires 64 bits.

Two consecutive pixels (64 bit, 0xaaaabbbbccccdddd ) will contain 10 bit chrominance blue of pixel 1 and 2(aaaa), 10 bit luminance of pixel 1(bbbb), 10 bit chrominance red of pixel 1 and 2 (cccc) and finally 10 bit luminance of pixel 2(dddd). The upper 6 bits of each component will be 0.

Thus in memory the data will be stored like this:

            8 bytes                   8 bytes                         etc.
            Cb(1,2) Y(1) Cr(1,2) Y(2) Cb(3,4)   Y(3)   Cr(3,4)   Y(4)    etc.
            ..........................Cb(n-1,n) Y(n-1) Cr(n-1,n) Y(n)

So the first 2 bytes in memory are the first pixels luminance component. ImageBuffer::vpData will therefore point to Cb(1,2) when using a 16 bit pointer.

idpfBGR888Packed  The image will be transferred as an RGB image with 24 bit per pixel.

This is an interleaved pixel format suitable for most processing functions. Most blit/display function however will expect idpfRGB888Packed. The data is stored pixel-wise:

            3 bytes        3 bytes        3 bytes      etc.
            R(1)G(1)B(1)   R(2)G(2)B(2)   R(3)G(3)B(3) etc.
            ..........................................
            ...........................   R(n)G(n)B(n)

So the first byte in memory is the first pixels red component. ImageBuffer::vpData will therefore point to R(1) when using a byte pointer.

idpfBGR101010Packed_V2  A 10 bit per colour component RGB packed format.

This format will use 4 bytes to store one 10 bit per colour component RGB pixel. The following memory layout is used for each pixel:

            byte 0   | byte 1   | byte 2   | byte 3   |
            0      7 | 890....5 | 6..90..3 | 4    9xx |
            RRRRRRRR | RRGGGGGG | GGGGBBBB | BBBBBB   |

Note:
Access to a certain pixel can e.g. be implemented like this:
Show C++ code
idpfYUV444_UYVPacked  The image will be transferred as an YUV image with 24 bit per pixel.

This is an interleaved pixel format.

The data is stored pixel-wise:

            3 bytes        3 bytes        3 bytes      etc.
            Cb(1)Y(1)Cr(1) Cb(2)Y(2)Cr(2) Cb(3)Y(3)Cr(3) etc.
            ..........................................
            ...........................   Cb(n)Y(n)Cr(n)

So the first byte in memory is the first pixels Cb component. ImageBuffer::vpData will therefore point to Cb(1) when using a byte pointer.

idpfYUV444_UYV_10Packed  The image will be transferred as an YUV image with 30 bit of usable data per pixel.

This is an interleaved pixel format with 2 bytes per colour component. The data is stored pixel-wise:

            6 bytes        6 bytes        6 bytes      etc.
            Cb(1)Y(1)Cr(1) Cb(2)Y(2)Cr(2) Cb(3)Y(3)Cr(3) etc.
            ..........................................
            ...........................   Cb(n)Y(n)Cr(n)

The data of each colour component will be LSB aligned, thus the 6 MSB of each 16 bit will not contain valid data.

So the first byte in memory is the first pixels Cb component. ImageBuffer::vpData will therefore point to Cb(1) when using a 16 bit pointer.

idpfYUV444Packed  The image will be transferred as an YUV image with 24 bit per pixel.

This is an interleaved pixel format.

The data is stored pixel-wise:

            3 bytes        3 bytes        3 bytes      etc.
            Y(1)Cb(1)Cr(1) Y(2)Cb(2)Cr(2) Y(3)Cb(3)Cr(3) etc.
            ..........................................
            ...........................   Y(n)Cb(n)Cr(n)

So the first byte in memory is the first pixels luminance component. ImageBuffer::vpData will therefore point to Y(1) when using a byte pointer.

idpfYUV444_10Packed  The image will be transferred as an YUV image with 30 bit of usable data per pixel.

This is an interleaved pixel format with 2 bytes per colour component. The data is stored pixel-wise:

            6 bytes        6 bytes        6 bytes      etc.
            Y(1)Cb(1)Cr(1) Y(2)Cb(2)Cr(2) Y(3)Cb(3)Cr(3) etc.
            ..........................................
            ...........................   Y(n)Cb(n)Cr(n)

The data of each colour component will be LSB aligned, thus the 6 MSB of each 16 bit will not contain valid data.

So the first byte in memory is the first pixels luminance component. ImageBuffer::vpData will therefore point to Y(1) when using a 16 bit pointer.

enum TImageProcessingFilter

Defines valid filters which can be applied to the captured image before it is transferred to the user.

Enumerator:
ipfOff  No filter function will be applied to the image.
ipfSharpen  A sharpen filter will be applied to the image.

enum TImageRequestControlMode

Defines the behaviour of an mvIMPACT::acquire::ImageRequestControl.

Enumerator:
ircmManual  The standard mode for image requests.

In this mode one image will be captured from the hardware for each request that is send to the device driver. The image will be taken with respect to the current parameters as defined in the setting selected in the corresponding image request control.

ircmLive  Reserved. Currently not implemented.
ircmCounting  Reserved. Currently not implemented.
ircmTrial  In this mode no 'real' image will be captured, but the whole processing chain will be traversed once.

This mode can be used either to find out what the image format and parameters after an image capture would be with the current settings or to prepare the hardware before starting the first image acquisition to save time when real image data is processed.

When requesting an image in this mode, the corresponding wait function will return a complete request object with pixel format, dimensions and image buffer that contains some dummy data.

ircmUpdateBufferLayout  In this mode no 'real' image will be captured, but the whole processing chain will be traversed once.

This mode can be used either to find out what the image format and parameters after an image capture would be with the current settings or to prepare the hardware before starting the first image acquisiton to save time when real image data is processed.

In this mode, no wait function must be called. When the image request function has returned successfully, the current destination buffer layout will be available as part of the general information properties.

enum TImageRequestParam

Defines valid image request parameters.

Some functions accept this type as the input for certain parameter related functions such as obtaining a string representation of the parameter specified.

Enumerator:
irpPixelFormat  The pixel format of an image request buffer.
irpResult  The Result associated with an image request.
irpState  The current state of an image request.
irpCameraOutputUsed  The camera output used to transmit the image from the imaging device to the capture device.

enum TImageResultConfiguration

Defines Image Result Configuration.

Enumerator:
ircOff  Result is switched off.
ircOn  Result is switched on.

enum TImpactBufferFlag

Flags to define the way an mvIMPACT buffer are created and handled.

Enumerator:
ibfNone  A dummy constant to state that none of the flags shall be specified.

This flag can be used instead of writing code like this: TImpactBufferFlag(0) or static_cast<TImpactBufferFlag>(0).

ibfUseRequestMemory  If set no new memory will be allocated for the creation of the mvIMPACT buffer.

This way of creating the images is fast, but modifying the image data with an image processing function will always modify the image data associated with the underlying mvIMPACT::acquire::Request object.

Note:
Once the underlying request object has been unlocked, working with the image is no longer save when this flag was set during creation of the mvIMPACT buffer, as the memory might be freed by the driver. If you want to keep the created image do NOT specify this flag during creation.

Whenever a new image is acquired from a device the device might be using the memory already associated with another image thus you might end up with to IMPACT images that internally reference the same buffer. However a large DMA memory will (at least twice the size of one image) will allow to work with a double buffering scheme.

ibfRecycleBufHandle  If an exisiting IPL_BUFHANDLE is passed to a function it will try to copy data in this buffer instead of freeing it.

This flag can be used to allow the continuous usage of the same mvIMPACT buffer. If this flag is NOT specified whenever a valid mvIMPACT buffer handle is passed to a function accepting flags of type mvIMPACT::acquire::TImpactBufferFlag it migth free the existing buffer and create a new one.

If this flag is specified and the new buffer doesn't match the existing one in terms of the number of bands, size, etc. the function will fail and return an error code. Thus this flag can be used to optimize performance if the buffer layout will remain constant during application runtime.

enum 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 colour sensor.
iscmColor  This is a colour sensor.
iscmNIR  This is a sensor sensitive in the near IF spectrum only.

enum 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.

enum 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.

enum 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.

enum TLUTGammaMode

Defines valid LUT(LookUp Table) gamma modes.

Enumerator:
LUTgmStandard  Default gamma mode.

Maps an image by applying intensity transformation with gamma correction to the complete intensity range of the LUT.

LUTgmLinearStart  Maps an image by applying a linear interpolation in the lower intensity range of the LUT and an intensity transformation with gamma correction to the upper intensity range of the LUT.

enum TLUTImplementation

Defines valid LUT(LookUp Table) implementations.

Enumerator:
LUTiHardware  the mapping of the image data will be done in hardware.

This feature will no be available for every device.

LUTiSoftware  the mapping of the image data will be done with a optimized software algorithm.

enum TLUTInterpolationMode

Defines valid LUT(LookUp Table) interpolation modes.

Enumerator:
LUTimThreshold  Maps an image by applying intensity transformation based on a set of given threshold values.
LUTimLinear  Maps an image by applying intensity transformation with linear interpolation.
LUTimCubic  Maps an image by applying intensity transformation with cubic interpolation.

enum TLUTMapping

Defines valid LUT(LookUp Table) mapping modes.

Enumerator:
LUTm8To8  8 bit input data will be mapped to 8 bit output data.
LUTm10To8  10 bit input data will be mapped to 8 bit output data.
LUTm10To10  10 bit input data will be mapped to 10 bit output data.
LUTm12To10  12 bit input data will be mapped to 10 bit output data.
LUTm12To12  12 bit input data will be mapped to 12 bit output data.

enum TLUTMode

Defines valid LUT(LookUp Table) modes.

Enumerator:
LUTmInterpolated  Maps an image by applying interpolated intensity transformation between a set of given sampling points.
LUTmGamma  Maps an image by applying intensity transformation with gamma correction.
LUTmDirect  Maps an image by applying intensity transformation.

enum TMemoryManagerMode

Defines valid modes to operate the memory manager in.

Enumerator:
mmmAuto  Automatic mode.

In this mode the DMA memory is only used as intermediate buffer. The user has no direct access to it instead he get always a copy of the image that resides on the heap. Internally the DMA memory is organized as ring buffer. It decouples the autonomous grabbing of the board from the application. The size of the memory should be big enough to hold as many images as requests are used in the application.

mmmPool  Pool Mode.

This mode allows direct access to the DMA memory. So its not necessary for the driver to make copies of the images. This improves the performance of the system. But there is one disadvantage: The partitioning of the DMA memory is fixed and has to be done by the user. The block size must be set to the image size in bytes. Additional the block count must be set. Before these parameters can be changed it must be sure that all ImageBuffers are returned and the grabber is stopped.

enum TMemoryManagerPoolMode

Defines the pool mode of memory manager.

Enumerator:
mmpmOff  Dont use Pool.
mmpmFixed  Use Pool in Manual Mode.
mmpmAuto  Use Pool in Automatic Mode.

enum TMirrorMode

Defines valid mirror modes.

These enumeration values may be 'ored' together.

Enumerator:
mmOff  No Mirroring.
mmTopDown  The resulting image will be flipped around a horizontal axis.
mmLeftRight  The resulting image will be flipped around a vertical axis.
mmTopDownAndLeftRight  The resulting image will be both around a horizontal and vertical axis.

enum TMirrorOperationMode

Defines valid mirror operation modes.

Enumerator:
momGlobal  There will be a single mode option only and this mode will be applied to all channels of the image.
momChannelBased  The mirror mode can be selected for differently for each channel of the image.

enum TPROPHANDLING_ERROR

Errorcodes of the module handling everything related to properties.

Enumerator:
PROPHANDLING_NO_ERROR  The operation has been executed successfully.
PROPHANDLING_NOT_A_LIST  This component is not a list.

A list operation for this component has been called but this component does not reference a list.

PROPHANDLING_NOT_A_PROPERTY  This component is not a property.

A property operation for this component has been called but this component does not reference a property.

PROPHANDLING_NOT_A_METHOD  This component is not a method.

A method operation for this component has been called but this component does not reference a method.

PROPHANDLING_NO_READ_RIGHTS  The caller has no read rights for this component.

It has been tried to read data from this component, but the caller has no read rights for this component.

PROPHANDLING_NO_WRITE_RIGHTS  The caller has no write rights for this component.

It has been tried to modify data of this component, but the caller has no write rights for this component.

PROPHANDLING_NO_MODIFY_SIZE_RIGHTS  The caller can't modify the size of this component.

It has been tried to modify the size of this list or the number of values stored by a property, but the caller doesn't have the required right to do this.

This error will also be reported if the user tried to increase the number of values handled by a property above the maximum number of values it can handle. Therefore before resizing a property check if the new size might exceeds this maximum value by calling the appropriate function.

PROPHANDLING_INCOMPATIBLE_COMPONENTS  The two involved components are not compatible.

An operation requiring two compatible components has been called with two components, which are not compatible.

PROPHANDLING_NO_USER_ALLOCATED_MEMORY  This property doesn't use user defined memory.

The caller tried to relocate the user defined memory for a property, that doesn't reference user defined memory but uses the internal memory management.

PROPHANDLING_UNSUPPORTED_PARAMETER  One or more of the specified parameters are not supported by the function.
PROPHANDLING_SIZE_MISMATCH  Different sized value buffers have been passed.

While trying to read value pairs the caller passed two different sized value buffers to a function while one is too small to hold all the information.

PROPHANDLING_IMPLEMENTATION_MISSING  A feature that is not implemented so far has been requested.

The caller requested a feature, that hasn't been implemented so far. This error code is only provided for compatibility and will be set in very rare cases only.

PROPHANDLING_ACCESSTOKEN_CREATION_FAILED  An access token object couldn't be created.

This can either happen, because the caller has not the rights required to create an access token or because the system runs very low on memory.

PROPHANDLING_INVALID_PROP_VALUE  It has been tried to assign an invalid value to a property.

This can either happen if the value lies above or below the min. or max. value for a property or when it has been tried to write a value to a property, which is not in the properties translation dictionary (if it defines one).

To find out, which values are allowed for the property in question the user should

  • check if the property defines a translation dictionary
  • check the allowed values within a translation dictionary if one is defined
  • check the min and max value for properties, that define limits
PROPHANDLING_PROP_TRANSLATION_TABLE_CORRUPTED  The properties translation table has been corrupted.

The properties translation table has been corrupted for an unknown reason and can't be used anymore.

PROPHANDLING_PROP_VAL_ID_OUT_OF_BOUNDS  Invalid value index.

The caller tried to read a value from an invalid index from a property. Most properties store one value only, thus the only valid positive value index will be 0 (some negative index values are reserved for special values like e.g. the min/max value of a property). However some properties might store more then one value, thus the max. allowed index might be higher. The highest index allowed will always be the value count of a property minus one for properties with the mvIMPACT::acquire::cfFixedSize flag set. Other properties will automatically adjust the size once the user writes to an index out of bounds.

PROPHANDLING_PROP_TRANSLATION_TABLE_NOT_DEFINED  This property doesn't define a translation table.

The caller tried to modify a translation table, that hasn't been defined for this property.

PROPHANDLING_INVALID_PROP_VALUE_TYPE  An invalid value has been passed to the property.

Although properties are quite tolerant regarding the allowed assignment for them some value types can't be used to write all properties. As an example assigning a float value to an integer property would result in this error.

Another reason for this error might be when a user tried to access e.g. a float property with functions meant to be used for int properties.

PROPHANDLING_PROP_VAL_TOO_LARGE  A too large value has been passed.

One or more of the values the caller tried to write to the property are larger then the max. allowed value for this property.

PROPHANDLING_PROP_VAL_TOO_SMALL  A too small value has been passed.

One or more of the values the caller tried to write to the property are smaller than the min. allowed value for this property.

PROPHANDLING_COMPONENT_NOT_FOUND  The specified component could not be found.
PROPHANDLING_LIST_ID_INVALID  An invalid list has been referenced.
PROPHANDLING_COMPONENT_ID_INVALID  An invalid component within a list has been referenced.
PROPHANDLING_LIST_ENTRY_OCCUPIED  The specified list index is occupied.

During the creation of a new component the caller tried the insert the newly created component into a list at a position already used to store another component.

PROPHANDLING_COMPONENT_HAS_OWNER_ALREADY  The specified component already has an owner.

The caller tried to assign an owner to a component that already has an owner. An owner once defined can't be modified anymore.

PROPHANDLING_COMPONENT_ALREADY_REGISTERED  It has been tried to register the same component at twice in the same list.
PROPHANDLING_LIST_CANT_ACCESS_DATA  The desired data can't be accessed or found.

During loading or saving data this error can occur e.g. if it has been tried to import a setting from a location where the desired setting couldn't be found.

PROPHANDLING_METHOD_PTR_INVALID  The function pointer of the referenced method object is invalid.
PROPHANDLING_METHOD_INVALID_PARAM_LIST  A method object has an invalid parameter list.
PROPHANDLING_SWIG_ERROR  This indicates an internal error occurred within the SWIG generated wrapper code, when working under Python.
PROPHANDLING_INVALID_INPUT_PARAMETER  A invalid input parameter has been passed to a function of this module.

In most cases this might be a unassigned pointer, where a valid pointer to a user defined storage location was expected.

PROPHANDLING_COMPONENT_NO_CALLBACK_REGISTERED  The user tried to modify a registered callback, but no callback has been registered for this component.
PROPHANDLING_INPUT_BUFFER_TOO_SMALL  The user tried to read data into a user supplied storage location, but the buffer was too small to accommodate the result.
PROPHANDLING_WRONG_PARAM_COUNT  The number of parameters is incorrect.

This error might occur if the user called a function with a variable number of input or output parameters and the number of parameters passed to the function does not match the number of required parameters.

PROPHANDLING_UNSUPPORTED_OPERATION  The user tried to execute an operation, which is not supported by the component he is referring to.
PROPHANDLING_CANT_SERIALIZE_DATA  The user tried to save(serialize) a property list without having the right to do this.
PROPHANDLING_INVALID_FILE_CONTENT  The user tried to use a file to update or create a component list, that does not contain valid data for this operation.

This e.g. might happen, if the file does not contain valid XML data or XML data that is not well formed.

PROPHANDLING_CANT_ALLOCATE_LIST  This error will occur when the modules internal representation of the tree structure does not allow the allocation of a new list.

In this case either new list can't be allocated. The only way to solve this problem is to delete another list.

PROPHANDLING_CANT_REGISTER_COMPONENT  The referenced list has no space left to register this component at the desired position.

There might however be an empty space within the list where this element could be registered, but no more components can be registered at the end of this list.

PROPHANDLING_PROP_VALIDATION_FAILED  The user tried to assign a value to a property, that is invalid.

This will result in a detailed error message in the log-file. This error might arise e.g. when a string property doesn't allow the string to contain numbers. In this case trying to set the properties value to 'blabla7bla' would cause this error.

PROPHANDLING_LAST_VALID_ERROR_CODE  Defines the last valid error code value for the property module.

enum TPulseStartTrigger

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.

enum TRequestImageMemoryMode

Defines valid image modes for request objects.

Enumerator:
rimmAuto  Automatic mode.

In this mode the driver will decide what kind of memory will be used, when it will be allocated and when it will be freed.

rimmUser  User supplied memory mode.

A request in this mode can capture data directly into a user supplied buffer.

The user can assign a buffer to each request that has been set into this mode. However some devices require the capture memory to be aligned thus then the buffer supplied by the user must be aligned to the requirements of the driver as well. To find out, which alignment is needed, the property captureBufferAlignment must be queried.

enum TRequestResult

Defines valid result of an image request.

Whenever during the processing of the capture parameters but well before the actual image capture and error is detected the MSB of this enumeration will be set to 1. In this case almost every time the current input parameters can't lead to a correct image and have to be changed.

Enumerator:
rrOK  This image request has been processed successfully.
rrTimeout  This image request resulted in a timeout. No image has been captured during the allowed period of time.
rrError  An error occurred during the processing of this request.
rrRequestAborted  This request has been aborted either because there are no free internal buffers or the user itself caused this abort e.g. by clearing the request queue.
rrFrameIncomplete  An incomplete frame was transferred.

This can have several reasons, however the one most likely is that the transfer channel couldn't cope with the amount of data that was transmitted resulting in parts of the frame or in the worst case the complete frame being lost.

This e.g. might happen if several network devices transmit at the same time or a single device (e.g. connected to a PCI bus transfers more data then the PCI bus can pass to the receiving end until a temporary buffer on the device runs full. The log output will contain additional information.

If the information is available the property 'MissingData_pc' belonging to that request will contain information about the amount of data missing. Also some of the statistical properties will provide hints about how much data is lost. E.g. the properties 'MissingPacktesRecovered', 'RetransmitCount' and 'MissingDataAverage_pc' might be or interesst here. Please note that not every property is supported by every device.

rrDeviceAccessLost  The access to the device has been lost.

In this case no further access to the device will succeed. Only closing and re-opening the device will fix this problem. There can be numerous reasons for this error to occur, however the most likely one is that a device, that a timeout register inside the device, that needs to be refreshed constantly by the driver hasn't been refreshed during the timeout period. In this case the device will disconnect itself from the driver. This e.g. can happen if a network device is used and the application is operated in debug mode. For debugging the corresponding timeout register must be set to an appropriate value.

rrInconsistentBufferContent  A complete buffer has been delivered, but it did fail to pass the internal validation check.

This e.g. might happen with drivers that transmit buffers that contain more then a pure block of pixel data. Examples for this might be run-length encoded images, or buffers with additional information somewhere in the buffer that will be interpreted by the device driver. This error is most likely a result of a device that doesn't transfer data in the requested format. The log output will contain additional information.

rrFrameCorrupt  The device has reported that an image acquisition did fail on the device side thus BEFORE the data transfer.

This e.g. might happen if a device is running low on local memory or because of some other problem detected on the device itself. This result status is just meant for information. The associated buffer will not contain valid image data.

rrUnprocessibleRequest  This request is not processible.

If this flag (the MSB) is set this either indicates that the current input parameters can't be used to capture an image (in that case the result will not be the MSB alone) or that an internal error occurred during the process of this request.

rrNoBufferAvailable  No free buffer available to process this request.

To get more memory either some old requests should be unlocked or the size of the DMA memory (frame grabbers only) could be increased using the tools provided.

rrNotEnoughMemory  There is not enough memory available to the driver to process the current image request.

To get more memory either some old requests should be unlocked or the size of the DMA memory (frame grabbers only) could be increased using the tools provided.

rrCameraNotSupported  The current camera description is not supported by the capture device.

This error code currently is relevant for frame grabbers only and might occur e.g. when selecting a MEDIUM CameraLink® camera description for a grabber, that only supports BASE cameras.

enum TRequestState

Defines the current state of this mvIMPACT::acquire::Request.

Enumerator:
rsIdle  This mvIMPACT::acquire::Request is currently unused.
rsWaiting  This mvIMPACT::acquire::Request has been send into the drivers image request queue and currently wait to be processed.
rsCapturing  This mvIMPACT::acquire::Request is currently being processed.
rsReady  This mvIMPACT::acquire::Request has been processed.

The user is now responsible for this request. Before this mvIMPACT::acquire::Request is not unlocked again it can't be used by the driver. A mvIMPACT::acquire::Request in this state can safely be processed by the user. It's data will remain valid until either the mvIMPACT::acquire::Request is unlocked by the user or the device is closed.

rsBeingConfigured  This mvIMPACT::acquire::Request is currently in configuration mode.

Within this mode certain properties of the request object will become writeable, which e.g. will allow the user to pass a capture buffer to the request object.

enum 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.

enum 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  Substract a constant value from a register.

enum TScalerInterpolationMode

Defines valid scaler interpolation modes.

Enumerator:
simNearestNeighbor  Nearest neighbour interpolation (default).
simLinear  Linear interpolation.
simCubic  Cubic interpolation.

enum TScalerMode

Defines valid scaler modes.

Enumerator:
smOff  The scaler is switched off (default).
smOn  The scaler is switched on.

enum TScope

Defines the scope for data import/export operations.

Enumerator:
sGlobal  Save the setting as global as possible.
sUser  Save the setting in a user specific location.

enum TStorageFlag

Defines the way component lists are imported and exported.

component lists can be imported and exported from/to XML files and (under Windows©) from/into the Registry. These flags define how this is done.

Enumerator:
sfDefault  A dummy flag to specify the default behaviour.

Store/load operations will done in XML format in this case.

sfNative  Stores/loads the setting in/from a platform dependent location.

Under Windows© the Registry will be used to as a platform dependent location, while under other platforms an XML file will be processed in the path specified as the settings name.

Note:
Please note, that using this flag will introduce platform dependency. E.g. specifying this flag under Linux will process XML data, while under Windows© the Registry will be used. This is why A call to a load function with this flag with the corresponding XML file in the applications directory might succeed under Linux while it fails under Windows©.
sfRaw  Stores/loads the setting in raw mode.

Note:
Under Windows© this mode only works in connection with the mvIMPACT::acquire::sfNative flag. In that case an arbitrary hive from the registry can be used to create a tree of lists and properties. This only makes sense for very special applications and therefore is not needed to write applications, that load and store current settings.
sfVolatile  Stores lists volatile.

under Windows© when the mvIMPACT::acquire::sfNative flag is set this will store the component list as a volatile key in the Registry. This means that the data will remain in the Registry until the system is shut down.

sfProcessPropTranslationDict  If set properties translation dictionaries will be processed for this import/export operation.

This option forces the function to process the translation dictionaries, which might be assigned to properties.

sfCreateMissingEntries  If set ALL entries in the store data will be created.

When loading a setting not only the current lists data will be updated, but also properties, lists or data, which is found in the storage location but not in the setting to update will be added to the setting as well.

sfProcessReadOnlyComponents  If set read-only components will be processed for this import/export operation.

When importing, exporting or updating a component list components with the mvIMPACT::acquire::cfWriteAccess not set will be ignored.

sfIgnorePropData  If set data for properties will no be updated.

If this flag is set the values stored by the property will be ignored for this import/export operation.

Note:
This flag is ignored, if mvIMPACT::acquire::sfNative is specified.
sfProcessDocString  If set the documentation string will be processed.

If this flag is set the documentation string will be processed for this import/export operation.

Note:
This flag is ignored, if mvIMPACT::acquire::sfNative is specified.
sfProcessPropConstantsDict  If set the defined constants for properties will be processed.

If this flag is set the defined constants for properties will be processed for this import/export operation.

sfProcessInheritance  If set the lists inheritance relationship will be processed.

If this flag is set the inheritance relationship between lists will be processed for the current import/export operation.

Note:
Limitations:
  • derived lists must appear in a list after the parent list. So if a list is derived from another list, it has to be registered with a higher index either in the same list as the parent or in a list with a higher index then the list holding the parent in a top level list.

    Example for a legal structure: 
                A
            |-B
            | |-parent
            | |-child
            |-C
            | |-child
            |-child


    Example for illegal structures: 
                A
            |-child
            |-parent
    or 
                A
            |-B
            | |-child
            |-parent
  • this feature is not available when mvIMPACT::acquire::sfNative is specified.
sfIgnoreBasicData  Specifies if basic data shall be processed.

For e.g. settings it's not necessary to import/export information about the value type for properties or the size of lists etc. as this information is available internally anyway. So interface functions dealing with settings should specify this flag in any case.

sfIgnoreInvisible  Specifies if invisible components shall be processed.

When invisible data doesn't need to be processed this flag can be specified. Invisible components do not influence the current systems behaviour.

Note:
This feature is currently only supported for output operations and is ignored for input operations.
sfFile  Stores/loads the setting in/from an XML file.

If this flag is specified the data will be imported/exported from/to an XML file.

sfProcessDisplayName  If set the display name will be processed.

If this flag is set the display name will be processed for this import/export operation.

Note:
This flag is ignored, if mvIMPACT::acquire::sfNative is specified.

enum TThreadPriority

Defines valid thread priorities.

Enumerator:
tpIdle  Idle thread priority.
tpLowest  Lowest thread priority.
tpBelowNormal  Below normal thread priority.
tpNormal  Normal thread priority.
tpAboveNormal  Above normal thread priority.
tpHighest  Highest priority.
tpTimeCritical  time critical thread priority.

enum 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.

enum TUserDataAccessRight

Defines valid flags for controlling the user access rights to the user data that can be stored in the devices non-volatile memory.

Enumerator:
udarRead  The user has read rights for this entry.
udarWrite  The user has principle write rights for this entry.

If mvIMPACT::acquire::udarPassword is not set for this entry or the corresponding password has been set correctly, the user can modify the corresponding entry.

udarRW  Just combines mvIMPACT::acquire::udarRead and mvIMPACT::acquire::udarWrite.
udarPassword  A password is needed to modify this entry.

Even if mvIMPACT::acquire::udarWrite is specified the user can only modify this entry if the correct password has been set.

udarFull  Combines all other flags.

enum TUserDataReconnectBehaviour

Defined valid values for the behaviour of the user data when a device has been disconnected and reconnected within a running process.

Enumerator:
udrbKeepCachedData  Keep the data currently buffered in the properties describing the user data.

When the user data has been modified on another machine this will result in a loss of that data once this buffered data is written back to the devices non-volatile memory.

udrbUpdateFromDeviceData  Updates the properties describing the user data with the fresh data as read from the devices non-volatile memory.

This might result in the loss of data that has been edited but NOT written to the devices non-volatile memory if this data differs from the current data stored in the devices non-volatile memory.

enum TValueType

Allowed values types for property objects.

Enumerator:
vtInt  Defines a property for 32 bit integer types.
vtFloat  Defines a property for float types.
vtPtr  Defines a property for pointer types.
vtString  Defines a property for strings.
vtInt64  Defines a property for 64 bit integer types.

enum TVideoStandard

Defines valid video standards that might be supported by a video capture device.

Enumerator:
vsCCIR  CCIR video signal: Grey, 50 fields per second, 625 lines.
vsRS170  RS 170 video signal: Grey, 60 fields per second, 525 lines.
vsPALBGH  PAL video signal: Color, 50 fields per second, 625 lines.
vsNTSCM  NTSC video signal: Color, 60 fields per second, 525 lines.
vsSDI480i  SDI video signal: 60 fields per second, 480 lines, interlaced.
vsSDI576i  SDI video signal: 50 fields per second, 576 lines, interlaced.
vsSDI720p  SDI video signal: Different frame rates, 720 lines, progressive.
vsSDI1080i  SDI video signal: Different frame rates, 1080 lines, interlaced.
vsSDI1080p  SDI video signal: Different frame rates, 1080 lines, progressive.

enum TWhiteBalanceCalibrationMode

Defines valid white balance calibration modes.

Enumerator:
wbcmOff  Do not perform calibration, current values will be used.
wbcmNextFrame  Use the next image to perform the white balance calibration.

This is defined for bayer color sensors only.

wbcmContinuous  Do a continuous white balance calibration.

enum TWhiteBalanceParameter

Defines valid parameter sets selectable via the WhiteBalance property.

Enumerator:
wbpTungsten  A set of constant parameters optimised for scenes illuminated by tungsten light sources.
wbpHalogen  A set of constant parameters optimised for scenes illuminated by halogen light sources.
wbpFluorescent  A set of constant parameters optimised for scenes illuminated by fluorescent light sources.
wbpDayLight  A set of constant parameters optimised for scenes illuminated by day light.
wbpPhotoFlash  A set of constant parameters optimised for scenes illuminated by photo flash light sources.
wbpBlueSky  A set of constant parameters optimised for scenes illuminated by day light and perfect weather.
wbpUser1  A parameter set which can be modified by the user.
wbpUser2  A parameter set which can be modified by the user.
wbpUser3  A parameter set which can be modified by the user.
wbpUser4  A parameter set which can be modified by the user.

Variable Documentation

struct mvIMPACT::acquire::EventData ATTR_PACK

A structure for image buffer channel specific data.

A structure containing information about an event that has been reported by the device driver and has been successfully waited for(deprecated).

Fully describes a captured image.

Channel specific data in an image is data, that in e.g. and RGB image might differ for the color components red, green and blue.

This class serves as a describing structure for captured images.

const int END_OF_LIST = -1

A constant defining that a new component will be inserted at the end of a list when it's registered.

const int INVALID_ID = -1

A constant to check for a invalid ID returned from the property handling module.

const unsigned int smIgnoreLists = 0x2

When set lists are not taken into account during a search.

When this flag is set list objects will not be taken into account during a search for a component.

const unsigned int smIgnoreMethods = 0x4

When set method objects are not taken into account during a search.

When this flag is set method objects will not be taken into account during a search for a component.

const unsigned int smIgnoreProperties = 0x8

When set property objects are not taken into account during a search.

When this flag is set property objects will not be taken into account during a search for a component.