All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Basler_InstantCameraParams::CInstantCameraParams_Params Class Reference

Interface to instant camera parameters. More...

#include <pylon/_InstantCameraParams.h>

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

Public Attributes

Root - Instant camera parameters.
GenApi::IInteger & MaxNumBuffer
 The maximum number of buffers that are allocated and used for grabbing. More...
 
GenApi::IInteger & MaxNumQueuedBuffer
 The maximum number of buffers that are queued in the stream grabber input queue. More...
 
GenApi::IInteger & MaxNumGrabResults
 The maximum number of grab results available at any time during a grab session. More...
 
GenApi::IBoolean & ChunkNodeMapsEnable
 Enables/disables the use of a chunk node map for each grab result. More...
 
GenApi::IInteger & StaticChunkNodeMapPoolSize
 If larger than 0, a static chunk node map pool is used instead of dynamic chunk node map creation. More...
 
GenApi::IBoolean & GrabCameraEvents
 Enables/disables the grabbing of camera events while images are grabbed. More...
 
GenApi::IBoolean & MonitorModeActive
 The camera object is set to monitor mode when enabled, e.g. More...
 
GenApi::IInteger & NumQueuedBuffers
 The number of buffers queued at Low Level API stream grabber. More...
 
GenApi::IInteger & NumReadyBuffers
 The number of grab result buffers in the output queue that are ready for retrieval. More...
 
GenApi::IInteger & NumEmptyBuffers
 The number of empty buffers that are not used for grabbing yet. More...
 
GenApi::IInteger & OutputQueueSize
 The size of the grab result buffer output queue. More...
 
InternalGrabEngineThread - Parameters of the internal grab engine thread.
GenApi::IBoolean & InternalGrabEngineThreadPriorityOverride
 If enabled, the user can set a custom priority for the internal grab engine thread operating the stream grabber. More...
 
GenApi::IInteger & InternalGrabEngineThreadPriority
 The internal grab engine thread priority. More...
 
GrabLoopThread - Parameters of the optional grab loop thread.
GenApi::IBoolean & GrabLoopThreadUseTimeout
 If enabled, the user can set a custom timeout for the grab loop thread's call to RetrieveResult. More...
 
GenApi::IInteger & GrabLoopThreadTimeout
 A custom timeout for the grab loop thread's call to RetrieveResult. More...
 
GenApi::IBoolean & GrabLoopThreadPriorityOverride
 If enabled, the user can set a custom priority for the grab loop thread. More...
 
GenApi::IInteger & GrabLoopThreadPriority
 The grab loop thread priority. More...
 

Detailed Description

Interface to instant camera parameters.

Member Data Documentation

GenApi::IBoolean& Basler_InstantCameraParams::CInstantCameraParams_Params::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.

Visibility = Guru

GenApi::IBoolean& Basler_InstantCameraParams::CInstantCameraParams_Params::GrabCameraEvents

Enables/disables the grabbing of camera events while images are grabbed.

Is writable when the camera object is closed.

Visibility = Expert

GenApi::IInteger& Basler_InstantCameraParams::CInstantCameraParams_Params::GrabLoopThreadPriority

The grab loop thread priority.

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

Visibility = Guru

GenApi::IBoolean& Basler_InstantCameraParams::CInstantCameraParams_Params::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.

Visibility = Guru

GenApi::IInteger& Basler_InstantCameraParams::CInstantCameraParams_Params::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.

Visibility = Beginner

GenApi::IBoolean& Basler_InstantCameraParams::CInstantCameraParams_Params::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.

Visibility = Guru

GenApi::IInteger& Basler_InstantCameraParams::CInstantCameraParams_Params::InternalGrabEngineThreadPriority

The internal grab engine thread priority.

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

Visibility = Guru

GenApi::IBoolean& Basler_InstantCameraParams::CInstantCameraParams_Params::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.

Visibility = Guru

GenApi::IInteger& Basler_InstantCameraParams::CInstantCameraParams_Params::MaxNumBuffer

The maximum number of buffers that are allocated and used for grabbing.

Visibility = Beginner

GenApi::IInteger& Basler_InstantCameraParams::CInstantCameraParams_Params::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.

Visibility = Beginner

GenApi::IInteger& Basler_InstantCameraParams::CInstantCameraParams_Params::MaxNumQueuedBuffer

The maximum number of buffers that are queued in the stream grabber input queue.

Visibility = Beginner

GenApi::IBoolean& Basler_InstantCameraParams::CInstantCameraParams_Params::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.

Visibility = Guru

GenApi::IInteger& Basler_InstantCameraParams::CInstantCameraParams_Params::NumEmptyBuffers

The number of empty buffers that are not used for grabbing yet.

Visibility = Expert

GenApi::IInteger& Basler_InstantCameraParams::CInstantCameraParams_Params::NumQueuedBuffers

The number of buffers queued at Low Level API stream grabber.

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

GenApi::IInteger& Basler_InstantCameraParams::CInstantCameraParams_Params::NumReadyBuffers

The number of grab result buffers in the output queue that are ready for retrieval.

Visibility = Expert

GenApi::IInteger& Basler_InstantCameraParams::CInstantCameraParams_Params::OutputQueueSize

The size of the grab result buffer output queue.

Visibility = Expert

GenApi::IInteger& Basler_InstantCameraParams::CInstantCameraParams_Params::StaticChunkNodeMapPoolSize

If larger than 0, a static chunk node map pool is used instead of dynamic chunk node map creation.

Visibility = Guru


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

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