Common

Classes
class	BasicDeviceSettings
	A base class for essential device related settings. More...
class	BufferPart
	Contains information about a specific part of a captured buffer. More...
class	Component
	A base class to implement access to internal driver components. More...
class	ComponentAccess
	A base class to implement access to internal driver objects. More...
class	ComponentChangedEventArgs
	A class containing data generated by a component changed event. More...
class	ComponentCollection
	A base class for sets of properties that can be modified by the user. More...
class	ComponentList
	A class to provide access to component lists. More...
class	ComponentLocator
	A class to locate components within the driver. More...
class	ComponentLocatorBase
	A base class to locate components within the driver. More...
class	Device
	This class and its functions represent an actual device detected by this interface in the current system. More...
class	DeviceComponentLocator
	A class to locate components within the driver. More...
class	DeviceManager
	Grants access to devices that can be operated by this software interface. More...
class	DeviceWillBeClosedEventArgs
	A class containing data generated by an event triggered when a device is about to get closed. More...
class	ECantAccessData
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_LIST_CANT_ACCESS_DATA error. More...
class	ECantAllocateNewList
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_CANT_ALLOCATE_LIST error. More...
class	ECantRegisterComponent
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_CANT_REGISTER_COMPONENT error. More...
class	ECantSerializeData
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_CANT_SERIALIZE_DATA error. More...
class	EComponent
	A base class for mv.impact.acquire.Component object related exceptions from the property module. More...
class	EComponentIDInvalid
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_COMPONENT_ID_INVALID error. More...
class	EComponentNotFound
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_COMPONENT_NOT_FOUND error. More...
class	EDeviceManager
	A base class for device manager related exceptions. More...
class	EImplementationMissing
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_IMPLEMENTATION_MISSING error. More...
class	EIncompatibleComponents
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INCOMPATIBLE_COMPONENTS error. More...
class	EInputBufferTooSmall
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INPUT_BUFFER_TOO_SMALL error. More...
class	EInvalidFileContent
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INVALID_FILE_CONTENT error. More...
class	EInvalidInputParameter
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INVALID_INPUT_PARAMETER error. More...
class	EInvalidListID
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_LIST_ID_INVALID error. More...
class	EInvalidParameterList
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_METHOD_INVALID_PARAM_LIST error. More...
class	EInvalidValue
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INVALID_PROP_VALUE error. More...
class	EInvalidValueType
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INVALID_PROP_VALUE_TYPE error. More...
class	EListEntryOccupied
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_LIST_ENTRY_OCCUPIED error. More...
class	EMethod
	A base class for mv.impact.acquire.Method object related exceptions from the property module. More...
class	EMethodPtrInvalid
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_METHOD_PTR_INVALID error. More...
class	ENoModifySizeRights
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_NO_MODIFY_SIZE_RIGHTS error. More...
class	ENoReadRights
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_NO_READ_RIGHTS error. More...
class	ENotAList
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_NOT_A_LIST error. More...
class	ENotAMethod
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_NOT_A_METHOD error. More...
class	ENotAProperty
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_NOT_A_PROPERTY error. More...
class	ENoWriteRights
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_NO_WRITE_RIGHTS error. More...
class	EnumPropertyF< T >
	A template class to represent float properties and enumerated float properties. More...
class	EnumPropertyI< T >
	A template class to represent 32 bit integer properties and 32 bit enumerated integer properties. More...
class	EnumPropertyI64< T >
	A template class to represent 64-bit integer properties and enumerated 64 bit integer properties. More...
class	EProperty
	A base class for mv.impact.acquire.Property related exceptions from the property module. More...
class	EPropertyHandling
	A base class for exceptions related to the property module. More...
class	EPropertyList
	A base class for component list related exceptions from the property module. More...
class	ESizeMismatch
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_SIZE_MISMATCH error. More...
class	ETranslationTableCorrupted
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_TRANSLATION_TABLE_CORRUPTED error. More...
class	ETranslationTableNotDefined
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_TRANSLATION_TABLE_NOT_DEFINED error. More...
class	EUnsupportedOperation
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_UNSUPPORTED_OPERATION error. More...
class	EUnsupportedParameter
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_UNSUPPORTED_PARAMETER error. More...
class	EValidationFailed
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_VALIDATION_FAILED error. More...
class	EValIDOutOfBounds
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_VAL_ID_OUT_OF_BOUNDS error. More...
class	EValTooLarge
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_VAL_TOO_LARGE error. More...
class	EValTooSmall
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_VAL_TOO_SMALL error. More...
class	EWrongParamCount
	An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_WRONG_PARAM_COUNT error. More...
class	ExceptionFactory
	A factory class to raise Impact Acquire related exceptions. More...
class	FirmwareUpdater
	A class to perform a firmware update of a specific device. More...
class	FunctionInterface
	The function interface to devices supported by this interface. More...
class	GainOffsetKneeChannelParameters
	Properties for configuring settings belonging to a certain channel of the GainOffsetKnee filter. More...
class	IntPtrExtension
	Additional methods to extend the System.IntPtr structure's functionality. More...
interface	IRequestBuffer
	A default request buffer. More...
class	RequestProvider
	A helper class that can be used to create a simple continuous acquisition from a device. More...
class	RequestReadyEventArgs
	A class containing data generated by a request ready event fired by instances of the class mv.impact.acquire.helper.RequestProvider. More...
class	RequestReadyEventData
	A class containing data stored inside a mv.impact.acquire.helper.RequestReadyEventArgs event fired by instances of the class mv.impact.acquire.helper.RequestProvider when a new mv.impact.acquire.Request became ready. More...
class	UserSuppliedHeapBuffer
	A small helper class to create a user supplied buffer on the heap. More...
class	ImageDestination
	Properties to define the format of resulting images. More...
class	ImageProcessing
	Base class for image processing related properties. More...
class	ImageRequestControl
	A helper class to control the way an image request will be processed. More...
class	ImpactAcquireException
	An base class for exceptions generated by Impact Acquire. More...
class	Info
	A class to query various general information about the device, its driver and other information. More...
class	InfoBlueCOUGAR
	A more specific class to query information about a mvBlueCOUGAR devices and its driver (Device specific interface layout only). More...
class	InfoBlueDevice
	A more specific class to query information about a mvBlueDevice device and its driver (Device specific interface layout only). More...
class	InfoBlueFOX
	A more specific class to query information about a mvBlueFOX device and its driver (Device specific interface layout only). More...
interface	IRequestFactory
	A default request factory. More...
class	VideoStream
	A class to create compressed video stream from images captured or loaded using the Impact Acquire API. More...
class	VideoStreamPauseScope
	A smaller helper class for pausing a video stream for a defined time. More...
class	LibraryPath
	A small helper class to administer various library search path related variables and paths. More...
class	LUTParameters
	Properties for configuring settings belonging to a certain LUT (Look Up Table) to be applied to a captured image. More...
class	Method
	A class to call arbitrary driver functions. More...
class	MirrorParameters
	Properties for configuring settings belonging to the mirror filter that processes a certain channel of a captured image. More...
class	OutputSignalGeneratorBlueDevice
	A class to create complex digital output signals(Device specific interface layout only). More...
class	OutputSignalGeneratorFrameGrabber
	A class to create complex digital output signals(Device specific interface layout only). More...
class	Property
	A base class for properties. More...
class	PropertyF
	Provided for convenience only. This type represents a standard float property type. More...
class	PropertyI
	Provided for convenience only. This type represents a standard 32-bit integer property type. More...
class	PropertyI64
	Provided for convenience only. This type represents a standard 64-bit integer property type. More...
class	PropertyIBoolean
	Provided for convenience only. This type represents a standard boolean property type. More...
class	PropertyPtr
	A class to represent pointer properties. More...
class	PropertyS
	A class to represent string properties. More...
class	Request
	Contains information about a captured buffer. More...
class	RequestBitmapData
	A class containing a reference to a bitmap created from a request. More...
class	RequestInfoConfiguration
	Properties to configure which information shall be attached to the resulting images. More...
class	Statistics
	Contains statistical information. More...
class	SystemBlueFOX
	A class containing mvBlueFOX specific settings to control the overall behaviour of the driver(Device specific interface layout only). More...
class	SystemSettings
	A class for accessing general settings that control the overall behaviour of a device driver. More...
class	TImageBufferPixelFormatExtension
	Additional methods to extend the functionality of the mv.impact.acquire.TImageBufferPixelFormat enumeration. More...
class	TImageDestinationPixelFormatExtension
	Additional methods to extend the functionality of the mv.impact.acquire.TImageDestinationPixelFormat enumeration. More...
class	UserData
	A helper class to work with the device specific non-volatile memory(if available). More...
class	UserDataEntry
	A helper class that represents one entry in the devices non-volatile memory (if available). More...
class	WhiteBalancer
	Convenience class to provide an easy way for a more precise white balance calibration. More...
class	WhiteBalanceSettings
	Properties for adjusting the colors during a Bayer conversion. More...

Enumerations
enum	TAcquisitionMode : int {   amContinuous = 1 ,   amMultiFrame = 2 ,   amSingleFrame = 3 }
	Defines valid acquisition modes. More...
enum	TAcquisitionStartStopBehaviour : int {   assbDefault ,   assbUser }
	Defines valid modes for acquisition start/stop behaviour. More...
enum	TAoiMode : int {   amCentered = 0 ,   amFull ,   amUseAoi }
	Defines valid Area Of Interest modes. More...
enum	TBayerConversionMode : uint {   bcmLinearInterpolation ,   bcmAdaptiveEdgeSensing ,   bcmAuto ,   bcmPacked ,   bcmLinearPacked ,   bcmAdaptiveEdgeSensingPlus ,   bcmAdaptiveHomogeneityDirected }
	Defines the Bayer conversion algorithm to use. More...
enum	TBayerMosaicParity : int {   bmpUndefined = -1 ,   bmpGR ,   bmpRG ,   bmpBG ,   bmpGB }
	Defines valid Bayer formats. More...
enum	TBayerWhiteBalanceResult : int {   bwbrUnknown = 0 ,   bwbrOK = 1 ,   bwbrErrorUnknown = 2 ,   bwbrErrorTooDark = 3 ,   bwbrErrorTooBright = 4 }
	Defines valid results of a white balance calibration. More...
enum	TBoolean : int {   bFalse = 0 ,   bTrue = 1 }
	Defines a Boolean value type. More...
enum	TBufferPartDataType : int {   bpdtUnknown = 0 ,   bpdt2DImage = 1 ,   bpdt2DPlaneBiplanar = 2 ,   bpdt2DPlaneTriplanar = 3 ,   bpdt2DPlaneQuadplanar = 4 ,   bpdt3DImage = 5 ,   bpdt3DPlaneBiplanar = 6 ,   bpdt3DPlaneTriplanar = 7 ,   bpdt3DPlaneQuadplanar = 8 ,   bpdtConfidenceMap = 9 ,   bpdtGenICamChunkData = 10 ,   bpdtJPEG = 1000 ,   bpdtJPEG2000 ,   bpdtGDC_GenICamChunkData = 0x4000 ,   bpdtGDC_GenICamXML = 0x4001 ,   bpdtGDC_2DImage = 0x4200 ,   bpdtGDC_JPEG = 0x4201 ,   bpdtGDC_JPEG2000 = 0x4202 ,   bpdtGDC_H264 = 0x4203 }
	Defines buffer part data types. More...
