Package: harvesters-gui
Pieter Bruegel the Elder, The Harvesters, 1565, (c) The Metropolitan Museum of ArtWhat Is Harvester GUI?Harvester GUI is a reference implementation of aHarvester-based GUI. We need to admit that it must not be the one that satisfies your realuse cases but it should give you an idea how you can design a GUI that is based on Harvester as its image acquisition front-end.You can freely use, modify, distribute Harvester underApache License-2.0without worrying about the use of your software: personal, internal or commercial.Table of ContentsWhat Is Harvester GUI?AnnouncementsInstallationHow does Harvester GUI us?ScreenshotsUsing Harvester GUIAcknowledgementsDisclaimer: All external pictures should have associated credits. If there are missing credits, please tell us, we will correct it. Similarly, all excerpts should be sourced. If not, this is an error and we will correct it as soon as you tell us.AnnouncementsVersion 1.0.2: Resolves issue#22.Version 1.0.1: Resolves issue#17.Version 1.0.0: Resolves issue#16.Version 0.4.0: Resolves issue#15.Version 0.3.0: Resolves issues#11and#14.Version 0.2.6: Resolves issue#13.Version 0.2.5: Use Harvester version0.2.4.Version 0.2.4: Use Harvester version0.2.3.Version 0.2.3: Use Harvester version0.2.2.Version 0.2.2: Resolves issue#5.Version 0.2.1: Works with Harvester versions >=0.2.1.Version 0.2.0: Works with Harvester versions >=0.2.0.Version 0.1.0: Note that this version will be deprecated and the following versions will be incompatible with any of0.1.nversions.External linksHarvester: Image acquisition front-end libraryPyPI: This is the package distribution page of Harvester which is located in PyPIRead the Docs: You can find the API reference of Harvester and Harvester GUIInstallationIn this section, we will learn how to instruct procedures to get Harvester work.System RequirementsThe following software modules are required to get Harvester working:Python>=3.5,<3.9In addition, you will need the following items to let Harvester make something meaningful:GenTL ProducersGenICam compliant machine vision camerasInstalling Harvester GUIIf you want to use Harvester GUI, then please invoke the following command:$pipinstallharvesters_guiNote thatPyQt5is distributed under LGPL and it may not be ideal for your purpose. In the future, we might support other GUI frameworks which are more or less open and free.Launching Harvester GUITo launch Harvester GUI, let’s create a Python script file, namingharvester.py, that contains the following code:importsysfromPyQt5.QtWidgetsimportQApplicationfromharvesters_gui.frontend.pyqt5importHarvesterif__name__=='__main__':app=QApplication(sys.argv)h=Harvester()h.show()sys.exit(app.exec_())Then launchharvester.py:$pythonpath/to/harvester.pyYou will see Harvester GUI pops up.How does Harvester GUI us?Harvester GUI works on the top of Harvester and offers you high-performance image data visualization on the fly. It involves VisPy for controlling OpenGL functionality and PyQt for providing GUI.The main features of Harvester GUI are listed as follows:Image data visualization of the acquired imagesImage magnification using a mouse wheel or a trackpadImage dragging using a mouse or a trackpadAn arbitrary selection of image displaying point in the data path (Not implemented yet)Unlike Harvester, Harvester GUI limits the number of GenTL Producers to load just one. This is just a limitation to not make the GUI complicated. In general, the user should know which GenTL Producer should be loaded to control his target remote device. It’s not necessary to load multiple GenTL Producers for this use case. However, this is just an idea in an early stage. We might support multiple loading on even Harvester GUI in the future.ScreenshotsIn this section, we see some useful windows which Harvester GUI offers you.Image data visualizer windowThe image data visualizer window (below) offers you a visualization of the acquired images. In this screenshot, Harvester is acquiring a 4000 x 3000 pixel of RGB8 image at 30 fps; it means it’s acquiring images at 8.6 Gbps. It’s quite fast, isn’t it?Attribute controller windowThe attribute controller window (below) offers you to manipulate GenICam feature nodes of the target remote device. Changing exposure time, triggering the target remote device for image acquisition, storing a set of camera configuration so-called User Set, etc, you can manually control the target remote device anytime when you want to. It supports the visibility filter feature and regular expression feature. These features are useful in a case where you need to display only the features you are interested in.Using Harvester GUIImage data visualizer windowImage data visualizer window :: ToolbarMost of Harvester GUI’s features can be used through its toolbox. In this section, we describe each button’s functionality and how to use it. Regarding shortcut keys, replaceCtrlwithCommandon macOS.Selecting a CTI fileThis button is used to select a GenTL Producer file to load. The shortcut key isCtrl+o.Updating the remote device information listThis button is used to update the remote device information list; the list will be filled up with the remote devices that are handled by the GenTL Producer that you have loaded on Harvester GUI; sometime it might be empy if there’s no remote device is available. The shortcut key isCtrl+u. It might be useful when you newly connect a remote device to your system.Selecting a GenICam compliant remote deviceThis combo box shows a list of available GenICam compliant remote devices. You can select a remote device that you want to control. The shortcut key isCtrl+D, i.e.,Ctrl+Shift+d.Connecting a selected remote device to HarvesterThis button is used to connect a remote device which is being selected by the former combo box. The shortcut key isCtrl+c. Once you connect the remote device, the remote device is exclusively controlled.Disconnecting the connecting remote device from HarvesterThis button is used to disconnect the connecting remote device from Harvester. The shortcut key isCtrl+d.Starting image acquisitionThis button is used to start image acquisition. The shortcut key isCtrl+j. The acquired images will be drawing in the following canvas pane.Pausing/Resuming image drawingThis button is used to pausing/resuming drawing images on the canvas pane while it’s keep acquiring images in the background. The shortcut key isCtrl+k. If you want to resume drawing images, just click the button again. You can do the same thing with the start image acquisition button (Ctrl+j).Stopping image acquisitionThis button is used to stop image acquisition. The shortcut key isCtrl+l.Showing the remote device attribute dialogThis button is used to show the remote device attribute dialog. The shortcut key isCtrl+a. The remote device attribute dialog offers you to a way to intuitively control remote device attribute over a GUI.Showing the about dialogThis button is used to show the about dialog.Image data visualizer window :: CanvasThe canvas of Harvester GUI offers you not only image data visualization but also some intuitive object manipulations.Zooming into the displayed imageIf you’re using a mouse, spin the wheel to your pointing finger points at. If you are using a trackpad on a macOS, slide two fingers to the display side.Zooming out from the displayed imageIf you’re using a mouse, spin the wheel to your side. If you are using a trackpad on a macOS, slide two fingers to your side.Changing the part being displayedIf you’re using a mouse, grab any point in the canvas and drag the pointer as if you’re physically grabbing the image. The image will follow the pointer. If you are using a trackpad on a macOS, it might be useful if you assign the three finger slide for dragging.Attribute controller windowThe attribute controller offers you an interface to each GenICam feature node that the the target remote device provides.Attribute controller window :: ToolbarFiltering GenICam feature nodes by visibilityThis combo box offers you to apply visibility filter to the GenICam feature node tree. The shortcut key isCtrl+vGenICam defines the following visibility levels:Beginner: Features that should be visible for all users via the GUI and API.Expert: Features that require a more in-depth knowledge of the camera functionality.Guru: Advanced features that might bring the cameras into a state where it will not work properly anymore if it is set incorrectly for the cameras current mode of operation.Invisible: Features that should be kept hidden for the GUI users but still be available via the API.The following table shows each item in the combo box and the visibility status of each visibility level:Combo box itemBeginnerExpertGuruInvisibleBeginnerVisibleInvisibleInvisibleInvisibleExpertVisibleVisibleInvisibleInvisibleGuruVisibleVisibleVisibleInvisibleAllVisibleVisibleVisibleVisibleFiltering GenICam feature nodes by regular expressionThis text edit box offers you to filter GenICam feature nodes by regular expression.Expanding the feature node treeThis button is used to expand the feature node tree. The shortcut key isCtrl+e.Collapsing the feature node treeThis button is used to collapse the feature node tree. The shortcut key isCtrl+c.AcknowledgementsOpen source resourcesHarvester GUI uses the following open source libraries/resources:VisPyLicense:BSD 3-ClauseCopyright (c) 2013-2018 VisPy developershttp://vispy.orghttps://github.com/vispy/vispyPyQt5License:GPLv3Copyright (c) 2018 Riverbank Computing Limitedhttps://www.riverbankcomputing.comhttps://pypi.org/project/PyQt5/Icons8License:Creative Commons Attribution-NoDerivs 3.0 UnportedCopyright (c) Icons8 LLChttps://icons8.com