CVB.Net 14.1
Stemmer.Cvb Namespace Reference

Classes

struct  AffineMatrix2D
 Compacted affine matrix for 2D operations. More...
 
struct  AffineMatrix3D
 Affine transformation for 3D containing a transformation matrix and a translation vector. More...
 
class  Analyze
 A collection functions available in the Common Vision Blox Image Manager for analyzing image content. More...
 
struct  Angle
 Object for convenient and type-safe handling of angles. More...
 
class  AngleMath
 Provides trigonometry functions that work with Angle objects. More...
 
struct  Area2D
 Structure that represents an area of interest in the image. More...
 
class  AtCalibrator3D
 Calibrator to create point clouds from Automation Technologies cameras. More...
 
class  Calibrator3D
 Object used to reconstruct point clouds. More...
 
class  ComponentsPointer3D
 Point components of a point cloud. More...
 
class  Composite
 Aggregates multiple CVB objects under a common Purpose. More...
 
class  ConnectionStateChangeEventArgs
 Event arguments of the Device.ConnectionStateChanged event. More...
 
class  Convert3D
 Conversion functions for 3D objects. More...
 
class  ConvertColorSpace
 Simple color space conversion routines that are covered by the CVB Image Manager license. More...
 
struct  Cuboid
 3-dimensional range construct. More...
 
class  CvbException
 Base exception for all Cvb exceptions. More...
 
struct  DataType
 Data type description for a Image plane. More...
 
class  DataTypes
 Contains common CVB DataTypes. More...
 
class  DenseComponentsPointer3D
 Generic point components of a DensePointCloud. More...
 
class  DensePointCloud
 Dense point cloud object. More...
 
class  Device
 Generic CVB physical device. More...
 
class  DeviceFactory
 Factory object for creating Device objects. More...
 
class  ErrorCodes
 Native CVB error codes. More...
 
struct  Factors3D
 3D factor struct. More...
 
class  FactorsCalibrator3D
 Calibrator that multiplies the created X, Y and Z components with predefined factors. More...
 
struct  FeatureExtent
 The rectangular extent of a feature relative to an anchor point. More...
 
class  FileImage
 An Image loaded from the file system. More...
 
struct  GapFillingOptions
 Options for gap filling with Process.FillGaps(ImagePlane, GapFillingOptions). More...
 
class  GeometryFit
 Fitting algorithms for geometric objects. More...
 
interface  IAreaOfInterest
 Base Interface for all areas of interest More...
 
class  Image
 The Common Vision Blox image. More...
 
class  ImageData
 Stores the access data for image access. More...
 
class  ImageDrawer
 Immediate mode drawing on a Image plane. More...
 
struct  ImagePlane
 Plane information container. More...
 
class  ImagePlaneCollection
 Collection of plane informations. More...
 
class  ImagePlaneExtensions
 Extension methods used on image planes. More...
 
interface  INamed
 Interface for anything that has a name. More...
 
interface  INativeHandle
 Base interface for Cvb objects that are accessible through a native handle. More...
 
interface  IPosition
 Interface for anything that denotes a position. More...
 
interface  IQualified
 Interface for anything that has a quality (e.g. search results). More...
 
interface  IRotated
 Interface for anything that has a rotation. More...
 
interface  IScaled
 Interface for anything that has a scale. More...
 
interface  ISized
 Interface for anything that has a size. More...
 
class  LaserPlaneCalibrator3D
 Calibrator for applying parameters for calibrating laser plane. More...
 
class  LaserPlaneHomographyCalibrator3D
 Calibrator that uses the Metric created X-Z matrix to rectify the laser line triangulated range map. More...
 
class  LaserPlaneZigZagCalibrator3D
 Calibrator that uses the ZigZag algorithm to rectify the laser line triangulated range map. More...
 
struct  LinearAccessData
 Linear Access properties. More...
 
struct  LinearPlaneAccess1D
 Linear access to a plane; More...
 
struct  LocalMaximum
 Result type returned by the FindLocalMaxima function More...
 
class  MappedImage
 A mapped Common Vision Blox image. More...
 
struct  Matrix2D
 Double precision 2x2 Matrix struct. More...
 
struct  Matrix3D
 Double precision 3x3 matrix struct. More...
 
struct  Matrix3DH
 Double precision 4x4 matrix struct. More...
 
class  MatrixCalibrator3D
 Calibrator that multiplies the X, Y and Z components vector with a 4x4 matrix. More...
 
class  Mesh
 3D mesh object consisting of polygons. More...
 
class  NamespaceDoc
 The namespace and assembly Stemmer.Cvb holds all published definitions of the types that form Cvb.Net. More...
 
class  OverlayBitDrawer
 Immediate mode drawing on Image overlay plane(s). More...
 
class  PanoramicMappedImage
 Mapped image of two merged source images. More...
 
class  PfncFormatValue
 Helper methods for PfncFormat values. More...
 
class  PinholeCameraCalibrator3D
 Calibrator the calculates the X, Y and Z components via the pinhole camera model. More...
 
class  PixelFormatConverter
 Helper class that takes care of pixel format conversion. More...
 
class  Plane
 A single linear plane of component data. More...
 
struct  PlaneConfiguration
 Structure defining the plane order for painting Image objects. More...
 
class  PlaneEnumerator
 Container for a set of planes. More...
 
class  PlaneLinkCollection
 Collection of linked planes of a MappedImage. More...
 
struct  Point2D
 Multi-purpose 2D Point class More...
 
struct  Point2Dd
 Multi-purpose 2D Point class More...
 
struct  Point3Dcd
 Multi-purpose 3D float vector struct with confidence value. More...
 
struct  Point3Dcf
 Multi-purpose 3D float vector struct with confidence value. More...
 
struct  Point3Dd
 Multi-purpose 3D double vector struct. More...
 
struct  Point3Df
 Multi-purpose 3D float vector struct. More...
 
struct  Point3Dhd
 Multi-purpose homogeneous 3D double vector struct. More...
 
struct  Point3Dhf
 Multi-purpose homogeneous 3D float vector struct. More...
 
class  PointCloud
 Base class for point clouds. More...
 
class  PointCloudExtensions
 Extension methods for PointClouds. More...
 
struct  Polygon3D
 A polygon in 3D space. More...
 
class  Process
 Collection of functions available for image processing. More...
 
class  PropertyValueChangedEventArgs
 Generic event arguments for property value changes. More...
 
struct  Range
 Struct defining a range. More...
 
struct  Rect
 Cvb Rectangle structure. More...
 
struct  RectD
 Corresponds in intention and use with the type RectD, although RectD is far more widely used. More...
 
class  RectEventArgs
 Event arguments transporting a rectangular area. More...
 
class  Ref
 Class to store a reference to a value type in. More...
 
struct  RgbColor
 Color type resembling that of System.Drawing.Color but which can be used without the System.Drawing dependency. More...
 
struct  RotationAngles3D
 Rotation angle struct. More...
 
class  ScopedState
 Simple object for writing RAII-like scoped states (see example). More...
 
struct  SensorSettings
 Class to store camera sensor settings. More...
 
struct  Size2D
 Stores an ordered pair of integers, typical the width and height of a Rect. More...
 
struct  Size2Dd
 Stores an ordered pair of doubles, typical the width and height of a RectD. More...
 
class  SparseComponentsPointer3D
 Generic point components of a SparsePointCloud. More...
 
class  SparsePointCloud
 Sparse point cloud object. More...
 
class  SystemExtensions
 Extension methods for types located in the System name space. More...
 
class  Transform3D
 Transformation functions for 3D objects. More...
 
class  Transformations
 Container class for a selection of functions that perform a (non-geometric) transformation on the input image. More...
 
struct  ValueRange
 Container for range definitions. More...
 
struct  Vpat
 Virtual Pixel Access Table. More...
 
struct  VpatAccessData
 Typed VPAT access properties with coordinate pixel access. More...
 