enum	TCameraDataFormat : int {   cdfUnknown = 0 ,   cdfMono ,   cdfBayer ,   cdfBayerPacked ,   cdfRGB ,   cdfYUV }
	Defines the data format the camera is sending (deprecated. More...
enum	TCameraOutput : int {   coUndefined = -1 ,   coAuto = 0 ,   coComposite = 1 ,   coBase = 2 ,   coDigital = 3 ,   coSVideo = 4 ,   coMedium = 5 ,   coRGB = 6 ,   co2xComposite = 7 ,   co3xComposite = 8 ,   co4xComposite = 9 ,   coFull = 10 ,   coSDSDI = 11 ,   coHDSDI = 12 ,   co3GSDI = 13 }
	Defines valid ways a camera can offer image data to a capture device (deprecated. More...
enum	TChannelSplitMode : int {   csmVertical ,   csmHorizontal ,   csmExtractSingle }
	Defines valid modes for channel split filters. More...
enum	TColorProcessingMode : int {   cpmAuto = 0 ,   cpmRaw ,   cpmBayer ,   cpmBayerToMono ,   cpmRawToPlanes }
	Defines the color processing mode. More...
enum	TColorTwistInputCorrectionMatrixMode : int {   cticmmUser = 0x00010000 | 0x1000 ,   cticmmDeviceSpecific = 0x00010000 | 0x2000 }
	Defines valid values for input color correction matrices. More...
enum	TColorTwistOutputCorrectionMatrixMode : int {   ctocmmUser ,   ctocmmXYZToAdobeRGB_D50 ,   ctocmmXYZTosRGB_D50 ,   ctocmmXYZToWideGamutRGB_D50 ,   ctocmmXYZToAdobeRGB_D65 ,   ctocmmXYZTosRGB_D65 }
	Defines valid values for output color correction matrices. More...
enum	TDarkCurrentFilterMode : int {   dcfmOff = 0 ,   dcfmOn ,   dcfmCalibrateDarkCurrent ,   dcfmTransmitCorrectionImage }
	Defines valid modes for the dark current filter. More...
enum	TDefectivePixelsFilterMode : int {   dpfmOff = 0 ,   dpfm3x1Average ,   dpfm3x3Median ,   dpfmResetCalibration ,   dpfmCalibrateLeakyPixel ,   dpfmCalibrateColdPixel ,   dpfmCalibrateHotPixel ,   dpfmCalibrateHotAndColdPixel ,   dpfmReplaceDefectivePixelAfter3x3Filter }
	Defines valid modes for defective pixels filter. More...
enum	TDeviceAccessMode : int {   damUnknown ,   damNone ,   damRead ,   damControl ,   damExclusive }
	Defines valid device access modes. More...
enum	TDeviceAutoNegotiatePacketSizeMode : int {   danpsmHighToLow ,   danpsmLowToHigh }
	Defines the way the packet size auto negotiation is handled for GigE Vision™ devices. More...
enum	TDeviceCapability : uint {   dcNone = 0x0 ,   dcHotplugable = 0x1 ,   dcSelectableVideoInputs = 0x2 ,   dcNonVolatileUserMemory = 0x4 ,   dcCameraDescriptionSupport = 0x8 ,   dcEventSupport = 0x10 }
	Defines valid device capabilities. More...
enum	TDeviceClass : int {   dcGeneric ,   dcCamera ,   dcIntelligentCamera ,   dcFrameGrabber ,   dc3DCamera }
	Defines valid generic device classes. More...
enum	TDeviceInterfaceLayout : int {   dilDeviceSpecific = 1 ,   dilGenICam = 2 }
	Defines valid interface layouts for the device. More...
enum	TDeviceListType : int {   dltUndefined = -1 ,   dltSetting = 0 ,   dltRequest = 1 ,   dltRequestCtrl = 2 ,   dltInfo = 3 ,   dltStatistics = 4 ,   dltSystemSettings = 5 ,   dltIOSubSystem = 6 ,   dltRTCtr = 7 ,   dltCameraDescriptions = 8 ,   dltDeviceSpecificData = 9 ,   dltImageMemoryManager = 12 ,   dltLast = 13 ,   dltDeviceDriverLib = dltLast }
	Defines valid interface list types, which can be located using an instance of mv.impact.acquire.DeviceComponentLocator. More...
enum	TDeviceLoadSettings : int {   dlsAuto = 0 ,   dlsNoLoad }
	Defines valid modes for the loading of settings during initialization. More...
enum	TDeviceState : int {   dsAbsent = 0 ,   dsPresent ,   dsInitializing ,   dsUnreachable ,   dsPowerDown }
	Defines valid Device states. More...
enum	TDMR_ERROR : int {   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_ACQUISITION_ENGINE_BUSY = -2145 ,   DMR_BUSY = -2146 ,   DMR_OUT_OF_MEMORY = -2147 ,   DMR_LAST_VALID_ERROR_CODE = -2199 }
	Errors reported by the device manager. More...
enum	TFlatFieldFilterCorrectionMode : int {   ffcmDefault = 0 ,   ffcmBrightPreserving }
	Defines valid modes for the flat field correction. More...
enum	TFlatFieldFilterMode : int {   fffmOff = 0 ,   fffmOn ,   fffmCalibrateFlatField ,   fffmTransmitCorrectionImage }
	Defines valid modes for the flat field filter. More...
enum	THWUpdateResult : int {   urNoUpdatePerformed = 0 ,   urUpdateFW ,   urUpdateFWError ,   urDevAlreadyInUse ,   urUpdateFWOK ,   urSetDevID ,   urSetDevIDError ,   urSetDevIDInvalidID ,   urSetDevIDOK ,   urSetUserDataSizeError ,   urSetUserDataWriteError ,   urSetUserDataWriteOK ,   urGetUserDataReadError ,   urVerifyFWError ,   urVerifyFWOK }
	Defines valid Device HW update results. More...
enum	TImageBufferFormatReinterpreterMode : int {   ibfrmMono8_To_Mono8 = TImageBufferPixelFormat.ibpfMono8 << 16 | TImageBufferPixelFormat.ibpfMono8 ,   ibfrmMono8_To_RGB888Packed = TImageBufferPixelFormat.ibpfMono8 << 16 | TImageBufferPixelFormat.ibpfRGB888Packed ,   ibfrmMono8_To_BGR888Packed = TImageBufferPixelFormat.ibpfMono8 << 16 | TImageBufferPixelFormat.ibpfBGR888Packed ,   ibfrmMono10_To_Mono10 = TImageBufferPixelFormat.ibpfMono10 << 16 | TImageBufferPixelFormat.ibpfMono10 ,   ibfrmMono10_To_RGB101010Packed = TImageBufferPixelFormat.ibpfMono10 << 16 | TImageBufferPixelFormat.ibpfRGB101010Packed ,   ibfrmMono12_To_Mono12 = TImageBufferPixelFormat.ibpfMono12 << 16 | TImageBufferPixelFormat.ibpfMono12 ,   ibfrmMono12_To_RGB121212Packed = TImageBufferPixelFormat.ibpfMono12 << 16 | TImageBufferPixelFormat.ibpfRGB121212Packed ,   ibfrmMono14_To_Mono14 = TImageBufferPixelFormat.ibpfMono14 << 16 | TImageBufferPixelFormat.ibpfMono14 ,   ibfrmMono14_To_RGB141414Packed = TImageBufferPixelFormat.ibpfMono14 << 16 | TImageBufferPixelFormat.ibpfRGB141414Packed ,   ibfrmMono16_To_Mono16 = TImageBufferPixelFormat.ibpfMono16 << 16 | TImageBufferPixelFormat.ibpfMono16 ,   ibfrmMono16_To_RGB161616Packed = TImageBufferPixelFormat.ibpfMono16 << 16 | TImageBufferPixelFormat.ibpfRGB161616Packed }
	Valid image buffer format reinterpreter modes. More...
enum	TImageBufferPixelFormat : int {   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 ,   ibpfMono12Packed_V1 = 28 ,   ibpfYUV411_UYYVYY_Packed = 29 ,   ibpfRGB888Planar = 30 ,   ibpfAuto = -1 }
	Valid image buffer pixel formats. More...
enum	TImageDestinationPixelFormat : int {   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 ,   idpfMono12Packed_V1 = 28 ,   idpfYUV411_UYYVYY_Packed = 29 ,   idpfRGB888Planar = 30 }
	Defines the pixel format of the result image. More...
enum	TImageFileFormat : int {   iffAuto = -1 ,   iffBMP = 1 ,   iffJPEG = 2 ,   iffPNG = 13 ,   iffTIFF = 18 }
	Defines valid image file formats. More...
enum	TImageProcessingFilter : int {   ipfOff = 0 ,   ipfSharpen }
	Defines valid filters which can be applied to the captured image before it is transferred to the user. More...
enum	TImageProcessingMode : int {   ipmDefault = 0 ,   ipmProcessLatestOnly = 1 }
	Defines valid modes the internal image processing pipeline can be operated in. More...
enum	TImageProcessingOptimization : int {   ipoMaximizeSpeed = 0 ,   ipoMinimizeMemoryUsage = 1 }
	Defines valid modes the internal image processing algorithms can be operated in. More...
enum	TImageProcessingResult : int {   iprNotActive = 0 ,   iprApplied ,   iprFailure ,   iprSkipped ,   iprNotApplicable }
	Defines valid values for the result of a certain image processing algorithm applied to a request. More...
enum	TImageRequestControlMode : int {   ircmManual ,   ircmLive ,   ircmCounting ,   ircmTrial ,   ircmUpdateBufferLayout }
	Defines the behaviour of an mv.impact.acquire.ImageRequestControl. More...
enum	TImpactBufferFlag : uint {   ibfNone = 0x0 ,   ibfUseRequestMemory = 0x1 ,   ibfRecycleBufHandle = 0x2 }
	Flags to define the way an mvIMPACT buffer is created and handled. More...
enum	TInterfaceEnumerationBehaviour : int {   iebNotConfigured = 0 ,   iebForceIgnore = 1 ,   iebForceEnumerate = 2 }
	Defines the enumeration behaviour of a certain interface of a third party GenTL producer. More...
enum	TLibraryQuery : int {   lqDeviceManager = 0 ,   lqPropHandling = 1 }
	Defines valid libraries to query information from. More...
enum	TLUTGammaMode : int {   LUTgmStandard ,   LUTgmLinearStart }
	Defines valid LUT(LookUp Table) gamma modes. More...
enum	TLUTImplementation : int {   LUTiHardware ,   LUTiSoftware }
	Defines valid LUT(LookUp Table) implementations. More...
enum	TLUTInterpolationMode : int {   LUTimThreshold ,   LUTimLinear ,   LUTimCubic }
	Defines valid LUT(LookUp Table) interpolation modes. More...
enum	TLUTMapping : uint {   LUTm8To8 = ( 8 << 16 ) | 8 ,   LUTm10To8 = ( 10 << 16 ) | 8 ,   LUTm10To10 = ( 10 << 16 ) | 10 ,   LUTm12To10 = ( 12 << 16 ) | 10 ,   LUTm12To12 = ( 12 << 16 ) | 12 ,   LUTm14To14 = ( 14 << 16 ) | 14 ,   LUTm16To16 = ( 16 << 16 ) | 16 }
	Defines valid LUT(LookUp Table) mapping modes. More...
enum	TLUTMode : int {   LUTmInterpolated ,   LUTmGamma ,   LUTmDirect }
	Defines valid LUT(LookUp Table) modes. More...
enum	TMemoryManagerMode : int {   mmmAuto = 0 ,   mmmPool = 1 }
	Defines valid modes to operate the memory manager in. More...
enum	TMemoryManagerPoolMode : int {   mmpmOff = 0 ,   mmpmFixed = 1 ,   mmpmAuto = 2 }
	Defines the pool mode of memory manager. More...
enum	TMirrorMode : uint {   mmOff = 0 ,   mmTopDown = 0x1 ,   mmLeftRight = 0x2 ,   mmTopDownAndLeftRight = mmTopDown | mmLeftRight }
	Defines valid mirror modes. More...
enum	TMirrorOperationMode : int {   momGlobal ,   momChannelBased }
	Defines valid mirror operation modes. More...
enum	TPayloadType : int {   ptUnknown = 0 ,   pt2DImage = 1 ,   ptJPEG = 5 ,   ptJPEG2000 = 6 ,   ptH264 = 7 ,   ptChunkOnly = 8 ,   ptMultiPart = 10 ,   ptGenDC = 11 }
	Defines supported payload types. More...
enum	TPolarizedDataExtractionInterpolationMode : int {   primOff ,   primLinear }
	Defines valid modes for the interpolation mode of polarization data extraction filters. More...
enum	TPolarizedDataExtractionMode : int {   prmVertical ,   prmHorizontal ,   prmExtractSingle ,   prmMinimumValue ,   prmMeanValue ,   prm2By2 ,   prmExtractAngle ,   prmExtractDegree ,   prmPseudoColorRepresentation }
	Defines valid modes for polarization data extraction filters. More...
enum	TPropertyLimits {   plMaxValue = -1 ,   plMinValue = -2 ,   plStepWidth = -3 }
	Defines valid limits which can be queried for a mv.impact.acquire.Property object. More...
enum	TRequestImageMemoryMode : int {   rimmAuto ,   rimmUser }
	Defines valid image modes for request objects. More...
enum	TRequestResult : uint {   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 ,   rrDataAcquisitionNotSupported = rrUnprocessibleRequest | 7 }
	Defines valid result of an image request. More...
enum	TRequestState : int {   rsIdle ,   rsWaiting ,   rsCapturing ,   rsReady ,   rsBeingConfigured }
	Defines the current state of this mv.impact.acquire.Request. More...
enum	TScalerInterpolationMode : int {   simNearestNeighbor ,   simLinear ,   simCubic }
	Defines valid scaler interpolation modes. More...
enum	TScalerMode : int {   smOff ,   smOn }
	Defines valid scaler modes. More...
enum	TUserDataAccessRight : uint {   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 : int {   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	TVideoCodec : int {   vcMPEG2 = 2 ,   vcH264 = 27 ,   vcH265 = 173 }
	Defines valid video codecs that might be supported by the underlying video compression engine. More...
enum	TVideoStandard : int {   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 : int {   wbcmOff = 0 ,   wbcmNextFrame ,   wbcmContinuous }
	Defines valid white balance calibration modes. More...
enum	TWhiteBalanceParameter : int {   wbpTungsten = 0 ,   wbpHalogen ,   wbpFluorescent ,   wbpDayLight ,   wbpPhotoFlash ,   wbpBlueSky ,   wbpUser1 ,   wbpUser2 ,   wbpUser3 ,   wbpUser4 }
	Defines valid parameter sets selectable via the WhiteBalance property. More...

Functions
delegate void	ComponentChangedEventHandler (Object sender, ComponentChangedEventArgs args)
	A function prototype for component changed events as generated by instances of mv.impact.acquire.ComponentCallback.
delegate void	DeviceWillBeClosedEventHandler (Object sender, DeviceWillBeClosedEventArgs args)
	A function prototype for handling events triggered when a device is about to get closed.
delegate void	RequestReadyEventHandler (Object sender, RequestReadyEventArgs args)
	A function prototype for request ready events as generated by instances of mv.impact.acquire.helper.RequestProvider.

Detailed Description

Classes and functions that are available for all interface layouts.

Enumeration Type Documentation

TAcquisitionMode

enum TAcquisitionMode : int

Defines valid acquisition modes.

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

TAcquisitionStartStopBehaviour

enum TAcquisitionStartStopBehaviour : int

Defines valid modes for acquisition start/stop behaviour.

Since

1.12.11

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, queuing of image request buffers and the actual streaming of data from the device is de-coupled. This can sometimes be favorable 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-queuing some buffer before starting the actual data transfer can help to avoid capture queue underruns and thus data loss.

TAoiMode

enum TAoiMode : int

Defines valid Area Of Interest modes.

Enumerator
amCentered	Use a small centered 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. Since 2.37.0 Example: Assume a device that can deliver 1280*960 pixels. Now in the centered AOI mode a processing function will use a window smaller than the AOI in the middle of the image. The starting point can be calculated by the formula: offsetX = ( width - ( width / 2 ) ) / 2 offsetY = ( height - ( height / 2 ) ) / 2 The used AOI is just width / 2 * height / 2 thus takes up the center quarter of the selected AOI. In case of an AOI defined by the user, the central AOI of the delivered image is used. Deprecated Up to version 2.36.0 the AOI had just a size of 50*50 pixels. The behavior was the following: Assume a device that can deliver 640*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.
amFull	Use the complete image for image processing.
amUseAoi	Use a user defined AOI window for image processing.

TBayerConversionMode

enum TBayerConversionMode : uint

Defines the Bayer conversion algorithm to use.

Enumerator
bcmLinearInterpolation	Linear interpolation. This mode is fast but especially sharp edges will appear slightly blurred in the resulting image.
bcmAdaptiveEdgeSensing	Adaptive edge sensing. This mode requires more CPU time than linear interpolation, but the resulting image more closely matches the original scene. Edges will be reconstructed with higher accuracy except for noisy images. For better results in noisy images mv.impact.acquire.TBayerConversionMode.bcmLinearInterpolation is the recommended mode.
bcmAuto	Auto. This mode automatically sets the Bayer conversion algorithm according to the format property of the camera description.
bcmPacked	Packed. In this mode the resulting image will have half the height of the source image. The following algorithm will be used for generating the resulting image: 1 2 3 4 ... n 1 R G R G ... R G 2 G B G B ... G B | 1 | 2 | 3 | 4 | 5 |...| n | 1 |RGB|RGB|RGB|RGB|RGB|...|RGB| R1(dest) = R11 G1(dest) = (G12 + G21) / 2 B1(dest) = B22 R2(dest) = (R11 + R13) / 2 G2(dest) = ((G12 + G21) / 2) + (G12 + G23)) / 2 B2(dest) = (B22 + B24) / 2 ... Rn(dest) = R1(n-1) Gn(dest) = (G1(n) + G2(n-1)) / 2 Bn(dest) = B2(n) This mode is mainly useful for line scan cameras as for area cameras this would modify the aspect ratio. Since 2.5.9
bcmLinearPacked	Linear Packed. In this mode the resulting image will have half the height of the source image. The following algorithm will be used for generating the resulting image: 1 2 3 4 ... n 1 R G R G ... R G 2 G B G B ... G B | 1 | 2 | 3 | 4 | 5 |...| n | 1 |RGB|RGB|RGB|RGB|RGB|...|RGB| 2 |RGB|RGB|RGB|RGB|RGB|...|RGB| R1(dest) = R11 G1(dest) = G21 B1(dest) = B22 R2(dest) = (R11 + R13) / 2 G2(dest) = G12 B2(dest) = B22 R3(dest) = R13 G3(dest) = G23 B3(dest) = (B22 + B24) / 2 ... Rn(dest) = R1(n-1) Gn(dest) = G1(n) Bn(dest) = B2(n) This mode is mainly useful for line scan cameras as for area cameras this would modify the aspect ratio. Since 2.5.9
bcmAdaptiveEdgeSensingPlus	Adaptive edge sensing plus. This mode is even more demanding CPU-wise than adaptive edge sensing, but the resulting image is sharper and has fewer artifacts. The parameters of the sharpening filter can be set by the user, to fit specific needs. Since 2.26.0
bcmAdaptiveHomogeneityDirected	Adaptive edge sensing plus. This mode is most demanding CPU-wise, but the resulting image will have the best possible quality. It is based on the following algorithm: K. Hirakawa, T.W. Parks, Adaptive Homogeneity-Directed Demosaicing Algorithm, IEEE Trans. Image Processing, March, 2005. Since 2.27.0

TBayerMosaicParity

enum TBayerMosaicParity : int

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.

TBayerWhiteBalanceResult

enum TBayerWhiteBalanceResult : int

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.

TBoolean

enum TBoolean : int

Defines a Boolean value type.

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

TBufferPartDataType

enum TBufferPartDataType : int

Defines buffer part data types.

Since

2.20.0

Enumerator
bpdtUnknown	The framework is not aware of the data type of the data in the provided buffer part. From the application perspective this can be handled as raw data.
bpdt2DImage	Color or monochrome (2D) image (GenTL). This part carries all the pixel data of given image (even if the image is represented by a single-plane pixel format).
bpdt2DPlaneBiplanar	Single color plane of a planar (2D) image (GenTL). The data should be linked with the other color planes to get the complete image. The complete image consists of 2 planes. The planes of a given planar image must be placed as consecutive parts within the buffer.
bpdt2DPlaneTriplanar	Single color plane of a planar (2D) image (GenTL). The data should be linked with the other color planes to get the complete image. The complete image consists of 3 planes. The planes of a given planar image must be placed as consecutive parts within the buffer.
bpdt2DPlaneQuadplanar	Single color plane of a planar (2D) image (GenTL). The data should be linked with the other color planes to get the complete image. The complete image consists of 4 planes. The planes of a given planar image must be placed as consecutive parts within the buffer.
bpdt3DImage	3D image (pixel coordinates) (GenTL). This part carries all the pixel data of given image (even if the image is represented by a single-plane pixel format, for example when transferring the depth map only).
bpdt3DPlaneBiplanar	Single color plane of a planar (3D) image (GenTL). The data should be linked with the other color planes to get the complete image. The complete image consists of 2 planes. The planes of a given planar image must be placed as consecutive parts within the buffer.
bpdt3DPlaneTriplanar	Single color plane of a planar (3D) image (GenTL). The data should be linked with the other color planes to get the complete image. The complete image consists of 3 planes. The planes of a given planar image must be placed as consecutive parts within the buffer.
bpdt3DPlaneQuadplanar	Single color plane of a planar (3D) image (GenTL). The data should be linked with the other color planes to get the complete image. The complete image consists of 4 planes. The planes of a given planar image must be placed as consecutive parts within the buffer.
bpdtConfidenceMap	Confidence of the individual pixel values (GenTL). Expresses the level of validity of given pixel values. Confidence map is always used together with one or more additional image-based parts matching 1:1 dimension-wise. Each value in the confidence map expresses level of validity of the image pixel at matching position.
bpdtGenICamChunkData	Chunk data (GenTL). The data in this buffer part contains chunk data which can be decoded according the standard the data originated from. Since 2.50.0
bpdtJPEG	JPEG image data (GenTL).
bpdtJPEG2000	JPEG 2000 image data (GenTL).
bpdtGDC_GenICamChunkData	Chunk data (GenDC). The data in this buffer part contains chunk data which can be decoded according the standard the data originated from. Since 2.50.0
bpdtGDC_GenICamXML	GenICam XML data (GenDC). The data in this buffer part contains a GenICam XML file. Since 2.50.0
bpdtGDC_2DImage	Color or monochrome (2D) image (GenDC). This part carries all the pixel data of given image (even if the image is represented by a single-plane pixel format).
bpdtGDC_JPEG	JPEG image data (GenDC). Since 2.50.0
bpdtGDC_JPEG2000	JPEG 2000 image data (GenDC). Since 2.50.0
bpdtGDC_H264	A H.264 buffer (GenDC). The data in this buffer part contains H.264 frame. Since 2.50.0

TCameraDataFormat

enum TCameraDataFormat : int

Defines the data format the camera is sending (deprecated.

Deprecated

Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!

Enumerator
cdfUnknown	This is an unknown type. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
cdfMono	This is a mono data format. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
cdfBayer	This is a Bayer format. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
cdfBayerPacked	This is a Bayer Packed format. For each object line there is a red and a blue raw line to calculate the resulting color line. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
cdfRGB	This is a RGB format. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
cdfYUV	This is a YUV format. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!

TCameraOutput

enum TCameraOutput : int

Defines valid ways a camera can offer image data to a capture device (deprecated.

Deprecated

Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!

Enumerator
coUndefined	Specifies an undefined output. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
coAuto	Auto mode. Here the capture device tries to guess how the data is transmitted. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
coComposite	The camera will offer an analogue composite video signal. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
coBase	The camera will offer CameraLink® Base compliant image data. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
coDigital	The camera will offer digital image data. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
coSVideo	The camera will offer an analogue SVideo signal. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
coMedium	The camera will offer CameraLink® Medium compliant image data. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
coRGB	The camera will offer an analogue RGB signal. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
co2xComposite	Two cameras will offer two synchronous analogue signals. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
co3xComposite	Three cameras will offer three synchronous analogue signals. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
co4xComposite	Four cameras will offer four synchronous analogue signals. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
coFull	The camera will offer CameraLink® Full compliant image data. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
coSDSDI	The camera will offer serial digital interface(SDI) SD signal. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
coHDSDI	The camera will offer serial digital interface(SDI) HD signal. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!
co3GSDI	The camera will offer serial digital interface(SDI) 3G signal. Deprecated Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!

TChannelSplitMode

enum TChannelSplitMode : int

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

TColorProcessingMode

enum TColorProcessingMode : int

Defines the color processing mode.

Enumerator
cpmAuto	The driver decides (depending on the connected camera) what kind of color processing has to be applied.
cpmRaw	No color processing will be performed.
cpmBayer	A Bayer color 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 color 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) *

TColorTwistInputCorrectionMatrixMode

enum TColorTwistInputCorrectionMatrixMode : int

Defines valid values for input color correction matrices.

Since

2.2.2

Enumerator
cticmmUser	A user defined correction matrix.
cticmmDeviceSpecific	A device specific internally defined correction matrix. This will almost always be the best selection as then the driver internally uses the best matrix for known products.

TColorTwistOutputCorrectionMatrixMode

enum TColorTwistOutputCorrectionMatrixMode : int

Defines valid values for output color correction matrices.

Since

2.2.2

Enumerator
ctocmmUser	A user defined correction matrix.
ctocmmXYZToAdobeRGB_D50	Will apply the XYZ to Adobe RGB matrix with a D50 white reference. The following matrix will be applied: Row 0 Row 1 Row 2 1.9624274 -0.6105343 -0.3413404 -0.9787684 1.9161415 0.0334540 0.0286869 -0.1406752 1.3487655
ctocmmXYZTosRGB_D50	Will apply the XYZ to sRGB matrix with a D50 white reference. The following matrix will be applied: Row 0 Row 1 Row 2 3.1338561 -1.6168667 -0.4906146 -0.9787684 1.9161415 0.0334540 0.0719453 -0.2289914 1.4052427
ctocmmXYZToWideGamutRGB_D50	Will apply the XYZ to White Gamut RGB matrix with a D50 white reference. The following matrix will be applied: Row 0 Row 1 Row 2 1.4628067 -0.1840623 -0.2743606 -0.5217933, 1.4472381 0.0677227 0.0349342 -0.0968930 1.2884099
ctocmmXYZToAdobeRGB_D65	Will apply the XYZ to Adobe RGB matrix with a D65 white reference. The following matrix will be applied: Row 0 Row 1 Row 2 2.0413690 -0.5649464 -0.3446944 -0.9692660 1.8760108 0.0415560 0.0134474 -0.1183897 1.0154096
ctocmmXYZTosRGB_D65	Will apply the XYZ to sRGB matrix with a D65 white reference. The following matrix will be applied: Row 0 Row 1 Row 2 3.2404542 -1.5371385 -0.4985314 -0.9692660 1.8760108 0.0415560 0.0556434 -0.2040259 1.0572252

TDarkCurrentFilterMode

enum TDarkCurrentFilterMode : int

Defines valid modes for the dark current filter.

Enumerator
dcfmOff	The filter is switched off.
dcfmOn	The filter is switched on.
dcfmCalibrateDarkCurrent	The next selected number of images will be taken for calculating the dark current correction image. In this mode after the correction image has been calculated the mode will automatically switch back to mv.impact.acquire.TDarkCurrentFilterMode.dcfmOff
dcfmTransmitCorrectionImage	In this mode whenever reaching this filter, the captured image will be replaced by the last correction image, that has been created as a result of the filter being calibrated. Since 2.5.9

TDefectivePixelsFilterMode

enum TDefectivePixelsFilterMode : int

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 neighbor pixel.
dpfm3x3Median	The filter is active, detected defective pixels will be replaced with the median value calculated from the nearest neighbors (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 the 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 the average when the sensor is exposed to light.
dpfmCalibrateHotPixel	Detect defective hot pixels within the next frame captured. These are pixels that produce a higher read out code than the average when the sensor is exposed to light. Since 2.31.0
dpfmCalibrateHotAndColdPixel	Detect defective hot and cold pixels within the next frame captured. These are pixels that produce either a higher or a lower read out code than the average when the sensor is exposed to light. This effectively combines mv.impact.acquire.TDefectivePixelsFilterMode.dpfmCalibrateColdPixel and mv.impact.acquire.TDefectivePixelsFilterMode.dpfmCalibrateHotPixel Since 2.31.0
dpfmReplaceDefectivePixelAfter3x3Filter	The filter is active, detected defective pixel will be replaced and treated as being fed into a 3x3 de-Bayer algorithm before reaching the filter. This is a rather special mode that only makes sense for very specific use cases: Defective pixel data has been obtained by the filter from a device that did carry this data within it's non-volatile memory, the device itself does NOT provide a defective pixel replacement functionality and the device is operated in RGB or YUV mode using a 3 by 3 filter kernel. This will introduce artifacts in the pixels surrounding the defective pixel then and to compensate that a special handling is needed. To reduce CPU load another use case might be to detect defective pixels on a device in Bayer mode using the defective pixel filter of this SDK and then switch the device into RGB mode if supported. Again this is only needed if the device itself does not offer a defective pixel compensation. A far better way to tackle this of course would be (in that order): Compensate the defective pixels on the device BEFORE feeding the data into the Bayer filter Switch the device to a Bayer format, compensate the defective pixels on the host and THEN feed the data into a host-based Bayer filter Select a device with less defective pixels if these are causing harm to the application This mode will only operate on packed RGB or packed YUV444 data! It will assume that when given a pixel p all the surrounding pixels marked with a d in the following section need to be replaced as well(- stands for other pixels NOT affected by the replacement operation): --------------- --------------- ----ddd-------- ----dpd-------- ----ddd-------- --------------- Since 2.33.0

TDeviceAccessMode

enum TDeviceAccessMode : int

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.

TDeviceAutoNegotiatePacketSizeMode

enum TDeviceAutoNegotiatePacketSizeMode : int

Defines the way the packet size auto negotiation is handled for GigE Vision™ devices.

All modes will eventually result in the optimal packet value. However depending on the network setup one method might be faster than another.

Enumerator
danpsmHighToLow	Start with the maximum possible packet size. If set to mv.impact.acquire.TDeviceAutoNegotiatePacketSizeMode.danpsmHighToLow the packet size auto negotiation starts with the NICs current MTU value. If this value is too large (in terms of not all network components support it) decreasing sizes will be tried until the optimal (thus highest value supported by all network components) has been found. Note This mode is optimal when working with network interfaces where Jumbo frames are enabled.
danpsmLowToHigh	Start with the minimal possible packet size. If set to mv.impact.acquire.TDeviceAutoNegotiatePacketSizeMode.danpsmLowToHigh the packet size auto negotiation starts with the smallest possible MTU. Afterwards increasing sizes will be tried until the optimal (thus highest value supported by all network components) has been found. Note This mode is optimal when nothing is known about the network configuration.

TDeviceCapability

enum TDeviceCapability : uint

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

TDeviceClass

enum TDeviceClass : int

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.
dc3DCamera	A 3D camera.

TDeviceInterfaceLayout

enum TDeviceInterfaceLayout : int

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. Apart from that the interface layout also has impact at what time property values will be buffered for buffer captures.

Enumerator
dilDeviceSpecific	A device specific interface shall be used(deprecated for all GenICam™ compliant devices). For most devices supported by this SDK this will be the only interface 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 any third party hardware which might be usable with a certain device driver. In contrast to the other interface layouts, this layout will use a buffered property approach. This means that consecutive buffers can be requested each using defined but different settings. At the time of requesting a buffer, the driver will internally store the current property settings and will re-program the hardware later at the time of processing this request if the current settings differ from the settings that shall be used for this request. Deprecated This interface layout has been declared deprecated for GenICam™ compliant devices(mvBlueCOUGAR-S, mvBlueCOUGAR-X and mvBlueCOUGAR-XD). For these products please use mv.impact.acquire.TDeviceInterfaceLayout.dilGenICam instead. Newer devices like the mvBlueFOX3 will not support this interface layout at all. See also The Differences Between The Interface Layouts.
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 Impact Acquire. In this interface layout property value changes will always have immediate effect, thus when changing the exposure time directly after requesting a buffer this buffer might be captured with the new exposure time already depending on the time the buffer request is actually be processed. Note This interface layout will allow to access third party devices as well. See also 'GenICam' vs. 'DeviceSpecific' Interface Layout The Differences Between The Interface Layouts.

TDeviceListType

enum TDeviceListType : int

Defines valid interface list types, which can be located using an instance of mv.impact.acquire.DeviceComponentLocator.

Enumerator
dltUndefined	A placeholder for an undefined list type.
dltSetting	Specifies a certain setting. An additional string defines the name of the setting to look for.
dltRequest	Specifies the list of driver owned image request objects.
dltRequestCtrl	Specifies a certain image request control. An additional string defines the name of the setting to look for.
dltInfo	Specifies the driver interfaces list containing general information. This e.g. can be properties containing the driver version, the current state of the device and stuff like that.
dltStatistics	Specifies the driver interface list containing statistical information. This list e.g. might contain the current frame rate, the total number of images captured, etc.
dltSystemSettings	Specifies the driver interface list containing properties, which influence the overall operation of the device. This list e.g. might contain the priority of the drivers internal worker thread, the number of request objects the driver shall work with, etc..
dltIOSubSystem	Specifies the driver interface list containing properties to work with any kind of I/O pin belonging to that device. Here properties addressing the digital inputs and outputs and other I/O related properties can be found.
dltRTCtr	Specifies the driver interface list providing access to the drivers Hardware Real-Time Controller (HRTC). Here properties to control the behaviour of the HRTCs can be found. Note This feature might not be available for every device.
dltCameraDescriptions	Specifies the driver interface list providing access to the recognized camera description lists. Within this list all recognized camera descriptions can be found, each forming a sub list containing the properties describing the camera. Note This feature is only available for frame grabber devices currently.
dltDeviceSpecificData	Specifies the driver interface list providing access to the device specific settings lists. Note This feature currently is only available for frame grabber devices.
dltImageMemoryManager
dltLast
dltDeviceDriverLib	Specifies the device driver lib. An additional string defines the name of the device driver lib to look for. Since 2.17.0

TDeviceLoadSettings

enum TDeviceLoadSettings : int

Defines valid modes for the loading of settings during initialization.

Whenever a mv.impact.acquire.Device is initialized this enumeration type defines the mode the mv.impact.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 initialization 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.

TDeviceState

enum TDeviceState : int

Defines valid Device states.

Enumerator
dsAbsent	The mv.impact.acquire.Device has been unplugged. The mv.impact.acquire.Device has present been since the mv.impact.acquire.DeviceManager has been initialized, 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 mv.impact.acquire.Device is currently connected and initialized.
dsInitializing	The mv.impact.acquire.Device is connected and is currently initializing.
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.

TDMR_ERROR

enum TDMR_ERROR : int

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 initialized.
DMR_INIT_FAILED	The device manager couldn't be initialized. This is an internal error.
DMR_DRV_ALREADY_IN_USE	The device is already in use. This error e.g. will occur if this or another process has initialized this device already and an application tries to open the device once more or if a certain resource is available only once but shall be used twice.
DMR_DEV_CANNOT_OPEN	The specified device couldn't be initialized.
DMR_NOT_INITIALIZED	The device manager or another module hasn't been initialized properly. This error occurs if the user tries e.g. to close the device manager without having initialized it before or if a library used internally or a module or device associated with that library has not been initialized properly or if
DMR_DRV_CANNOT_OPEN	A device could not be initialized. 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. • within the current setup one or more parameters impose restrictions on the requested operation that don't allow its execution.
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 mv.impact.acquire.Request object failed. This might happen, if the mv.impact.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 mv.impact.acquire.Request object is invalid. The max. number for a mv.impact.acquire.Request object is the value of the property RequestCount in the mv.impact.acquire.SystemSettings 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 mv.impact.acquire.Request that will be used for this new image.
DEV_NO_FREE_REQUEST_AVAILABLE	The user requested a new image, but no free mv.impact.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 and 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 too 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	A called function or accessed feature is not available for this device.
DMR_FEATURE_NOT_AVAILABLE	The feature in question is (currently) not available for this device or driver. This might be because another feature currently blocks the one in question from being accessible. 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?). Since 1.5.0
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 https://www.balluff.com. There will always be an updated version of the library considered to be too old for download from here. Since 1.6.6
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. More information can be found in the *.log-file or the debug output. Since 1.7.2
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, mv.impact.acquire.TDMR_ERROR.DMR_WAIT_ABANDONED will be returned then. Since 1.7.2
DMR_EXECUTION_FAILED	The execution of a method object or reading/writing to a feature failed. More information can be found in the log-file. Since 1.9.0
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. Since 1.10.31
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. Since 1.10.31
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 Since 1.10.31
DEV_ACCESS_DENIED	The requested access to a device could not be granted. There are multiple reasons for this error code. Detailed information can be found in the *.log-file. POSSIBLE CAUSES: • an application tries to access a device exclusively that is already open in another process • 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 • an application tried to execute a function that is currently not available • an application tries to write to a read-only location. Since 1.10.39
DMR_PRELOAD_CHECK_FAILED	A pre-load 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. Since 1.10.52
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. Since 1.10.57
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 sent 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. • ... Since 1.10.87
DMR_INVALID_QUEUE_SELECTION	An error returned when the user application attempts to operate on an invalid queue. Since 1.11.0
DMR_ACQUISITION_ENGINE_BUSY	An error returned when the user application attempts to start the acquisition engine at a time, where it is already running. Since 2.5.3
DMR_BUSY	An error returned when the user application attempts to perform any operation that currently for any reason cannot be started because something else already running. The log-output will provide additional information. Since 2.32.0
DMR_OUT_OF_MEMORY	An error returned when for any reason internal resources (memory, handles, ...) cannot be allocated. The log-output will provide additional information. Since 2.32.0
DMR_LAST_VALID_ERROR_CODE	Defines the last valid error code value for device and device manager related errors.

TFlatFieldFilterCorrectionMode

enum TFlatFieldFilterCorrectionMode : int

Defines valid modes for the flat field correction.

Enumerator
ffcmDefault	The default flat field correction is used.
ffcmBrightPreserving	The flat field correction with clipping compensation is used. This mode prevents clipping artifacts when overexposing the image, but may cause missing codes in the histogram and a brighter image.

TFlatFieldFilterMode

enum TFlatFieldFilterMode : int

Defines valid modes for the flat field filter.

Enumerator
fffmOff	The filter is switched off.
fffmOn	The filter is switched on.
fffmCalibrateFlatField	The next selected number of images will be taken for calculating the flat field correction image. In this mode after the correction image has been calculated the mode will automatically switch back to mv.impact.acquire.TFlatFieldFilterMode.fffmOff
fffmTransmitCorrectionImage	In this mode whenever reaching this filter, the captured image will be replaced by the last correction image, that has been created as a result of the filter being calibrated. Since 2.5.9

THWUpdateResult

enum THWUpdateResult : int

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 mv.impact.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 mv.impact.acquire.Device is currently updating firmware.
urUpdateFWError	The mv.impact.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 mv.impact.acquire.Device indicates that the firmware has been updated successfully.
urSetDevID	The mv.impact.acquire.Device is currently setting device ID.
urSetDevIDError	The mv.impact.acquire.Device signaled an error when setting device ID.
urSetDevIDInvalidID	An invalid device ID has been specified. Valid device IDs are within 0 and 250 including the upper and lower limit.
urSetDevIDOK	The mv.impact.acquire.Device has successfully been assigned a new ID.
urSetUserDataSizeError	Size Error in writing User Data to mv.impact.acquire.Device .
urSetUserDataWriteError	Write Error in writing User Data to mv.impact.acquire.Device .
urSetUserDataWriteOK	Writing user data to mv.impact.acquire.Device was successful.
urGetUserDataReadError	Reading user data from an mv.impact.acquire.Device failed.
urVerifyFWError	The mv.impact.acquire.Device indicates an error during verifying firmware.
urVerifyFWOK	The mv.impact.acquire.Device indicates that the firmware has been verified successfully.

TImageBufferFormatReinterpreterMode

enum TImageBufferFormatReinterpreterMode : int

Valid image buffer format reinterpreter modes.

Since

2.10.1

Enumerator
ibfrmMono8_To_Mono8	Attach or remove a mv.impact.acquire.TBayerMosaicParity attribute to a mv.impact.acquire.TImageBufferPixelFormat.ibpfMono8 buffer OR change the existing Bayer attribute to a different value. The new mv.impact.acquire.TBayerMosaicParity value for the buffer can be selected by the property FormatReinterpreterBayerMosaicParity.
ibfrmMono8_To_RGB888Packed	Reinterpret mv.impact.acquire.TImageBufferPixelFormat.ibpfMono8 as mv.impact.acquire.TImageBufferPixelFormat.ibpfRGB888Packed. This will effectively divide the width by 3 but preserve the original line pitch.
ibfrmMono8_To_BGR888Packed	Reinterpret mv.impact.acquire.TImageBufferPixelFormat.ibpfMono8 as mv.impact.acquire.TImageBufferPixelFormat.ibpfBGR888Packed. This will effectively divide the width by 3 but preserve the original line pitch.
ibfrmMono10_To_Mono10	Attach or remove a mv.impact.acquire.TBayerMosaicParity attribute to a mv.impact.acquire.TImageBufferPixelFormat.ibpfMono8 buffer OR change the existing Bayer attribute to a different value. The new mv.impact.acquire.TBayerMosaicParity value for the buffer can be selected by the property FormatReinterpreterBayerMosaicParity.
ibfrmMono10_To_RGB101010Packed	Reinterpret mv.impact.acquire.TImageBufferPixelFormat.ibpfMono10 as mv.impact.acquire.TImageBufferPixelFormat.ibpfRGB101010Packed. This will effectively divide the width by 3 but preserve the original line pitch.
ibfrmMono12_To_Mono12	Attach or remove a mv.impact.acquire.TBayerMosaicParity attribute to a mv.impact.acquire.TImageBufferPixelFormat.ibpfMono8 buffer OR change the existing Bayer attribute to a different value. The new mv.impact.acquire.TBayerMosaicParity value for the buffer can be selected by the property FormatReinterpreterBayerMosaicParity.
ibfrmMono12_To_RGB121212Packed	Reinterpret mv.impact.acquire.TImageBufferPixelFormat.ibpfMono12 as mv.impact.acquire.TImageBufferPixelFormat.ibpfRGB121212Packed. This will effectively divide the width by 3 but preserve the original line pitch.
ibfrmMono14_To_Mono14	Attach or remove a mv.impact.acquire.TBayerMosaicParity attribute to a mv.impact.acquire.TImageBufferPixelFormat.ibpfMono8 buffer OR change the existing Bayer attribute to a different value. The new mv.impact.acquire.TBayerMosaicParity value for the buffer can be selected by the property FormatReinterpreterBayerMosaicParity.
ibfrmMono14_To_RGB141414Packed	Reinterpret mv.impact.acquire.TImageBufferPixelFormat.ibpfMono14 as mv.impact.acquire.TImageBufferPixelFormat.ibpfRGB141414Packed. This will effectively divide the width by 3 but preserve the original line pitch.
ibfrmMono16_To_Mono16	Attach or remove a mv.impact.acquire.TBayerMosaicParity attribute to a mv.impact.acquire.TImageBufferPixelFormat.ibpfMono8 buffer OR change the existing Bayer attribute to a different value. The new mv.impact.acquire.TBayerMosaicParity value for the buffer can be selected by the property FormatReinterpreterBayerMosaicParity.
ibfrmMono16_To_RGB161616Packed	Reinterpret mv.impact.acquire.TImageBufferPixelFormat.ibpfMono16 as mv.impact.acquire.TImageBufferPixelFormat.ibpfRGB161616Packed. This will effectively divide the width by 3 but preserve the original line pitch.

TImageBufferPixelFormat

enum TImageBufferPixelFormat : int

Valid image buffer pixel formats.

Also refer to Pixel Formats in Impact Acquire and Other Contexts

Enumerator
ibpfRaw	An unprocessed block of data.
ibpfMono8	A single channel 8 bit per pixel format. (PFNC name: Mono8)
ibpfMono16	A single channel 16 bit per pixel format. (PFNC name: Mono16)
ibpfRGBx888Packed	A four channel interleaved RGB format with 32 bit per pixel containing one alpha byte per pixel. (PFNC name: BGRa8) 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. mv.impact.acquire.Request.imageData will therefore point to B(1) when using a byte pointer. The 4th byte could be used for alpha information but isn't used by this framework. Note This format reports 3 channels only for backward compatibility reasons while in fact memory is allocated for 4 channels! Use this format with some extra care! See also Converting packed data to planar formats
ibpfYUV422Packed	A three channel interleaved YUV422 format using 32 bit for a pair of pixels. (PFNC name: YUV422_8) This format uses 2:1 horizontal downsampling, meaning the Y component is sampled at each pixel, while U(Cb) and V(Cr) components are sampled every 2 pixels in horizontal direction. Each component takes 8 bits, therefore a 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. mv.impact.acquire.Request.imageData will therefore point to Y(1) when using a byte pointer. See also Converting packed data to planar formats
ibpfRGBx888Planar	A four channel planar RGB format. (PFNC name: RGBa8_Planar) This is a format best suitable for most image processing functions. The data is stored in 4 separate planes (one 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. mv.impact.acquire.Request.imageData will therefore point to R(1) when using a byte pointer. All red data will follow! Note This format reports 3 channels only for backward compatibility reasons while in fact memory is allocated for 4 channels! Use this format with some extra care!
ibpfMono10	A single channel 10 bit per pixel format. (PFNC name: Mono10) 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. (PFNC name: Mono12) 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. (PFNC name: Mono14) Each pixel in this format consumes 2 bytes of memory. The lower 14 bit of this 2 bytes will contain valid data.
ibpfRGB888Packed	A three channel interleaved RGB format containing 24 bit per pixel. (PFNC name: BGR8) 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. mv.impact.acquire.Request.imageData will therefore point to B(1) when using a byte pointer. See also Converting packed data to planar formats
ibpfYUV444Planar	A three channel YUV444 planar format occupying 24 bit per pixels. (PFNC name: YUV444_8_YVU_Planar) 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. mv.impact.acquire.Request.imageData will therefore point to Y(1) when using a byte pointer.
ibpfMono32	A single channel 32 bit per pixel format. (PFNC name: Mono32)
ibpfYUV422Planar	A three channel YUV422 planar format occupying 32 bit for a pair of pixels. (PFNC name: YUV422_8_YVU_Planar) This format uses 2:1 horizontal downsampling, meaning 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. mv.impact.acquire.Request.imageData will therefore point to Y(1) when using a byte pointer.
ibpfRGB101010Packed	A three channel interleaved RGB image occupying 48 bit with 30 bit of usable data per pixel. (PFNC name: BGR10) 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. 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 color 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. mv.impact.acquire.Request.imageData will therefore point to B(1) when using a 16 bit pointer. See also Converting packed data to planar formats
ibpfRGB121212Packed	A three channel interleaved RGB image occupying 48 bit with 36 bit of usable data per pixel. (PFNC name: BGR12) 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. 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 color 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. mv.impact.acquire.Request.imageData will therefore point to B(1) when using a 16 bit pointer. See also Converting packed data to planar formats
ibpfRGB141414Packed	A three channel interleaved RGB image occupying 48 bit with 42 bit of usable data per pixel. (PFNC name: BGR14) 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. 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 color 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. mv.impact.acquire.Request.imageData will therefore point to B(1) when using a 16 bit pointer. See also Converting packed data to planar formats
ibpfRGB161616Packed	A three channel interleaved RGB image occupying 48 bit per pixel. (PFNC name: BGR16) 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. 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 color component will be LSB aligned. So the first 2 bytes in memory are the first pixels blue component. mv.impact.acquire.Request.imageData will therefore point to B(1) when using a 16 bit pointer. See also Converting packed data to planar formats
ibpfYUV422_UYVYPacked	A three channel interleaved YUV422 format occupying 32 bit for a pair of pixels. (PFNC name: YUV422_8_UYVY) This format uses 2:1 horizontal downsampling, meaning 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. mv.impact.acquire.Request.imageData will therefore point to Cb(1,2) when using a byte pointer. See also Converting packed data to planar formats
ibpfMono12Packed_V2	A single channel 12 bit per pixel packed format occupying 12 bit per pixel. (PFNC name: Mono12Packed) 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 a 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 (pseudo code assuming 'pointerToStartOfTheBuffer' is a 'byte pointer'): GetMono12Packed_V1Pixel( pointerToStartOfTheBuffer, pixelIndex ) const int offsetFromStartOfTheBuffer = (3*pixel)/2 if pixel divisible by 2 return (pointerToStartOfTheBuffer[offset+1] << shift) | (pointerToStartOfTheBuffer[offset] >> 4) return pointerToStartOfTheBuffer[offset] << shift) | (pointerToStartOfTheBuffer[offset+1] & 0xF)
ibpfYUV422_10Packed	A three channel interleaved YUV422 format occupying 64 bit for a pair of pixels. (PFNC name: YUV422_10) This format uses 2:1 horizontal downsampling, meaning 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. mv.impact.acquire.Request.imageData will therefore point to Y(1) when using a 16 bit pointer. See also Converting packed data to planar formats
ibpfYUV422_UYVY_10Packed	A three channel interleaved YUV422 format occupying 64 bit for a pair of pixels. (PFNC name: YUV422_10_UYV) This format uses 2:1 horizontal downsampling, meaning 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. mv.impact.acquire.Request.imageData will therefore point to Cb(1,2) when using a 16 bit pointer. See also Converting packed data to planar formats
ibpfBGR888Packed	A three channel interleaved RGB format with 24 bit per pixel. (PFNC name: RGB8) 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. mv.impact.acquire.Request.imageData will therefore point to R(1) when using a byte pointer. See also Converting packed data to planar formats
ibpfBGR101010Packed_V2	A three channel 10 bit per color component RGB packed format occupying 32 bit per pixel. (PFNC name: RGB10p32) This format will use 4 bytes to store one 10 bit per color 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 | The last 2 bit of each 32 bit bit may contain undefined data. See also Converting packed data to planar formats
ibpfYUV444_UYVPacked	A three channel interleaved YUV format occupying 24 bit per pixel. (PFNC name: YUV8_UYV) 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. mv.impact.acquire.Request.imageData will therefore point to Cb(1) when using a byte pointer. See also Converting packed data to planar formats
ibpfYUV444_UYV_10Packed	A three channel interleaved YUV format occupying 48 bit per pixel with 30 bit of usable data per pixel. (PFNC name: YUV422_10_UYV) 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. 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. mv.impact.acquire.Request.imageData will therefore point to Cb(1) when using a 16 bit pointer. See also Converting packed data to planar formats
ibpfYUV444Packed	A three channel interleaved YUV format occupying 24 bit per pixel. (PFNC name: YUV8) 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. mv.impact.acquire.Request.imageData will therefore point to Y(1) when using a byte pointer. See also Converting packed data to planar formats
ibpfYUV444_10Packed	A three channel interleaved YUV format occupying 48 bit per pixel with 30 bit of usable data per pixel. (PFNC name: YUV10) 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. mv.impact.acquire.Request.imageData will therefore point to Y(1) when using a 16 bit pointer. See also Converting packed data to planar formats
ibpfMono12Packed_V1	A single channel 12 bit per pixel packed format occupying 12 bit per pixel. (PFNC name: Mono12p) 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 0..7(1) bits 8..11(1) bits 0..3(2) bits 4..11(2) bits 0..7(3) bits 8..11(3) bits 0..3(4) bits 4..11(4) etc. Note When the width is not divisible by 2 the line pitch of a 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 (pseudo code assuming 'pointerToStartOfTheBuffer' is a 'byte pointer'): GetMono12Packed_V1Pixel( pointerToStartOfTheBuffer, pixelIndex ) const int offsetFromStartOfTheBuffer = pixel + pixel/2 if pixel divisible by 2 return (pointerToStartOfTheBuffer[offset] >> 4) | (pointerToStartOfTheBuffer[offset+1] << 4) return pointerToStartOfTheBuffer[offset]) | (pointerToStartOfTheBuffer[offset+1] & 0xF) << 8) Since 2.5.0
ibpfYUV411_UYYVYY_Packed	A three channel interleaved YUV format occupying 48 bit for four pixels. (PFNC name: YUV411_8_UYYVYY) This format uses 4:1 horizontal downsampling, meaning the Y component is sampled at each pixel, while U(Cb) and V(Cr) components are sampled every 4 pixels in horizontal direction. If each component takes 8 bits, four pixels require 48 bits. Four consecutive pixels (48 bit, 0xaabbccddeeff ) contain 8 bit chrominance blue of pixels 1, 2, 3 and 4(aa), 8 bit luminance of pixel 1(bb),8 bit luminance of pixel 2(cc), 8 bit chrominance red of pixels 1, 2, 3 and 4(dd), 8 bit luminance of pixel 3(ee) and finally 8 bit luminance of pixel 4(ff). Thus in memory the data will be stored like this: 6 bytes 6 bytes etc. Cb(1,2,3,4) Y(1) Y(2) Cr(1,2,3,4) Y(3) Y(4) Cb(5,6,7,8) Y(5) Y(6) Cr(5,6,7,8) Y(7) Y(8) etc. .................. Cb(n,n+1,n+2,n+3) Y(n) Y(n+1) Cr(n,n+1,n+2,n+3) Y(n+2) Y(n+3) So the first byte in memory is the chrominance blue component. mv.impact.acquire.Request.imageData will therefore point to Cb when using a byte pointer. See also Converting packed data to planar formats Since 2.13.0
ibpfRGB888Planar	A three channel planar RGB format. (PFNC name: RGB8_Planar) This is a format best suitable for most image processing functions. The image will be converted into 3 planes(a plane for each color component). 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) So the first byte in memory is the first pixels red component. mv.impact.acquire.Request.imageData will therefore point to R(1) when using a byte pointer. Since 2.17.0
ibpfAuto	The framework will decide which format will be used.

TImageDestinationPixelFormat

enum TImageDestinationPixelFormat : int

Defines the pixel format of the result image.

Also refer to Pixel Formats in Impact Acquire and Other Contexts

Enumerator
idpfAuto	The driver will decide which destination format will be used.
idpfRaw	An unprocessed block of data.
idpfMono8	A single channel 8 bit per pixel format. (PFNC name: Mono8)
idpfRGBx888Packed	A four channel interleaved RGB format with 32 bit per pixel containing one alpha byte per pixel. (PFNC name: BGRa8) 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. mv.impact.acquire.Request.imageData will therefore point to B(1) when using a byte pointer. The 4th byte could be used for alpha information but isn't used by this framework. Note This format reports 3 channels only for backward compatibility reasons while in fact memory is allocated for 4 channels! Use this format with some extra care! See also Converting packed data to planar formats
idpfYUV422Packed	A three channel interleaved YUV422 format using 32 bit for a pair of pixels. (PFNC name: YUV422_8) This format uses 2:1 horizontal downsampling, meaning the Y component is sampled at each pixel, while U(Cb) and V(Cr) components are sampled every 2 pixels in horizontal direction. Each component takes 8 bits, therefore a 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. mv.impact.acquire.Request.imageData will therefore point to Y(1) when using a byte pointer. See also Converting packed data to planar formats
idpfRGBx888Planar	A four channel planar RGB format. (PFNC name: RGBa8_Planar) This is a format best suitable for most image processing functions. The data is stored in 4 separate planes (one 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. mv.impact.acquire.Request.imageData will therefore point to R(1) when using a byte pointer. All red data will follow! Note This format reports 3 channels only for backward compatibility reasons while in fact memory is allocated for 4 channels! Use this format with some extra care!
idpfMono10	A single channel 10 bit per pixel format. (PFNC name: Mono10) Each pixel in this format consumes 2 bytes of memory. The lower 10 bit of this 2 bytes will contain valid data.
idpfMono12	A single channel 12 bit per pixel format. (PFNC name: Mono12) Each pixel in this format consumes 2 bytes of memory. The lower 12 bit of this 2 bytes will contain valid data.
idpfMono14	A single channel 14 bit per pixel format. (PFNC name: Mono14) Each pixel in this format consumes 2 bytes of memory. The lower 14 bit of this 2 bytes will contain valid data.
idpfMono16	A single channel 16 bit per pixel format. (PFNC name: Mono16)
idpfRGB888Packed	A three channel interleaved RGB format containing 24 bit per pixel. (PFNC name: BGR8) 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. mv.impact.acquire.Request.imageData will therefore point to B(1) when using a byte pointer. See also Converting packed data to planar formats
idpfYUV422Planar	A three channel planar YUV422 format. (PFNC name: YUV422_8_YVU_Planar) This format uses 2:1 horizontal downsampling, meaning 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. mv.impact.acquire.Request.imageData will therefore point to Y(1) when using a byte pointer.
idpfRGB101010Packed	A three channel interleaved RGB image occupying 48 bit with 30 bit of usable data per pixel. (PFNC name: BGR10) 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. 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 color 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. mv.impact.acquire.Request.imageData will therefore point to B(1) when using a 16 bit pointer. See also Converting packed data to planar formats
idpfRGB121212Packed	A three channel interleaved RGB image occupying 48 bit with 36 bit of usable data per pixel. (PFNC name: BGR12) 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. 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 color 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. mv.impact.acquire.Request.imageData will therefore point to B(1) when using a 16 bit pointer. See also Converting packed data to planar formats
idpfRGB141414Packed	A three channel interleaved RGB image occupying 48 bit with 42 bit of usable data per pixel. (PFNC name: BGR14) 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. 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 color 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. mv.impact.acquire.Request.imageData will therefore point to B(1) when using a 16 bit pointer. See also Converting packed data to planar formats
idpfRGB161616Packed	A three channel interleaved RGB image occupying 48 bit per pixel. (PFNC name: BGR16) 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. 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 color component will be LSB aligned. So the first 2 bytes in memory are the first pixels blue component. mv.impact.acquire.Request.imageData will therefore point to B(1) when using a 16 bit pointer. See also Converting packed data to planar formats
idpfYUV422_UYVYPacked	A three channel interleaved YUV422 format occupying 32 bit for a pair of pixels. (PFNC name: YUV422_8_UYV) This format uses 2:1 horizontal downsampling, meaning 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. mv.impact.acquire.Request.imageData will therefore point to Cb(1,2) when using a byte pointer. See also Converting packed data to planar formats
idpfMono12Packed_V2	A single channel 12 bit per pixel packed format occupying 12 bit per pixel. (PFNC name: Mono12Packed) 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 a 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 (pseudo code assuming 'pointerToStartOfTheBuffer' is a 'byte pointer'): GetMono12Packed_V1Pixel( pointerToStartOfTheBuffer, pixelIndex ) const int offsetFromStartOfTheBuffer = (3*pixel)/2 if pixel divisible by 2 return (pointerToStartOfTheBuffer[offset+1] << shift) | (pointerToStartOfTheBuffer[offset] >> 4) return pointerToStartOfTheBuffer[offset] << shift) | (pointerToStartOfTheBuffer[offset+1] & 0xF)
idpfYUV422_10Packed	A three channel interleaved YUV422 format occupying 64 bit for a pair of pixels. (PFNC name: YUV422_10) This format uses 2:1 horizontal downsampling, meaning 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. mv.impact.acquire.Request.imageData will therefore point to Y(1) when using a 16 bit pointer. See also Converting packed data to planar formats
idpfYUV422_UYVY_10Packed	A three channel interleaved YUV422 format occupying 64 bit for a pair of pixels. (PFNC name: YUV422_10_UYV) This format uses 2:1 horizontal downsampling, meaning 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. mv.impact.acquire.Request.imageData will therefore point to Cb(1,2) when using a 16 bit pointer. See also Converting packed data to planar formats
idpfBGR888Packed	A three channel interleaved RGB format with 24 bit per pixel. (PFNC name: RGB8) 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. mv.impact.acquire.Request.imageData will therefore point to R(1) when using a byte pointer. See also Converting packed data to planar formats
idpfBGR101010Packed_V2	A three channel 10 bit per color component RGB packed format occupying 32 bit per pixel. (PFNC name: RGB10p32) This format will use 4 bytes to store one 10 bit per color 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 | The last 2 bit of each 32 bit bit may contain undefined data. See also Converting packed data to planar formats
idpfYUV444_UYVPacked	A three channel interleaved YUV format occupying 24 bit per pixel. (PFNC name: YUV8_UYV) 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. mv.impact.acquire.Request.imageData will therefore point to Cb(1) when using a byte pointer. See also Converting packed data to planar formats
idpfYUV444_UYV_10Packed	A three channel interleaved YUV format occupying 48 bit per pixel with 30 bit of usable data per pixel. (PFNC name: YUV422_8_UYV) 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. 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. mv.impact.acquire.Request.imageData will therefore point to Cb(1) when using a 16 bit pointer. See also Converting packed data to planar formats
idpfYUV444Packed	A three channel interleaved YUV format occupying 24 bit per pixel. (PFNC name: YUV8) 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. mv.impact.acquire.Request.imageData will therefore point to Y(1) when using a byte pointer. See also Converting packed data to planar formats
idpfYUV444_10Packed	A three channel interleaved YUV format occupying 48 bit per pixel with 30 bit of usable data per pixel. (PFNC name: YUV10) 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. mv.impact.acquire.Request.imageData will therefore point to Y(1) when using a 16 bit pointer. See also Converting packed data to planar formats
idpfMono12Packed_V1	A single channel 12 bit per pixel packed format occupying 12 bit per pixel. (PFNC name: Mono12p) 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 0..7(1) bits 8..11(1) bits 0..3(2) bits 4..11(2) bits 0..7(3) bits 8..11(3) bits 0..3(4) bits 4..11(4) etc. Note When the width is not divisible by 2 the line pitch of a 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 (pseudo code assuming 'pointerToStartOfTheBuffer' is a 'byte pointer'): GetMono12Packed_V1Pixel( pointerToStartOfTheBuffer, pixelIndex ) const int offsetFromStartOfTheBuffer = pixel + pixel/2 if pixel divisible by 2 return (pointerToStartOfTheBuffer[offset] >> 4) | (pointerToStartOfTheBuffer[offset+1] << 4) return pointerToStartOfTheBuffer[offset]) | (pointerToStartOfTheBuffer[offset+1] & 0xF) << 8) Since 2.5.0
idpfYUV411_UYYVYY_Packed	A three channel interleaved YUV format occupying 48 bit for four pixels. (PFNC name: YUV411_8_UYYVYY) This format uses 4:1 horizontal downsampling, meaning the Y component is sampled at each pixel, while U(Cb) and V(Cr) components are sampled every 4 pixels in horizontal direction. If each component takes 8 bits, four pixels require 48 bits. Four consecutive pixels (48 bit, 0xaabbccddeeff ) contain 8 bit chrominance blue of pixels 1, 2, 3 and 4(aa), 8 bit luminance of pixel 1(bb),8 bit luminance of pixel 2(cc), 8 bit chrominance red of pixels 1, 2, 3 and 4(dd), 8 bit luminance of pixel 3(ee) and finally 8 bit luminance of pixel 4(ff). Thus in memory the data will be stored like this: 6 bytes 6 bytes etc. Cb(1,2,3,4) Y(1) Y(2) Cr(1,2,3,4) Y(3) Y(4) Cb(5,6,7,8) Y(5) Y(6) Cr(5,6,7,8) Y(7) Y(8) etc. .................. Cb(n,n+1,n+2,n+3) Y(n) Y(n+1) Cr(n,n+1,n+2,n+3) Y(n+2) Y(n+3) So the first byte in memory is the chrominance blue component. mv.impact.acquire.Request.imageData will therefore point to Cb when using a byte pointer. See also Converting packed data to planar formats Since 2.13.0
idpfRGB888Planar	A three channel planar RGB format. (PFNC name: RGB8_Planar) This is a format best suitable for most image processing functions. The image will be converted into 3 planes(a plane for each color component). 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) So the first byte in memory is the first pixels red component. mv.impact.acquire.Request.imageData will therefore point to R(1) when using a byte pointer. Since 2.17.0

