eBUS Python Enums List¶
- class eBUS.PvAccessType(value)¶
GigE Vision device access type.
The PvAccessType indicates whether (and to what degree) a second PC can connect to a GigE Vision device after the first one connects. The GigE Vision device stores the value in the GenICam GevCCP feature.
The value can be set at connection time using
PvDevice.Connect(recommended) or altered using the GenICam GevCCP feature, programmatically or through a GenICam browser dialog.Enum
PvAccessUnknown
Value not known; You can’t set the value with
PvDevice.Connect.PvAccessOpen
Open access; the GigE Vision device isn’t connected to any other PC. You can’t set this value with
PvDevice.Connect.PvAccessControl
Shared access; a main controller has read-write access to the device and any other PvDevice can have read-only access to the device.See alsoPvAccessExclusive
Exclusive access. The controller has full read-write access and any other requests but discovery or resent packets are denied.
PvAccessReadOnly
Can be used with
PvDevice.Connectwhen requesting read-only access to a device currently on PvAccessOpen or PvAccessControl.- PvAccessUnknown = 0¶
- PvAccessOpen = 1¶
- PvAccessControl = 2¶
- PvAccessExclusive = 3¶
- PvAccessReadOnly = 4¶
- class eBUS.PvActionAckStatusEnum(value)¶
Action command status enum.
Enum
PvActionAckStatusOK
The action command was received and executed with success.
PvActionAckStatusLate
The schedule action command was received after it was supposed to be executed.
PvActionAckStatusOverflow
The action command was dropped as too many action commands were already queued on the device.
PvActionAckStatusNoRefTime
The scheduled action command could not be synchronized as a reference time was not available.
- PvActionAckStatusOK = 0¶
- PvActionAckStatusLate = 1¶
- PvActionAckStatusOverflow = 2¶
- PvActionAckStatusNoRefTime = 3¶
- class eBUS.PvBayerFilterType(value)¶
Filter settings for
PvBufferConverter.SetBayerFilter.Enum
PvBayerFilterSimple
2x2 nearest neighbor used when converting from Bayer
PvBayerFilter3X3
3x3 kernel considered when converting from Bayer.
- PvBayerFilterSimple = 1¶
- PvBayerFilter3X3 = 2¶
- class eBUS.PvDataReceiverType(value)¶
The eBUS SDK Data Receiver Type.
Enum
PvDataReceiverTypeUnknown
PvDataReceiverTypeEBusDriver
PvDataReceiverTypeUserMode
PvDataReceiverTypeTCP
- PvDataReceiverTypeUnknown = -1¶
- PvDataReceiverTypeEBusDriver = 0¶
- PvDataReceiverTypeUserMode = 1¶
- PvDataReceiverTypeTCP = 2¶
- class eBUS.PvDeviceClass(value)¶
GigE Vision device class.
Enum
PvDeviceClassUnknown
Device class unknown; indeterminate.
PvDeviceClassTransmitter
This device is a transmitter. This implies all its streaming channels transmit data.
PvDeviceClassReceiver
This device is a receiver. This implies all its streaming channels receive data.
PvDeviceClassTransceiver
This device is a transceiver. This implies that one or more streaming channels transmit data and one or more streaming channels receive data.
PvDeviceClassPeripheral
This device is a peripheral. This implies that this device does not have any streaming channels.
- PvDeviceClassUnknown = 0¶
- PvDeviceClassTransmitter = 1¶
- PvDeviceClassReceiver = 2¶
- PvDeviceClassTransceiver = 3¶
- PvDeviceClassPeripheral = 4¶
- class eBUS.PvDeviceInfoType(value)¶
The type of device the object represents.
Enum
PvDeviceInfoTypeUnknown
An unknown device type.
PvDeviceInfoTypeGEV
A GigE Vision compliant device.
PvDeviceInfoTypePleoraProtocol
A device compliant with Pleora Protocol (before GigE Vision)
PvDeviceInfoTypeUSB
A USB device
PvDeviceInfoTypeU3V
A USB3 Vision device
- PvDeviceInfoTypeUnknown = -1¶
- PvDeviceInfoTypeGEV = 0¶
- PvDeviceInfoTypePleoraProtocol = 1¶
- PvDeviceInfoTypeUSB = 2¶
- PvDeviceInfoTypeU3V = 3¶
- class eBUS.PvDeviceType(value)¶
The device type.
Enum
PvDeviceTypeUnknown
The device is of unknown type
PvDeviceTypeGEV
The device is GigE Vision compliant
PvDeviceTypeU3V
The device is USB3 Vision compliant
- PvDeviceTypeUnknown = -1¶
- PvDeviceTypeGEV = 0¶
- PvDeviceTypeU3V = 1¶
- class eBUS.PvDeviceSerial(value)¶
Device serial port enumeration.
Enum
PvDeviceSerial0
Serial port 0, or UART0
PvDeviceSerial1
Serial port 1, or UART1
PvDeviceSerialBulk0
Bulk interface 0, or BULK0. Can be UART, USRT or I2C depending on device configuration.
PvDeviceSerialBulk1
Bulk interface 1, or BULK1. Can be UART, USRT or I2C depending on device configuration.
PvDeviceSerialBulk2
Bulk interface 2, or BULK2. Can be UART, USRT or I2C depending on device configuration.
PvDeviceSerialBulk3
Bulk interface 3, or BULK3. Can be UART, USRT or I2C depending on device configuration.
PvDeviceSerialBulk4
Bulk interface 4, or BULK4. Can be UART, USRT or I2C depending on device configuration.
PvDeviceSerialBulk5
Bulk interface 5, or BULK5. Can be UART, USRT or I2C depending on device configuration.
PvDeviceSerialBulk6
Bulk interface 6, or BULK6. Can be UART, USRT or I2C depending on device configuration.
PvDeviceSerialBulk7
Bulk interface 7, or BULK7. Can be UART, USRT or I2C depending on device configuration.
- PvDeviceSerialInvalid = -1¶
- PvDeviceSerial0 = 0¶
- PvDeviceSerial1 = 1¶
- PvDeviceSerialBulk0 = 2¶
- PvDeviceSerialBulk1 = 3¶
- PvDeviceSerialBulk2 = 4¶
- PvDeviceSerialBulk3 = 5¶
- PvDeviceSerialBulk4 = 6¶
- PvDeviceSerialBulk5 = 7¶
- PvDeviceSerialBulk6 = 8¶
- PvDeviceSerialBulk7 = 9¶
- class eBUS.PvEncodingEnum(value)¶
The encoding used by the PvCompressionFilter.
Enum
PvEncodingUnknown
Value not known, indeterminate. The value is currently not supported.
PvEncodingPTC1
Pleora Compression Version 1 encoding.
- PvEncodingUnknown = -1¶
- PvEncodingPTC1 = 0¶
- class eBUS.PvGenAccessMode(value)¶
Access Mode of the register
Enum
PvGenAccessModeReadOnly
PvGenAccessModeReadWrite
PvGenAccessModeWriteOnly
PvGenAccessModeNotImplemented
PvGenAccessModeNotAvailable
PvGenAccessModeUndefined
- PvGenAccessModeReadOnly = 0¶
- PvGenAccessModeReadWrite = 1¶
- PvGenAccessModeWriteOnly = 2¶
- PvGenAccessModeNotImplemented = 3¶
- PvGenAccessModeNotAvailable = 4¶
- PvGenAccessModeUndefined = 999¶
- class eBUS.PvGenCache(value)¶
The cached value of the register behind the feature.
Enum
PvGenCacheWriteThrough
PvGenCacheWriteAround
PvGenCacheNone
PvGenCacheUndefined
- PvGenCacheWriteThrough = 0¶
- PvGenCacheWriteAround = 1¶
- PvGenCacheNone = 2¶
- PvGenCacheUndefined = 999¶
- class eBUS.PvGenEndianness(value)¶
The Data Endianness for the register.
Enum
PvGenEndiannessInvalid
PvGenEndiannessLittle
PvGenEndiannessBig
- PvGenEndiannessInvalid = -1¶
- PvGenEndiannessLittle = 0¶
- PvGenEndiannessBig = 1¶
- class eBUS.PvGenNameSpace(value)¶
PvGenNameSpace Enum
Enum
PvGenNameSpaceStandard
PvGenNameSpaceCustom
PvGenNameSpaceUndefined
- PvGenNameSpaceStandard = 0¶
- PvGenNameSpaceCustom = 1¶
- PvGenNameSpaceUndefined = 999¶
- class eBUS.PvGenRepresentation(value)¶
PvGenRepresentation suggests how the UI should present a numerical feature (
PvGenIntegerorPvGenFloat).To get a feature’s representation, use the following methods:
Enum
PvGenRepresentationLinear
Linear. Use a slider.
PvGenRepresentationLogarithmic
Logarithmic. Use a slider. The GenICam standard doesn’t specify if the feature’s value represents x or y in the formula x = n ^ y.
PvGenRepresentationBoolean
Boolean. The number might be presented as a check box or enable. Use a similar UI as for features from the PvGenBoolean class.
PvGenRepresentationPureNumber
Pure number. Use an edit box with a decimal display.
PvGenRepresentationHexNumber
Hex number. Use an edit box with a hexadecimal display.
PvGenRepresentationUndefined
Not defined; valid representation not provided.
- PvGenRepresentationLinear = 0¶
- PvGenRepresentationLogarithmic = 1¶
- PvGenRepresentationBoolean = 2¶
- PvGenRepresentationPureNumber = 3¶
- PvGenRepresentationHexNumber = 4¶
- PvGenRepresentationIPV4Address = 5¶
- PvGenRepresentationMACAddress = 6¶
- PvGenRepresentationUndefined = 999¶
- class eBUS.PvGenRefresh(value)¶
Refresh method for a GenApi browser.
GenApi browsers typically provides different methods for refresh the parameters it is displaying.
Enum
PvGenRefreshPolling
The polling time provided for parameters in the XML are used to control parameter refreshing.
PvGenRefreshAuto
A round-robbin refresh is performed on all visible features.
PvGenRefreshManual
Refresh is disabled. The browser may offer a manual Refresh button that can be used to control parameter refreshing.
- PvGenRefreshInvalid = -1¶
- PvGenRefreshPolling = 0¶
- PvGenRefreshAuto = 1¶
- PvGenRefreshManual = 2¶
- class eBUS.PvGenSign(value)¶
PvGenSign Enum.
Enum
PvGenSignUndefined
PvGenSignUnsigned
PvGenSignSigned
- PvGenSignUndefined = -1¶
- PvGenSignUnsigned = 0¶
- PvGenSignSigned = 1¶
- class eBUS.PvGenType(value)¶
Feature data type (Boolean, integer, etc.)
Each feature has a type that defines the information it contains and how it can be used. The type also determines the eBUS SDK class used to represent it (and the methods that are available).
To test for a feature’s type, use
PvGenParameter.GetType.Enum
PvGenTypeInteger
- Type: Integer
PvGenTypeEnum
- Type: Enumeration
PvGenTypeBoolean
- Type: Boolean
PvGenTypeString
- Type: String
PvGenTypeCommand
- Type: Command
PvGenTypeFloat
- Type: Float
PvGenTypeUndefined
Type: Not defined; valid type not provided.
- PvGenTypeInteger = 0¶
- PvGenTypeEnum = 1¶
- PvGenTypeBoolean = 2¶
- PvGenTypeString = 3¶
- PvGenTypeCommand = 4¶
- PvGenTypeFloat = 5¶
- PvGenTypeRegister = 6¶
- PvGenTypeUndefined = 999¶
- class eBUS.PvGenVisibility(value)¶
Feature (PvGenParameter object) visibility.
Every feature has a visibility setting that suggests how difficult the feature is to use and when it shouldn’t be made available (visible) to the end user. The current visibility might be a program-specific variable available, for example, in an options or configuration dialog. When opening the program for the first time, the visibility would typically be set to beginner.
You can test the feature-by-feature visibility using the following methods:
PvGenParameter
PvGenParameter.IsVisiblePvGenParameterPvGenParameter.GetVisibilityPvGenEnumEntryPvGenEnumEntry.IsVisible(for enumeration entries) PvGenEnumEntryPvGenEnumEntry.GetVisibility(for enumeration entries)The visibility levels, from lowest to highest:
Beginner (PvGenVisibilityBeginner) Expert (PvGenVisibilityExpert) Guru (PvGenVisibilityGuru) Invisible (PvGenVisibilityInvisible)
If a program’s current visibility were set to Expert, the user would expect to see Beginner and Expert-level features, but not Guru or Invisible-level features.
Enum
PvGenVisibilityBeginner
Always visible, to all users.
PvGenVisibilityExpert
Intended for advanced users.
PvGenVisibilityGuru
Intended for very advanced users.
PvGenVisibilityInvisible
Appears in the API, but not the GUI.
PvGenVisibilityUndefined
Not defined; valid visibility not provided.
- PvGenVisibilityBeginner = 0¶
- PvGenVisibilityExpert = 1¶
- PvGenVisibilityGuru = 2¶
- PvGenVisibilityInvisible = 3¶
- PvGenVisibilityUndefined = 999¶
- class eBUS.PvInterfaceType(value)¶
The type of interface the object represents.
Enum
PvInterfaceTypeUnknown
interface unknown
PvInterfaceTypeUSBHostController
A USB host controller. USB devices (
PvDeviceInfoUSBorPvDeviceInfoU3V) are enumerated through this interface.PvInterfaceTypeNetworkAdapter
A network interface. Ethernet devices (
PvDeviceInfoGEVorPvDeviceInfoPleoraProtocol) are enumerated through this interface.- PvInterfaceTypeUnknown = -1¶
- PvInterfaceTypeUSBHostController = 0¶
- PvInterfaceTypeNetworkAdapter = 1¶
- class eBUS.PvMultiPartDataType(value)¶
Enumeration reprensenting the data type of a section of a multi-part container.
Enum
PvMultiPartInvalid
Invalid or uninitialized value.
PvMultiPart2DImage
2D image.
Color or monochrome (2D) image. This part carries all the pixel data of the given image (even if the image is represented by a single-plane pixel format).
PvMultiPart2DPlaneOfBiPlanar
2D plane of a two-plane image.
Single plane of a planar (2D) image. The data should be linked with the other 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 payload.
PvMultiPart2DPlaneOfTriPlanar
2D plane of a three-plane image.
Single plane of a planar (2D) image. The data should be linked with the other 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 payload.
PvMultiPart2DPlaneOfQuadPlanar
2D plane of a four-plane image.
Single plane of a planar (2D) image. The data should be linked with the other 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 payload.
PvMultiPart3DImage
3D image.
3D image (pixel coordinates). This part carries all the pixel data of the given image (even if the image is represented by a single-plane pixel format, for example when transferring the depth map only).
PvMultiPart3DPlaneOfBiPlanar
3D plane of a two-plane image. Single plane of a planar 3D image. The data should be linked with the other coordinate 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 payload.
PvMultiPart3DPlaneOfTriPlanar
3D plane of a three-plane image.
Single plane of a planar 3D image. The data should be linked with the other coordinate 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 payload.
PvMultiPart3DPlaneOfQuadPlanar
3D plane of a four-plane image.
Single plane of a planar 3D image. The data should be linked with the other coordinate 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 payload.
PvMultiPartConfidenceMap
Confidence map.
Confidence of the individual pixel values. 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. The data format must be a Confidence PFNC format.
PvMultiPartChunkData
Chunk data section. Always last in a multi-part container.
Part carrying the chunk data in the Extended Chunk Data Mode. This MUST be always the last part in the payload. There MUST NOT be more than one chunk data part in the payload.
PvMultiPartJPEGImage
JPEG image.
JPEG compressed image following the guidelines defined for the GVSP JPEG payload type.
The data_type_specific field is used to carry information found in the JPEG data leader packet.
PvMultiPartJPEG2000Image
JEPG 2000 image.
JPEG 2000 compressed image following the guidelines defined for the GVSP JPEG 2000 payload type.
The data type specific field is used to carry information found in the JPEG 2000 data leader packet.
- PvMultiPartInvalid = 0¶
- PvMultiPart2DImage = 1¶
- PvMultiPart2DPlaneOfBiPlanar = 2¶
- PvMultiPart2DPlaneOfTriPlanar = 3¶
- PvMultiPart2DPlaneOfQuadPlanar = 4¶
- PvMultiPart3DImage = 5¶
- PvMultiPart3DPlaneOfBiPlanar = 6¶
- PvMultiPart3DPlaneOfTriPlanar = 7¶
- PvMultiPart3DPlaneOfQuadPlanar = 8¶
- PvMultiPartConfidenceMap = 9¶
- PvMultiPartChunkData = 10¶
- PvMultiPartJPEGImage = 11¶
- PvMultiPartJPEG2000Image = 12¶
- class eBUS.PvPayloadType(value)¶
GVSP payload type.
Enum
PvPayloadTypeUndefined
Undefined or non initialized payload type
PvPayloadTypeNone
A proprietary type used for GigE Vision Validation Framework testing. Refer to
IPvStreamingChannelSource.SetTestPayloadFormatModefor more details.PvPayloadTypeImage
Image payload type. Access from PvBuffer using
PvBuffer.GetImage.PvPayloadTypeRawData
Raw data payload type. Access from PvBuffer using
PvBuffer.GetRawData.PvPayloadTypeFile
File payload type. Not currently supported.
PvPayloadTypeChunkData
Chunk data payload type. Not currently supported.
PvPayloadTypeExtendedChunkData
Extended chunk data payload type. Not currently supported.
PvPayloadTypeJPEG
JPEG compressed image payload type. Not currently supported.
PvPayloadTypeJPEG2000
JPEG 2000 compressed image payload type. Not currently supported.
PvPayloadTypeH264
H.264 compressed video stream payload type. Not currently supported.
PvPayloadTypeMultiZoneImage
Multi-zone image payload type. Not currently supported.
PvPayloadTypeMultiPart
Multi-part payload type.
PvPayloadTypeDeviceSpecificBase
Base value for device specific payload type. Not currently supported.
PvPayloadTypePleoraCompressed
Pleora compressed payload type.
- PvPayloadTypeUndefined = -1¶
- PvPayloadTypeNone = 0¶
- PvPayloadTypeImage = 1¶
- PvPayloadTypeRawData = 2¶
- PvPayloadTypeFile = 3¶
- PvPayloadTypeChunkData = 4¶
- PvPayloadTypeExtendedChunkData = 5¶
- PvPayloadTypeJPEG = 6¶
- PvPayloadTypeJPEG2000 = 7¶
- PvPayloadTypeH264 = 8¶
- PvPayloadTypeMultiZoneImage = 9¶
- PvPayloadTypeMultiPart = 10¶
- PvPayloadTypeDeviceSpecificBase = 32768¶
- PvPayloadTypePleoraCompressed = 32999¶
- class eBUS.PvPixelType(value)¶
Pixel types use by image buffers.
**
PvBufferConverterconversion currently supported to the following pixel types:**PvPixelRGBa
PvPixelBGRa
PvPixelRGB
PvPixelBGR
PvPixelRGB565
PvPixelMono8
Pre GEV 2.0 pixel types:
PvPixelRGB8Packed
PvPixelBGR8Packed
PvPixelRGBA8Packed
PvPixelBGRA8Packed
PvPixelRGB10Packed
PvPixelBGR10Packed
PvPixelRGB12Packed
PvPixelBGR12Packed
PvPixelRGB16Packed
PvPixelBGR10V1Packed
PvPixelBGR10V2Packed
PvPixelYUV411Packed
PvPixelYUV422Packed
PvPixelYUV422YUYVPacked
PvPixelYUV444Packed
PvPixelRGB8Planar
PvPixelRGB10Planar
PvPixelRGB12Planar
PvPixelRGB16Planar
- PvPixelUndefined = 0¶
- PvPixelMono8 = 17301505¶
- PvPixelMono8s = 17301506¶
- PvPixelMono10 = 17825795¶
- PvPixelMono10Packed = 17563652¶
- PvPixelMono12 = 17825797¶
- PvPixelMono12Packed = 17563654¶
- PvPixelMono16 = 17825799¶
- PvPixelBayerGR8 = 17301512¶
- PvPixelBayerRG8 = 17301513¶
- PvPixelBayerGB8 = 17301514¶
- PvPixelBayerBG8 = 17301515¶
- PvPixelBayerGR10 = 17825804¶
- PvPixelBayerRG10 = 17825805¶
- PvPixelBayerGB10 = 17825806¶
- PvPixelBayerBG10 = 17825807¶
- PvPixelBayerGR12 = 17825808¶
- PvPixelBayerRG12 = 17825809¶
- PvPixelBayerGB12 = 17825810¶
- PvPixelBayerBG12 = 17825811¶
- PvPixelRGB8 = 35127316¶
- PvPixelBGR8 = 35127317¶
- PvPixelRGBa8 = 35651606¶
- PvPixelBGRa8 = 35651607¶
- PvPixelRGB10 = 36700184¶
- PvPixelBGR10 = 36700185¶
- PvPixelRGB12 = 36700186¶
- PvPixelBGR12 = 36700187¶
- PvPixelRGB10V1Packed = 35651612¶
- PvPixelRGB10p32 = 35651613¶
- PvPixelYUV411_8_UYYVYY = 34340894¶
- PvPixelYUV422_8_UYVY = 34603039¶
- PvPixelYUV8_UYV = 35127328¶
- PvPixelRGB8_Planar = 35127329¶
- PvPixelRGB10_Planar = 36700194¶
- PvPixelRGB12_Planar = 36700195¶
- PvPixelRGB16_Planar = 36700196¶
- PvPixelMono14 = 17825829¶
- PvPixelBayerGR10Packed = 17563686¶
- PvPixelBayerRG10Packed = 17563687¶
- PvPixelBayerGB10Packed = 17563688¶
- PvPixelBayerBG10Packed = 17563689¶
- PvPixelBayerGR12Packed = 17563690¶
- PvPixelBayerRG12Packed = 17563691¶
- PvPixelBayerGB12Packed = 17563692¶
- PvPixelBayerBG12Packed = 17563693¶
- PvPixelBayerGR16 = 17825838¶
- PvPixelBayerRG16 = 17825839¶
- PvPixelBayerGB16 = 17825840¶
- PvPixelBayerBG16 = 17825841¶
- PvPixelYUV422_8 = 34603058¶
- PvPixelRGB16 = 36700211¶
- PvPixelRGB12V1Packed = 35913780¶
- PvPixelRGB565p = 34603061¶
- PvPixelBGR565p = 34603062¶
- PvPixelMono1p = 16842807¶
- PvPixelMono2p = 16908344¶
- PvPixelMono4p = 17039417¶
- PvPixelYCbCr8_CbYCr = 35127354¶
- PvPixelYCbCr422_8 = 34603067¶
- PvPixelYCbCr411_8_CbYYCrYY = 34340924¶
- PvPixelYCbCr601_8_CbYCr = 35127357¶
- PvPixelYCbCr601_422_8 = 34603070¶
- PvPixelYCbCr601_411_8_CbYYCrYY = 34340927¶
- PvPixelYCbCr709_8_CbYCr = 35127360¶
- PvPixelYCbCr709_422_8 = 34603073¶
- PvPixelYCbCr709_411_8_CbYYCrYY = 34340930¶
- PvPixelYCbCr422_8_CbYCrY = 34603075¶
- PvPixelYCbCr601_422_8_CbYCrY = 34603076¶
- PvPixelYCbCr709_422_8_CbYCrY = 34603077¶
- PvPixelMono10p = 17432646¶
- PvPixelMono12p = 17563719¶
- PvPixelBGR10p = 35520584¶
- PvPixelBGR12p = 35913801¶
- PvPixelBGR14 = 36700234¶
- PvPixelBGR16 = 36700235¶
- PvPixelBGRa10 = 37748812¶
- PvPixelBGRa10p = 36175949¶
- PvPixelBGRa12 = 37748814¶
- PvPixelBGRa12p = 36700239¶
- PvPixelBGRa14 = 37748816¶
- PvPixelBGRa16 = 37748817¶
- PvPixelRGB10p = 35520594¶
- PvPixelBayerBG10p = 17432658¶
- PvPixelBayerBG12p = 17563731¶
- PvPixelBayerGB10p = 17432660¶
- PvPixelBayerGB12p = 17563733¶
- PvPixelBayerGR10p = 17432662¶
- PvPixelBayerGR12p = 17563735¶
- PvPixelBayerRG10p = 17432664¶
- PvPixelBayerRG12p = 17563737¶
- PvPixelYCbCr411_8 = 34340954¶
- PvPixelYCbCr8 = 35127387¶
- PvPixelRGB12p = 35913820¶
- PvPixelRGB14 = 36700253¶
- PvPixelRGBa10 = 37748830¶
- PvPixelRGBa10p = 36175967¶
- PvPixelRGBa12 = 37748832¶
- PvPixelRGBa12p = 36700257¶
- PvPixelRGBa14 = 37748834¶
- PvPixelRGBa16 = 37748835¶
- PvPixelYCbCr422_10 = 35651685¶
- PvPixelYCbCr422_12 = 35651686¶
- PvPixelSCF1WBWG8 = 17301607¶
- PvPixelSCF1WBWG10 = 17825896¶
- PvPixelSCF1WBWG10p = 17432681¶
- PvPixelSCF1WBWG12 = 17825898¶
- PvPixelSCF1WBWG12p = 17563755¶
- PvPixelSCF1WBWG14 = 17825900¶
- PvPixelSCF1WBWG16 = 17825901¶
- PvPixelSCF1WGWB8 = 17301614¶
- PvPixelSCF1WGWB10 = 17825903¶
- PvPixelSCF1WGWB10p = 17432688¶
- PvPixelSCF1WGWB12 = 17825905¶
- PvPixelSCF1WGWB12p = 17563762¶
- PvPixelSCF1WGWB14 = 17825907¶
- PvPixelSCF1WGWB16 = 17825908¶
- PvPixelSCF1WGWR8 = 17301621¶
- PvPixelSCF1WGWR10 = 17825910¶
- PvPixelSCF1WGWR10p = 17432695¶
- PvPixelSCF1WGWR12 = 17825912¶
- PvPixelSCF1WGWR12p = 17563769¶
- PvPixelSCF1WGWR14 = 17825914¶
- PvPixelSCF1WGWR16 = 17825915¶
- PvPixelSCF1WRWG8 = 17301628¶
- PvPixelSCF1WRWG10 = 17825917¶
- PvPixelSCF1WRWG10p = 17432702¶
- PvPixelSCF1WRWG12 = 17825919¶
- PvPixelSCF1WRWG12p = 17563776¶
- PvPixelSCF1WRWG14 = 17825921¶
- PvPixelSCF1WRWG16 = 17825922¶
- PvPixelYCbCr10_CbYCr = 36700291¶
- PvPixelYCbCr10p_CbYCr = 35520644¶
- PvPixelYCbCr12_CbYCr = 36700293¶
- PvPixelYCbCr12p_CbYCr = 35913862¶
- PvPixelYCbCr422_10p = 34865287¶
- PvPixelYCbCr422_12p = 35127432¶
- PvPixelYCbCr601_10_CbYCr = 36700297¶
- PvPixelYCbCr601_10p_CbYCr = 35520650¶
- PvPixelYCbCr601_12_CbYCr = 36700299¶
- PvPixelYCbCr601_12p_CbYCr = 35913868¶
- PvPixelYCbCr601_422_10 = 35651725¶
- PvPixelYCbCr601_422_10p = 34865294¶
- PvPixelYCbCr601_422_12 = 35651727¶
- PvPixelYCbCr601_422_12p = 35127440¶
- PvPixelYCbCr709_10_CbYCr = 36700305¶
- PvPixelYCbCr709_10p_CbYCr = 35520658¶
- PvPixelYCbCr709_12_CbYCr = 36700307¶
- PvPixelYCbCr709_12p_CbYCr = 35913876¶
- PvPixelYCbCr709_422_10 = 35651733¶
- PvPixelYCbCr709_422_10p = 34865302¶
- PvPixelYCbCr709_422_12 = 35651735¶
- PvPixelYCbCr709_422_12p = 35127448¶
- PvPixelYCbCr422_10_CbYCrY = 35651737¶
- PvPixelYCbCr422_10p_CbYCrY = 34865306¶
- PvPixelYCbCr422_12_CbYCrY = 35651739¶
- PvPixelYCbCr422_12p_CbYCrY = 35127452¶
- PvPixelYCbCr601_422_10_CbYCrY = 35651741¶
- PvPixelYCbCr601_422_10p_CbYCrY = 34865310¶
- PvPixelYCbCr601_422_12_CbYCrY = 35651743¶
- PvPixelYCbCr601_422_12p_CbYCrY = 35127456¶
- PvPixelYCbCr709_422_10_CbYCrY = 35651745¶
- PvPixelYCbCr709_422_10p_CbYCrY = 34865314¶
- PvPixelYCbCr709_422_12_CbYCrY = 35651747¶
- PvPixelYCbCr709_422_12p_CbYCrY = 35127460¶
- PvPixelBiColorRGBG8 = 34603173¶
- PvPixelBiColorBGRG8 = 34603174¶
- PvPixelBiColorRGBG10 = 35651751¶
- PvPixelBiColorRGBG10p = 34865320¶
- PvPixelBiColorBGRG10 = 35651753¶
- PvPixelBiColorBGRG10p = 34865322¶
- PvPixelBiColorRGBG12 = 35651755¶
- PvPixelBiColorRGBG12p = 35127468¶
- PvPixelBiColorBGRG12 = 35651757¶
- PvPixelBiColorBGRG12p = 35127470¶
- PvPixelCoord3D_A8 = 17301679¶
- PvPixelCoord3D_B8 = 17301680¶
- PvPixelCoord3D_C8 = 17301681¶
- PvPixelCoord3D_ABC8 = 35127474¶
- PvPixelCoord3D_ABC8_Planar = 35127475¶
- PvPixelCoord3D_AC8 = 34603188¶
- PvPixelCoord3D_AC8_Planar = 34603189¶
- PvPixelCoord3D_A16 = 17825974¶
- PvPixelCoord3D_B16 = 17825975¶
- PvPixelCoord3D_C16 = 17825976¶
- PvPixelCoord3D_ABC16 = 36700345¶
- PvPixelCoord3D_ABC16_Planar = 36700346¶
- PvPixelCoord3D_AC16 = 35651771¶
- PvPixelCoord3D_AC16_Planar = 35651772¶
- PvPixelCoord3D_A32f = 18874557¶
- PvPixelCoord3D_B32f = 18874558¶
- PvPixelCoord3D_C32f = 18874559¶
- PvPixelCoord3D_ABC32f = 39846080¶
- PvPixelCoord3D_ABC32f_Planar = 39846081¶
- PvPixelCoord3D_AC32f = 37748930¶
- PvPixelCoord3D_AC32f_Planar = 37748931¶
- PvPixelConfidence1 = 17301700¶
- PvPixelConfidence1p = 16842949¶
- PvPixelConfidence8 = 17301702¶
- PvPixelConfidence16 = 17825991¶
- PvPixelConfidence32f = 18874568¶
- PvPixelR8 = 17301705¶
- PvPixelR10 = 17432778¶
- PvPixelR12 = 17563851¶
- PvPixelR16 = 17825996¶
- PvPixelG8 = 17301709¶
- PvPixelG10 = 17432782¶
- PvPixelG12 = 17563855¶
- PvPixelG16 = 17826000¶
- PvPixelB8 = 17301713¶
- PvPixelB10 = 17432786¶
- PvPixelB12 = 17563859¶
- PvPixelB16 = 17826004¶
- PvPixelCoord3D_A10p = 17432789¶
- PvPixelCoord3D_B10p = 17432790¶
- PvPixelCoord3D_C10p = 17432791¶
- PvPixelCoord3D_A12p = 17563864¶
- PvPixelCoord3D_B12p = 17563865¶
- PvPixelCoord3D_C12p = 17563866¶
- PvPixelCoord3D_ABC10p = 35520731¶
- PvPixelCoord3D_ABC10p_Planar = 35520732¶
- PvPixelCoord3D_ABC12p = 35913950¶
- PvPixelCoord3D_ABC12p_Planar = 35913951¶
- PvPixelCoord3D_AC10p = 34865392¶
- PvPixelCoord3D_AC10p_Planar = 34865393¶
- PvPixelCoord3D_AC12p = 35127538¶
- PvPixelCoord3D_AC12p_Planar = 35127539¶
- PvPixelMono14p = 17694980¶
- PvPixelBayerGR14p = 17694981¶
- PvPixelBayerRG14p = 17694982¶
- PvPixelBayerGB14p = 17694983¶
- PvPixelBayerBG14p = 17694984¶
- PvPixelBayerGR14 = 17826057¶
- PvPixelBayerRG14 = 17826058¶
- PvPixelBayerGB14 = 17826059¶
- PvPixelBayerBG14 = 17826060¶
- PvPixelBayerGR4p = 17039629¶
- PvPixelBayerRG4p = 17039630¶
- PvPixelBayerGB4p = 17039631¶
- PvPixelBayerBG4p = 17039632¶
- PvPixelMono32 = 18874641¶
- class eBUS.PvResultCode(value)¶
PvResult Code information about the success or failure of the methods you use.
Most successful methods return PV_OK, however, there are exceptions:
Some methods return immediately, but the ultimate success of the method may not be know for some time after (several seconds or more). These methods return PV_PENDING. Pending operations are considered successful.
To use result codes (best coding practices):
Call a method.
Test the result for success. Use
PvResult.IsSuccess,PvResult.IsOK, or test against specific PvResultCode values.
Enum
PV_OK
Success! (Immediate.)
PV_NOT_INITIALIZED
An error code hasn’t been set.
When initially created, the PvResult object has the value NOT_INITIALIZED.The value only occurs when the object is first created; no method returns NOT_INITIALIZED.PV_NOT_FOUND
The expected item wasn’t found.
Possible causes include:
Connecting to a GigE Vision device that doesn’t exist (or isn’t on the network).
Accessing a non-existent parameter.
PV_CANNOT_OPEN_FILE
The file doesn’t exist or can’t be opened.
PV_NO_MORE_ITEM
No more of what was requested is currently available.
PV_NOT_CONNECTED
The object (PvDevice or PvStream object) isn’t connected.
Refer to the documentation of the method being called or call
PvResult.GetDescriptionfor further information.PV_STATE_ERROR
The method is (probably) legal, but the system’s current state doesn’t allow the action.
For example, you can’t queue buffers to a stream (using
PvStream.QueueBuffer) before opening it (usingPvStream.Open).PV_THREAD_ERROR
An error occurred while attempting to perform an operation on a thread like starting,stopping or changing priority.
PV_INVALID_DATA_FORMAT
The data format is not supported for the requested operation.
PV_ABORTED
The operation was aborted
PV_NOT_ENOUGH_MEMORY
Not enough memory. An operation failed to complete as not enough memory was available.
PV_GENERIC_ERROR
An undefined error occurred.
Refer to the documentation of the method being called or call
PvResult.GetDescriptionfor further information.PV_INVALID_PARAMETER
A parameter passed to the method is invalid.
Possible causes include:
A value is out-of-bounds.
An empty string, where a non-empty string is required.
A null pointer.
PV_CANCEL
The user closed a dialog and the operation was not performed. This can occur if the “Cancel” button is clicked.
PV_PENDING
Success! (Pending.)
Returned by
PvStream.QueueBufferto indicate that a buffer has been successfully queued but the operation is still pending (the data has not yet been received).PV_TIMEOUT
The operation timed out.
The operation exceeded its specified maximum wait time without succeeding.
PV_NO_LICENSE
An eBUS SDK license is missing.
To receive data from a GigE Vision device that does not contain a Pleora video interface, a receiver license is required. A license is also required to transmit data using the eBUS SDK using PvTransmitterGEV. When working with images, a watermark is applied when no license is present. This is so that the SDK can be used for evaluation purposes.
PV_GENICAM_XML_ERROR
The GenICam XML file could not be loaded into GenApi.
The file could be corrupted or simply incorrectly structured. Some third-party vendors use XML files that don’t conform to the GenApi schema.
PV_CANT_READ_MANIFEST
The manifest table of the device could not be read
Device was discovered but the manifest table could not be read. It may have a corrupt firmware load or could be powered incorrectly.
PV_NOT_IMPLEMENTED
The requested feature or functionality is not implemented.
Can happen when a dynamically selected feature or capability is not implemented in the SDK.
PV_NOT_SUPPORTED
The requested feature or functionality is not supported.
PV_FILE_ERROR
A file operation error occured.
PV_ERR_OVERFLOW
Overflow occurred.
Can happen when a counter overflows or when an attempt was made to write past the upper boundary of a file or data structure.
PV_IMAGE_ERROR
Error with an image.
May be returned when a corrupt image arrives due to discontinuities in data between the camera and the hardware responsible for transmitting packets in the GigE Vision device. | This can include data overrun, partial and full lines missing.
PV_MISSING_PACKETS
Some packets are missing in the buffer.
Happens when at least one packet of the buffer is missing when it was released back to the calling application.
PV_BUFFER_TOO_SMALL
The buffer was not large enough to hold the payload of the block being received.
Call
PvBuffer.GetRequiredSizeto use the information from the leader packet to determine the size of buffer that would have been required to receive the block.Call
PvBuffer.AllocorPvBuffer.Attachto allocate or associate an a larger area of memory to receive the next block.PV_TOO_MANY_RESENDS
Too many resend packets were requested, buffer acquisition failure.
PV_RESENDS_FAILURE
Failure to receive all missing packets for a buffer through resend packets.
PV_TOO_MANY_CONSECUTIVE_RESENDS
Buffer reception failed, consecutive missing buffers higher than allowed.
The data receiver may stop attempting to receive a block if a set of consecutive packets exceeding MaximumResendGroupSize.
PV_AUTO_ABORTED
Buffer reception failed.
The data receiver entered a state where so many packets and/or blocks were missing that all queued buffers were automatically aborted on an internal reset.
PV_BAD_VERSION
Some component versions are not compatible.
PV_NO_MORE_ENTRY
There are no more entries to retrieve/enumerate.
PV_NO_AVAILABLE_DATA
There is no available data to enumerate.
PV_NETWORK_ERROR
A network error occurred while performing the requested operation.
PV_RESYNC
Kick out of the driver because of a forced resynchronisation.
PV_BUSY
The resource requested is already in use.
PV_CORRUPTED_DATA
The data is corrupted.
- PV_OK = 0¶
- PV_NOT_INITIALIZED = 1541¶
- PV_NOT_FOUND = 25¶
- PV_CANNOT_OPEN_FILE = 6¶
- PV_NO_MORE_ITEM = 21¶
- PV_NOT_CONNECTED = 23¶
- PV_STATE_ERROR = 28¶
- PV_THREAD_ERROR = 29¶
- PV_INVALID_DATA_FORMAT = 1281¶
- PV_ABORTED = 1¶
- PV_NOT_ENOUGH_MEMORY = 24¶
- PV_GENERIC_ERROR = 16384¶
- PV_INVALID_PARAMETER = 16385¶
- PV_CANCEL = 16386¶
- PV_PENDING = 65535¶
- PV_TIMEOUT = 30¶
- PV_NO_LICENSE = 1538¶
- PV_GENICAM_XML_ERROR = 2308¶
- PV_CANT_READ_MANIFEST = 2309¶
- PV_NOT_IMPLEMENTED = 1540¶
- PV_NOT_SUPPORTED = 26¶
- PV_FILE_ERROR = 16¶
- PV_ERR_OVERFLOW = 27¶
- PV_IMAGE_ERROR = 37¶
- PV_MISSING_PACKETS = 39¶
- PV_BUFFER_TOO_SMALL = 4¶
- PV_TOO_MANY_RESENDS = 2816¶
- PV_RESENDS_FAILURE = 2817¶
- PV_TOO_MANY_CONSECUTIVE_RESENDS = 2819¶
- PV_AUTO_ABORTED = 2818¶
- PV_BAD_VERSION = 513¶
- PV_NO_MORE_ENTRY = 1539¶
- PV_NO_AVAILABLE_DATA = 20¶
- PV_NETWORK_ERROR = 19¶
- PV_NETWORK_CONFIG_ERROR = 1536¶
- PV_RESYNC = 40¶
- PV_BUSY = 514¶
- PV_CORRUPTED_DATA = 771¶
- class eBUS.PvScanType(value)¶
The Image Source Scan Type. It could be Area scan or line scan in 3D or not.
Enum
PvScanTypeInvalid
PvScanTypeArea
PvScanTypeLine
PvScanTypeArea3D
PvScanTypeLine3D
- PvScanTypeInvalid = -1¶
- PvScanTypeArea = 0¶
- PvScanTypeLine = 1¶
- PvScanTypeArea3D = 2¶
- PvScanTypeLine3D = 3¶
- class eBUS.PvStreamType(value)¶
The Image Stream Type.
Enum
PvStreamTypeUnknown
PvStreamTypeGEV
PvStreamTypeU3V
PvStreamTypeRTP
- PvStreamTypeUnknown = -1¶
- PvStreamTypeGEV = 0¶
- PvStreamTypeU3V = 1¶
- PvStreamTypeRTP = 2¶
- class eBUS.PvUSBStatus(value)¶
USB device status.
Enum
PvUSBStatusConnected
USB device successfully enumerated.
PvUSBStatusFailedEnumeration
Impossible to enumerate the device.
PvUSBStatusGeneralFailure
General failure of connection to the USB device.
PvUSBStatusCausedOvercurrent
The device caused an over current situation on the USB bus.
PvUSBStatusNotEnoughPower
The device lacks power and thus cannot even be enumerated.
PvUSBStatusNotEnoughBandwidth
Not enough bandwidth on the USB bus to enumerate the device.
PvUSBStatusHubNestedTooDeeply
The device is nested too deeply in the hub architecture to be properly enumerated.
PvUSBStatusInLegacyHub
The device cannot be enumerated as is connected in a legacy hub.
PvUSBStatusEnumerating
The device is currently being enumerated.
PvUSBStatusReset
The device is currently restarting.
- PvUSBStatusNotInitialized = -1¶
- PvUSBStatusConnected = 0¶
- PvUSBStatusFailedEnumeration = 1¶
- PvUSBStatusGeneralFailure = 2¶
- PvUSBStatusCausedOvercurrent = 3¶
- PvUSBStatusNotEnoughPower = 4¶
- PvUSBStatusNotEnoughBandwidth = 5¶
- PvUSBStatusHubNestedTooDeeply = 6¶
- PvUSBStatusInLegacyHub = 7¶
- PvUSBStatusEnumerating = 8¶
- PvUSBStatusReset = 9¶
- class eBUS.PvUSBSpeed(value)¶
The speed grade of the USB device or interface.
Enum
PvUSBSpeedUnsupported
An error indicated an unsupported or mismatched speed
PvUSBSpeedUnknown
The USB speed is not determined
PvUSBSpeedLow
The USB speed is low (USB 1.1 maximum 1.5Mbps)
PvUSBSpeedFull
The USB speed is full (USB 1.1 maximum 12Mbps)
PvUSBSpeedHigh
The USB speed is high (USB 2.0 maximum 480Mbps)
PvUSBSpeedSuper
The USB speed is super (USB 3.0 maximum 5Gbps)
- PvUSBSpeedUnsupported = -1¶
- PvUSBSpeedUnknown = 0¶
- PvUSBSpeedLow = 1¶
- PvUSBSpeedFull = 2¶
- PvUSBSpeedHigh = 3¶
- PvUSBSpeedSuper = 4¶
- class eBUS.PvUserSetState(value)¶
UserSetState enumeration type.
Enum
PvUserSetStateSaveStart
The device is about to start a UserSetSave
PvUserSetStateSaveCompleted
The device has just completed a UserSetSave
PvUserSetStateLoadStart
The device is about to start a UserSetLoad
PvUserSetStateLoadCompleted
The device has just completed a UserSetLoad
- PvUserSetStateSaveStart = 0¶
- PvUserSetStateSaveCompleted = 1¶
- PvUserSetStateLoadStart = 2¶
- PvUserSetStateLoadCompleted = 3¶
