Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
template_article [2017/06/02 09:41] jschlie1 |
template_article [2017/06/06 16:15] (current) nfische [Modes/Processes] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Name of logic (i.e. Append) ====== | + | ====== Template Logic Description ====== |
| THIS position should be used for a brief introduction (max 2 sentences!) of the logic, stating WHAT and WHY it is doing something. | THIS position should be used for a brief introduction (max 2 sentences!) of the logic, stating WHAT and WHY it is doing something. | ||
| Line 8: | Line 8: | ||
| Here, a very specific example should be given/described. In the future, this can be supported by screenshots etc.. For the moment, give an example easy enough for the user to understand, but specific enough to elaborate why a given parameter is a good set for this very situation. | Here, a very specific example should be given/described. In the future, this can be supported by screenshots etc.. For the moment, give an example easy enough for the user to understand, but specific enough to elaborate why a given parameter is a good set for this very situation. | ||
| - | ===== Modes (only use if n > 1 modes) ===== | + | ===== Modes/Processes ===== |
| - | ==== ModeBBBB ==== | + | ==== thisIsTheNameOfMode1 ==== |
| Here, a short introduction for the given mode should be placed. Again, state WHAT and WHY this mode us useful in not more than 2 sentences. | Here, a short introduction for the given mode should be placed. Again, state WHAT and WHY this mode us useful in not more than 2 sentences. | ||
| - | === #Parameters === | ||
| - | * make a list of parameters | ||
| - | * or make a table | ||
| - | === #Inputs === | ||
| - | * make a list of existing inputs for this mode | ||
| - | * or make a table | ||
| - | === #Outputs === | ||
| - | * make a list of existing outputs for this mode | ||
| - | * or make a table | ||
| - | === #New/Changed Header Values === | ||
| - | * which header values have changed | ||
| - | * which header values are new | ||
| - | ==== ModeBBBB ==== | + | |< 100% 30% >| |
| + | ^ Parameters ^ Description ^ | ||
| + | | Some changeable parameter | Description of this parameter | | ||
| + | | -> and its sub-parameter | more description | | ||
| + | | Next main parameter | and more more more | | ||
| + | | -> and its sub-parameter | ... descriptions | | ||
| + | |||
| + | |< 100% 30% >| | ||
| + | ^ Input ^ Description ^ | ||
| + | | FirstInput | Input Description 1 | | ||
| + | | SecondInput | Input Description 2 | | ||
| + | | //ThirdInput// | Input Description 3: Optional Input in Italic | | ||
| + | |||
| + | |< 100% 30% >| | ||
| + | ^ Output ^ Description ^ | ||
| + | | FirstOutput | Output Description | | ||
| + | |||
| + | |< 100% 30% >| | ||
| + | ^ New/Changed Header Values ^ Description ^ | ||
| + | | headerValue1 | what does it say? how is it changed? | | ||
| + | | headerValue2 | what does it say? how is it changed? | | ||
| + | | headerValue3 | what does it say? how is it changed? | | ||
| + | | headerValue4 | what does it say? how is it changed? | | ||
| + | |||
| + | ==== thisIsTheNameOfMode2 ==== | ||
| Here, a short introduction for the given mode should be placed. Again, state WHAT and WHY this mode us useful in not more than 2 sentences. | Here, a short introduction for the given mode should be placed. Again, state WHAT and WHY this mode us useful in not more than 2 sentences. | ||
| - | === #Parameters === | ||
| - | * make a list of parameters | ||
| - | * or make a table | ||
| - | === #Inputs === | ||
| - | * make a list of existing inputs for this mode | ||
| - | * or make a table | ||
| - | === #Outputs === | ||
| - | * make a list of existing outputs for this mode | ||
| - | * or make a table | ||
| - | === #New/Changed Header Values === | ||
| - | * which header values have changed | ||
| - | * which header values are new | ||
| - | ===== Concept ===== | + | |< 100% 30% >| |
| - | In this paragraph, the "HOW a logic works under the hood" and WHY someone should use it can be elaborated with higher detail | + | ^ Parameters ^ Description ^ |
| + | | Some changeable parameter | Description of this parameter | | ||
| + | | -> and its sub-parameter | more description | | ||
| + | | Next main parameter | and more more more | | ||
| + | | -> and its sub-parameter | ... descriptions | | ||
| - | Describes a scenario in an image processing workflow where this logic can be used to solve the resulting problem. Also, wikipages, publications or anything else describing the theory behind an algorithm should be linked here, if applicable. | + | |< 100% 30% >| |
| + | ^ Input ^ Description ^ | ||
| + | | FirstInput | Input Description 1 | | ||
| + | | SecondImput | Input Description 2 | | ||
| + | | ThridImput | Input Description 1 | | ||
| + | |||
| + | |< 100% 30% >| | ||
| + | ^ Output ^ Description ^ | ||
| + | | FirstOutput | Output Description | | ||
| + | |||
| + | |< 100% 30% >| | ||
| + | ^ New/Changed Header Values ^ Description ^ | ||
| + | | headerValue1 | what does it say? how is it changed? | | ||
| + | | headerValue2 | what does it say? how is it changed? | | ||
| + | | headerValue3 | what does it say? how is it changed? | | ||
| + | | headerValue4 | what does it say? how is it changed? | | ||
| + | |||
| + | ===== Concept ===== | ||
| + | In this paragraph, the "HOW a logic works under the hood" and WHY someone should use it can be elaborated with higher detail. Describes a scenario in an image processing workflow where this logic can be used to solve the resulting problem. Also, wikipages, publications or anything else describing the theory behind an algorithm should be linked here, if applicable. | ||