TImageFileFormat

enum TImageFileFormat : int

Defines valid image file formats.

Since

2.23.0

Enumerator
iffAuto	Automatically tries to select the file format e.g. from the file extension.
iffBMP	The BMP format.
iffJPEG	The JPEG format.
iffPNG	The PNG format.
iffTIFF	The TIFF format.

TImageProcessingFilter

enum TImageProcessingFilter : int

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.

TImageProcessingMode

enum TImageProcessingMode : int

Defines valid modes the internal image processing pipeline can be operated in.

Since

2.14.0

Enumerator
ipmDefault	The default mode where every image is processed in the order they have been acquired.
ipmProcessLatestOnly	This mode can be useful for applications where processing on the host takes longer than the average time between two consecutive frames transmitted by the device. This might be useful for applications that display the processed result but that also want to capture data at the highest possible frame rate and is not important that EVERY image gets processed. Note This mode might result in images being returned without the expected processing on the host. See also mv.impact.acquire.Device.userControlledImageProcessingEnable, mv.impact.acquire.Request.hasProcessingBeenSkipped, mv.impact.acquire.Request.getImageProcessingResultsIterator

TImageProcessingOptimization

enum TImageProcessingOptimization : int

Defines valid modes the internal image processing algorithms can be operated in.

See also