class  WhiteBalance
 WhiteBalance functions inside the Image Manager. More...
 
struct  WhiteBalanceFactors
 Factors for white balance correction. More...
 
class  WrappedImage
 A wrapped image wraps another pixel buffer without owning it. More...
 

Enumerations

enum  SubPixelMode { ParabolicFast = 1 , ParabolicAccurate = 2 , Gaussian = 3 }
 Method for determining sub pixel accuracy when working with the FindLocalMaxima functions. More...
 
enum  Neighborhood { Use3x3 = 1 , Use5x5 = 2 , Use7x7 = 3 , Use9x9 = 4 }
 Neighborhood to use in sub pixel calculation of local maxima. The bigger the neighborhood for calculation is, the longer the sub pixel fit will take. More...
 
enum  CoordinateSystemType { PixelCoordinates , ImageCoordinates }
 Enumeration of the different available coordinate systems that an Area of interest may be defined in. More...
 
enum  CompositePurpose {
  Custom = -1 , Image = 0 , ImageList , MultiAoi ,
  RangeMap , PointCloud , ImageCube
}
 Purpose of a Composite. More...
 
enum  MonochromeConversion { EqualWeights , PerceptiveWeights }
 Options for converting to monochrome. More...
 
enum  DeviceUpdateMode { UpdateDeviceImage , NewDeviceImage }
 Defines how to treat the optional device image, when the device itself is updated. More...
 
enum  TriggerState { NotSupported = -2 , Unknown = -1 , Off = 0 , On = 1 }
 The current state of the Device.TriggerMode property. More...
 
enum  ConnectionState { NotSupported , Connected , Disconnected }
 Current connection state of the Device. More...
 
enum  DiscoverFlags {
  FindAll = 0 , IncludeEmpty = 1 , IncludeInaccessible = 1 << 12 , IncludeMockTL = 1 << 13 ,
  UpToLevelSystem = 1 << 1 , UpToLevelVin = 2 << 1 , UpToLevelTL = 3 << 1 , UpToLevelInterface = 4 << 1 ,
  UpToLevelDevice = 5 << 1 , UpToLevelStream = 6 << 1 , IgnoreVins = 1 << 8 , IgnoreTLs = 1 << 9 ,
  IgnoreGevSD = 1 << 10 , IgnoreGevFD = 1 << 11
}
 Flags controlling the discovery process. More...
 
enum  AcquisitionStack { Vin , PreferVin , GenTL , PreferGenTL }
 The acquisition stack when opening the device. More...
 
enum  PixelDataType {
  Undefined , UInt , Int , Float ,
  ComplexPackedFloat
}
 Defines the numeric data type of one pixel. More...
 
enum  ColorModel {
  RGBGuess = -2 , MonoGuess = -1 , Unknown = 0 , Mono = 1 ,
  RGB = 2 , YUV = 3 , HSI = 4 , YCbCr = 5 ,
  CieLUV = 6 , CieLab = 7 , HLS = 8 , YCC = 9 ,
  HSV = 10 , CieXYZ = 11
}
 Color model that this image is using. More...
 
enum  MappingOption { CopyPixels , LinkPixels }
 Mapping options when creating a (potentially) mapped image More...
 
enum  RotationMap { By90Degrees = 1 , By180Degrees = 2 , By270Degrees = 3 }
 Amount of rotation to apply when mapping an image. More...
 
enum  HighBitScaleMode { Default = -1 , Global = 0 , ViewPort = 1 , WrapAround = 2 }
 Defines the mode that is being used for scaling high bit images (more than 8 bits per pixel) to an 8 bit display. More...
 
enum  ImageDataLockMode { ReadOnly = 1 , WriteOnly = 2 , ReadWrite = 3 }
 Specifies flags passed to the ImagePlane.GetLockedAccess method. More...
 
enum  OverlayBitDrawMode { Set , Erase }
 Specifies whether overlay bits are set or erased in the draw operation. More...
 
enum  PanoramaDirection { Horizontal = 0 , Vertical = 1 }
 Defines the direction of the panoramic image. More...
 
