3.1.9 Console Window

The console window is a command shell allowing to access amira's advanced control features. It serves two purposes. First, it gives you some feedback on what is currently going on. Such feedback messages include warnings, error indications and notes on problems as well as information on results. Second, it provides a command line interface where amira commands can be entered.

Figure 37: amira's console window displays info messages and lets you enter Tcl commands.

amira's console commands are based on the Tcl script language (Tool Command Language). Examples are:

    load C:/MyData/something.am
    viewer 0 setSize 200 200
    viewer 0 snapshot C:/snapshot.tif

The amira scripting syntax and the specific commands are described in the Chapter 5 (Scripting). To execute a single console command just type in its name and arguments and press `Enter'. If you select an object and then press the [TAB] key on the empty command line, then the name of the object will be automatically inserted.

You can also type the beginning of a command word and type the [TAB] key to complete the word. This only works if the beginning is unique. Pressing [TAB] a second time will show the possible completions. Often, this saves a lot of typing. Commands provided by data objects and modules are documented in the reference section of the users guide. Pressing the [F1] key for such a command without any arguments pops up the help text for this command. This is also true for commands provided by the ports of an object.

Additionally the console window provides a command history mechanism. Use `up arrow' and `down arrow' to scroll up and down in the history list.

To execute a file containing many Tcl commands use source <filename> or load the script file via amira's file dialog from the file menu. amira script files are usually identified by the extension .hx. For advanced script examples take a look at amira's demo files located in $AMIRA_ROOT/share/demo.