General.

Since

2.12.2

Enumerator
ipoMaximizeSpeed	Will maximize the execution speed. This might result in a higher memory consumption.
ipoMinimizeMemoryUsage	Will minimize the memory footprint. This might result in a higher CPU load. Note This mode will also result in a higher amount of memory allocation and freeing operations thus if the application itself is working with heap memory a lot the long term effects of heap fragmentation should be considered!

TImageProcessingResult

enum TImageProcessingResult : int

Defines valid values for the result of a certain image processing algorithm applied to a request.

Since

2.14.0

Enumerator
iprNotActive	This algorithm was either switched off or not needed when applied to this request object. When an algorithm is switched on and this result is returned this can indicate e.g. that for a format conversion the input and output format where identical.
iprApplied	This algorithm has been applied to this request object.
iprFailure	A problem was encountered when this algorithm has been applied to this request object. One reason for this result might be that an unsupported pixel format was fed into this algorithm. The log-file will provide additional information then.
iprSkipped	This algorithm has NOT been applied because of a lack of processing time. In most cases the acquisition frame rate(thus the frame rate generated on the device) was higher than the processing frame rate the host can handle and the user has explicitly configured the image processing mode to skip images then.
iprNotApplicable	This algorithm has NOT been applied because it was not applicable. This result will be reported whenever a buffer was fed into a filter that was not applicable. An example for such a situation would be a JPEG image that has been fed into a de-Bayer algorithm. Since 2.22.1

