All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
Pylon Namespace Reference

Contains definitions of pylon types. More...

Namespaces

 Key
 This namespace contains keys for accessing the properties of pylon info objects.
 

Classes

class  CAcquireContinuousConfiguration
 Changes the configuration of the camera to free-running continuous acquisition. More...
 
class  CAcquireSingleFrameConfiguration
 An instant camera configuration for single frame acquisition, Use together with CInstantCamera::GrabOne() only. More...
 
class  IBufferFactory
 Usable to create a custom buffer factory when needed. More...
 
class  CCameraEventHandler
 The camera event handler base class. More...
 
interface  IChunkParser
 Low Level API: The interface for chunk parsers analyzing a data stream consisting of chunks. More...
 
interface  ISelfReliantChunkParser
 Low Level API: Interface for chunk parsers with an own chunk data node map attached. More...
 
class  CChunkParser
 Low Level API: Base class for chunk parsers returned by camera objects. More...
 
class  CConfigurationEventHandler
 The configuration event handler base class. More...
 
class  TList
 STL std::vector like container class. More...
 
class  DeviceInfoList
 STL std::vector like container for Pylon::CDeviceInfo objects. More...
 
class  TlInfoList
 STL std::vector like container for Pylon::CTlInfo objects. More...
 
class  InterfaceInfoList
 STL std::vector like container for Pylon::CInterfaceInfo objects. More...
 
interface  IDevice
 Low Level API: The interface implemented by all device objects. More...
 
interface  IPylonDevice
 Low Level API: Interface for camera objects. More...
 
class  AccessModeSet
 Collection of access mode bits. More...
 
interface  IDeviceFactory
 Interface to be implemented by device factories used to create devices. More...
 
class  CDeviceInfo
 Holds information about an enumerated device. More...
 
interface  IEventAdapter
 Low Level API: IEventAdapter delivers event messages to ports. More...
 
interface  IEventGrabber
 Low Level API: Interface of an object receiving asynchronous events. More...
 
class  CEventGrabberProxyT
 Low Level API: The event grabber class with parameter access methods. More...
 
class  CFeaturePersistence
 Utility class for saving and restoring camera features to and from a file or string. More...
 
class  CGrabResultData
 Makes the data for one grabbed buffer available. More...
 
class  CGrabResultPtr
 A smart pointer holding a reference to grab result data. More...
 
interface  IImage
 Usable to access image properties and image buffer. More...
 
class  CImageEventHandler
 The image event handler base class. More...
 
class  CImageFormatConverter
 Creates new images by converting a source image to another format. More...
 
class  CImagePersistenceOptions
 Used to pass options to CImagePersistence methods. More...
 
class  CImagePersistence
 Contains static functions supporting loading and saving of images. More...
 
interface  IProperties
 interface for a property container More...
 
class  CInfoBase
 Base implementation for PYLON info container. More...
 
class  CInstantCamera
 Provides convenient access to a camera device. More...
 
class  CInstantCameraArray
 Supports grabbing with multiple camera devices. More...
 
class  CInterfaceInfo
 Class used for storing information about an interface object provided by a transport layer. More...
 
class  CNodeMapProxyT
 Implementation Detail: This class wraps programming interfaces that are generated from GenICam parameter description files to provide native parameter access. More...
 
struct  SBGRA8Pixel
 Describes the memory layout of a BGRA8 pixel. This pixel is used in Windows bitmaps. More...
 
struct  SBGR8Pixel
 Describes the memory layout of a BGR8 pixel. This pixel is used in Windows bitmaps. More...
 
struct  SRGB8Pixel
 Describes the memory layout of a RGB8 pixel. More...
 
struct  SRGB16Pixel
 Describes the memory layout of a RGB16 pixel. More...
 
struct  SYUV422_UYVY
 Describes the memory layout of a YUV422_UYVY pixel with information about brightness and chroma for two pixels. More...
 
struct  SYUV422_YUYV
 Describes the memory layout of a YUV422_YUYV pixel with information about brightness and chroma for two pixels. More...
 
