Recent changes to Home

WikiPage Home modified by Stephan Meister

Stephan Meister — Wed, 05 Dec 2012 10:01:13 -0000

--- v8
+++ v9
@@ -54,24 +54,10 @@
 
 - First, experiment with existing modules (see above) to get a feeling what charon is about.
 - In case you do not know much about standard tools such as CMake, read the [Developer Beginner Guide](DeveloperBeginnerGuide).
-- In case you would like to build the project on your own, read the [Quick Build Guide](QuickBuildGuide) and the [Build-FAQ](BuildFAQ) (no need for this, really!).
+- In case you would like to build the project on your own, read the [Quick Build Guide](BuildGuide) and the [Build-FAQ](BuildFAQ).
 - If you want to (or need to, if you are our student ;D) contribute your new modules later on, read the [Coding Conventions](CodingConventions) first!
-- Think of a simple plugin. We suggest to write a Thresholder, which takes an input image and sets all image intensities above a threshold (specified as parameter of the module) to one. The output image should be made available as so-called output-slot.
-- Use the [TemplateGenerator](template-generator) tool (you will find it in the binaries) to visually create your very first own module!
-- The tool creates three files and a CMake project. Use CMake to create a project in your favourite programming environment. (We recommend Visual Studio under Windows and QtCreator under Linux. Both are free and great tools!)
-- The .cpp file created by the TemplateGenerator contains only management code (for shared libraries). Ignore it! The .h file contains a list of input and output slots you defined in TemplateGenerator.
-- Open the generated .hxx-File and look out for a method called execute(). Add your thresholding code here. There is one important note which you will appreciate if your code does not compile or work correctly: InputSlot\, OutputSlot\, Parameter\ and ParameterList\ are templated objects to formalize the module architecture. If you want to access the actual content of a slot or a parameter, you need to use the round bracket operator "()".
+- Think of a simple plugin. We suggest to write a Thresholder, which takes an input image and sets all image intensities above a threshold (specified as parameter of the module) to one. The output image should be made available as so-called output-slot. Read the [PluginGuide] for a Tutorial.
 