TImageRequestControlMode

enum TImageRequestControlMode : int

Defines the behaviour of an mv.impact.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 sent 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 acquisition 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.

TImpactBufferFlag

enum TImpactBufferFlag : uint

Flags to define the way an mvIMPACT buffer is 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 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 existing 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 mv.impact.acquire.TImpactBufferFlag it might 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.

TInterfaceEnumerationBehaviour

enum TInterfaceEnumerationBehaviour : int

Defines the enumeration behaviour of a certain interface of a third party GenTL producer.

Since

2.34.0

Enumerator
iebNotConfigured	The interface will enumerate devices or not according to the general enumeration behavior of this interface type(according to EnumerateEnable setting).
iebForceIgnore	The interface will not enumerate devices, regardless of the general enumeration behavior of this interface type(overrides EnumerateEnable setting).
iebForceEnumerate	The interface will forcefully enumerate devices, regardless of the general enumeration behavior of this interface type(overrides EnumerateEnable setting).

TLibraryQuery

enum TLibraryQuery : int

Defines valid libraries to query information from.

Enumerator
lqDeviceManager	Specifies the mvDeviceManager library.
lqPropHandling	Specifies the mvPropHandling library.

TLUTGammaMode

enum TLUTGammaMode : int

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.

TLUTImplementation