enum  PfncFormat {
  Mono1p = 0x01010037 , Mono2p = 0x01020038 , Mono4p = 0x01040039 , Mono8 = 0x01080001 ,
  Mono8s = 0x01080002 , Mono10 = 0x01100003 , Mono10p = 0x010A0046 , Mono12 = 0x01100005 ,
  Mono12p = 0x010C0047 , Mono14 = 0x01100025 , Mono16 = 0x01100007 , BayerBG8 = 0x0108000B ,
  BayerBG10 = 0x0110000F , BayerBG10p = 0x010A0052 , BayerBG12 = 0x01100013 , BayerBG12p = 0x010C0053 ,
  BayerBG16 = 0x01100031 , BayerGB8 = 0x0108000A , BayerGB10 = 0x0110000E , BayerGB10p = 0x010A0054 ,
  BayerGB12 = 0x01100012 , BayerGB12p = 0x010C0055 , BayerGB16 = 0x01100030 , BayerGR8 = 0x01080008 ,
  BayerGR10 = 0x0110000C , BayerGR10p = 0x010A0056 , BayerGR12 = 0x01100010 , BayerGR12p = 0x010C0057 ,
  BayerGR16 = 0x0110002E , BayerRG8 = 0x01080009 , BayerRG10 = 0x0110000D , BayerRG10p = 0x010A0058 ,
  BayerRG12 = 0x01100011 , BayerRG12p = 0x010C0059 , BayerRG16 = 0x0110002F , RGBa8 = 0x02200016 ,
  RGBa10 = 0x0240005F , RGBa10p = 0x02280060 , RGBa12 = 0x02400061 , RGBa12p = 0x02300062 ,
  RGBa14 = 0x02400063 , RGBa16 = 0x02400064 , RGB8 = 0x02180014 , RGB8_Planar = 0x02180021 ,
  RGB10 = 0x02300018 , RGB10_Planar = 0x02300022 , RGB10p = 0x021E005C , RGB10p32 = 0x0220001D ,
  RGB12 = 0x0230001A , RGB12_Planar = 0x02300023 , RGB12p = 0x0224005D , RGB14 = 0x0230005E ,
  RGB16 = 0x02300033 , RGB16_Planar = 0x02300024 , RGB565p = 0x02100035 , BGRa8 = 0x02200017 ,
  BGRa10 = 0x0240004C , BGRa10p = 0x0228004D , BGRa12 = 0x0240004E , BGRa12p = 0x0230004F ,
  BGRa14 = 0x02400050 , BGRa16 = 0x02400051 , BGR8 = 0x02180015 , BGR10 = 0x02300019 ,
  BGR10p = 0x021E0048 , BGR12 = 0x0230001B , BGR12p = 0x02240049 , BGR14 = 0x0230004A ,
  BGR16 = 0x0230004B , BGR565p = 0x02100036 , R8 = 0x010800C9 , R10 = 0x010A00CA ,
  R12 = 0x010C00CB , R16 = 0x011000CC , G8 = 0x010800CD , G10 = 0x010A00CE ,
  G12 = 0x010C00CF , G16 = 0x011000D0 , B8 = 0x010800D1 , B10 = 0x010A00D2 ,
  B12 = 0x010C00D3 , B16 = 0x011000D4 , Coord3D_ABC8 = 0x021800B2 , Coord3D_ABC8_Planar = 0x021800B3 ,
  Coord3D_ABC10p = 0x021E00DB , Coord3D_ABC10p_Planar = 0x021E00DC , Coord3D_ABC12p = 0x022400DE , Coord3D_ABC12p_Planar = 0x022400DF ,
  Coord3D_ABC16 = 0x023000B9 , Coord3D_ABC16_Planar = 0x023000BA , Coord3D_ABC32f = 0x026000C0 , Coord3D_ABC32f_Planar = 0x026000C1 ,
  Coord3D_AC8 = 0x021000B4 , Coord3D_AC8_Planar = 0x021000B5 , Coord3D_AC10p = 0x021400F0 , Coord3D_AC10p_Planar = 0x021400F1 ,
  Coord3D_AC12p = 0x021800F2 , Coord3D_AC12p_Planar = 0x021800F3 , Coord3D_AC16 = 0x022000BB , Coord3D_AC16_Planar = 0x022000BC ,
  Coord3D_AC32f = 0x024000C2 , Coord3D_AC32f_Planar = 0x024000C3 , Coord3D_A8 = 0x010800AF , Coord3D_A10p = 0x010A00D5 ,
  Coord3D_A12p = 0x010C00D8 , Coord3D_A16 = 0x011000B6 , Coord3D_A32f = 0x012000BD , Coord3D_B8 = 0x010800B0 ,
  Coord3D_B10p = 0x010A00D6 , Coord3D_B12p = 0x010C00D9 , Coord3D_B16 = 0x011000B7 , Coord3D_B32f = 0x012000BE ,
  Coord3D_C8 = 0x010800B1 , Coord3D_C10p = 0x010A00D7 , Coord3D_C12p = 0x010C00DA , Coord3D_C16 = 0x011000B8 ,
  Coord3D_C32f = 0x012000BF , Confidence1 = 0x010800C4 , Confidence1p = 0x010100C5 , Confidence8 = 0x010800C6 ,
  Confidence16 = 0x011000C7 , Confidence32f = 0x012000C8 , BiColorBGRG8 = 0x021000A6 , BiColorBGRG10 = 0x022000A9 ,
  BiColorBGRG10p = 0x021400AA , BiColorBGRG12 = 0x022000AD , BiColorBGRG12p = 0x021800AE , BiColorRGBG8 = 0x021000A5 ,
  BiColorRGBG10 = 0x022000A7 , BiColorRGBG10p = 0x021400A8 , BiColorRGBG12 = 0x022000AB , BiColorRGBG12p = 0x021800AC ,
  SCF1WBWG8 = 0x01080067 , SCF1WBWG10 = 0x01100068 , SCF1WBWG10p = 0x010A0069 , SCF1WBWG12 = 0x0110006A ,
  SCF1WBWG12p = 0x010C006B , SCF1WBWG14 = 0x0110006C , SCF1WBWG16 = 0x0110006D , SCF1WGWB8 = 0x0108006E ,
  SCF1WGWB10 = 0x0110006F , SCF1WGWB10p = 0x010A0070 , SCF1WGWB12 = 0x01100071 , SCF1WGWB12p = 0x010C0072 ,
  SCF1WGWB14 = 0x01100073 , SCF1WGWB16 = 0x01100074 , SCF1WGWR8 = 0x01080075 , SCF1WGWR10 = 0x01100076 ,
  SCF1WGWR10p = 0x010A0077 , SCF1WGWR12 = 0x01100078 , SCF1WGWR12p = 0x010C0079 , SCF1WGWR14 = 0x0110007A ,
  SCF1WGWR16 = 0x0110007B , SCF1WRWG8 = 0x0108007C , SCF1WRWG10 = 0x0110007D , SCF1WRWG10p = 0x010A007E ,
  SCF1WRWG12 = 0x0110007F , SCF1WRWG12p = 0x010C0080 , SCF1WRWG14 = 0x01100081 , SCF1WRWG16 = 0x01100082 ,
  YCbCr8 = 0x0218005B , YCbCr8_CbYCr = 0x0218003A , YCbCr10_CbYCr = 0x02300083 , YCbCr10p_CbYCr = 0x021E0084 ,
  YCbCr12_CbYCr = 0x02300085 , YCbCr12p_CbYCr = 0x02240086 , YCbCr411_8 = 0x020C005A , YCbCr411_8_CbYYCrYY = 0x020C003C ,
  YCbCr422_8 = 0x0210003B , YCbCr422_8_CbYCrY = 0x02100043 , YCbCr422_10 = 0x02200065 , YCbCr422_10_CbYCrY = 0x02200099 ,
  YCbCr422_10p = 0x02140087 , YCbCr422_10p_CbYCrY = 0x0214009A , YCbCr422_12 = 0x02200066 , YCbCr422_12_CbYCrY = 0x0220009B ,
  YCbCr422_12p = 0x02180088 , YCbCr422_12p_CbYCrY = 0x0218009C , YCbCr601_8_CbYCr = 0x0218003D , YCbCr601_10_CbYCr = 0x02300089 ,
  YCbCr601_10p_CbYCr = 0x021E008A , YCbCr601_12_CbYCr = 0x0230008B , YCbCr601_12p_CbYCr = 0x0224008C , YCbCr601_411_8_CbYYCrYY = 0x020C003F ,
  YCbCr601_422_8 = 0x0210003E , YCbCr601_422_8_CbYCrY = 0x02100044 , YCbCr601_422_10 = 0x0220008D , YCbCr601_422_10_CbYCrY = 0x0220009D ,
  YCbCr601_422_10p = 0x0214008E , YCbCr601_422_10p_CbYCrY = 0x0214009E , YCbCr601_422_12 = 0x0220008F , YCbCr601_422_12_CbYCrY = 0x0220009F ,
  YCbCr601_422_12p = 0x02180090 , YCbCr601_422_12p_CbYCrY = 0x021800A0 , YCbCr709_8_CbYCr = 0x02180040 , YCbCr709_10_CbYCr = 0x02300091 ,
  YCbCr709_10p_CbYCr = 0x021E0092 , YCbCr709_12_CbYCr = 0x02300093 , YCbCr709_12p_CbYCr = 0x02240094 , YCbCr709_411_8_CbYYCrYY = 0x020C0042 ,
  YCbCr709_422_8 = 0x02100041 , YCbCr709_422_8_CbYCrY = 0x02100045 , YCbCr709_422_10 = 0x02200095 , YCbCr709_422_10_CbYCrY = 0x022000A1 ,
  YCbCr709_422_10p = 0x02140096 , YCbCr709_422_10p_CbYCrY = 0x021400A2 , YCbCr709_422_12 = 0x02200097 , YCbCr709_422_12_CbYCrY = 0x022000A3 ,
  YCbCr709_422_12p = 0x02180098 , YCbCr709_422_12p_CbYCrY = 0x021800A4 , YCbCr2020_8_CbYCr = 0x021800F4 , YCbCr2020_10_CbYCr = 0x023000F5 ,
  YCbCr2020_10p_CbYCr = 0x021E00F6 , YCbCr2020_12_CbYCr = 0x023000F7 , YCbCr2020_12p_CbYCr = 0x022400F8 , YCbCr2020_411_8_CbYYCrYY = 0x020C00F9 ,
  YCbCr2020_422_8 = 0x021000FA , YCbCr2020_422_8_CbYCrY = 0x021000FB , YCbCr2020_422_10 = 0x022000FC , YCbCr2020_422_10_CbYCrY = 0x022000FD ,
  YCbCr2020_422_10p = 0x021400FE , YCbCr2020_422_10p_CbYCrY = 0x021400FF , YCbCr2020_422_12 = 0x02200100 , YCbCr2020_422_12_CbYCrY = 0x02200101 ,
  YCbCr2020_422_12p = 0x02180102 , YCbCr2020_422_12p_CbYCrY = 0x02180103 , YUV8_UYV = 0x02180020 , YUV411_8_UYYVYY = 0x020C001E ,
  YUV422_8 = 0x02100032 , YUV422_8_UYVY = 0x0210001F , Mono10Packed = 0x010C0004 , Mono12Packed = 0x010C0006 ,
  BayerBG10Packed = 0x010C0029 , BayerBG12Packed = 0x010C002D , BayerGB10Packed = 0x010C0028 , BayerGB12Packed = 0x010C002C ,
  BayerGR10Packed = 0x010C0026 , BayerGR12Packed = 0x010C002A , BayerRG10Packed = 0x010C0027 , BayerRG12Packed = 0x010C002B ,
  RGB10V1Packed = 0x0220001C , RGB12V1Packed = 0x02240034 , Custom = -2147483648 , InvalidPixelFormat = 0
}
 GenICam Pixel Format Naming Convention (PFNC) format values. More...
 
