|
<< Click to Display Table of Contents >> Navigation: »No topics above this level« About this Documentation |
At the top level of this documentation a general introduction gives an overview of Common Vision Blox, covering the topics
•where to get it
•how to activate licenses for Common Vision Blox
•getting started with GenICam Browser or Management Console.
Following that are sections documenting* the Common Vision Blox
•Image Manager and the
•Foundation Package (the two basic modules of Common Vision Blox). Image Processing
•Image Processing Tools and Foundation Tools are also available as single manuals in %CVB%Doc (Windows) or /opt/cvb/doc (Linux) directory.
Please refer CVB Release Notes for tool availability in your setup (win32, Win64,Linux).
For users unfamiliar with Common Vision Blox, it is recommended to go through the Introduction and the Image Manager chapters first to learn the basic concepts that are valid throughout all the other modules of Common Vision Blox.
Additional Online Documentation for CVB is available as:
❑ Hardware depending CVB Configuration
❑ CVB GenICam Driver User Guide
❑ CVB Programmers Reference (C, C++, .Net and Python API)
❑ Application Notes
Hints for Programming with Common Vision Blox as well as Example Applications (Tutorials) for Image Manager and Foundation Package information for Common Vision Blox may also be found in this manual and under
❑ %CVB%Tutorial path.
❑ Local CVB documentation files after installation can be found in directories :
%CVB%Doc (Windows)
/opt/cvb/doc (Linux)
*Inside either of these groups, the documentation of each module always consists of the following sections:
•An Introduction and Overview part that explains the background of the module and the implemented algorithms in enough detail to use them successfully in an application.
•A Reference part for the DLLs and/or Active X Controls that come with the module.
This reference part is auto-generated using the utility Doxygen.
It lists and cross-references the available functions and definitions with their signatures.
To map these to another language, please also have a look at the definitions in the header/wrapper file for the programming language you've chosen (usually IntelliSense or a similar mechanism will display the exact function signature in your language as soon as you type the function/type name in you development environment...).
•Optionally a Documentation of the .Net wrapper for the module.
This section is only present where the .Net wrapper's API differs significantly from the C/C++ API.
This is the case where an effort has been made to create an object oriented wrapper around the plain C exports that usually dominate the Common Vision Blox API.
Object oriented APIs significantly increase the ease of use, however it is not always easy to map methods and properties of objects to their underlying C function calls, which is why we used the tool NDoc2 to generate an MSDN-style documentation for our object oriented wrappers where applicable.