class  SPixelData
 Describes the data of one pixel. More...
 
class  CPixelTypeMapper
 A simple pixeltypemapper (maps device specific pixelformats read from device-node map to pylon pixeltypes by their name). More...
 
class  CCameraPixelTypeMapperT
 A camera specific pixeltypemapper (maps device specific pixelformats contained in the generated camera classes to pylon pixeltypes by their name). More...
 
class  PylonAutoInitTerm
 Helper class to automagically call PylonInitialize and PylonTerminate in constructor and destructor. More...
 
class  CPylonDeviceProxyT
 Low Level API: The camera class for generic camera devices. More...
 
class  CPylonImage
 Describes an image. More...
 
class  CPylonImageBase
 Provides basic functionality for pylon image classes. More...
 
class  VersionInfo
 Holds a four-part version number consisting of major.minor.subminor.build. More...
 
class  GrabResult
 Low Level API: A grab result that combines the used image buffer and status information. More...
 
class  EventResult
 Low Level API: An event result. More...
 
class  CGrabResultImageT
 Low Level API: Adapts grab result to Pylon::IImage. More...
 
interface  IReusableImage
 Extends the IImage interface to be able to reuse the image's resources to represent a different image. More...
 
class  CSoftwareTriggerConfiguration
 Changes the configuration of the camera so that the acquisition of frames is triggered by software trigger. More...
 
interface  IStreamGrabber
 Low Level API: Interface to an (input) data stream. More...
 
class  CStreamGrabberProxyT
 Low Level API: The stream grabber class with parameter access methods. More...
 
class  CTlFactory
 the Transport Layer Factory More...
 
class  CTlInfo
 Class used for storing the result of the transport layer enumeration process. More...
 
interface  ITransportLayer
 The interface of Transport Layer objects. More...
 
class  GenericException
 pylon exception class More...
 
class  BadAllocException
 Exception thrown if memory could not be allocated. More...
 
class  InvalidArgumentException
 Exception thrown if an argument passed is invalid. More...
 
class  OutOfRangeException
 Exception thrown if an argument is out of range. More...
 
class  PropertyException
 Exception thrown if a property access fails. More...
 
class  RuntimeException
 Exception thrown if a runtime error occurs. More...
 
class  LogicalErrorException
 Exception thrown to indicate logical errors in program flow. More...
 
class  AccessException
 Exception thrown to indicate an access error. (i.E. A when trying to set a read-only value) More...
 
class  TimeoutException
 Exception thrown when a timeout has elapsed. More...
 
class  DynamicCastException
 Exception thrown to indicate a dynamic cast has failed. Usually this means a value is not of expected type. More...
 
class  CLock
 A simple recursive lock class. More...
 
class  AutoLock
 A scoped lock class to acquire and release a CLock upon creation and destruction. More...
 
class  WaitObject
 A platform independent wait object. More...
 
class  WaitObjectEx
 A wait object that the user may signal. More...
 
class  WaitObjects
 A set of wait objects. More...
 
class  CActionTriggerConfiguration
 Changes the configuration of the camera so that it is triggered by the first available action command. More...
 
class  CBaslerGigECamera
 Low Level API: The camera class for Basler GigE Vision camera devices. More...
 
class  CBaslerGigECameraEventHandler
 The camera event handler base class. More...
 
class  CBaslerGigEConfigurationEventHandler
 The configuration event handler base class. More...
 
class  CBaslerGigEDeviceInfo
 Implementation of the GiGE specific device info object. More...
 
class  CBaslerGigEGrabResultData
 The GigE specific grab result data. More...
 
class  CBaslerGigEGrabResultPtr
 The GigE specific grab result smart pointer. More...
 
class  CBaslerGigEImageEventHandler
 The image event handler base class. More...
 
struct  CBaslerGigEInstantCameraTraits
 Lists all the types used by the GigE device specific instant camera class. More...
 
class  CBaslerGigEInstantCamera
 Extends the CInstantCamera by GigE specific parameter interface classes and GigE specific methods. More...
 