enum  PlaneRole {
  Undefined = -1 , PixMono = 0 , PixRGB_R , PixRGB_G ,
  PixRGB_B , PixYUV_Y , PixYUV_U , PixYUV_V ,
  PixHSV_H , PixHSV_S , PixHSV_V , PixLAB_L ,
  PixLAB_A , PixLAB_B , PixConfidence , PixRGB_RGB ,
  CoordCartesian_X = 0x1000 , CoordCartesian_Y , CoordCartesian_Z , CoordCartesian_W ,
  CoordPolar_Rho , CoordPolar_Phi , CoordCylindrical_Rho , CoordCylindrical_Phi ,
  CoordCylindrical_Z , CoordSpherical_Rho , CoordSpherical_Phi , CoordSpherical_Theta
}
 Role of a plane. More...
 
enum  PointCloudFlags {
  Float = 0 << 0 , Double = 1 << 0 , XYZ = 0 << 0 , XYZW = 1 << 5 ,
  XYZConfidence = 1 << 6 , WithConfidence = 1 << 12 , NoExtrinsinc = 1 << 24 , NoMeshIndices = 1 << 25
}
 Flags for creating PointClouds. More...
 
enum  PointCloudLayout {
  Invalid = 0 , Linear = 1 , SeparatePlanar = 2 , Planar = 3 ,
  Interleaved = 4
}
 Supported point cloud layouts. More...
 
enum  FileFormat {
  Ascii , Ply , Stl , WavefrontObj ,
  Tiff
}
 File format to store a point cloud in. More...
 
enum  GapFillingMethod { LinearInterpolation = 0 }
 Supported methods for GapFillingOptions. More...
 
enum  SensorPixelPosition { Absolute = 0 , Relative = 1 }
 Indicates pixel position on sensor. More...
 
enum  SensorPixelsMirrored { None = 0 , X = 1 , Y = 2 , XY = 3 }
 Indicates if sensor pixels are mirrored in rangemap. More...
 
enum  ConversionMode { Automatic }
 Mode used by conversion to dense point cloud. More...
 
enum  VpatRotation {
  Unknown = -1 , Rotation0 = 0 , Rotation90 = 1 , Rotation180 = 2 ,
  Rotation270 = 3
}
 Identifiers for discrete VPAT rotations More...
 
enum  VpatLayout { Confuse , LinearWithDataType , Linear , ReverseLinear }
 Defines diagnostic information about the contents a VPAT. More...
 

Functions

delegate void NativeHandleEventDelegate (INativeHandle sender)
 Delegate for the INativeHandle.ObjectDisposing event. More...
 
delegate void Movie2Error (IntPtr recorder, int errorcode, [MarshalAs(UnmanagedType.LPStr)] string errormessage, [MarshalAs(UnmanagedType.LPStr)] string errorlocation, IntPtr userdata)
 Error callback for the Movie2.dll More...
 
delegate void Movie2ImageSnapped (IntPtr recorder, IntPtr userdata)
 ImageSnapped callback for Movie2.dll More...
 
delegate void Movie2ImageUpdated (IntPtr recorder, IntPtr userdata)
 ImageUpdated callback for Movie2.dll More...
 
delegate void Movie2ProvideMetaData (IntPtr recorder, IntPtr stringbuffer, int buffersize, IntPtr userdata)
 Metadata callback for Movie2.dll More...
 

Enumeration Type Documentation

◆ AcquisitionStack

The acquisition stack when opening the device.

Enumerator
Vin 

Use vin acquisition stack or fail.

PreferVin 

Prefer to load the vin acquisition stack. If the vin stack cannot be loaded try opening the non-streamable device before failing.

GenTL 

Use GenTL acquisition stack or fail.

PreferGenTL 

Prefer the GenTL acquisition stack. If the GenTL stack cannot be loaded first try opening the vin stack, then try opening the non-streamable device before failing.

◆ ColorModel

enum ColorModel

Color model that this image is using.

Enumerator
RGBGuess 

Color space was not explicitly specified, but is likely to be RGB

MonoGuess 

Color space was not explicitly specified, but is likely to be monochrome

Unknown 

color space is not known

Mono 

monochrome "color" space

RGB 

RGB color space

YUV 

YUV color space

HSI 

HSI color space

YCbCr 

YCbCr color model

CieLUV 

CIE LUV color model

CieLab 

CIE Lab color model

HLS 

HLS (Hue, Lightness, Saturation) color model

YCC 

YCC color model

HSV 

HSV (Hue, Saturation, Value) color model

CieXYZ 

CIE XYZ color model

◆ CompositePurpose

Purpose of a Composite.

Enumerator
Custom 

Custom composite.

Image 

One image with extra data.

ImageList 

Multiple images grouped together.

MultiAoi 

Multiple images that represent multiple AOIs in one frame.

RangeMap 

A 2 1/2d image with extra data.

PointCloud 

3D data with possible extra data.

ImageCube 

A(n) (hyper spectral) image cube.

◆ ConnectionState

Current connection state of the Device.

Enumerator
NotSupported 

Connection state handling is not supported by the Device.

Connected 

The Device object is currently connected to the remote hardware.

Disconnected 

The Device object is currently disconnected from the remote hardware.

◆ ConversionMode

Mode used by conversion to dense point cloud.

Enumerator
Automatic 

Automatically determines resolution and which points to keep in the resulting dense point cloud.

◆ CoordinateSystemType

Enumeration of the different available coordinate systems that an Area of interest may be defined in.

Enumerator
PixelCoordinates 

Pixel coordinates are defined as follows:

  • The distance from one pixel to the next in horizontal or vertical direction has a length of 1
  • The origin (0,0) is located in the top left corner of the image
  • The positive x axis points right, the positive y axis points down
ImageCoordinates 

The image coordinate system is defined by the Image.CoordinateSystem property of the image and specifies an affine linear transformation from the pixel coordinate system to the image coordinate system. It is a right handed coordinate system: the positive y axis points "down", the positive x axis points right.

◆ DeviceUpdateMode

Defines how to treat the optional device image, when the device itself is updated.

A method containing this as a parameter indicates a Device.Handle change. This invalidates the old handle in a way that no IDeviceInterfaces are available anymore. The only thing remaining is the old ring buffer, but only with access to the last synchronized buffer.

If a method call containing this as a parameter succeeds it is necessary for the client application to update the Device.Handle in objects, that only use handle.

Enumerator
UpdateDeviceImage 

Updates the handle of any existing device image.

If unsure use this as the default.

The result of this operation is that the currently active device image is moved to the new device image internally. The result is that the current image buffer is lost and replaced by an empty/black buffer.

NewDeviceImage 

Creates a new device image keeping the old one intact.

Use this option if you still do processing on the old image data while performing the switch operation.

Attention: If you bound the old device image to a display or used it in another control to always access the current image data, keep in mind that you need to assign the new device image of the device manually.

◆ DiscoverFlags

Flags controlling the discovery process.

Enumerator
FindAll 

Default flags to find all devices and vin drivers.

IncludeEmpty 

Include also nodes which have no children.

You can use this for example to list all interfaces even if no devices are found on them.

IncludeInaccessible 

Normally inaccessible devices are filtered out: this flag includes them.

IncludeMockTL 

Normally inaccessible mockTL is not considered: this flag includes it.

UpToLevelSystem 

Limit discovery depth to system level (factory).

UpToLevelVin 

Limit discovery depth to vin driver level.

UpToLevelTL 

Limit discovery depth to transport library level.

UpToLevelInterface 

Limit discovery depth to interface library level.

UpToLevelDevice 

Limit discovery depth to device level.

UpToLevelStream 

Limit discovery depth to stream level.

IgnoreVins 

Ignore vin drivers in discovery.

