Step 1 : Choose an input file or create a new one

The most convenient way to use GrainSpotter in Fable is to make a Fable project of the files you are analyzing. This is most easily done if the files are under one top-level directory, for example, SimulationAl20081209 in the figure below. To make a project, right click in the Navigator and select New -> Project -> General -> Project and click Next. Give the project a name, uncheck the "Use default location", and browse for the location of your directory. When you click Finish, a .project file will be created in your directory and the files will appear in the Navigator. If you don't see the Navigator in the GrainSpotter perspective, then select Window -> Reset Perspective. If you are in another perspective, then you can use Window -> Show View -> Other -> General -> Navigator.

You can then double click an existing .ini file in the Navigator to edit it. If you right click a .ini file in the Navigator and select "Open With", you can choose to edit the file with different editors. The GrainSpotter Input File Editor, which is the default, is described below. You could also use the Text Editor if you prefer. Fable remembers your last choice, and double-clicking will open the file with that editor.

Alternatively, in the GrainSpotter menu, select Grainspotter -> Open .ini File or Grainspotter -> New .ini File.

Step 2 : Edit the input file

You typically specify the GrainSpotter input parameters via the GrainSpotter Input File Editor as shown below. There is ToolTip help available on most of the entries and often additional, context sensitive help is available by pressing F1. You can get help for all of the parameters in one place by clicking the "Parameters Help..." button.

GrainSpotter Input Editor Interface

[Full Size Image]

GrainSpotter needs a set of g-vectors to run. These g-vectors are determined by the spots on the xray diffraction images and the geometry of the experiment. The g-vectors are usually calculated by a program called ImageD11 based on the spots it finds and are usually specified in a file with a .gve extension. You can enter the .gve file name in the text box. You can also browse for the file, or you can drag a .gve file from the Navigator. Using the Open button you can open the .gve file in the GVE File 3D Editor to view the g-vectors in it if you like.

You must also specify a .log file name for the output, either by entering it, browsing for it, or by dragging one from the Navigator. It is likely you want one named after the input file, and you can generate that via the "Generate Name" button. This is especially useful if you have opened an existing .ini file and want to save it for a new run with different parameters and a different .log file name.

The parameters are described in the GrainSpotter documentation or in the help described above and will not be covered here. The controls for entering these parameters should be intuitive. You, of course, need to know something about GrainSpotter to use it well.

Step 3 : Save the input file

As the .ini file editor is edited, a * appears in the title indicating it has been changed. You can choose to save the .ini file you are editing using Save or SaveAs from the File menu. You can also use Ctrl-S to save the file. If you use SaveAs, Fable will attempt to load the saved file in a new editor if you are using the GrainSpotter Input File Editor. If, however, you are using the Text Editor, the file you are editing will be replaced in the editor with the saved one. In either case, the former one will be preserved as it is.

You don't have to manually save the file. If your file has not been saved when you launch GrainSpotter, you will be prompted to save it.

Step 4 : Launch grainspotter

You can launch GrainSpotter in several ways. There is a Run button on either side of the GrainSpotter Input File Editor (so one is always in view for small screens). You can also use Grainspotter->Run in the GrainSpotter menu.

GrainSpotter is run as a job in a separate thread. There will be a progress bar that displays information such as how many grains have been found and what percentage of the calculation is finished. You can cancel the run from the progress dialog. In addition, the GrainSpotter output appears in the Console as it runs.

Once Grainspotter has finished running, then there are three views or editors that can be brought up:

You can choose which of these appear in Window->Preferences->GrainSpotter->Run. By default the GrainSpotter Log File Editor appears with the produced .log file.