Pylon Logo Basler Logo
List of all members
Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0 Class Reference

A parameter class containing all parameters as members that are available for Instant Camera. More...

#include <pylon/_InstantCameraParams.h>

Inheritance diagram for Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0:
Inheritance graph
[legend]

Public Attributes

Categories: Root
Pylon::IBooleanExAcquisitionStartStopExecutionEnable
 If set, this will automatically execute AcquisitionStart when calling StartGrabbing and AcquisitionStop when calling StopGrabbing This option is enabled by default - Applies to: InstantCamera. More...
 
Pylon::IBooleanExChunkNodeMapsEnable
 Enables/disables the use of a chunk node map for each grab result Grab result chunk node maps can be disabled to save resources - Applies to: InstantCamera. More...
 
Pylon::IBooleanExClearBufferModeEnable
 If set, all buffers will be cleared (set to 0) before grabbing an image Note that this requires additional processing time per frame - Applies to: InstantCamera. More...
 
Pylon::IBooleanExGrabCameraEvents
 Enables/disables the grabbing of camera events while images are grabbed Is writable when the camera object is closed - Applies to: InstantCamera. More...
 
Pylon::IIntegerExMaxNumBuffer
 The maximum number of buffers that are allocated and used for grabbing - Applies to: InstantCamera. More...
 
Pylon::IIntegerExMaxNumGrabResults
 The maximum number of grab results available at any time during a grab session This value can be limited to save resources Furthermore, it can be used to check that the grab results are returned correctly - Applies to: InstantCamera. More...
 
Pylon::IIntegerExMaxNumQueuedBuffer
 The maximum number of buffers that are queued in the stream grabber input queue - Applies to: InstantCamera. More...
 
Pylon::IBooleanExMigrationModeActive
 The migration mode is set up according to this setting at defined points e g , when the camera is opened - Applies to: InstantCamera. More...
 
Pylon::IBooleanExMonitorModeActive
 The camera object is set to monitor mode when enabled, e g when using the GigE multicast feature Is writable when the camera object is closed - Applies to: InstantCamera. More...
 
Pylon::IIntegerExNumEmptyBuffers
 The number of empty buffers that are not used for grabbing yet - Applies to: InstantCamera. More...
 
Pylon::IIntegerExNumQueuedBuffers
 The number of buffers queued at Low Level API stream grabber - Applies to: InstantCamera. More...
 
Pylon::IIntegerExNumReadyBuffers
 The number of grab result buffers in the output queue that are ready for retrieval - Applies to: InstantCamera. More...
 
Pylon::IIntegerExOutputQueueSize
 The size of the grab result buffer output queue - Applies to: InstantCamera. More...
 
Pylon::IIntegerExStaticChunkNodeMapPoolSize
 If larger than 0, a static chunk node map pool is used instead of dynamic chunk node map creation - Applies to: InstantCamera. More...
 
Categories: GrabLoopThread
Pylon::IIntegerExGrabLoopThreadPriority
 The grab loop thread priority - Applies to: InstantCamera. More...
 
Pylon::IBooleanExGrabLoopThreadPriorityOverride
 If enabled, the user can set a custom priority for the grab loop thread Otherwise, the priority of the newly created thread is not changed - Applies to: InstantCamera. More...
 
Pylon::IIntegerExGrabLoopThreadTimeout
 A custom timeout for the grab loop thread's call to RetrieveResult RetrieveResult is configured to throw an exception on timeout, which will stop the grab session - Applies to: InstantCamera. More...
 
Pylon::IBooleanExGrabLoopThreadUseTimeout
 If enabled, the user can set a custom timeout for the grab loop thread's call to RetrieveResult RetrieveResult is configured to throw an exception on timeout, which will stop the grab session - Applies to: InstantCamera. More...
 
Categories: InternalGrabEngineThread
Pylon::IIntegerExInternalGrabEngineThreadPriority
 The internal grab engine thread priority - Applies to: InstantCamera. More...
 
Pylon::IBooleanExInternalGrabEngineThreadPriorityOverride
 If enabled, the user can set a custom priority for the internal grab engine thread operating the stream grabber Otherwise the priority defaults to 25 - Applies to: InstantCamera. More...
 

Detailed Description

A parameter class containing all parameters as members that are available for Instant Camera.

The parameter class is used by the Pylon::CInstantCamera class. The code sample Grab shows the usage by setting the MaxNumBuffer parameter.

Member Data Documentation

Pylon::IBooleanEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::AcquisitionStartStopExecutionEnable

If set, this will automatically execute AcquisitionStart when calling StartGrabbing and AcquisitionStop when calling StopGrabbing This option is enabled by default - Applies to: InstantCamera.