enum TLUTImplementation : int

Defines valid LUT(LookUp Table) implementations.

Enumerator
LUTiHardware	The mapping of the image data will be done in hardware. When set to 'Hardware' the LUT operation will NOT introduce additional CPU load. This feature will no be available for every device.
LUTiSoftware	The mapping of the image data will be done with an optimized software algorithm.

TLUTInterpolationMode

enum TLUTInterpolationMode : int

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.

TLUTMapping

enum TLUTMapping : uint

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.
LUTm14To14	14 bit input data will be mapped to 14 bit output data. Since 2.0.2
LUTm16To16	16 bit input data will be mapped to 16 bit output data. Since 2.0.2

TLUTMode

enum TLUTMode : int

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. Since the human eye perceives light similar to a logarithm of real light intensity it's characteristic curve is non-linear. It follows the rule of (intensity ^ gamma) with a gamma value between 0.3-0.5. To provide as much useful information as possible, the image is converted from 12-bit acquired by the sensor to 8-bit utilizing this characteristic curve. The result is a linearized image optimized for the human eye's non-linear behavior which allows to perceive as much intensity differences as possible. Conversion from 12- to 8-bit utilizing the gamma function
LUTmDirect	Maps an image by applying intensity transformation.

TMemoryManagerMode

enum TMemoryManagerMode : int

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.