class  CBaslerGigEInstantCameraArray
 GigE specific instant camera array. More...
 
struct  GigEActionCommandResult
 Optional result structure of IGigETransportLayer::IssueActionCommand and IGigETransportLayer::IssueScheduledActionCommand. More...
 
interface  IGigETransportLayer
 Extends the ITransportLayer interface by GigE Vision specific functionality. More...
 
class  CPylonGigETLParams
 Low Level API: Class for pylon GigE Vision cameras providing access to transport layer related parameters. More...
 
class  CPylonGigEStreamGrabber
 Low Level API: Class for pylon GigE Vision cameras providing access to stream grabber related methods and parameters. More...
 
class  CPylonGigEEventGrabber
 Low Level API: Class for pylon GigE Vision cameras providing access to event grabber related methods and parameters. More...
 
class  CPylonGigECameraT
 Low Level API: The camera class for pylon GigE Vision camera devices. More...
 
interface  IPylonGigEDevice
 Low Level API: The interface for Basler GigE camera devices. More...
 
class  CPylonGigEDeviceProxyT
 Low Level API: The camera class for GigE Vision camera devices. More...
 
class  CBaslerUsbCamera
 Low Level API: The camera class for Basler USB3 Vision camera devices. More...
 
class  CBaslerUsbCameraEventHandler
 The camera event handler base class. More...
 
class  CBaslerUsbConfigurationEventHandler
 The configuration event handler base class. More...
 
class  CBaslerUsbDeviceInfo
 PylonUsb specific Device Info object. More...
 
class  CBaslerUsbGrabResultData
 The USB specific grab result data class. More...
 
class  CBaslerUsbGrabResultPtr
 The USB specific grab result smart pointer. More...
 
class  CBaslerUsbImageEventHandler
 The image event handler base class. More...
 
struct  CBaslerUsbInstantCameraTraits
 Lists all the types used by the Device Specific Instant Camera class for USB. More...
 
class  CBaslerUsbInstantCamera
 Extends the CInstantCamera by USB specific parameter interface classes. More...
 
class  CBaslerUsbInstantCameraArray
 USB specific instant camera array. More...
 
class  CPylonUsbTLParams
 Low Level API: Class for pylon USB3 Vision cameras providing access to transport layer related parameters. More...
 
class  CPylonUsbStreamGrabber
 Low Level API: Class for pylon USB3 Vision cameras providing access to stream grabber related methods and parameters. More...
 
class  CPylonUsbEventGrabber
 Low Level API: Class for pylon USB3 Vision cameras providing access to event grabber related methods and parameters. More...
 
class  CPylonUsbCameraT
 Low Level API: The camera class for pylon USB3 Vision camera devices. More...
 

Typedefs

typedef DeviceInfoList DeviceInfoList_t
 STL std::vector like container for Pylon::CDeviceInfo objects. More...
 
typedef TlInfoList TlInfoList_t
 STL std::vector like container for Pylon::CTlInfo objects. More...
 
typedef InterfaceInfoList InterfaceInfoList_t
 STL std::vector like container for Pylon::CInterfaceInfo objects. More...
 
typedef Pylon::Callback1
< IPylonDevice * > 
DeviceCallback
 callback type with a IPylonDevice as parameter
 
typedef void * DeviceCallbackHandle
 opaque device callback object
 
typedef ECleanup EOwnership
 Deprecated: Use ECleanup instead.
 
typedef CGrabResultImageT
< GrabResult
CGrabResultImage
 Low Level API: Adapts a copy of a grab result to pylon image. More...
 
typedef GenICam::gcstring String_t
 Pylon's string definition.
 
typedef GenICam::gcstring_vector StringList_t
 Pylon's string list definition.
 
typedef void * StreamBufferHandle
 This opaque type represents a registered buffer.
 
typedef pthread_t THREADHANDLE
 Typedef for a pthreads thread handle.
 

Enumerations

