Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
eyes:logics:extractbymember [2017/06/09 18:37] nfische created |
eyes:logics:extractbymember [2017/06/12 19:33] (current) kbertra2 [Process] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Template Logic Description ====== | + | ====== ExtractByMembers ====== |
| - | THIS position should be used for a brief introduction (max 2 sentences!) of the logic, stating WHAT and WHY it is doing something. | + | Use this logic to extract particles images based on their membership to classes as selected beforehand with the interactive logic [[eyes:interactive:extract|]]. |
| ===== Usage ===== | ===== Usage ===== | ||
| - | 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. | + | After [[:eyes:logics:Classification]] one often wants not only to define certain class averages for further processing, but also the corresponding particles images. For this purpose, class averages have to be first selected with the interactive logic [[eyes:interactive:extract|]]. This logic then allows to extract or exclude the corresponding particles from the total data. Alternatively, with the key "referenceData" this logic may be used to select particles according to their assignment to a certain reference from [[:eyes:logics:Alignment]]. |
| ===== Example ==== | ===== 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. | ||
| + | ===== Process ===== | ||
| |< 100% 30% >| | |< 100% 30% >| | ||
| ^ Parameters ^ Description ^ | ^ Parameters ^ Description ^ | ||
| - | | Some changeable parameter | Description of this parameter | | + | | Work on key - //clusterMember// | Use this key to extract particles images according to their class membership. | |
| - | | -> and its sub-parameter | more description | | + | | Work on key - //referenceData// | Use this key to extract particles images according to their assignment to a certain reference. | |
| - | | Next main parameter | and more more more | | + | | Extract mode - //Keep selected// | All particles belonging to the chosen classes/references will be kept. | |
| - | | -> and its sub-parameter | ... descriptions | | + | | Extract mode - //Discard selected// | All particles belonging to the chosen classes/references will be discarded, and only particles belonging to the not chosen classes/references will be kept. | |
| - | |< 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. | ||
| - | |||
| - | |< 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% >| | |< 100% 30% >| | ||
| ^ Input ^ Description ^ | ^ Input ^ Description ^ | ||
| - | | FirstInput | Input Description 1 | | + | | Pre extract io | Information about the chosen class averages/references, i.e. "io::out" from the interactive logic [[eyes:interactive:extract|]]. | |
| - | | SecondImput | Input Description 2 | | + | | In | Particle images with assigned class membership ("clusterMember") or reference ("referenceData").| |
| - | | ThridImput | Input Description 1 | | + | |
| |< 100% 30% >| | |< 100% 30% >| | ||
| ^ Output ^ Description ^ | ^ Output ^ Description ^ | ||
| - | | FirstOutput | Output Description | | + | | FirstOutput | Extracted particle images. | |
| - | + | ||
| - | |< 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. | + | |