-Short Example:
-
-    :::cpp
-    // Example declaration:
-    InputSlot > mySlot;
-
-    [...]
-
-    // Example usage:
-    mySlot().get_threshold(15);
 
 Please drop us an email and tell us about your first experiences (daniel*d# kondermann*a# iwr.uni*minus# heidelberg.de)!

WikiPage Home modified by Stephan Meister

Stephan Meister — Tue, 27 Nov 2012 16:43:51 -0000

--- v7
+++ v8
@@ -80,7 +80,7 @@
 - [Plugin Debugging](PluginDebugging)
 - [Plugin Testing](PluginTesting)
 - [CDash Dashboard](http://charon-suite.sourceforge.net/CDash)
-- [Project Build](ProjectBuild) (detailed description for building the project)
+- [Build Guide](BuildGuide) (detailed description for building the project)
 - [Example workflows](http://charon-suite.sourceforge.net/doc/examples/)
 
 ### Documentation, Module and Application References ###

WikiPage Home modified by Stephan Meister

Stephan Meister — Tue, 18 Sep 2012 10:06:42 -0000

--- v6
+++ v7
@@ -43,8 +43,15 @@
 - Klick on individual modules to see the parameters and browse the inline documentation for each module to understand the parameters.
 - Klick on the play button to run the algorithm.
 - Optionally change filenames of the examaple file parameters in the FileReader modules to see what the algorithm does with your data!
+
+Building your own plugins
+-------------------------
+
 In case you want *to implement a new model*, you need can do this *in a maximum of four hours*. (Prerequisites are knowledge in C++ and your favourite programming environment).
 Once you did this the first time, *each new module definition and creation takes around 5-10 minutes! *
+
+A step-by-step tutorial on how to create a new plugin can be found in the [PluginGuide].
+
 - First, experiment with existing modules (see above) to get a feeling what charon is about.
 - In case you do not know much about standard tools such as CMake, read the [Developer Beginner Guide](DeveloperBeginnerGuide).
 - In case you would like to build the project on your own, read the [Quick Build Guide](QuickBuildGuide) and the [Build-FAQ](BuildFAQ) (no need for this, really!).

WikiPage Home modified by Jens-Malte Gottfried

Jens-Malte Gottfried — Fri, 10 Aug 2012 12:21:48 -0000

--- v5
+++ v6
@@ -1,5 +1,11 @@
 Welcome to Charon-Suite
 =======================
+
+**Note: We are currently migrating the pages from the [Trac Wiki][1] to the new SourceForge Wiki. Content is still incomplete. When facing missing pages, refer to the [old location][1]**
+
+   [1]: https://sourceforge.net/apps/trac/charon-suite/wiki/
+
+
 With years of experience in computer vision, we learned (the hard way) that image processing libraries are very difficult to maintain and extend when working in a research environment.
 Typically, the learning curve for such libraries is quite steep and their life-cycle shorter than 10 years.
 Therefore, we decided to create a *framework* and associated tools *rather than a library*.

WikiPage Home modified by Jens-Malte Gottfried

Jens-Malte Gottfried — Fri, 10 Aug 2012 11:39:38 -0000

--- v4
+++ v5
@@ -75,17 +75,17 @@
 
 - [Charon-Suite Manpages](http://charon-suite.sourceforge.net/doc/man/index.html)
 - Doxygen Documentation:
-    - [charon-core](http://charon-suite.sourceforge.net/doc/charon-core/html/)
-    - [charon-utils](http://charon-suite.sourceforge.net/doc/charon-utils/html/hierarchy.html)
-    - [charon](http://charon-suite.sourceforge.net/doc/charon/html/hierarchy.html)
-    - [tuchulcha](http://charon-suite.sourceforge.net/doc/tuchulcha/html/)
+    - [Charon-Core](http://charon-suite.sourceforge.net/doc/charon-core/html/)
+    - [Charon-Utils](http://charon-suite.sourceforge.net/doc/charon-utils/html/hierarchy.html)
+    - [Charon-Flow](http://charon-suite.sourceforge.net/doc/charon/html/hierarchy.html)
+    - [Tuchulcha](http://charon-suite.sourceforge.net/doc/tuchulcha/html/)
 
 A synopsis of the existing charon modules with their input/output slots and parameters is available online:
 
 - **[Charon-Utils](charon-utils)**:
     [Modules](http://charon-suite.sourceforge.net/doc/charon-utils/modRef/)
     [Grouped](http://charon-suite.sourceforge.net/doc/charon-utils/modRef/groups.html)
-- **[Charon](charon-flow)**:
+- **[Charon-Flow](charon-flow)**:
     [Modules](http://charon-suite.sourceforge.net/doc/charon/modRef/)
     [Grouped](http://charon-suite.sourceforge.net/doc/charon/modRef/groups.html)
 
@@ -95,7 +95,7 @@
 --------------------------------------- | --------------------------------------
 [Charon-Core](charon-core)  ([doc][1])  |  Basic framework for module management
 [Charon-Utils](charon-utils) ([doc][2]) |  Basic Image manipulation and processing modules such as file reading, writing and display
-[Charon](charon-flow) ([doc][3])        |  Optical flow estimation modules
+[Charon-Flow](charon-flow) ([doc][3])   |  Optical flow estimation modules
 [Argos](argos)                          |  Advanced image viewer
 [Tuchulcha](tuchulcha) ([doc][4])       |  Graphical configuration/workflow editor for algorithm prototyping
 [TemplateGenerator](template-generator) |  Software assistant to set up module code templates

WikiPage Home modified by Jens-Malte Gottfried

Jens-Malte Gottfried — Fri, 10 Aug 2012 11:36:10 -0000

--- v3
+++ v4
@@ -5,62 +5,49 @@
 Therefore, we decided to create a *framework* and associated tools *rather than a library*.
 
 ### What is it and why is it useful? ###
-* *charon is an open source framework for computer vision prototyping.*
-* The idea is not to rely on any given image processing library such as OpenCV, Vigra, CImg or even Matlab and Python.
-* Instead we just define interfaces with a dead-simple plugin-architecture we call [Charon-Core] which has been stable since its first implementation in 2009.
-* Each part of a computer vision algorithm is called a *module* and you can *visually connect algorithms* in a tool named [Tuchulcha]. Think LabVIEW, but more generic and sexier.
-* Modules can be implemented in *any language* and may use *any software packages*.
-* Modules can be *visually plugged together*, and then be executed via C++ code or a *command line tool*.
-* The software is *very easy to learn* (there is a software assistant called [TemplateGenerator] which creates the code-template for such modules based on your interface definition).
-* You can choose your favourite programming environment thanks to [CMake](http://cmake.org/).
-* It is cross-platform and fully open source under the [LGPL](http://www.gnu.org/licenses/lgpl.html). *Do what you like with it*.
-* The number of existing algorithms and helper code such as *file reading and writing, parameter files, etc.* is steadily increasing.
-* From a supervisor's perspective it is also very useful as you can *experiment with the methods your students implemented*.
-* *Visualization* of results can either be done with special modules or *via python or Matlab without writing data converters*.
-* Modules can be easily *added* or removed from a project *without recompilation*.
-* Developing or changing modules is fast, only the module module itself needs to be (re)compiled. The rest of the project can stay untouched. This can be called the c++ equivalent of *rapid prototyping*.
-* The environment *allows for white box testing* to see which module influences the overall outcome to which extent.
+- *charon is an open source framework for computer vision prototyping.*
+- The idea is not to rely on any given image processing library such as OpenCV, Vigra, CImg or even Matlab and Python.
+- Instead we just define interfaces with a dead-simple plugin-architecture we call [Charon-Core](charon-core) which has been stable since its first implementation in 2009.
+- Each part of a computer vision algorithm is called a *module* and you can *visually connect algorithms* in a tool named [Tuchulcha](tuchulcha). Think LabVIEW, but more generic and sexier.
+- Modules can be implemented in *any language* and may use *any software packages*.
+- Modules can be *visually plugged together*, and then be executed via C++ code or a *command line tool*.
+- The software is *very easy to learn* (there is a software assistant called [TemplateGenerator](template-generator) which creates the code-template for such modules based on your interface definition).
+- You can choose your favourite programming environment thanks to [CMake](http://cmake.org/).
+- It is cross-platform and fully open source under the [LGPL](http://www.gnu.org/licenses/lgpl.html). *Do what you like with it*.
+- The number of existing algorithms and helper code such as *file reading and writing, parameter files, etc.* is steadily increasing.
+- From a supervisor's perspective it is also very useful as you can *experiment with the methods your students implemented*.
+- *Visualization* of results can either be done with special modules or *via python or Matlab without writing data converters*.
+- Modules can be easily *added* or removed from a project *without recompilation*.
+- Developing or changing modules is fast, only the module module itself needs to be (re)compiled. The rest of the project can stay untouched. This can be called the c++ equivalent of *rapid prototyping*.
+- The environment *allows for white box testing* to see which module influences the overall outcome to which extent.
 
 An image of a typical workflow for optical flow estimation in order to help you getting an idea of what we do with the software is visible in the screenshots:
 [[project_screenshots]]
 
 Here you can find some **[example workflows](http://charon-suite.sourceforge.net/doc/examples/)**.
 
-News
-----
-* Doxygen Documentation online:
-	* [charon-core](http://charon-suite.sourceforge.net/doc/charon-core/html/)
-	* [charon-utils](http://charon-suite.sourceforge.net/doc/charon-utils/html/hierarchy.html)
-	* [charon](http://charon-suite.sourceforge.net/doc/charon/html/hierarchy.html)
-	* [tuchulcha](http://charon-suite.sourceforge.net/doc/tuchulcha/html/)
-* Module Documentation online:
-	* [charon-utils](http://charon-suite.sourceforge.net/doc/charon-utils/modRef/)
-	* [charon](http://charon-suite.sourceforge.net/doc/charon/modRef/)
-* Manpages online: [manpages](http://charon-suite.sourceforge.net/doc/man/)
-* Example Workflows: [examples](http://charon-suite.sourceforge.net/doc/examples/)
-
 Getting Started
 ---------------
 Getting started takes little time, even for beginners!
 In case you would like to *experiment with existing modules*:
 
-* Download the Windows binaries or install the Debian package ([InstallationGuide]).
-* You will find files ending on .wrp in the data (which are plain-text parameter files, specifiying how modules are plugged together to form an algorithm).
-* Start tuchulcha(.exe on Windows) and load a .wrp file to look at the algorithm details.
-* Klick on individual modules to see the parameters and browse the inline documentation for each module to understand the parameters.
-* Klick on the play button to run the algorithm.
-* Optionally change filenames of the examaple file parameters in the FileReader modules to see what the algorithm does with your data!
+- Download the Windows binaries or install the Debian package ([Installation Guide](InstallationGuide)).
+- You will find files ending on .wrp in the data (which are plain-text parameter files, specifiying how modules are plugged together to form an algorithm).
+- Start tuchulcha(.exe on Windows) and load a .wrp file to look at the algorithm details.
+- Klick on individual modules to see the parameters and browse the inline documentation for each module to understand the parameters.
+- Klick on the play button to run the algorithm.
+- Optionally change filenames of the examaple file parameters in the FileReader modules to see what the algorithm does with your data!
 In case you want *to implement a new model*, you need can do this *in a maximum of four hours*. (Prerequisites are knowledge in C++ and your favourite programming environment).
 Once you did this the first time, *each new module definition and creation takes around 5-10 minutes! *
-* First, experiment with existing modules (see above) to get a feeling what charon is about.
-* In case you do not know much about standard tools such as CMake, read the [DeveloperBeginnerGuide].
-* In case you would like to build the project on your own, read the [QuickBuildGuide] and the [Build-FAQ] (no need for this, really!).
-* If you want to (or need to, if you are our student ;D) contribute your new modules later on, read the [CodingConventions] first!
-* Think of a simple plugin. We suggest to write a Thresholder, which takes an input image and sets all image intensities above a threshold (specified as parameter of the module) to one. The output image should be made available as so-called output-slot.
-* Use the [TemplateGenerator] tool (you will find it in the binaries) to visually create your very first own module!
-* The tool creates three files and a CMake project. Use CMake to create a project in your favourite programming environment. (We recommend Visual Studio under Windows and QtCreator under Linux. Both are free and great tools!)
-* The .cpp file created by the TemplateGenerator contains only management code (for shared libraries). Ignore it! The .h file contains a list of input and output slots you defined in TemplateGenerator.
-* Open the generated .hxx-File and look out for a method called execute(). Add your thresholding code here. There is one important note which you will appreciate if your code does not compile or work correctly: InputSlot\, OutputSlot\, Parameter\ and ParameterList\ are templated objects to formalize the module architecture. If you want to access the actual content of a slot or a parameter, you need to use the round bracket operator "()".
+- First, experiment with existing modules (see above) to get a feeling what charon is about.
+- In case you do not know much about standard tools such as CMake, read the [Developer Beginner Guide](DeveloperBeginnerGuide).
+- In case you would like to build the project on your own, read the [Quick Build Guide](QuickBuildGuide) and the [Build-FAQ](BuildFAQ) (no need for this, really!).
+- If you want to (or need to, if you are our student ;D) contribute your new modules later on, read the [Coding Conventions](CodingConventions) first!
+- Think of a simple plugin. We suggest to write a Thresholder, which takes an input image and sets all image intensities above a threshold (specified as parameter of the module) to one. The output image should be made available as so-called output-slot.
+- Use the [TemplateGenerator](template-generator) tool (you will find it in the binaries) to visually create your very first own module!
+- The tool creates three files and a CMake project. Use CMake to create a project in your favourite programming environment. (We recommend Visual Studio under Windows and QtCreator under Linux. Both are free and great tools!)
+- The .cpp file created by the TemplateGenerator contains only management code (for shared libraries). Ignore it! The .h file contains a list of input and output slots you defined in TemplateGenerator.
+- Open the generated .hxx-File and look out for a method called execute(). Add your thresholding code here. There is one important note which you will appreciate if your code does not compile or work correctly: InputSlot\, OutputSlot\, Parameter\ and ParameterList\ are templated objects to formalize the module architecture. If you want to access the actual content of a slot or a parameter, you need to use the round bracket operator "()".
 
 Short Example:
 
@@ -76,37 +63,43 @@
 Please drop us an email and tell us about your first experiences (daniel*d# kondermann*a# iwr.uni*minus# heidelberg.de)!
 
 ### More detailed information: ###
-* [PluginDevFAQ]
-* [PluginDebugging]
-* [PluginTesting]
-* [CDash Dashboard](http://charon-suite.sourceforge.net/CDash)
-* [ProjectBuild] (detailed description for building the project)
-* [Example workflows](http://charon-suite.sourceforge.net/doc/examples/)
+- [Plugin Developer FAQ](PluginDevFAQ)
+- [Plugin Debugging](PluginDebugging)
+- [Plugin Testing](PluginTesting)
+- [CDash Dashboard](http://charon-suite.sourceforge.net/CDash)
+- [Project Build](ProjectBuild) (detailed description for building the project)
+- [Example workflows](http://charon-suite.sourceforge.net/doc/examples/)
 
-### Module and Application References ###
-The manpages of the applications shipped with charon-suite may be read online:
-[Charon-Suite Manpages](http://charon-suite.sourceforge.net/doc/man/index.html)
+### Documentation, Module and Application References ###
+The doxygen documentation and manpages of the applications shipped with charon-suite may be read online:
+
+- [Charon-Suite Manpages](http://charon-suite.sourceforge.net/doc/man/index.html)
+- Doxygen Documentation:
+    - [charon-core](http://charon-suite.sourceforge.net/doc/charon-core/html/)
+    - [charon-utils](http://charon-suite.sourceforge.net/doc/charon-utils/html/hierarchy.html)
+    - [charon](http://charon-suite.sourceforge.net/doc/charon/html/hierarchy.html)
+    - [tuchulcha](http://charon-suite.sourceforge.net/doc/tuchulcha/html/)
 
 A synopsis of the existing charon modules with their input/output slots and parameters is available online:
 
-- **[Charon-Utils]**:
+- **[Charon-Utils](charon-utils)**:
     [Modules](http://charon-suite.sourceforge.net/doc/charon-utils/modRef/)
     [Grouped](http://charon-suite.sourceforge.net/doc/charon-utils/modRef/groups.html)
-- **[Charon]**:
+- **[Charon](charon-flow)**:
     [Modules](http://charon-suite.sourceforge.net/doc/charon/modRef/)
     [Grouped](http://charon-suite.sourceforge.net/doc/charon/modRef/groups.html)
 
 Parts of Charon-Suite
 ---------------------
-Component                 |  Description
-------------------------- | --------------------------------------
-[Charon-Core]  ([doc][1]) |  Basic framework for module management
-[Charon-Utils] ([doc][2]) |  Basic Image manipulation and processing modules such as file reading, writing and display
-[Charon] ([doc][3])       |  Optical flow estimation modules
-[Argos]                   |  Advanced image viewer
-[Tuchulcha] ([doc][4])    |  Graphical configuration/workflow editor for algorithm prototyping
-[TemplateGenerator]       |  Software assistant to set up module code templates
-[Hekate]                  |  Feature Detection, 3D Reconstruction and Stereo modules
+Component                               |  Description
+--------------------------------------- | --------------------------------------
+[Charon-Core](charon-core)  ([doc][1])  |  Basic framework for module management
+[Charon-Utils](charon-utils) ([doc][2]) |  Basic Image manipulation and processing modules such as file reading, writing and display
+[Charon](charon-flow) ([doc][3])        |  Optical flow estimation modules
+[Argos](argos)                          |  Advanced image viewer
+[Tuchulcha](tuchulcha) ([doc][4])       |  Graphical configuration/workflow editor for algorithm prototyping
+[TemplateGenerator](template-generator) |  Software assistant to set up module code templates
+[Hekate](hekate)                        |  Feature Detection, 3D Reconstruction and Stereo modules
 
    [1]: http://charon-suite.sourceforge.net/doc/charon-core/html/
    [2]: http://charon-suite.sourceforge.net/doc/charon-utils/html/hierarchy.html

WikiPage Home modified by Jens-Malte Gottfried

Jens-Malte Gottfried — Fri, 10 Aug 2012 11:01:46 -0000

--- v2
+++ v3
@@ -113,10 +113,6 @@
    [3]: http://charon-suite.sourceforge.net/doc/charon/html/hierarchy.html
    [4]: http://charon-suite.sourceforge.net/doc/tuchulcha/html/
 
-Developer Self-Organization
----------------------------
-- [Developer-Update]: Wiki for work in progress and recent achievements.
-- [Developer-Discussion]: Public discussions and lists of wishes/ideas for potential future development.
 
 License
 -------

WikiPage Home modified by Jens-Malte Gottfried

Jens-Malte Gottfried — Wed, 25 Jul 2012 11:44:08 -0000

--- v1
+++ v2
@@ -1,8 +1,123 @@
-Welcome to your wiki!
+Welcome to Charon-Suite
+=======================
+With years of experience in computer vision, we learned (the hard way) that image processing libraries are very difficult to maintain and extend when working in a research environment.
+Typically, the learning curve for such libraries is quite steep and their life-cycle shorter than 10 years.
+Therefore, we decided to create a *framework* and associated tools *rather than a library*.
 
-This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].
+### What is it and why is it useful? ###
+* *charon is an open source framework for computer vision prototyping.*
+* The idea is not to rely on any given image processing library such as OpenCV, Vigra, CImg or even Matlab and Python.
+* Instead we just define interfaces with a dead-simple plugin-architecture we call [Charon-Core] which has been stable since its first implementation in 2009.
+* Each part of a computer vision algorithm is called a *module* and you can *visually connect algorithms* in a tool named [Tuchulcha]. Think LabVIEW, but more generic and sexier.
+* Modules can be implemented in *any language* and may use *any software packages*.
+* Modules can be *visually plugged together*, and then be executed via C++ code or a *command line tool*.
+* The software is *very easy to learn* (there is a software assistant called [TemplateGenerator] which creates the code-template for such modules based on your interface definition).
+* You can choose your favourite programming environment thanks to [CMake](http://cmake.org/).
+* It is cross-platform and fully open source under the [LGPL](http://www.gnu.org/licenses/lgpl.html). *Do what you like with it*.
+* The number of existing algorithms and helper code such as *file reading and writing, parameter files, etc.* is steadily increasing.
+* From a supervisor's perspective it is also very useful as you can *experiment with the methods your students implemented*.
+* *Visualization* of results can either be done with special modules or *via python or Matlab without writing data converters*.
+* Modules can be easily *added* or removed from a project *without recompilation*.
+* Developing or changing modules is fast, only the module module itself needs to be (re)compiled. The rest of the project can stay untouched. This can be called the c++ equivalent of *rapid prototyping*.
+* The environment *allows for white box testing* to see which module influences the overall outcome to which extent.
 
-The wiki uses [Markdown](/p/charon-suite/wiki/markdown_syntax/) syntax.
+An image of a typical workflow for optical flow estimation in order to help you getting an idea of what we do with the software is visible in the screenshots:
+[[project_screenshots]]
 
-[[project_admins]]
-[[download_button]]
+Here you can find some **[example workflows](http://charon-suite.sourceforge.net/doc/examples/)**.
+
+News
+----
+* Doxygen Documentation online:
+	* [charon-core](http://charon-suite.sourceforge.net/doc/charon-core/html/)
+	* [charon-utils](http://charon-suite.sourceforge.net/doc/charon-utils/html/hierarchy.html)
+	* [charon](http://charon-suite.sourceforge.net/doc/charon/html/hierarchy.html)
+	* [tuchulcha](http://charon-suite.sourceforge.net/doc/tuchulcha/html/)
+* Module Documentation online:
+	* [charon-utils](http://charon-suite.sourceforge.net/doc/charon-utils/modRef/)
+	* [charon](http://charon-suite.sourceforge.net/doc/charon/modRef/)
+* Manpages online: [manpages](http://charon-suite.sourceforge.net/doc/man/)
+* Example Workflows: [examples](http://charon-suite.sourceforge.net/doc/examples/)
+
+Getting Started
+---------------
+Getting started takes little time, even for beginners!
+In case you would like to *experiment with existing modules*:
+
+* Download the Windows binaries or install the Debian package ([InstallationGuide]).
+* You will find files ending on .wrp in the data (which are plain-text parameter files, specifiying how modules are plugged together to form an algorithm).
+* Start tuchulcha(.exe on Windows) and load a .wrp file to look at the algorithm details.
+* Klick on individual modules to see the parameters and browse the inline documentation for each module to understand the parameters.
+* Klick on the play button to run the algorithm.
+* Optionally change filenames of the examaple file parameters in the FileReader modules to see what the algorithm does with your data!
+In case you want *to implement a new model*, you need can do this *in a maximum of four hours*. (Prerequisites are knowledge in C++ and your favourite programming environment).
+Once you did this the first time, *each new module definition and creation takes around 5-10 minutes! *
+* First, experiment with existing modules (see above) to get a feeling what charon is about.
+* In case you do not know much about standard tools such as CMake, read the [DeveloperBeginnerGuide].
+* In case you would like to build the project on your own, read the [QuickBuildGuide] and the [Build-FAQ] (no need for this, really!).
+* If you want to (or need to, if you are our student ;D) contribute your new modules later on, read the [CodingConventions] first!
+* Think of a simple plugin. We suggest to write a Thresholder, which takes an input image and sets all image intensities above a threshold (specified as parameter of the module) to one. The output image should be made available as so-called output-slot.
+* Use the [TemplateGenerator] tool (you will find it in the binaries) to visually create your very first own module!
+* The tool creates three files and a CMake project. Use CMake to create a project in your favourite programming environment. (We recommend Visual Studio under Windows and QtCreator under Linux. Both are free and great tools!)
+* The .cpp file created by the TemplateGenerator contains only management code (for shared libraries). Ignore it! The .h file contains a list of input and output slots you defined in TemplateGenerator.
+* Open the generated .hxx-File and look out for a method called execute(). Add your thresholding code here. There is one important note which you will appreciate if your code does not compile or work correctly: InputSlot\, OutputSlot\, Parameter\ and ParameterList\ are templated objects to formalize the module architecture. If you want to access the actual content of a slot or a parameter, you need to use the round bracket operator "()".
+
+Short Example:
+
+    :::cpp
+    // Example declaration:
+    InputSlot > mySlot;
+
+    [...]
+
+    // Example usage:
+    mySlot().get_threshold(15);
+
+Please drop us an email and tell us about your first experiences (daniel*d# kondermann*a# iwr.uni*minus# heidelberg.de)!
+
+### More detailed information: ###
+* [PluginDevFAQ]
+* [PluginDebugging]
+* [PluginTesting]
+* [CDash Dashboard](http://charon-suite.sourceforge.net/CDash)
+* [ProjectBuild] (detailed description for building the project)
+* [Example workflows](http://charon-suite.sourceforge.net/doc/examples/)
+
+### Module and Application References ###
+The manpages of the applications shipped with charon-suite may be read online:
+[Charon-Suite Manpages](http://charon-suite.sourceforge.net/doc/man/index.html)
+
+A synopsis of the existing charon modules with their input/output slots and parameters is available online:
+
+- **[Charon-Utils]**:
+    [Modules](http://charon-suite.sourceforge.net/doc/charon-utils/modRef/)
+    [Grouped](http://charon-suite.sourceforge.net/doc/charon-utils/modRef/groups.html)
+- **[Charon]**:
+    [Modules](http://charon-suite.sourceforge.net/doc/charon/modRef/)
+    [Grouped](http://charon-suite.sourceforge.net/doc/charon/modRef/groups.html)
+
+Parts of Charon-Suite
+---------------------
+Component                 |  Description
+------------------------- | --------------------------------------
+[Charon-Core]  ([doc][1]) |  Basic framework for module management
+[Charon-Utils] ([doc][2]) |  Basic Image manipulation and processing modules such as file reading, writing and display
+[Charon] ([doc][3])       |  Optical flow estimation modules
+[Argos]                   |  Advanced image viewer
+[Tuchulcha] ([doc][4])    |  Graphical configuration/workflow editor for algorithm prototyping
+[TemplateGenerator]       |  Software assistant to set up module code templates
+[Hekate]                  |  Feature Detection, 3D Reconstruction and Stereo modules
+
+   [1]: http://charon-suite.sourceforge.net/doc/charon-core/html/
+   [2]: http://charon-suite.sourceforge.net/doc/charon-utils/html/hierarchy.html
+   [3]: http://charon-suite.sourceforge.net/doc/charon/html/hierarchy.html
+   [4]: http://charon-suite.sourceforge.net/doc/tuchulcha/html/
+
+Developer Self-Organization
+---------------------------
+- [Developer-Update]: Wiki for work in progress and recent achievements.
+- [Developer-Discussion]: Public discussions and lists of wishes/ideas for potential future development.
+
+License
+-------
+The project is released under the conditions of the [LGPL](http://www.gnu.org/licenses/lgpl.html).

WikiPage Home modified by Jens-Malte Gottfried

Jens-Malte Gottfried — Wed, 25 Jul 2012 07:06:35 -0000

Welcome to your wiki! This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage]. The wiki uses [Markdown](/p/charon-suite/wiki/markdown_syntax/) syntax. [[project_admins]] [[download_button]]