![]() |
Visual Servoing Platform
version 3.3.0
|
#include "vpPylonGrabberGigE.h"
Public Types | |
enum | UserSetName { USERSET_DEFAULT, USERSET_USERSET1, USERSET_USERSET2, USERSET_USERSET3, USERSET_UNKNOWN } |
Public Member Functions | |
vpPylonGrabberGigE () | |
virtual | ~vpPylonGrabberGigE () |
void | acquire (vpImage< unsigned char > &I) |
void | acquire (vpImage< vpRGBa > &I) |
void | close () |
void | connect () |
void | disconnect () |
float | getBlackLevel () |
std::ostream & | getCameraInfo (std::ostream &os) |
Pylon::CInstantCamera * | getCameraHandler () |
unsigned int | getCameraIndex () const |
std::string | getCameraSerial (unsigned int index) |
float | getExposure () |
float | getFrameRate () |
float | getGain () |
unsigned int | getNumCameras () |
float | getGamma () |
bool | loadUserSet (UserSetName user_set) |
UserSetName | getUserSetDefault () |
bool | isConnected () const |
bool | isCaptureStarted () const |
void | open (vpImage< unsigned char > &I) |
void | open (vpImage< vpRGBa > &I) |
vpPylonGrabber & | operator>> (vpImage< unsigned char > &I) |
vpPylonGrabber & | operator>> (vpImage< vpRGBa > &I) |
float | setBlackLevel (float blacklevel_value=0) |
void | setCameraIndex (unsigned int index) |
void | setCameraSerial (const std::string &serial) |
float | setExposure (bool exposure_on, bool exposure_auto, float exposure_value=0) |
float | setGain (bool gain_auto, float gain_value=0) |
float | setFrameRate (float frame_rate) |
float | setGamma (bool gamma_on, float gamma_value=1) |
bool | saveUserSet (UserSetName user_set, bool set_default=false) |
bool | setUserSetDefault (UserSetName user_set) |
void | startCapture () |
void | stopCapture () |
Inherited functionalities from vpFramegrabber | |
unsigned int | getHeight () const |
unsigned int | getWidth () const |
Public Attributes | |
bool | init |
Protected Member Functions | |
void | open () |
bool | selectUserSet (UserSetName user_set) |
Protected Attributes | |
unsigned int | height |
unsigned int | width |
Allows to grab images from a Basler GigE camera using Pylon SDK.
This class should not be instantiated directly. Use vpPylonFactory::createPylonGrabber() instead.
Definition at line 64 of file vpPylonGrabberGigE.h.
|
inherited |
Valid values for user set names.
Enumerator | |
---|---|
USERSET_DEFAULT | The default user set. |
USERSET_USERSET1 | User set 1. |
USERSET_USERSET2 | User set 2. |
USERSET_USERSET3 | User set 3. |
USERSET_UNKNOWN | User set not supported. |
Definition at line 105 of file vpPylonGrabber.h.
vpPylonGrabberGigE::vpPylonGrabberGigE | ( | ) |
Default constructor that consider the first camera found on the bus as active.
Definition at line 54 of file vpPylonGrabberGigE.cpp.
|
virtual |
Default destructor that closes the connection with the camera.
Definition at line 62 of file vpPylonGrabberGigE.cpp.
|
virtual |
Acquire a gray level image from the active camera.
I | : Image data structure (8 bits image). |
Implements vpPylonGrabber.
Definition at line 650 of file vpPylonGrabberGigE.cpp.
Acquire a color image from the active camera.
I | : Image data structure (RGBa image). |
Implements vpPylonGrabber.
Definition at line 679 of file vpPylonGrabberGigE.cpp.
|
virtual |
Stop active camera capturing images and disconnect the active camera.
If you want to use again this camera, you may call setCameraIndex(const unsigned int &) and open(vpImage<unsigned char> &) or open(vpImage<vpRGBa> &) to connect again the camera.
Implements vpPylonGrabber.
Definition at line 639 of file vpPylonGrabberGigE.cpp.
|
virtual |
Connect the active camera.
Implements vpPylonGrabber.
Definition at line 586 of file vpPylonGrabberGigE.cpp.
|
virtual |
Disconnect the active camera.
Implements vpPylonGrabber.
Definition at line 619 of file vpPylonGrabberGigE.cpp.
|
virtual |
Return blacklevel value in % or raw value. If the camera doesn't support blacklevel property, return an exception.
According to SFNC (standard feature naming convention) of GenICam standard, Black level is used instead of brightness.
See "Terminology Changes" section of the page: https://www.ptgrey.com/kb/11020?countryid=237
Implements vpPylonGrabber.
Definition at line 166 of file vpPylonGrabberGigE.cpp.
|
virtual |
Return the handler to the active camera or NULL if the camera is not connected. This function was designed to provide a direct access to the Pylon SDK to get access to advanced functionalities that are not implemented in this class.
Implements vpPylonGrabber.
Definition at line 112 of file vpPylonGrabberGigE.cpp.
|
inlinevirtual |
Return the index of the active camera.
Implements vpPylonGrabber.
Definition at line 81 of file vpPylonGrabberGigE.h.
|
virtual |
Print to the output stream active camera information (serial number, camera model, camera vendor, sensor, resolution, firmware version, ...).
Implements vpPylonGrabber.
Definition at line 85 of file vpPylonGrabberGigE.cpp.
|
virtual |
Return the serial id of a camera with index.
index | : Camera index. |
Implements vpPylonGrabber.
Definition at line 221 of file vpPylonGrabberGigE.cpp.
|
virtual |
Return exposure value in ms. If the camera doesn't support exposure property, return an exception.
According to SFNC (standard feature naming convention) of GenICam standard, Exposure is used and deprecates shutter.
See "Terminology Changes" section of the page: https://www.ptgrey.com/kb/11020?countryid=237
Implements vpPylonGrabber.
Definition at line 189 of file vpPylonGrabberGigE.cpp.
|
virtual |
Return camera capture framerate. If the camera doesn't support framerate property, return an exception.
Implements vpPylonGrabber.
Definition at line 129 of file vpPylonGrabberGigE.cpp.
|
virtual |
Return camera gain value in dB or raw value. If the camera doesn't support gain property, return an exception.
Implements vpPylonGrabber.
Definition at line 143 of file vpPylonGrabberGigE.cpp.
|
virtual |
Return gamma correction value. If the camera doesn't support gamma property, return an exception.
Implements vpPylonGrabber.
Definition at line 207 of file vpPylonGrabberGigE.cpp.
|
inlineinherited |
Return the number of rows in the image.
Definition at line 113 of file vpFrameGrabber.h.
|
virtual |
Implements vpPylonGrabber.
Definition at line 67 of file vpPylonGrabberGigE.cpp.
|
virtual |
Gets the configuration set being used as the default startup set.
Implements vpPylonGrabber.
Definition at line 272 of file vpPylonGrabberGigE.cpp.
|
inlineinherited |
Return the number of columns in the image.
Definition at line 115 of file vpFrameGrabber.h.
|
inlinevirtual |
Return true if the camera capture is started.
Implements vpPylonGrabber.
Definition at line 94 of file vpPylonGrabberGigE.h.
|
inlinevirtual |
Return true if the camera is connected.
Implements vpPylonGrabber.
Definition at line 92 of file vpPylonGrabberGigE.h.
|
virtual |
Loads the selected configuration into the camera's volatile memory and makes it the active configuration set.
user_set | See vpPylonGrabber::UserSetName for valid values. |
Implements vpPylonGrabber.
Definition at line 251 of file vpPylonGrabberGigE.cpp.
|
protected |
Connect to the active camera and start capture.
Similar then calling:
Definition at line 745 of file vpPylonGrabberGigE.cpp.
|
virtual |
Connect to the active camera, start capture and retrieve an image.
I | : Captured image. |
Implements vpPylonGrabber.
Definition at line 718 of file vpPylonGrabberGigE.cpp.
Connect to the active camera, start capture and retrieve an image.
I | : Captured image. |
Implements vpPylonGrabber.
Definition at line 728 of file vpPylonGrabberGigE.cpp.
|
virtual |
Operator that allows to capture a grey level image.
I | : The captured image. |
Implements vpPylonGrabber.
Definition at line 789 of file vpPylonGrabberGigE.cpp.
|
virtual |
Operator that allows to capture a color image.
I | : The captured image. |
Implements vpPylonGrabber.
Definition at line 799 of file vpPylonGrabberGigE.cpp.
|
virtual |
Saves the current active configuration set into the selected user set.
user_set | See vpPylonGrabber::UserSetName for valid values. |
set_default | Whether to set the configuration set to be used as the default startup set. |
Implements vpPylonGrabber.
Definition at line 494 of file vpPylonGrabberGigE.cpp.
|
protected |
Selects the configuration set to load, save, or configure.
user_set | See vpPylonGrabber::UserSetName for valid values. |
Default User Set is read-only and cannot be modified.
Definition at line 759 of file vpPylonGrabberGigE.cpp.
|
virtual |
Set camera blacklevel mode and parameter.
blacklevel_value | : This is the level of black in an image. A high blacklevel will result in a low amount of black in the image. |
According to SFNC (standard feature naming convention) of GenICam standard, Black level is used instead of brightness.
See "Terminology Changes" section of the page: https://www.ptgrey.com/kb/11020?countryid=237
Implements vpPylonGrabber.
Definition at line 402 of file vpPylonGrabberGigE.cpp.
|
virtual |
If multiples cameras are connected on the bus, select the camera to dial with.
index | : Current camera index, a value comprised between 0 (the first camera found on the bus) and the number of cameras found and returned by getNumCameras() minus 1. |
If two cameras are connected on the bus, setting index to one allows to communicate with the second one. This identifier is not unique. That is why, it is also possible to select a camera by its serial number, which is unique using setCameraSerial().
vpException::badValue | : If the index is greater or equal to the number of cameras connected to the bus. |
Implements vpPylonGrabber.
Definition at line 312 of file vpPylonGrabberGigE.cpp.
|
virtual |
Set the current camera from its unique serial identifier.
serial | : Camera serial string. |
Implements vpPylonGrabber.
Definition at line 328 of file vpPylonGrabberGigE.cpp.
|
virtual |
Set camera exposure mode and parameter.
exposure_on | : If true turn exposure on, otherwise turn off. |
exposure_auto | : If true set auto exposure, if false set manual exposure applying exposure_value parameter. |
exposure_value | : This is the exposure value in ms. |
According to SFNC (standard feature naming convention) of GenICam standard, Exposure is used and deprecates shutter.
See "Terminology Changes" section of the page: https://www.ptgrey.com/kb/11020?countryid=237
Implements vpPylonGrabber.
Definition at line 433 of file vpPylonGrabberGigE.cpp.
|
virtual |
Set camera frame rate.
frame_rate | : Camera frame rate (fps) to set. |
Implements vpPylonGrabber.
Definition at line 347 of file vpPylonGrabberGigE.cpp.
|
virtual |
Set camera gain mode and value.
gain_auto | : If true set auto gain, if false set manual gain applying gain_value parameter. |
gain_value | : The amount of amplification that is applied to a pixel in manual mode. An increase in gain can result in an increase in noise. |
Implements vpPylonGrabber.
Definition at line 369 of file vpPylonGrabberGigE.cpp.
|
virtual |
Set camera gamma correction mode and parameter.
gamma_on | : If true turn gamma correction on, otherwise turn off. |
gamma_value | : Parameter used to perform gamma correction of pixel intensity. |
Implements vpPylonGrabber.
Definition at line 469 of file vpPylonGrabberGigE.cpp.
|
virtual |
Sets the configuration set to be used as the default startup set.
user_set | See vpPylonGrabber::UserSetName for valid values. |
Implements vpPylonGrabber.
Definition at line 521 of file vpPylonGrabberGigE.cpp.
|
virtual |
Start active camera capturing images.
Implements vpPylonGrabber.
Definition at line 552 of file vpPylonGrabberGigE.cpp.
|
virtual |
Stop active camera capturing images.
Implements vpPylonGrabber.
Definition at line 570 of file vpPylonGrabberGigE.cpp.
|
protectedinherited |
Number of rows in the image.
Definition at line 106 of file vpFrameGrabber.h.
Referenced by vpDirectShowGrabber::getFormat().
|
inherited |
Set to true if the frame grabber has been initialized.
Definition at line 103 of file vpFrameGrabber.h.
|
protectedinherited |
Number of columns in the image.
Definition at line 107 of file vpFrameGrabber.h.
Referenced by vpDirectShowGrabber::getFormat().