enum  EDeviceAccessMode { Control = 0x1, Stream = 0x3, Event = 0x4, Exclusive = 0x5 }
 The available access modes when opening a camera object. More...
 
enum  EDeviceAccessiblityInfo
 Information about the accessibility of a device.
 
enum  EImageOrientation { ImageOrientation_TopDown, ImageOrientation_BottomUp }
 Defines the vertical orientation of an image in memory. More...
 
enum  EImageFileFormat { ImageFileFormat_Tiff = 1, ImageFileFormat_Png = 3 }
 Lists the available file formats. More...
 
enum  EGrabStrategy { GrabStrategy_OneByOne, GrabStrategy_LatestImageOnly, GrabStrategy_LatestImages, GrabStrategy_UpcomingImage }
 Lists the possible grab strategies. More...
 
enum  ECleanup { Cleanup_None, Cleanup_Delete, Ownership_ExternalOwnership = Cleanup_None, Ownership_TakeOwnership = Cleanup_Delete }
 Defines who deletes a passed object if it is not needed anymore. More...
 
enum  EGrabLoop { GrabLoop_ProvidedByInstantCamera, GrabLoop_ProvidedByUser }
 Defines the use of an additional grab loop thread. More...
 
enum  ERegistrationMode { RegistrationMode_Append, RegistrationMode_ReplaceAll }
 Defines how to register an item. More...
 
enum  ECameraEventAvailability { CameraEventAvailability_Mandatory, CameraEventAvailability_Optional }
 Defines how to register a camera event handler. More...
 
enum  ETimeoutHandling { TimeoutHandling_Return, TimeoutHandling_ThrowException }
 Defines how to handle a timeout for a method. More...
 
enum  EPayloadType {
  PayloadType_Undefined = -1, PayloadType_Image, PayloadType_RawData, PayloadType_File,
  PayloadType_ChunkData, PayloadType_DeviceSpecific = 0x8000
}
 Possible payload type values. More...
 
