All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Modules | Classes | Typedefs | Enumerations
Instant Camera

Instant Camera classes make it possible to grab images with a few lines of code reducing the programming effort to a minimum. More...

Collaboration diagram for Instant Camera:

Modules

 Instant Camera for Basler GigE Devices
 
 Instant Camera for Basler USB3 Vision Devices
 

Classes

class  Pylon::CAcquireContinuousConfiguration
 Changes the configuration of the camera to free-running continuous acquisition. More...
 
class  Pylon::CAcquireSingleFrameConfiguration
 An instant camera configuration for single frame acquisition, Use together with CInstantCamera::GrabOne() only. More...
 
class  Pylon::CCameraEventHandler
 The camera event handler base class. More...
 
class  Pylon::CConfigurationEventHandler
 The configuration event handler base class. More...
 
class  Pylon::CGrabResultData
 Makes the data for one grabbed buffer available. More...
 
class  Pylon::CGrabResultPtr
 A smart pointer holding a reference to grab result data. More...
 
class  Pylon::CImageEventHandler
 The image event handler base class. More...
 
class  Pylon::CInstantCamera
 Provides convenient access to a camera device. More...
 
class  Pylon::CInstantCameraArray
 Supports grabbing with multiple camera devices. More...
 
class  Pylon::CSoftwareTriggerConfiguration
 Changes the configuration of the camera so that the acquisition of frames is triggered by software trigger. More...
 
class  Pylon::IBufferFactory
 Usable to create a custom buffer factory when needed. More...
 

Typedefs

typedef ECleanup Pylon::EOwnership
 Deprecated: Use ECleanup instead.
 

Enumerations

enum  Pylon::EGrabStrategy { Pylon::GrabStrategy_OneByOne, Pylon::GrabStrategy_LatestImageOnly, Pylon::GrabStrategy_LatestImages, Pylon::GrabStrategy_UpcomingImage }
 Lists the possible grab strategies. More...
 
enum  Pylon::ECleanup { Pylon::Cleanup_None, Pylon::Cleanup_Delete, Pylon::Ownership_ExternalOwnership = Cleanup_None, Pylon::Ownership_TakeOwnership = Cleanup_Delete }
 Defines who deletes a passed object if it is not needed anymore. More...
 
enum  Pylon::EGrabLoop { Pylon::GrabLoop_ProvidedByInstantCamera, Pylon::GrabLoop_ProvidedByUser }
 Defines the use of an additional grab loop thread. More...
 
enum  Pylon::ERegistrationMode { Pylon::RegistrationMode_Append, Pylon::RegistrationMode_ReplaceAll }
 Defines how to register an item. More...
 
enum  Pylon::ECameraEventAvailability { Pylon::CameraEventAvailability_Mandatory, Pylon::CameraEventAvailability_Optional }
 Defines how to register a camera event handler. More...
 
enum  Pylon::ETimeoutHandling { Pylon::TimeoutHandling_Return, Pylon::TimeoutHandling_ThrowException }
 Defines how to handle a timeout for a method. More...
 
enum  Pylon::EPayloadType {
  Pylon::PayloadType_Undefined = -1, Pylon::PayloadType_Image, Pylon::PayloadType_RawData, Pylon::PayloadType_File,
  Pylon::PayloadType_ChunkData, Pylon::PayloadType_DeviceSpecific = 0x8000
}
 Possible payload type values. More...
 

Detailed Description

Instant Camera classes make it possible to grab images with a few lines of code reducing the programming effort to a minimum.

More information can be found here:

Enumeration Type Documentation

Defines how to register a camera event handler.

Enumerator
CameraEventAvailability_Mandatory 

The camera event must be provided by the camera, otherwise an exception is thrown.

CameraEventAvailability_Optional 

The camera event handler is not used if the camera does not support the camera event.

Defines who deletes a passed object if it is not needed anymore.

Enumerator
Cleanup_None 

The caller is responsible for deleting the passed object. The object needs to be detached or deregistered before deletion.

Cleanup_Delete 

The passed object is deleted if it is not needed anymore.

Ownership_ExternalOwnership 

Deprecated: Use Cleanup_None instead.

Ownership_TakeOwnership 

Deprecated: Use Cleanup_Delete instead.

Defines the use of an additional grab loop thread.

Enumerator
GrabLoop_ProvidedByInstantCamera 

The grab loop thread is provided by the Instant Camera. It calls RetrieveResult() in a loop. Grabbed images are processed by registered image event handlers. The grab loop thread is started when the grab starts.

GrabLoop_ProvidedByUser 

The user code calls RetrieveResult() in a loop to process grabbed images and camera events.

Lists the possible grab strategies.

Enumerator
GrabStrategy_OneByOne 

The images are processed in the order of their arrival. This is the default grab strategy.

GrabStrategy_LatestImageOnly 

Only the latest image is kept in the output queue, all other grabbed images are skipped. If no image is in the output queue when retrieving an image with CInstantCamera::RetrieveResult(), the processing waits for the upcoming image.

GrabStrategy_LatestImages 

This strategy can be used to grab images while keeping only the latest images. If the application does not retrieve all images in time, all other grabbed images are skipped. The CInstantCamera::OutputQueueSize parameter can be used to control how many images can be queued in the output queue. When setting the output queue size to 1, this strategy is equivalent to GrabStrategy_LatestImageOnly grab strategy. When setting the output queue size to CInstantCamera::MaxNumBuffer, this strategy is equivalent to GrabStrategy_OneByOne.

GrabStrategy_UpcomingImage 

The input buffer queue is kept empty. This prevents grabbing. However, when retrieving an image with a call to the CInstantCamera::RetrieveResult() method a buffer is queued into the input queue and then the call waits for the upcoming image. The buffer is removed from the queue on timeout. Hence after the call to the CInstantCamera::RetrieveResult() method the input buffer queue is empty again. The upcoming image grab strategy cannot be used together with USB camera devices. See the advanced topics section of the pylon Programmer's Guide for more information.

Possible payload type values.

Enumerator
PayloadType_Undefined 

Undefined payload.

PayloadType_Image 

The buffer contains image data.

PayloadType_RawData 

The buffer contains raw data.

PayloadType_File 

The buffer contains file data.

PayloadType_ChunkData 

The buffer contains chunk data.

PayloadType_DeviceSpecific 

The buffer contains device specific data.

Defines how to register an item.

Enumerator
RegistrationMode_Append 

The item is appended to the list of registered items.

RegistrationMode_ReplaceAll 

The item replaces all other registered items.

Defines how to handle a timeout for a method.

Enumerator
TimeoutHandling_Return 

The method returns on timeout. What data is returned can be found in the documentation of the method.

TimeoutHandling_ThrowException 

An exception is thrown on timeout.


pylon 5.0.5
Copyright © 2006-2016 Basler AG (Thu Aug 11 2016 18:01:28)