Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
eyes:logics:script [2017/06/12 13:11] sfiedle created |
eyes:logics:script [2017/06/12 16:14] (current) sfiedle [Usage] |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Script ====== | ====== Script ====== | ||
- | THIS position should be used for a brief introduction (max 2 sentences!) of the logic, stating WHAT and WHY it is doing something. | + | The Script uses [[https://www.lua.org/manual/5.1/index.html#index|Lua 5.1]] in order to read or modify header values of images. CCC values of a stack of images can be read by the Script and used as weighting factors in a different logic. |
===== 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. | + | The Script needs to be combined with the element [[eyes:logics:variable|]]. |
- | ===== Example ==== | + | At first a Variable is set up with the certain data type. In order to access a single image in a cow workflow the script needs to call the cow.io[#number of the image in the IO]. Then to read a header value of that image the script needs to be expanded by the name of the header in quotation marks ["image header values name"]. |
- | 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. | + | |
+ | |||
+ | **cow.VariableName = cow.io[#number of the image in the IO]["image header values name"]** | ||
+ | ===== Example ==== | ||
+ | {{ :eyes:logics:scriptcall.png |}} | ||
+ | {{ :eyes:logics:script.png |}} | ||
===== Parameters and I/O ===== | ===== Parameters and I/O ===== | ||
|< 100% 30% >| | |< 100% 30% >| | ||
^ Input ^ Description ^ | ^ Input ^ Description ^ | ||
- | | FirstInput | Input Description 1 | | + | | FirstInput | Input to be modified by the script | |
- | | SecondInput | Input Description 2 | | + | |
- | | //ThirdInput// | Input Description 3: Optional Input in Italic | | + | |
|< 100% 30% >| | |< 100% 30% >| | ||
^ Output ^ Description ^ | ^ Output ^ Description ^ | ||
- | | FirstOutput | Output Description | | + | | FirstOutput | Output| |
===== Concept ===== | ===== 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. | + | The Script elements works with[[https://www.lua.org/manual/5.1/index.html#index|Lua 5.1 Reference Manual]]. |
+ | In the following link all [[https://www.lua.org/manual/5.1/index.html#index|Lua functions]] are listed at the end of the page. |