enum  EPixelType {
  PixelType_Undefined = -1, PixelType_Mono1packed = 0x80000000 | 0x01000000 | (( 1 ) << 16) | 0x000c, PixelType_Mono2packed = 0x80000000 | 0x01000000 | (( 2 ) << 16) | 0x000d, PixelType_Mono4packed = 0x80000000 | 0x01000000 | (( 4 ) << 16) | 0x000e,
  PixelType_Mono8 = 0x01000000 | (( 8 ) << 16) | 0x0001, PixelType_Mono8signed = 0x01000000 | (( 8 ) << 16) | 0x0002, PixelType_Mono10 = 0x01000000 | (( 16 ) << 16) | 0x0003, PixelType_Mono10packed = 0x01000000 | (( 12 ) << 16) | 0x0004,
  PixelType_Mono10p = 0x01000000 | (( 10 ) << 16) | 0x0046, PixelType_Mono12 = 0x01000000 | (( 16 ) << 16) | 0x0005, PixelType_Mono12packed = 0x01000000 | (( 12 ) << 16) | 0x0006, PixelType_Mono12p = 0x01000000 | (( 12 ) << 16) | 0x0047,
  PixelType_Mono16 = 0x01000000 | (( 16 ) << 16) | 0x0007, PixelType_BayerGR8 = 0x01000000 | (( 8 ) << 16) | 0x0008, PixelType_BayerRG8 = 0x01000000 | (( 8 ) << 16) | 0x0009, PixelType_BayerGB8 = 0x01000000 | (( 8 ) << 16) | 0x000a,
  PixelType_BayerBG8 = 0x01000000 | (( 8 ) << 16) | 0x000b, PixelType_BayerGR10 = 0x01000000 | (( 16 ) << 16) | 0x000c, PixelType_BayerRG10 = 0x01000000 | (( 16 ) << 16) | 0x000d, PixelType_BayerGB10 = 0x01000000 | (( 16 ) << 16) | 0x000e,
  PixelType_BayerBG10 = 0x01000000 | (( 16 ) << 16) | 0x000f, PixelType_BayerGR12 = 0x01000000 | (( 16 ) << 16) | 0x0010, PixelType_BayerRG12 = 0x01000000 | (( 16 ) << 16) | 0x0011, PixelType_BayerGB12 = 0x01000000 | (( 16 ) << 16) | 0x0012,
  PixelType_BayerBG12 = 0x01000000 | (( 16 ) << 16) | 0x0013, PixelType_RGB8packed = 0x02000000 | (( 24 ) << 16) | 0x0014, PixelType_BGR8packed = 0x02000000 | (( 24 ) << 16) | 0x0015, PixelType_RGBA8packed = 0x02000000 | (( 32 ) << 16) | 0x0016,
  PixelType_BGRA8packed = 0x02000000 | (( 32 ) << 16) | 0x0017, PixelType_RGB10packed = 0x02000000 | (( 48 ) << 16) | 0x0018, PixelType_BGR10packed = 0x02000000 | (( 48 ) << 16) | 0x0019, PixelType_RGB12packed = 0x02000000 | (( 48 ) << 16) | 0x001a,
  PixelType_BGR12packed = 0x02000000 | (( 48 ) << 16) | 0x001b, PixelType_RGB16packed = 0x02000000 | (( 48 ) << 16) | 0x0033, PixelType_BGR10V1packed = 0x02000000 | (( 32 ) << 16) | 0x001c, PixelType_BGR10V2packed = 0x02000000 | (( 32 ) << 16) | 0x001d,
  PixelType_YUV411packed = 0x02000000 | (( 12 ) << 16) | 0x001e, PixelType_YUV422packed = 0x02000000 | (( 16 ) << 16) | 0x001f, PixelType_YUV444packed = 0x02000000 | (( 24 ) << 16) | 0x0020, PixelType_RGB8planar = 0x02000000 | (( 24 ) << 16) | 0x0021,
  PixelType_RGB10planar = 0x02000000 | (( 48 ) << 16) | 0x0022, PixelType_RGB12planar = 0x02000000 | (( 48 ) << 16) | 0x0023, PixelType_RGB16planar = 0x02000000 | (( 48 ) << 16) | 0x0024, PixelType_YUV422_YUYV_Packed = 0x02000000 | (( 16 ) << 16) | 0x0032,
  PixelType_BayerGR12Packed = 0x01000000 | (( 12 ) << 16) | 0x002A, PixelType_BayerRG12Packed = 0x01000000 | (( 12 ) << 16) | 0x002B, PixelType_BayerGB12Packed = 0x01000000 | (( 12 ) << 16) | 0x002C, PixelType_BayerBG12Packed = 0x01000000 | (( 12 ) << 16) | 0x002D,
  PixelType_BayerGR10p = 0x01000000 | (( 10 ) << 16) | 0x0056, PixelType_BayerRG10p = 0x01000000 | (( 10 ) << 16) | 0x0058, PixelType_BayerGB10p = 0x01000000 | (( 10 ) << 16) | 0x0054, PixelType_BayerBG10p = 0x01000000 | (( 10 ) << 16) | 0x0052,
  PixelType_BayerGR12p = 0x01000000 | (( 12 ) << 16) | 0x0057, PixelType_BayerRG12p = 0x01000000 | (( 12 ) << 16) | 0x0059, PixelType_BayerGB12p = 0x01000000 | (( 12 ) << 16) | 0x0055, PixelType_BayerBG12p = 0x01000000 | (( 12 ) << 16) | 0x0053,
  PixelType_BayerGR16 = 0x01000000 | (( 16 ) << 16) | 0x002E, PixelType_BayerRG16 = 0x01000000 | (( 16 ) << 16) | 0x002F, PixelType_BayerGB16 = 0x01000000 | (( 16 ) << 16) | 0x0030, PixelType_BayerBG16 = 0x01000000 | (( 16 ) << 16) | 0x0031,
  PixelType_RGB12V1packed = 0x02000000 | (( 36 ) << 16) | 0X0034, PixelType_Double = 0x80000000 | 0x01000000 | (( 48 ) << 16) | 0x100
}
 Lists the available pixel types. More...
 
