From f2c8d5a1a37d5d34421248c514cf01b651ccfe4e Mon Sep 17 00:00:00 2001 From: kznr Date: Thu, 26 Mar 2020 17:55:02 +0900 Subject: [PATCH] Update the documentation for PyPI --- docs/index.rst | 90 +++++++++++++++++++++++++++++++++----------------- 1 file changed, 59 insertions(+), 31 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index be3eb87..a34f13f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,55 +2,83 @@ Harvester's Documentation ######################### -*Even though we just wanted to research image processing algorithms, why did we have to change our image acquisition library every time we change the camera that we use for the research? -- Anonymous* +.. figure:: https://user-images.githubusercontent.com/8652625/40595190-1e16e90e-626e-11e8-9dc7-207d691c6d6d.jpg + :align: center + :alt: The Harvesters -*************** -About Harvester -*************** + Pieter Bruegel the Elder, The Harvesters, 1565, (c) The Metropolitan Museum of Art -Harvester was created to be a public and friendly image acquisition library for all people who those want to learn computer/machine vision. Technically speaking, Harvester is a Python library which is responsible for the following tasks: +############ +Introduction +############ -* Image acquisition -* Device manipulation -* Image data visualization (optional) +Hello everyone. I'm Kazunari, the author of Harvester and a technical contributor to GenICam. -Harvester consumes image acquisition libraries, so-called GenTL Producers. If you have an officially certified GenTL Producer and GenICam compliant machine vision cameras, then Harvester supply you the acquired image data as `numpy `_ array to make your image processing task productive. +Since I opened the source code of Harvester in May 2018, so many people tried out that and gave me very positive feedback that improves Harvester. The number of feedback and the number of people who I discussed with was much more than I expected what I had in the beginning and it truly was one of the exciting experiences I ever had in my professional career. -You can freely use, modify, distribute Harvester under `Apache License-2.0 `_ without worrying about the use of your software: personal, internal or commercial. +The original motivation that drove me to develop Harvester was like this: Until I got the idea of Harvester, I had to learn and adapt to popular proprietary 3rd party image acquisition/processing libraries from scratch every time even though I just wanted to acquire an image. To be honest, I had felt it's a bit annoying. A straightforward solution to the issue was to have a unified image acquisition library. In addition, as a guy who likes to work with Python, I wanted to make it a Python module to boost productivity. -Currently, Harvester is being developed and maintained by the motivated volunteer contributors from all over the world. +I believe that Harvester can help you to concentrate on image processing that you really have to be responsible for. Of course, you would have to implement the algorithm again using other sophisticated and powerful proprietary libraries to optimize the performance in reality. However, (this is very important so let me stress this) Harvester is just a productive sandbox that encapsulates the image acquisition process and does not intend to take the place of such superior image processing libraries because they were designed for exactly that purpose. Harvester just wants to shorten the time you spend to realize your brilliant ideas as much as possible. With this meaning, Harvester can be considered as a tool that helps you to quickly iterate the prototyping process. Note that it is vital for designers because the prototyping process defines the basic quality of the final product. Fortunately, Harvester has got firm support from the high-quality GenTL Producers on the market. It means you can smoothly start working with any GenICam compliant cameras that you may want to work with. -*************************** -Why is it called Harvester? -*************************** +So, everyone, there's no worry anymore. Keep having fun working. Harvester has got your back. -Harvester's name was derived from the great Flemish painter, Pieter Bruegel the Elder's painting so-called "The Harvesters". Harvesters harvest a crop every season that has been fully grown and the harvested crop is passed to the consumers. On the other hand, image acquisition libraries acquire images as their crop and the images are passed to the following processes. We found the similarity between them and decided to name our library Harvester. +Greetings, Kazunari Kudo. -Apart from anything else, we love its peaceful and friendly name. We hope you also like it ;-) +************************** +Harvester as Python Module +************************** -.. figure:: https://user-images.githubusercontent.com/8652625/40595190-1e16e90e-626e-11e8-9dc7-207d691c6d6d.jpg - :align: center - :alt: The Harvesters - :scale: 55 % +Techincally speaking, Harvester consists of two Python modules, Harvester Core and Harvester GUI, and technically speaking, each library is responsible for the following tasks: + +- Harvester Core: Image acquisition & remote device manipulation +- Harvester GUI: Image data visualization - Pieter Bruegel the Elder, The Harvesters, 1565, (c) 2000–2018 The Metropolitan Museum of Art +Harvester consumes image acquisition libraries, so-called GenTL Producers. Just grabbing a GenTL Producer and GenICam compliant machine vision cameras, then Harvester will supply you the acquired image data as `numpy `_ array to make your image processing task productive. + +You can freely use, modify, distribute Harvester under `Apache License-2.0 `_ without worrying about the use of your software: personal, internal or commercial. + +Currently, Harvester is being developed by the motivated contributors from all over the world. + +*********************** +Where Is The Name From? +*********************** + +Harvester's name is from the great Flemish painter, Pieter Bruegel the Elder's painting so-called "The Harvesters". You can see the painting in the top of this page. Harvesters harvest a crop every season that has been fully grown and the harvested crop is passed to the consumers. On the other hand, image acquisition libraries acquire images as their crop and the images are passed to the following processes. We found the similarity between them and decided to name our library Harvester. + +Apart from anything else, we love its peaceful and friendly name. **************** -Asking questions +Asking Questions **************** -We have prepared a chat room in Gitter. Please don't hesitate to drop your message when you get a question regarding Harvester! +We have prepared an FAQ page. Perhaps your issue could be resolved just reading through it: + +https://github.com/genicam/harvesters/wiki/FAQ + +If any article was not mentioning about the issue you are facing, please try to visit the following page and check if there's a ticket that is relevant to the issue. If nothing has been mentioned yet, feel free to create an issue ticket so that we can support you: -https://gitter.im/genicam-harvester/chatroom +https://github.com/genicam/harvesters/issues -************** -External links -************** +*************** +Important Links +*************** -* `GitHub `_: This is the main repository of Harvester -* `PyPI `_: This is the package distribution page of Harvester which is located in PyPI -* `Read the Docs `_: You can find the API reference of Harvester Core and Harvester GUI +.. list-table:: + + - - Documentation + - https://harvesters.readthedocs.io/en/latest/ + - - Digital Object Identifier + - https://zenodo.org/record/3554804#.Xd4HSi2B01I + - - EMVA website + - https://www.emva.org/standards-technology/genicam/genicam-downloads/ + - - Harvester GUI + - https://github.com/genicam/harvesters_gui + - - Issue tracker + - https://github.com/genicam/harvesters/issues + - - PyPI + - https://pypi.org/project/harvesters/ + - - Source repository + - https://github.com/genicam/harvesters ***************** Table of Contents