Skip to content

GuiIdeas

Jump to bottom
Adrian Quintana edited this page Dec 11, 2017 · 1 revision

Gui Ideas

The idea of the GUI is that is a graphical "editor" of only the variable in the header of the script, which can also be used to launch the script. The header should be organized as follows (for now):

Obligatory header organization:

  • Include a {end-of-header} label at the end of the header
  • Variable declaration (visible in GUI): Variablename=XXX
    • If XXX is True or False, the variable is considered as a Boolean (yes/no button in GUI)
    • If XXX starts with " or ', the variable is considered as a string (text field in GUI)
    • If XXX is a number, the variable is considered as a number (text field in GUI)
  • The first single comment line (starting with "#") above each variable will be displayed in the GUI, as a label left from the variable entry field
  • More detailed help for each variable can be placed between the comment line and the variable declaration line using """ ...""". This text will become visible in the GUI by pressing a "what's this?" button, right from the variable entry field. NOTE that the first character in newlines within these comments should start with spaces or a tab
  • An {expert} label on the comment line ("#") marks the option as "expert" (by default not shown, if you press the "show expert options" button they will be shown in yellow)

An example of how to set a variable in the script header:


# {expert} Maximum allowed shift for tilted particles (in pixels):
""" Particles that shift more will be discarded.
     Be careful to start new lines in this comment with spaces or tabs!!!
"""
MaxShift=10

Optional header flags:

  • A {please cite} label on a comment line (starting with "#") will display a message at the top of the protocol stating "If you publish results obtained with this protocol, please cite:", followed by the text on rest of the comment line. If more than one citation lines are present, they will all be displayed. DONT use very long citations, as this will results in an ugly gui. E.g.:
  • Include a {section} label on a comment line (starting with "#") to separate variables by blue line+title in GUI

An example of a section and a citation:


# {please cite} Scheres et al. (2007) Nature Methods, 4, 27-29
# {section} Global parameters

-- Main.SjorsScheres - 21 Mar 2007

  • snap1.jpg:
Clone this wiki locally