enum  EPixelColorFilter {
  PCF_BayerRG, PCF_BayerGB, PCF_BayerGR, PCF_BayerBG,
  PCF_Undefined
}
 Lists the Bayer color filter types. More...
 
enum  EGrabStatus { ,
  Idle, Queued, Grabbed, Canceled,
  Failed
}
 Low Level API: Possible grab status values. More...
 
enum  EWaitExResult { waitex_timeout = 0, waitex_signaled = 1, waitex_abandoned = 2, waitex_alerted = -1 }
 The return value of the Pylon::WaitObject::WaitEx() and Pylon::WaitObjectEx::WaitEx() methods. More...
 
enum  ready_mask_t { ready_none = 0x00, ready_read = 0x01, ready_write = 0x02, ready_except = 0x04 }
 File descriptor ready mask. More...
 
enum  EGigEActionCommandStatus { GigEActionCommandStatus_Ok = 0, GigEActionCommandStatus_NoRefTime = 0xE1018013, GigEActionCommandStatus_Overflow = 0xE1018015, GigEActionCommandStatus_ActionLate = 0xE1018016 }
 Lists possible status codes returned by IGigETransportLayer::IssueActionCommand or IGigETransportLayer::IssueScheduledActionCommand. More...
 

Functions

template<class T >
TList< T >::iterator operator+ (intptr_t iInc, const typename TList< T >::iterator &iter)
 Gets the sum of the given iInc and the given iter. More...
 
template<class Function >
DeviceCallbackHandle RegisterRemovalCallback (IPylonDevice *pDevice, Function f)
 Low Level API: Register a C-function as a removal callback. More...
 
template<class Client , class Member >
DeviceCallbackHandle RegisterRemovalCallback (IPylonDevice *pDevice, Client &c, Member m)
 Low Level API: Register a C++-member function as removal callback. More...
 
AccessModeSet operator+ (EDeviceAccessMode lhs, EDeviceAccessMode rhs)
 Creates a set containing lhs and rhs operands. More...
 
AccessModeSet operator| (EDeviceAccessMode lhs, EDeviceAccessMode rhs)
 Creates a set containing lhs and rhs operands. More...
 
AccessModeSet operator+ (const AccessModeSet &lhs, EDeviceAccessMode rhs)
 Adds the operand rhs to the set lhs. More...
 
AccessModeSet operator| (const AccessModeSet &lhs, EDeviceAccessMode rhs)
 Adds the operand rhs to the set lhs. More...
 
bool IsMonoPacked (EPixelType pixelType)
 Returns true if the pixel type is Mono and the pixel values are not byte aligned.
 
bool IsBayerPacked (EPixelType pixelType)
 Returns true if the pixel type is Bayer and the pixel values are not byte aligned.
 
bool IsRGBPacked (EPixelType pixelType)
 Returns true if the pixel type is RGB and the pixel values are not byte aligned.
 
bool IsBGRPacked (EPixelType pixelType)
 Returns true if the pixel type is BGR and the pixel values are not byte aligned.
 
bool IsPacked (EPixelType pixelType)
 Returns true if the pixels of the given pixel type are not byte aligned.
 
bool IsPackedInLsbFormat (EPixelType pixelType)
 
uint32_t PlaneCount (EPixelType pixelType)
 Returns number of planes in the image composed of the pixel type.
 
EPixelType GetPlanePixelType (EPixelType pixelType)
 Returns the pixel type of a plane.
 
bool IsPlanar (EPixelType pixelType)
 Returns true if images of the pixel type are divided into multiple planes.
 
EPixelColorFilter GetPixelColorFilter (EPixelType pixelType)
 Returns the Bayer color filter type.
 
uint32_t BitPerPixel (EPixelType pixelType)
 Returns the bits needed to store a pixel. More...
 
uint32_t SamplesPerPixel (EPixelType pixelType)
 Returns the number of measured values per pixel. More...
 