IgnoreTLs 

Ignore GenTL producers in discovery.

IgnoreGevSD 

Ignore socket driver for GEVTL GenTL Producer.

IgnoreGevFD 

Ignore filter driver for GEVTL GenTL Producer.

◆ FileFormat

enum FileFormat

File format to store a point cloud in.

Enumerator
Ascii 

ASCII text file with each point in one row.

Ply 

PLY format for storing sparse point clouds and meshes.

Stl 

STL format for storing sparse point clouds and meshes.

WavefrontObj 

OBJ format for storing sparse point clouds and meshes.

Tiff 

Custom TIFF format for storing sparse and dense point clouds.

◆ GapFillingMethod

Supported methods for GapFillingOptions.

Enumerator
LinearInterpolation 

Gaps in a range map are filled by linear interpolation.

◆ HighBitScaleMode

Defines the mode that is being used for scaling high bit images (more than 8 bits per pixel) to an 8 bit display.

Enumerator
Default 

Default treatment applies the mode Global to 8 bit images and the mode ViewPort otherwise.

Global 

Apply global scaling (i.e. use the global maximum and minimum value of the source data type to scale to 8 bits). This mode cannot be used on images with floating point valued pixels; if an image with floating point pixels is encountered, the ViewPort mode will be used instead.

ViewPort 

Scale according to the local view port: The view port is being searched for the minimum and maximum pixel value, and the pixel values that are currently visible (i.e. inside the view port) will be scaled to the full range of 0...255.

WrapAround 

Display images with > 8 bits per pixel by limiting the display to the lowest 8 bits. This is not a particularly beautiful display mode for high bit images because it will show extreme contrasts where that 8 bit wrap around happens, but it used to be the only display mode in the CVB display.

◆ ImageDataLockMode

Specifies flags passed to the ImagePlane.GetLockedAccess method.

Enumerator
ReadOnly 

The image is locked for reading.

WriteOnly 

The image is locked for writing.

ReadWrite 

The image is locked for reading or writing.

◆ MappingOption

Mapping options when creating a (potentially) mapped image

Enumerator
CopyPixels 

Create a deep copy of the source pixels

LinkPixels 

Create a linked copy of the source pixels that shares the memory of the source pixels i.e. changes to one image affect the linked image as well

◆ MonochromeConversion

Options for converting to monochrome.

Enumerator
EqualWeights 

give equal weights to red, green and blue while converting

PerceptiveWeights 

weigh the red green and blue channel with values that resemble human perception

◆ Neighborhood

Neighborhood to use in sub pixel calculation of local maxima. The bigger the neighborhood for calculation is, the longer the sub pixel fit will take.

Enumerator
Use3x3 

3x3 environment around the pixel-accurate result.

Use5x5 

5x5 environment around the pixel-accurate result.

Use7x7 

7x7 environment around the pixel-accurate result.

Use9x9 

9x9 environment around the pixel-accurate result.

◆ OverlayBitDrawMode

Specifies whether overlay bits are set or erased in the draw operation.

Enumerator
Set 

Draw operation sets overlay bits.

Erase 

Draw operation erases overlay bits.

◆ PanoramaDirection

Defines the direction of the panoramic image.

Enumerator
Horizontal 

Images are stitch horizontally.

Vertical 

Images are stitched vertically.

◆ PfncFormat

enum PfncFormat

GenICam Pixel Format Naming Convention (PFNC) format values.

Enumerator
Mono1p 

Monochrome 1-bit packed.

Mono2p 

Monochrome 2-bit packed.

Mono4p 

Monochrome 4-bit packed.

Mono8 

Monochrome 8-bit.

Mono8s 

Monochrome 8-bit signed.

Mono10 

Monochrome 10-bit unpacked.

Mono10p 

Monochrome 10-bit packed.

Mono12 

Monochrome 12-bit unpacked.

Mono12p 

Monochrome 12-bit packed.

Mono14 

Monochrome 14-bit unpacked.

Mono16 

Monochrome 16-bit.

BayerBG8 

Bayer Blue-Green 8-bit.

BayerBG10 

Bayer Blue-Green 10-bit unpacked.

BayerBG10p 

Bayer Blue-Green 10-bit packed.

BayerBG12 

Bayer Blue-Green 12-bit unpacked.

BayerBG12p 

Bayer Blue-Green 12-bit packed.

BayerBG16 

Bayer Blue-Green 16-bit.

BayerGB8 

Bayer Green-Blue 8-bit.

BayerGB10 

Bayer Green-Blue 10-bit unpacked.

BayerGB10p 

Bayer Green-Blue 10-bit packed.

BayerGB12 

Bayer Green-Blue 12-bit unpacked.

BayerGB12p 

Bayer Green-Blue 12-bit packed.

BayerGB16 

Bayer Green-Blue 16-bit.

BayerGR8 

Bayer Green-Red 8-bit.

BayerGR10 

Bayer Green-Red 10-bit unpacked.

BayerGR10p 

Bayer Green-Red 10-bit packed.

BayerGR12 

Bayer Green-Red 12-bit unpacked.

BayerGR12p 

Bayer Green-Red 12-bit packed.

BayerGR16 

Bayer Green-Red 16-bit,

BayerRG8 

Bayer Red-Green 8-bit.

BayerRG10 

Bayer Red-Green 10-bit unpacked.

BayerRG10p 

Bayer Red-Green 10-bit packed.

BayerRG12 

Bayer Red-Green 12-bit unpacked.

BayerRG12p 

Bayer Red-Green 12-bit packed.

BayerRG16 

Bayer Red-Green 16-bit.

RGBa8 

Red-Green-Blue-alpha 8-bit.

RGBa10 

Red-Green-Blue-alpha 10-bit unpacked.

RGBa10p 

Red-Green-Blue-alpha 10-bit packed.

RGBa12 

Red-Green-Blue-alpha 12-bit unpacked.

RGBa12p 

Red-Green-Blue-alpha 12-bit packed.

RGBa14 

Red-Green-Blue-alpha 14-bit unpacked.

RGBa16 

Red-Green-Blue-alpha 16-bit.

RGB8 

Red-Green-Blue 8-bit.

RGB8_Planar 

Red-Green-Blue 8-bit planar.

RGB10 

Red-Green-Blue 10-bit unpacked.

RGB10_Planar 

Red-Green-Blue 10-bit unpacked planar.

RGB10p 

Red-Green-Blue 10-bit packed.

RGB10p32 

Red-Green-Blue 10-bit packed into 32-bit.

RGB12 

Red-Green-Blue 12-bit unpacked.

RGB12_Planar 

Red-Green-Blue 12-bit unpacked planar.

RGB12p 

Red-Green-Blue 12-bit packed.

RGB14 

Red-Green-Blue 14-bit unpacked.

RGB16 

Red-Green-Blue 16-bit.

RGB16_Planar 

Red-Green-Blue 16-bit planar.

RGB565p 

Red-Green-Blue 5/6/5-bit packed.

BGRa8 

Blue-Green-Red-alpha 8-bit.

BGRa10 

Blue-Green-Red-alpha 10-bit unpacked.

BGRa10p 

Blue-Green-Red-alpha 10-bit packed.

BGRa12 

Blue-Green-Red-alpha 12-bit unpacked.

BGRa12p 

Blue-Green-Red-alpha 12-bit packed.

BGRa14 

Blue-Green-Red-alpha 14-bit unpacked.

BGRa16 

Blue-Green-Red-alpha 16-bit.

BGR8 

Blue-Green-Red 8-bit.

BGR10 

Blue-Green-Red 10-bit unpacked.

BGR10p 

Blue-Green-Red 10-bit packed.

BGR12 

Blue-Green-Red 12-bit unpacked.

BGR12p 

Blue-Green-Red 12-bit packed.

BGR14 

Blue-Green-Red 14-bit unpacked.

BGR16 

Blue-Green-Red 16-bit.

BGR565p 