Visibility: Guru

Pylon::IBooleanEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::ChunkNodeMapsEnable

Enables/disables the use of a chunk node map for each grab result Grab result chunk node maps can be disabled to save resources - Applies to: InstantCamera.

Visibility: Guru

Pylon::IBooleanEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::ClearBufferModeEnable

If set, all buffers will be cleared (set to 0) before grabbing an image Note that this requires additional processing time per frame - Applies to: InstantCamera.

Visibility: Guru

Pylon::IBooleanEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::GrabCameraEvents

Enables/disables the grabbing of camera events while images are grabbed Is writable when the camera object is closed - Applies to: InstantCamera.

Visibility: Expert

Pylon::IIntegerEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::GrabLoopThreadPriority

The grab loop thread priority - Applies to: InstantCamera.

This value sets the absolute thread priority for the grab loop thread.

Visibility: Guru

Pylon::IBooleanEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::GrabLoopThreadPriorityOverride

If enabled, the user can set a custom priority for the grab loop thread Otherwise, the priority of the newly created thread is not changed - Applies to: InstantCamera.

Visibility: Guru

Pylon::IIntegerEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::GrabLoopThreadTimeout

A custom timeout for the grab loop thread's call to RetrieveResult RetrieveResult is configured to throw an exception on timeout, which will stop the grab session - Applies to: InstantCamera.

Visibility: Beginner

Pylon::IBooleanEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::GrabLoopThreadUseTimeout

If enabled, the user can set a custom timeout for the grab loop thread's call to RetrieveResult RetrieveResult is configured to throw an exception on timeout, which will stop the grab session - Applies to: InstantCamera.

Visibility: Guru

Pylon::IIntegerEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::InternalGrabEngineThreadPriority

The internal grab engine thread priority - Applies to: InstantCamera.

This value sets the absolute thread priority for the internal grab engine thread operating the stream grabber.

Visibility: Guru

Pylon::IBooleanEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::InternalGrabEngineThreadPriorityOverride

If enabled, the user can set a custom priority for the internal grab engine thread operating the stream grabber Otherwise the priority defaults to 25 - Applies to: InstantCamera.

Visibility: Guru

Pylon::IIntegerEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::MaxNumBuffer

The maximum number of buffers that are allocated and used for grabbing - Applies to: InstantCamera.

Visibility: Beginner

Pylon::IIntegerEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::MaxNumGrabResults

The maximum number of grab results available at any time during a grab session This value can be limited to save resources Furthermore, it can be used to check that the grab results are returned correctly - Applies to: InstantCamera.

Visibility: Beginner

Pylon::IIntegerEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::MaxNumQueuedBuffer

The maximum number of buffers that are queued in the stream grabber input queue - Applies to: InstantCamera.

Visibility: Beginner

Pylon::IBooleanEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::MigrationModeActive

The migration mode is set up according to this setting at defined points e g , when the camera is opened - Applies to: InstantCamera.

Visibility: Guru

Pylon::IBooleanEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::MonitorModeActive

The camera object is set to monitor mode when enabled, e g when using the GigE multicast feature Is writable when the camera object is closed - Applies to: InstantCamera.

Visibility: Guru

Pylon::IIntegerEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::NumEmptyBuffers

The number of empty buffers that are not used for grabbing yet - Applies to: InstantCamera.

Visibility: Expert

Pylon::IIntegerEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::NumQueuedBuffers

The number of buffers queued at Low Level API stream grabber - Applies to: InstantCamera.

This is the number of buffers that are queued for grabbing in the stream grabber. The number is influenced by the number of available free buffers and the maximum number of buffers that can be queued. See also the MaxNumBuffer and MaxNumQueuedBuffer parameters.

This parameter can be used to check whether the number of buffers ready for grabbing is stable, which means that the image processing is fast enough to keep up with the rate of incoming images when using the GrabStrategy_OneByOne grab strategy.

Visibility: Expert

Pylon::IIntegerEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::NumReadyBuffers

The number of grab result buffers in the output queue that are ready for retrieval - Applies to: InstantCamera.

Visibility: Expert

Pylon::IIntegerEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::OutputQueueSize

The size of the grab result buffer output queue - Applies to: InstantCamera.

Visibility: Expert

Pylon::IIntegerEx& Basler_InstantCameraParams::CInstantCameraParams_Params_v6_1_0::StaticChunkNodeMapPoolSize

If larger than 0, a static chunk node map pool is used instead of dynamic chunk node map creation - Applies to: InstantCamera.

Visibility: Guru


The documentation for this class was generated from the following file:

pylon 6.1.0
Copyright (c) 2006-2020 Basler AG (Mon Mar 16 2020 10:56:53)