Visual Servoing Platform  version 3.6.1 under development (2024-11-15)
vpPylonGrabberGigE.h
1 /****************************************************************************
2  *
3  * ViSP, open source Visual Servoing Platform software.
4  * Copyright (C) 2005 - 2023 by Inria. All rights reserved.
5  *
6  * This software is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  * See the file LICENSE.txt at the root directory of this source
11  * distribution for additional information about the GNU GPL.
12  *
13  * For using ViSP with software that can not be combined with the GNU
14  * GPL, please contact Inria about acquiring a ViSP Professional
15  * Edition License.
16  *
17  * See https://visp.inria.fr for more information.
18  *
19  * This software was developed at:
20  * Inria Rennes - Bretagne Atlantique
21  * Campus Universitaire de Beaulieu
22  * 35042 Rennes Cedex
23  * France
24  *
25  * If you have questions regarding the use of this file, please contact
26  * Inria at visp@inria.fr
27  *
28  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
29  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
30  *
31  * Description: Header of vpPylonGrabberGigE class.
32  *
33  * Authors:
34  * Wenfeng CAI
35  *
36 *****************************************************************************/
37 
44 #ifndef _vpPylonGrabberGigE_h_
45 #define _vpPylonGrabberGigE_h_
46 
47 #include <visp3/core/vpConfig.h>
48 
49 #include <visp3/sensor/vpPylonGrabber.h>
50 
51 #ifdef VISP_HAVE_PYLON
52 
53 #include <pylon/gige/BaslerGigEInstantCamera.h>
54 
55 BEGIN_VISP_NAMESPACE
66 class VISP_EXPORT vpPylonGrabberGigE : public vpPylonGrabber
67 {
68 public:
70  virtual ~vpPylonGrabberGigE();
71 
73  void acquire(vpImage<vpRGBa> &I);
74 
75  void close();
76  void connect();
77  void disconnect();
78 
79  float getBlackLevel();
80  std::ostream &getCameraInfo(std::ostream &os);
81  Pylon::CInstantCamera *getCameraHandler();
83  unsigned int getCameraIndex() const { return m_index; };
84  std::string getCameraSerial(unsigned int index);
85  float getExposure();
86  float getFrameRate();
87  float getGain();
88  unsigned int getNumCameras();
89  float getGamma();
90  bool loadUserSet(UserSetName user_set);
91  UserSetName getUserSetDefault();
92 
94  bool isConnected() const { return m_connected; }
96  bool isCaptureStarted() const { return m_camera.IsGrabbing(); }
98  void open(vpImage<vpRGBa> &I);
99 
102 
103  float setBlackLevel(float blacklevel_value = 0);
104  void setCameraIndex(unsigned int index);
105  void setCameraSerial(const std::string &serial);
106  float setExposure(bool exposure_on, bool exposure_auto, float exposure_value = 0);
107  float setGain(bool gain_auto, float gain_value = 0);
108  float setFrameRate(float frame_rate);
109  float setGamma(bool gamma_on, float gamma_value = 1);
110  bool saveUserSet(UserSetName user_set, bool set_default = false);
111  bool setUserSetDefault(UserSetName user_set);
112 
113  void startCapture();
114  void stopCapture();
115 
116 protected:
117  void open();
118  bool selectUserSet(UserSetName user_set);
119 
120 private:
121  Pylon::CBaslerGigEInstantCamera m_camera;
122  unsigned int m_index;
123  unsigned int m_numCameras;
124  bool m_connected;
125 };
126 END_VISP_NAMESPACE
127 #endif // #ifdef VISP_HAVE_PYLON
128 #endif // #ifndef _vpPylonGrabberGigE_h_
bool isCaptureStarted() const
Return true if the camera capture is started.
unsigned int getCameraIndex() const
bool isConnected() const
Return true if the camera is connected.
virtual void startCapture()=0
virtual void close()=0
Stop active camera capturing images and disconnect the active camera.
virtual float getFrameRate()=0
virtual void disconnect()=0
virtual float setExposure(bool exposure_on, bool exposure_auto, float exposure_value)=0
virtual float setGain(bool gain_auto, float gain_value)=0
virtual unsigned int getNumCameras()=0
Get the number of cameras of specific subclasses. GigE, USB, etc.
virtual void setCameraSerial(const std::string &serial)=0
virtual float getBlackLevel()=0
virtual float setGamma(bool gamma_on, float gamma_value=1)=0
virtual float setFrameRate(float frame_rate)=0
virtual float getGain()=0
virtual void acquire(vpImage< unsigned char > &I)=0
virtual void stopCapture()=0
virtual float getExposure()=0
virtual bool setUserSetDefault(UserSetName user_set)=0
Sets the configuration set to be used as the default startup set.
virtual void open(vpImage< unsigned char > &I)=0
virtual vpPylonGrabber & operator>>(vpImage< unsigned char > &I)=0
virtual void connect()=0
virtual std::string getCameraSerial(unsigned int index)=0
virtual std::ostream & getCameraInfo(std::ostream &os)=0
virtual UserSetName getUserSetDefault()=0
Gets the configuration set being used as the default startup set.
virtual Pylon::CInstantCamera * getCameraHandler()=0
virtual void setCameraIndex(unsigned int index)=0
virtual bool loadUserSet(UserSetName user_set)=0
Loads the selected configuration into the camera's volatile memory and makes it the active configurat...
virtual bool saveUserSet(UserSetName user_set, bool set_default=false)=0
Saves the current active configuration set into the selected user set.
virtual float setBlackLevel(float blacklevel_value)=0
virtual float getGamma()=0