Blue-Green-Red 5/6/5-bit packed.

R8 

Red 8-bit.

R10 

Red 10-bit.

R12 

Red 12-bit.

R16 

Red 16-bit.

G8 

Green 8-bit.

G10 

Green 10-bit.

G12 

Green 12-bit.

G16 

Green 16-bit.

B8 

Blue 8-bit.

B10 

Blue 10-bit.

B12 

Blue 12-bit.

B16 

Blue 16-bit.

Coord3D_ABC8 

3D coordinate A-B-C 8-bit.

Coord3D_ABC8_Planar 

3D coordinate A-B-C 8-bit planar.

Coord3D_ABC10p 

3D coordinate A-B-C 10-bit packed.

Coord3D_ABC10p_Planar 

3D coordinate A-B-C 10-bit packed planar.

Coord3D_ABC12p 

3D coordinate A-B-C 12-bit packed.

Coord3D_ABC12p_Planar 

3D coordinate A-B-C 12-bit packed planar.

Coord3D_ABC16 

3D coordinate A-B-C 16-bit.

Coord3D_ABC16_Planar 

3D coordinate A-B-C 16-bit planar.

Coord3D_ABC32f 

3D coordinate A-B-C 32-bit floating point.

Coord3D_ABC32f_Planar 

3D coordinate A-B-C 32-bit floating point planar.

Coord3D_AC8 

3D coordinate A-C 8-bit.

Coord3D_AC8_Planar 

3D coordinate A-C 8-bit planar.

Coord3D_AC10p 

3D coordinate A-C 10-bit packed.

Coord3D_AC10p_Planar 

3D coordinate A-C 10-bit packed planar.

Coord3D_AC12p 

3D coordinate A-C 12-bit packed.

Coord3D_AC12p_Planar 

3D coordinate A-C 12-bit packed planar.

Coord3D_AC16 

3D coordinate A-C 16-bit.

Coord3D_AC16_Planar 

3D coordinate A-C 16-bit planar.

Coord3D_AC32f 

3D coordinate A-C 32-bit floating point.

Coord3D_AC32f_Planar 

3D coordinate A-C 32-bit floating point planar.

Coord3D_A8 

3D coordinate A 8-bit.

Coord3D_A10p 

3D coordinate A 10-bit packed.

Coord3D_A12p 

3D coordinate A 12-bit packed.

Coord3D_A16 

3D coordinate A 16-bit.

Coord3D_A32f 

3D coordinate A 32-bit floating point.

Coord3D_B8 

3D coordinate B 8-bit.

Coord3D_B10p 

3D coordinate B 10-bit packed.

Coord3D_B12p 

3D coordinate B 12-bit packed.

Coord3D_B16 

3D coordinate B 16-bit.

Coord3D_B32f 

3D coordinate B 32-bit floating point.

Coord3D_C8 

3D coordinate C 8-bit.

Coord3D_C10p 

3D coordinate C 10-bit packed.

Coord3D_C12p 

3D coordinate C 12-bit packed.

Coord3D_C16 

3D coordinate C 16-bit.

Coord3D_C32f 

3D coordinate C 32-bit floating point.

Confidence1 

Confidence 1-bit unpacked.

Confidence1p 

Confidence 1-bit packed.

Confidence8 

Confidence 8-bit.

Confidence16 

Confidence 16-bit.

Confidence32f 

Confidence 32-bit floating point.

BiColorBGRG8 

Bi-color Blue/Green - Red/Green 8-bit.

BiColorBGRG10 

Bi-color Blue/Green - Red/Green 10-bit unpacked.

BiColorBGRG10p 

Bi-color Blue/Green - Red/Green 10-bit packed.

BiColorBGRG12 

Bi-color Blue/Green - Red/Green 12-bit unpacked.

BiColorBGRG12p 

Bi-color Blue/Green - Red/Green 12-bit packed.

BiColorRGBG8 

Bi-color Red/Green - Blue/Green 8-bit.

BiColorRGBG10 

Bi-color Red/Green - Blue/Green 10-bit unpacked.

BiColorRGBG10p 

Bi-color Red/Green - Blue/Green 10-bit packed.

BiColorRGBG12 

Bi-color Red/Green - Blue/Green 12-bit unpacked.

BiColorRGBG12p 

Bi-color Red/Green - Blue/Green 12-bit packed.

SCF1WBWG8 

Sparse Color Filter #1 White-Blue-White-Green 8-bit.

SCF1WBWG10 

Sparse Color Filter #1 White-Blue-White-Green 10-bit unpacked.

SCF1WBWG10p 

Sparse Color Filter #1 White-Blue-White-Green 10-bit packed.

SCF1WBWG12 

Sparse Color Filter #1 White-Blue-White-Green 12-bit unpacked.

SCF1WBWG12p 

Sparse Color Filter #1 White-Blue-White-Green 12-bit packed.

SCF1WBWG14 

Sparse Color Filter #1 White-Blue-White-Green 14-bit unpacked.

SCF1WBWG16 

Sparse Color Filter #1 White-Blue-White-Green 16-bit unpacked.

SCF1WGWB8 

Sparse Color Filter #1 White-Green-White-Blue 8-bit.

SCF1WGWB10 

Sparse Color Filter #1 White-Green-White-Blue 10-bit unpacked.

SCF1WGWB10p 

Sparse Color Filter #1 White-Green-White-Blue 10-bit packed.

SCF1WGWB12 

Sparse Color Filter #1 White-Green-White-Blue 12-bit unpacked.

SCF1WGWB12p 

Sparse Color Filter #1 White-Green-White-Blue 12-bit packed.

SCF1WGWB14 

Sparse Color Filter #1 White-Green-White-Blue 14-bit unpacked.

SCF1WGWB16 

Sparse Color Filter #1 White-Green-White-Blue 16-bit.

SCF1WGWR8 

Sparse Color Filter #1 White-Green-White-Red 8-bit.

SCF1WGWR10 

Sparse Color Filter #1 White-Green-White-Red 10-bit unpacked.

SCF1WGWR10p 

Sparse Color Filter #1 White-Green-White-Red 10-bit packed.

SCF1WGWR12 

Sparse Color Filter #1 White-Green-White-Red 12-bit unpacked.

SCF1WGWR12p 

Sparse Color Filter #1 White-Green-White-Red 12-bit packed.

SCF1WGWR14 

Sparse Color Filter #1 White-Green-White-Red 14-bit unpacked.

SCF1WGWR16 

Sparse Color Filter #1 White-Green-White-Red 16-bit.

SCF1WRWG8 

Sparse Color Filter #1 White-Red-White-Green 8-bit.

SCF1WRWG10 

Sparse Color Filter #1 White-Red-White-Green 10-bit unpacked.

SCF1WRWG10p 

Sparse Color Filter #1 White-Red-White-Green 10-bit packed.

SCF1WRWG12 

Sparse Color Filter #1 White-Red-White-Green 12-bit unpacked.

SCF1WRWG12p 

Sparse Color Filter #1 White-Red-White-Green 12-bit packed.

SCF1WRWG14 

Sparse Color Filter #1 White-Red-White-Green 14-bit unpacked.

SCF1WRWG16 

Sparse Color Filter #1 White-Red-White-Green 16-bit.

YCbCr8 

YCbCr 4:4:4 8-bit.

YCbCr8_CbYCr 

YCbCr 4:4:4 8-bit.

YCbCr10_CbYCr 

YCbCr 4:4:4 10-bit unpacked.

YCbCr10p_CbYCr 

YCbCr 4:4:4 10-bit packed.

YCbCr12_CbYCr 

YCbCr 4:4:4 12-bit unpacked.

YCbCr12p_CbYCr 

YCbCr 4:4:4 12-bit packed.

YCbCr411_8 

YCbCr 4:1:1 8-bit.

YCbCr411_8_CbYYCrYY 

YCbCr 4:1:1 8-bit.

YCbCr422_8 

YCbCr 4:2:2 8-bit.