TMemoryManagerPoolMode

enum TMemoryManagerPoolMode : int

Defines the pool mode of memory manager.

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

TMirrorMode

enum TMirrorMode : uint

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.

TMirrorOperationMode

enum TMirrorOperationMode : int

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.

TPayloadType

enum TPayloadType : int

Defines supported payload types.

Since

3.2.0

Enumerator
ptUnknown	The framework is not aware of the data type of this request. From the application perspective this can be handled as raw data. However the most likely reason for unknown data is that the request either does not contain any data right now or the last capture operation did fail for any reason. Since 3.2.0
pt2DImage	Color or monochrome (2D) image. This request carries pixel data belonging to a single image and maybe some additional chunk data as well. Since 3.2.0
ptJPEG	JPEG image data. This request carries JPEG data belonging to a single image. Since 3.2.0
ptJPEG2000	JPEG 2000 image data. This request carries JPEG 2000 data belonging to a single image. Since 3.2.0
ptH264	H.264 image data. This request carries H.264 data belonging to a single image. Since 3.2.0
ptChunkOnly	Chunk data only. This request carries chunk data as defined by the corresponding vision standards and no additional payload. See also Chunk Data Format Since 3.2.0
ptMultiPart	Multi-Part data. This request carries multi-part data as defined by the corresponding vision standards and maybe some additional chunk data as well. In order to access the individual parts forming the full request the buffer part related API can be used. See also Multi-Part Format Since 3.2.0
ptGenDC	GenDC data. This request carries GenDC data as defined by the corresponding vision standards. In order to access the individual parts forming the full request either the buffer part related API can be used or the full GenDC container can be interpreted by using official header files or knowledge obtained by reading the GenICam™ GenDC standard. See also GenICam™ GenDC Format Since 3.2.0