bool IsYUV (EPixelType pixelType)
 Returns true when the pixel type represents a YUV format.
 
bool IsRGBA (EPixelType pixelType)
 Returns true when the pixel type represents an RGBA format.
 
bool IsRGB (EPixelType pixelType)
 Returns true when the pixel type represents an RGB or RGBA format.
 
bool IsBGRA (EPixelType pixelType)
 Returns true when the pixel type represents a BGRA format.
 
bool IsBGR (EPixelType pixelType)
 Returns true when the pixel type represents a BGR or BGRA format.
 
bool IsBayer (EPixelType pixelType)
 Returns true when the pixel type represents a Bayer format.
 
bool IsMono (EPixelType pixelType)
 Returns true when a given pixel is monochrome, e.g. PixelType_Mono8 or PixelType_BayerGR8.
 
bool IsMonoImage (EPixelType pixelType)
 Returns true when an image using the given pixel type is monochrome, e.g. PixelType_Mono8.
 
uint32_t GetPixelIncrementX (EPixelType pixelType)
 Returns the minimum step size expressed in pixels for extracting an AOI.
 
uint32_t GetPixelIncrementY (EPixelType pixelType)
 Returns the minimum step size expressed in pixels for extracting an AOI.
 
uint32_t BitDepth (EPixelType pixelType)
 Returns the bit depth of a value of the pixel in bits. More...
 
bool ComputeStride (size_t &strideBytes, EPixelType pixelType, uint32_t width, size_t paddingX=0)
 Computes the stride in byte. More...
 
size_t ComputePaddingX (size_t strideBytes, EPixelType pixelType, uint32_t width)
 Computes the padding value from row stride in byte. More...
 
size_t ComputeBufferSize (EPixelType pixelType, uint32_t width, uint32_t height, size_t paddingX=0)
 Computes the buffer size in byte. More...
 
void PylonInitialize (void)
 Initializes the pylon runtime system. More...
 
void PylonTerminate (bool ShutDownLogging=true)
 Frees up resources allocated by the pylon runtime system. More...
 
void GetPylonVersion (unsigned int *major, unsigned int *minor, unsigned int *subminor, unsigned int *build)
 Returns the version number of pylon. More...
 
const char * GetPylonVersionString ()
 Returns the version number of pylon as string.
 
VersionInfo GetSfncVersion (GenApi::INodeMap *pNodeMap)
 Helper function for getting the SFNC version from the camera device node map.
 
void GetRTThreadPriorityCapabilities (int &prioMin, int &prioMax)
 Queries the range of allowed thread priorities.
 
int GetRTThreadPriority (THREADHANDLE thread)
 Indicates the current thread priority of a thread.
 
void SetRTThreadPriority (THREADHANDLE thread, int priority)
 Allows to set the realtime thread priority of a threadValues greater than 0 set the thread's static priority and imply realtime scheduling (SCHED_RR scheduling policy). When setting the value 0, non-realtime scheduling is used. The thread's dynamic priority depends on the process' dynamic priority (nice scheduling). More...
 
THREADHANDLE GetCurrentThreadHandle ()
 Get current running thread handle. More...
 
int GetCurrentThreadIdentifier ()
 Get current running thread id. More...
 

Variables

const char *const BaslerGigEDeviceClass = "BaslerGigE"
 This device class can be used to create the corresponding Transport Layer object or when creating Devices with the Transport Layer Factory.
 
const char *const BaslerUsbDeviceClass = "BaslerUsb"
 This device class can be used to create the corresponding Transport Layer object or when creating Devices with the Transport Layer Factory.
 
const char *const BaslerBconDeviceClass = "BaslerBcon"
 This device class can be used to create the corresponding Transport Layer object or when creating Devices with the Transport Layer Factory.
 

Detailed Description

Contains definitions of pylon types.

Typedef Documentation

STL std::vector like container for Pylon::CDeviceInfo objects.

STL std::vector like container for Pylon::CDeviceInfo objects.