YCbCr422_8_CbYCrY 

YCbCr 4:2:2 8-bit.

YCbCr422_10 

YCbCr 4:2:2 10-bit unpacked.

YCbCr422_10_CbYCrY 

YCbCr 4:2:2 10-bit unpacked.

YCbCr422_10p 

YCbCr 4:2:2 10-bit packed.

YCbCr422_10p_CbYCrY 

YCbCr 4:2:2 10-bit packed.

YCbCr422_12 

YCbCr 4:2:2 12-bit unpacked.

YCbCr422_12_CbYCrY 

YCbCr 4:2:2 12-bit unpacked.

YCbCr422_12p 

YCbCr 4:2:2 12-bit packed.

YCbCr422_12p_CbYCrY 

YCbCr 4:2:2 12-bit packed.

YCbCr601_8_CbYCr 

YCbCr 4:4:4 8-bit BT.601.

YCbCr601_10_CbYCr 

YCbCr 4:4:4 10-bit unpacked BT.601.

YCbCr601_10p_CbYCr 

YCbCr 4:4:4 10-bit packed BT.601.

YCbCr601_12_CbYCr 

YCbCr 4:4:4 12-bit unpacked BT.601.

YCbCr601_12p_CbYCr 

YCbCr 4:4:4 12-bit packed BT.601.

YCbCr601_411_8_CbYYCrYY 

YCbCr 4:1:1 8-bit BT.601.

YCbCr601_422_8 

YCbCr 4:2:2 8-bit BT.601.

YCbCr601_422_8_CbYCrY 

YCbCr 4:2:2 8-bit BT.601.

YCbCr601_422_10 

YCbCr 4:2:2 10-bit unpacked BT.601.

YCbCr601_422_10_CbYCrY 

YCbCr 4:2:2 10-bit unpacked BT.601.

YCbCr601_422_10p 

YCbCr 4:2:2 10-bit packed BT.601.

YCbCr601_422_10p_CbYCrY 

YCbCr 4:2:2 10-bit packed BT.601.

YCbCr601_422_12 

YCbCr 4:2:2 12-bit unpacked BT.601.

YCbCr601_422_12_CbYCrY 

YCbCr 4:2:2 12-bit unpacked BT.601.

YCbCr601_422_12p 

YCbCr 4:2:2 12-bit packed BT.601.

YCbCr601_422_12p_CbYCrY 

YCbCr 4:2:2 12-bit packed BT.601.

YCbCr709_8_CbYCr 

YCbCr 4:4:4 8-bit BT.709.

YCbCr709_10_CbYCr 

YCbCr 4:4:4 10-bit unpacked BT.709.

YCbCr709_10p_CbYCr 

YCbCr 4:4:4 10-bit packed BT.709.

YCbCr709_12_CbYCr 

YCbCr 4:4:4 12-bit unpacked BT.709.

YCbCr709_12p_CbYCr 

YCbCr 4:4:4 12-bit packed BT.709.

YCbCr709_411_8_CbYYCrYY 

YCbCr 4:1:1 8-bit BT.709.

YCbCr709_422_8 

YCbCr 4:2:2 8-bit BT.709.

YCbCr709_422_8_CbYCrY 

YCbCr 4:2:2 8-bit BT.709.

YCbCr709_422_10 

YCbCr 4:2:2 10-bit unpacked BT.709.

YCbCr709_422_10_CbYCrY 

YCbCr 4:2:2 10-bit unpacked BT.709.

YCbCr709_422_10p 

YCbCr 4:2:2 10-bit packed BT.709.

YCbCr709_422_10p_CbYCrY 

YCbCr 4:2:2 10-bit packed BT.709.

YCbCr709_422_12 

YCbCr 4:2:2 12-bit unpacked BT.709.

YCbCr709_422_12_CbYCrY 

YCbCr 4:2:2 12-bit unpacked BT.709.

YCbCr709_422_12p 

YCbCr 4:2:2 12-bit packed BT.709.

YCbCr709_422_12p_CbYCrY 

YCbCr 4:2:2 12-bit packed BT.709.

YCbCr2020_8_CbYCr 

YCbCr 4:4:4 8-bit BT.2020.

YCbCr2020_10_CbYCr 

YCbCr 4:4:4 10-bit unpacked BT.2020.

YCbCr2020_10p_CbYCr 

YCbCr 4:4:4 10-bit packed BT.2020.

YCbCr2020_12_CbYCr 

YCbCr 4:4:4 12-bit unpacked BT.2020.

YCbCr2020_12p_CbYCr 

YCbCr 4:4:4 12-bit packed BT.2020.

YCbCr2020_411_8_CbYYCrYY 

YCbCr 4:1:1 8-bit BT.2020.

YCbCr2020_422_8 

YCbCr 4:2:2 8-bit BT.2020.

YCbCr2020_422_8_CbYCrY 

YCbCr 4:2:2 8-bit BT.2020.

YCbCr2020_422_10 

YCbCr 4:2:2 10-bit unpacked BT.2020.

YCbCr2020_422_10_CbYCrY 

YCbCr 4:2:2 10-bit unpacked BT.2020.

YCbCr2020_422_10p 

YCbCr 4:2:2 10-bit packed BT.2020.

YCbCr2020_422_10p_CbYCrY 

YCbCr 4:2:2 10-bit packed BT.2020.

YCbCr2020_422_12 

YCbCr 4:2:2 12-bit unpacked BT.2020.

YCbCr2020_422_12_CbYCrY 

YCbCr 4:2:2 12-bit unpacked BT.2020.

YCbCr2020_422_12p 

YCbCr 4:2:2 12-bit packed BT.2020.

YCbCr2020_422_12p_CbYCrY 

YCbCr 4:2:2 12-bit packed BT.2020.

YUV8_UYV 

YUV 4:4:4 8-bit.

YUV411_8_UYYVYY 

YUV 4:1:1 8-bit.

YUV422_8 

YUV 4:2:2 8-bit.

YUV422_8_UYVY 

YUV 4:2:2 8-bit.

Mono10Packed 

GigE Vision specific format, Monochrome 10-bit packed.

Mono12Packed 

GigE Vision specific format, Monochrome 12-bit packed.

BayerBG10Packed 

GigE Vision specific format, Bayer Blue-Green 10-bit packed.

BayerBG12Packed 

GigE Vision specific format, Bayer Blue-Green 12-bit packed.

BayerGB10Packed 

GigE Vision specific format, Bayer Green-Blue 10-bit packed.

BayerGB12Packed 

GigE Vision specific format, Bayer Green-Blue 12-bit packed.

BayerGR10Packed 

GigE Vision specific format, Bayer Green-Red 10-bit packed.

BayerGR12Packed 

GigE Vision specific format, Bayer Green-Red 12-bit packed.

BayerRG10Packed 

GigE Vision specific format, Bayer Red-Green 10-bit packed.

BayerRG12Packed 

GigE Vision specific format, Bayer Red-Green 12-bit packed.

RGB10V1Packed 

GigE Vision specific format, Red-Green-Blue 10-bit packed - variant 1.

RGB12V1Packed 

GigE Vision specific format, Red-Green-Blue 12-bit packed - variant 1.

Custom 

Start number for custom pixel formats.

InvalidPixelFormat 

Invalid pixel format.

◆ PixelDataType

Defines the numeric data type of one pixel.

Enumerator
Undefined 

Indeterminable data type. (Mostly here because the native CVB data type descriptor can take all sorts of weird values).

UInt 

Unsigned integer.

Positive integer numbers including zero.

Int 

Signed integer.

Positive and negative integer numbers including zero.

Float 

Floating point number.

Real numbers.

ComplexPackedFloat 

Complex packed floating point number.

◆ PlaneRole

enum PlaneRole

Role of a plane.

Roles describe the component role a plane aggregates.

Enumerator
Undefined 

Undefined role; for initialization only.

PixMono 

Monochrome or lightness plane.

PixRGB_R 