TPolarizedDataExtractionInterpolationMode

enum TPolarizedDataExtractionInterpolationMode : int

Defines valid modes for the interpolation mode of polarization data extraction filters.

Since

2.29.0

Enumerator
primOff	No interpolation. The resulting image therefore will have the same amount of pixels for horizontal or vertical polarization data extraction modes or a reduced number of pixels for all other modes. Since 2.29.0
primLinear	Linear interpolation. The resulting image therefore will have either 4 times the number of pixels for horizontal or vertical polarization data extraction modes or the same dimensions as the input image for single extraction mode. The additional pixel data will be generated using linear interpolation algorithm Since 2.29.0

TPolarizedDataExtractionMode

enum TPolarizedDataExtractionMode : int

Defines valid modes for polarization data extraction filters.

Since

2.29.0

Enumerator
prmVertical	The pixels will be re-arranged one after the other thus the resulting image will have a width of 'input image width / 2' and a height of 'input image height * 2'. The resulting image will consist of several small images sitting on top of each other. The first image will contain all the upper left pixels from each extraction ROI, the last image all the lower right pixels. The images in between will be extracted line by line and then row by row. Since 2.29.0
prmHorizontal	The pixels will be re-arranged one after the other thus the resulting image will have a width of 'input image width * 2' and a height of 'input image height / 2'. The resulting image will consist of several small images sitting next each other. The first image will contain all the upper left pixels from each extraction ROI, the last image all the lower right pixels. The images in between will be extracted line by line and then row by row. Since 2.29.0
prmExtractSingle	The pixel selected by 'PolarizedDataExtractionChannelIndex' will be extracted and forwarded from each region defined by '2 * 2'. The resulting image therefore will have a width equal to 'input image width / 2' and a height equal to 'input image height / 2' Since 2.29.0
prmMinimumValue	The pixel with the minimum value will be extracted and forwarded from each region defined by '2 * 2'. The resulting image therefore will have a width equal to 'input image width / 2' and a height equal to 'input image height / 2' Since 2.29.0
prmMeanValue	The mean value of all pixels whose value ranges from 'PolarizedDataExtractionLowerLimit' to 'PolarizedDataExtractionUpperLimit' will be calculated within each region defined by '2 * 2' in the source image and will be forwarded as a single new pixel in the destination image. The resulting image therefore will have a width equal to 'input image width / 2' and a height equal to 'input image height / 2' Since 2.29.0
prm2By2	The pixels will be re-arranged in a way the image keeps its original dimension but each polarization angle will afterwards occupy a certain section in the image. The upper left quarter of the resulting image will contain all the upper left pixels from each 2 by 2 pixel region etc. Since 2.29.1
prmExtractAngle	The angle of the maximum polarization for every '2 * 2' region in the image will be calculated and the resulting value will then be mapped to the value range of the source pixel format. The resulting image therefore will have a width equal to 'input image width / 2' and a height equal to 'input image height / 2'. From each 2 by 2 region (thus 4 input values) a single output value will be calculated and placed into the resulting image. In this mode the output pixel format will be the same as the input pixel format and the resulting value will be mapped to this pixel formats value range thus the maximum angle (180 degree) will correspond the maximum pixel value in this format (e.g. 1023 for mv.impact.acquire.ibpfMono10). The angle of the maximum polarization is calculated based the formula: Note Pixels which are saturated or which don't show a signal at all will cause incorrect polarization data. This happens as a result of wrong relations between the different polarization directions which causes wrong values for the different stokes parameters resulting in incorrect pixel data. Different exposure settings might improve the result. Since 2.38.0
prmExtractDegree	The degree of the polarization for every '2 * 2' region in the image will be calculated and the resulting value will then be mapped to the value range of the source pixel format. The resulting image therefore will have a width equal to 'input image width / 2' and a height equal to 'input image height / 2'. From each 2 by 2 region (thus 4 input values) a single output value will be calculated and placed into the resulting image. In this mode the output pixel format will be the same as the input pixel format and the resulting value will be mapped to this pixel formats value range thus the maximum polarization will correspond the maximum pixel value in this format (e.g. 1023 for mv.impact.acquire.ibpfMono10). The calculation of the degree of the maximum polarization is based the formula: Note Pixels which are saturated or which don't show a signal at all will cause incorrect polarization data. This happens as a result of wrong relations between the different polarization directions which causes wrong values for the different stokes parameters resulting in incorrect pixel data. Different exposure settings might improve the result. Since 2.38.0
prmPseudoColorRepresentation	The angle of the maximum polarization and the degree of the polarization for every '2 * 2' region in the image will be calculated and the resulting value will then be mapped to the value range of and 8-bit HSL image. The angle and the degree are calculated as described in mv.impact.acquire.TPolarizedDataExtractionMode.prmExtractDegree and mv.impact.acquire.TPolarizedDataExtractionMode.prmExtractAngle mode. Afterwards the angle is used as hue and the degree is used as saturation value in the HSL color representation and converted to RGB color representation. The resulting image therefore will have a width equal to 'input image width / 2' and a height equal to 'input image height / 2'. From each 2 by 2 region (thus 4 input values) 2 output values will be calculated and placed into the resulting temporary HSL image. Afterwards this HSL image will transformed back to RGB to generate a pseudo-color image in mv.impact.acquire.ibpfRGB888Planar format. Note Pixels which are saturated or which don't show a signal at all will cause incorrect polarization data. This happens as a result of wrong relations between the different polarization directions which causes wrong values for the different stokes parameters resulting in incorrect pixel data. Different exposure settings might improve the result. Since 2.38.0

TPropertyLimits

enum TPropertyLimits

Defines valid limits which can be queried for a mv.impact.acquire.Property object.

This group contains classes and functions that are available for all interface layouts.

Enumerator
plMaxValue	Set/Get the maximum value for this mv.impact.acquire.Property. Pass this as the index to set or get the maximum number of values this property can store with a call to the mv.impact.acquire.Property object's corresponding read or write method.
plMinValue	Set/Get the minimum value for this mv.impact.acquire.Property. Pass this as the index to set or get the maximum number of values this property can store with a call to the mv.impact.acquire.Property object's corresponding read or write method.
plStepWidth	Set/Get the step width value for this mv.impact.acquire.Property. Pass this as the index to set or get the maximum number of values this property can store with a call to the mv.impact.acquire.Property object's corresponding read or write method.

TRequestImageMemoryMode

enum TRequestImageMemoryMode : int

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.

TRequestResult

enum TRequestResult : uint

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. mvBlueFOX specific: This error typically results in some kind of USB transmission problem. The log-file will contain more information in that case.
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 than 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 of interest 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 than 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. Another possibility might be, that the process currently hosting the application cannot map all the capture memory requested by the application. In this case adding more memory to the system might solve the problem. Please note that when running on a 32 bit system no more than 2 GB of RAM can be used by a single process, thus applications demanding a lot of memory might still not run then. In this case only reducing the number of request buffers will help.
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.
rrDataAcquisitionNotSupported	The device does not support capturing data in the current configuration. This error code will occur if a request has been sent to a device that does not support the acquisition of data. This can e.g. be the case for GEV or U3V devices that do NOT support at least 1 streaming channel for U3V devices that have been opened with mv.impact.acquire.TDeviceAccessMode.damRead access Since 2.5.0

TRequestState

enum TRequestState : int

Defines the current state of this mv.impact.acquire.Request.

Enumerator
rsIdle	This mv.impact.acquire.Request is currently unused.
rsWaiting	This mv.impact.acquire.Request has been sent into the framework's image request queue and currently awaits processing.
rsCapturing	This mv.impact.acquire.Request is currently being processed.
rsReady	This mv.impact.acquire.Request has been processed. The user is now responsible for this request. Before this mv.impact.acquire.Request is not unlocked again it can't be used by the framework. A mv.impact.acquire.Request in this state can safely be processed by the user. Its data will remain valid until either the mv.impact.acquire.Request is unlocked by the user or the device is closed.
rsBeingConfigured	This mv.impact.acquire.Request is currently in configuration mode. In 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. The user is now responsible for this request. Before this mv.impact.acquire.Request is not unlocked again it can't be used by the framework.

TScalerInterpolationMode

enum TScalerInterpolationMode : int

Defines valid scaler interpolation modes.

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

TScalerMode

enum TScalerMode : int

Defines valid scaler modes.

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

TUserDataAccessRight

enum TUserDataAccessRight : uint

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 mv.impact.acquire.TUserDataAccessRight.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 mv.impact.acquire.TUserDataAccessRight.udarRead and mv.impact.acquire.TUserDataAccessRight.udarWrite.
udarPassword	A password is needed to modify this entry. Even if mv.impact.acquire.TUserDataAccessRight.udarWrite is specified the user can only modify this entry if the correct password has been set.
udarFull	Combines all other flags.

TUserDataReconnectBehaviour

enum TUserDataReconnectBehaviour : int

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.

TVideoCodec

enum TVideoCodec : int

Defines valid video codecs that might be supported by the underlying video compression engine.

Enumerator
vcMPEG2	MPEG2. Recommend file extension for this codec: .m2v Supported input pixel formats for this video codec: mv.impact.acquire.ibpfYUV422Packed mv.impact.acquire.ibpfYUV422Planar
vcH264	H264. Recommend file extension for this codec: .mp4 Supported input pixel formats for this video codec: mv.impact.acquire.ibpfYUV422Packed mv.impact.acquire.ibpfYUV422Planar
vcH265	H265. Recommend file extension for this codec: .mp4 Supported input pixel formats for this video codec: mv.impact.acquire.ibpfYUV422Packed mv.impact.acquire.ibpfYUV422Planar

TVideoStandard

enum TVideoStandard : int

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.

TWhiteBalanceCalibrationMode

enum TWhiteBalanceCalibrationMode : int

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.

TWhiteBalanceParameter

enum TWhiteBalanceParameter : int

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.

Function Documentation

ComponentChangedEventHandler()

delegate void ComponentChangedEventHandler	(	Object	sender,
		ComponentChangedEventArgs	args )

A function prototype for component changed events as generated by instances of mv.impact.acquire.ComponentCallback.

Parameters

[in]	sender	A reference to the sender of this event.
[in]	args	Additional data provided by the event.

DeviceWillBeClosedEventHandler()

delegate void DeviceWillBeClosedEventHandler	(	Object	sender,
		DeviceWillBeClosedEventArgs	args )

A function prototype for handling events triggered when a device is about to get closed.

Parameters

[in]	sender	A reference to the sender of this event.
[in]	args	Additional data provided by the event.

RequestReadyEventHandler()

delegate void RequestReadyEventHandler	(	Object	sender,
		RequestReadyEventArgs	args )

A function prototype for request ready events as generated by instances of mv.impact.acquire.helper.RequestProvider.

Since

2.4.0

Parameters

[in]	sender	A reference to the sender of this event.
[in]	args	Additional data provided by the event.