STL std::vector like container for Pylon::CInterfaceInfo objects.

STL std::vector like container for Pylon::CInterfaceInfo objects.

STL std::vector like container for Pylon::CTlInfo objects.

STL std::vector like container for Pylon::CTlInfo objects.

Enumeration Type Documentation

The return value of the Pylon::WaitObject::WaitEx() and Pylon::WaitObjectEx::WaitEx() methods.

Enumerator
waitex_timeout 

The time-out interval elapsed.

waitex_signaled 

The wait operation completed successfully.

waitex_abandoned 

Windows only (see MSDN for more information)

waitex_alerted 

The wait was interrupted (Windows: queued APC or I/O completion routine; UNIX: signal)

File descriptor ready mask.

Return value of the Pylon::WaitObject::GetReadyMask() method. Indicates to which type of file descriptor set a wait object's file descriptor is to be added when using the file descriptor as input for the select() or poll() function.

Example: When the ready_read bit of a wait object's GetReadyMask() value is set, add the wait object's file descriptor to the read file descriptor set.

Enumerator
ready_none 

The file descriptor is not valid.

ready_read 

The file desriptor is to be added to a read file descriptor set.

ready_write 

The file descriptor is to be added to a write file descriptor set.

ready_except 

The file descriptor is to be added to a exception file descriptor set.

Function Documentation

THREADHANDLE Pylon::GetCurrentThreadHandle ( )
inline

Get current running thread handle.

This wrapper method return the handle of the current running thread.

int Pylon::GetCurrentThreadIdentifier ( )
inline

Get current running thread id.

This wrapper method return the id of the current running thread.

void Pylon::GetPylonVersion ( unsigned int *  major,
unsigned int *  minor,
unsigned int *  subminor,
unsigned int *  build 
)

Returns the version number of pylon.

It is possible to pass a NULL pointer for a version number category if the value is not of interest.

template<class T >
TList<T>::iterator Pylon::operator+ ( intptr_t  iInc,
const typename TList< T >::iterator &  iter 
)

Gets the sum of the given iInc and the given iter.

Parameters
[in]iIncIncrement from which the sum is calculated.
[in]iterIterator from which the sum is calculated.
Returns
Sum of iterator.
void Pylon::PylonInitialize ( void  )

Initializes the pylon runtime system.

You must call PylonInitialize before calling any other pylon functions. When finished you must call PylonTerminate to free up all resources used by pylon.

You can use the helperclass PylonAutoInitTerm to let the compiler call PylonInitialze and PylonTerminate.

Just create a local object on the stack in your main function and the constructor and destructor will call the functions. See PylonAutoInitTerm for a sample.

PylonInitialize/PylonTerminate is reference counted. For every call of PylonInitialize, a call to PylonTerminate is required. The last call to PylonTerminate will free up all resources.

void Pylon::PylonTerminate ( bool  ShutDownLogging = true)

Frees up resources allocated by the pylon runtime system.

Call this function before terminating the application. Don't use any pylon methods or pylon objects after having called PylonTerminate().

PylonInitialize/PylonTerminate is reference counted. For every call of PylonInitialize, a call to PylonTerminate is required. The last call to PylonTerminate will free up all resources.

void Pylon::SetRTThreadPriority ( THREADHANDLE  thread,
int  priority 
)

Allows to set the realtime thread priority of a threadValues greater than 0 set the thread's static priority and imply realtime scheduling (SCHED_RR scheduling policy). When setting the value 0, non-realtime scheduling is used. The thread's dynamic priority depends on the process' dynamic priority (nice scheduling).

Setting realtime priorities requires certain permissions. The pylon install guide described how to grant an application the permissions to set realtime thread priorities.

Typically a thread that receives image data should be set to realtime thread priorities to reduce jitter and delays. Be aware that such a realtime thread shouldn't perform time consuming tasks (like image processing). A realtime thread that is continuously working can cause the whole operating system to be blocked!


pylon 5.0.9
Copyright © 2006-2017 Basler AG (Tue May 30 2017 17:24:58)