Red plane of an RGB image.

PixRGB_G 

Green plane of an RGB image.

PixRGB_B 

Blue plane of an RGB image.

PixYUV_Y 

Y plane of a YUV image.

PixYUV_U 

U plane of a YUV image.

PixYUV_V 

V plane of a YUV image.

PixHSV_H 

Hue plane of an HSV image.

PixHSV_S 

Saturation plane of an HSV image.

PixHSV_V 

Value plane of an HSV image.

PixLAB_L 

Lightness plane of a LAB image.

PixLAB_A 

A plane of a LAB image.

PixLAB_B 

B plane of a LAB image.

PixConfidence 

Confidence plane of a point cloud.

Normally in the range 0f 0 to 1. Where 0 means no point and 1 means 100% a point.

PixRGB_RGB 

Red-green-blue plane of an RGB image.

CoordCartesian_X 

X component of a XYZ point cloud.

CoordCartesian_Y 

Y component of a XYZ point cloud.

CoordCartesian_Z 

Z component of a XYZ point cloud.

CoordCartesian_W 

W component of a XYZ point cloud.

CoordPolar_Rho 

Rho component of a polar point cloud.

CoordPolar_Phi 

Phi component of a polar point cloud.

CoordCylindrical_Rho 

Rho component of a cylindrical point cloud.

CoordCylindrical_Phi 

Phi component of a cylindrical point cloud.

CoordCylindrical_Z 

Z component of a cylindrical point cloud.

CoordSpherical_Rho 

Rho component of a spherical point cloud.

CoordSpherical_Phi 

Phi component of a spherical point cloud.

CoordSpherical_Theta 

Theta component of a spherical point cloud.

◆ PointCloudFlags

Flags for creating PointClouds.

Enumerator
Float 

Create the point cloud with float components.

Double 

Create the point cloud with double components.

XYZ 

Create the point cloud with three Cartesian components (x, y, z).

XYZW 

Create the point cloud with four Cartesian, homogeneous components (x, y, z, w).

XYZConfidence 

Create point cloud with three Cartesian components (x, y, z) and a confidence plane.

WithConfidence 

Create the point cloud with an additional confidence plane.

NoExtrinsinc 

Only apply intrinsic calibration in Calibrator3D.CreatePointCloud(Image, PointCloudFlags).

NoMeshIndices 

Do not use directly: use PointCloud.FromFile(string) to not load mesh information.

◆ PointCloudLayout

Supported point cloud layouts.

Enumerator
Invalid 

No known / supported point cloud format.

Linear 

No known buffer layout. For this layout only the plane roles X, Y and Z are known with their increments. Thus the PointCloud composite either has no buffer or no buffer that can be mapped via a PFNC value.

SeparatePlanar 

Each plane is in its own, contiguous buffer. For each plane role X, Y and Z exists one distinct buffer. Increment to the next element is element sized as in a simple array. If the component data types are float, the composite has at least three buffers with PFNC values Coord3D_A32f, Coord3D_B32f and Coord3D_C32f.

Planar 

All planes are in one planar, contiguous buffer. All plane roles X, Y and Z lay component wise one after the other. First all x, then all y and finally all z components. If the component data type is float, the composite has at least one buffer with a PFNC value of Coord3D_ABC32f_Planar.

Interleaved 

All points are stored x,y,z interleaved as in Point3D. All plane roles X, Y and Z lay point wise one after the other. If the component data type is float, the composite has at least one buffer with a PFNC value of Coord3D_ABC32f.

◆ RotationMap

Amount of rotation to apply when mapping an image.

Enumerator
By90Degrees 

Image will be rotated by 90 degrees.

By180Degrees 

Image will be rotated by 180 degrees.

By270Degrees 

Image will be rotated by 270 degrees.

◆ SensorPixelPosition

Indicates pixel position on sensor.

Enumerator
Absolute 

Scaled rangemap values represent absolute pixel position on sensor.

Relative 

Scaled rangemap values represent relative pixel position to given offset on sensor.

◆ SensorPixelsMirrored

Indicates if sensor pixels are mirrored in rangemap.

Enumerator
None 

No mirroring is applied.

Sensor pixel values are mirrored in X (or denoted by u), so that the columns of the range map will be flipped.

Sensor pixel values are mirrored in Y (or denoted by v), so that the range map pixel values will be flipped.

XY 

Sensor pixel values are mirrored in X and Y.

◆ SubPixelMode

Method for determining sub pixel accuracy when working with the FindLocalMaxima functions.

Enumerator
ParabolicFast 

An approximate parabolic fit. Results similar to the exact parabolic fit as long as the maximum is steep enough (i.e. not plateau shaped). Only usable with a 3x3 neighborhood.

ParabolicAccurate 

A full parabolic least squares fit.

Gaussian 

A Gaussian least squares fit.

◆ TriggerState

The current state of the Device.TriggerMode property.

Enumerator
NotSupported 

Configuring the trigger is not supported by this device.

Unknown 

Trigger state is unknown (device/configuration dependent).

This is the default for a newly created device which supports the ITrigger interface.

Off 

Trigger is disabled (camera is in free-run).

On 

Trigger is enabled (either hardware or software dependent on configuration).

◆ VpatLayout

enum VpatLayout

Defines diagnostic information about the contents a VPAT.

Enumerator
Confuse 

VPAT is mixed up, increments are not linearly arranged.

LinearWithDataType 

VPAT is linear and uses an increment that matches the data type of the image.

That means the delta from one pixel to the next in x direction is exactly the number of bytes occupied by one pixel or the delta from one pixel to the next in y direcction is exactly width * bytes per pixel). Note that this will never be the case for interleaved multi planar images.

Linear 

The VPAT has linear arrangement.

ReverseLinear 

The VPAT has linear arrangement and a negative increment.

◆ VpatRotation

Identifiers for discrete VPAT rotations

VPAT rotation may be switched on or off for many drivers in their ini-file.

Enumerator
Unknown 

VPAT is irregular, so it is impossible to tell the rotation.

Rotation0 

VPAT represents an image without rotation.

Rotation90 

VPAT represents an image that has been rotated by 90° counter clockwise.

Rotation180 

VPAT represents an image that has been rotated by 180° counter clockwise.

Rotation270 

VPAT represents an image that has been rotated by 270° counter clockwise.

Function Documentation

◆ Movie2Error()

delegate void Movie2Error ( IntPtr  recorder,
int  errorcode,
[MarshalAs(UnmanagedType.LPStr)] string  errormessage,
[MarshalAs(UnmanagedType.LPStr)] string  errorlocation,
IntPtr  userdata 
)

Error callback for the Movie2.dll

Parameters
recorderrecorder object for which the callback has been invoked
errorcodeerror that occurred
errormessageerror message
errorlocationadditional error information
userdataprivate data pointer

◆ Movie2ImageSnapped()

delegate void Movie2ImageSnapped ( IntPtr  recorder,
IntPtr  userdata 
)

ImageSnapped callback for Movie2.dll

Parameters
recorderrecorder on which an image has been snapped
userdataprivate data pointer

◆ Movie2ImageUpdated()

delegate void Movie2ImageUpdated ( IntPtr  recorder,
IntPtr  userdata 
)

ImageUpdated callback for Movie2.dll

Parameters
recorderrecorder on which an image has been updated
userdataprivate data pointer

◆ Movie2ProvideMetaData()

delegate void Movie2ProvideMetaData ( IntPtr  recorder,
IntPtr  stringbuffer,
int  buffersize,
IntPtr  userdata 
)

Metadata callback for Movie2.dll

Parameters
recorderrecorder on which meta data are required
stringbufferstring buffer to be filled with the meta data
buffersizesize of the string buffer
userdataprivate data pointer

◆ NativeHandleEventDelegate()

delegate void NativeHandleEventDelegate ( INativeHandle  sender)

Delegate for the INativeHandle.ObjectDisposing event.

Parameters
senderObject which raised the event.