Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision 		Previous revision
eyes:logics:splitinput [2017/06/09 16:31]
jschlie1 created 		eyes:logics:splitinput [2017/06/09 17:36] (current)
jschlie1
Line 1: Line 1:
 ====== SplitInput ====== ====== SplitInput ======
-THIS position should be used for a brief introduction (max 2 sentences!) ​of the logic, stating WHAT and WHY it is doing something.+This module splits an input stack of images into equally sized subsets of images based on a selected splitting method. This can be useful, to  ​
  
-===== Usage ===== +===== Parameters and I/O =====
-Here, a general/generic description of HOW the logic is USED should be given. Try to be as general as possible, but also mention prerequisites,​ restrictions,​ advantages, requirements which are specific of this logic. Basically everything the user needs to know to successfully use this logic. +
- +
-===== Example ==== +
-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/​Processes ===== +
-==== 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.+
  
 |< 100% 30% >| |< 100% 30% >|
 ^ Parameters ​                ^ Description ​    ^ ^ Parameters ​                ^ Description ​    ^
-| Some changeable parameter  ​| Description of this parameter ​| +| Mode                       | Select a mode (see below). ​| 
-| -> and its sub-parameter ​  | more description ​| +| -> Header key              ​| If "Split by headerkey"​ is selected as mode, the user needs to specify a header key here. | 
-| Next main parameter ​       ​| and more more more | +| Number of outputs ​         ​| Select the number of outputs/​stacks,​ the input shall be split into. |
-| -> and its sub-parameter ​  | ... descriptions ​|+
  
 |< 100% 30% >| |< 100% 30% >|
-^ Input   ^ Description ^ +^ Modes                      ​^ Description ​    ​^ 
-| FirstInput  ​| Input Description 1 | +| Split by headerkey ​        | If selected, the specified header key is used to sort the data, before ​the set is split into equally sized subsets. | 
-| SecondInput | Input Description 2 | +| Randomize ​                 ​| The images will be randomly split into the selected number ​of outputs stacks. All output stacks will be equally sized. | 
-| //​ThirdInput// ​ | Input Description 3: Optional Input in Italic | +| Equally spaced ​            | The original stack with its original sorting will be split into equally sized stacks. |
- +
-|< 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. +
- +
-|< 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 | +
-| 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.+