Batch Processing

The Batch Processing dialog enables you to design your own processing sequence and create reports for each file opened. A group of files can for example be drag dropped from ImageMet Explorer or selected from the Open File Menu and process automatically. The Batch Processors automation features can be further enhanced when combined with the ActiveReporter, The Sniffer and the Plug-in Interface.

The Batch Dialog

The Batch dialog is activated from the Automatic Processing panel by clicking the Batch Setup button

The processing sequence can be selected from the left list box by double clicking or by the add ( >> ) button. In the information box below there will be written a short description of the selected function.

The sequence order can be changed by the "Move Up/ Move Down bottoms; the top most command will be processed first.

For certain processing steps there are associated settings which can be viewed and set when the "Settings" button is active.

The colors of the selected batch process indicate possible abnormalities:

• Black: means that everything is normal
• Gray: means that the function is not available because the required module is not included in the license. These functions will be ignored when running the batch process.
• Red: Indicates a problem with the settings of the function, typically a reference to a missing file. Such functions are ignored during a batch process.

To save memory it is a good idea to delete the current windows whenever a new file is loaded; this is set by the "Close Windows Before New Loading" check box.

Setting the checkbox "Run when loading files" will cause the sequence to be performed whenever loading a new file or a group of files, but only when the batch dialog is open. To batch process a group (batch) of file just select and open them in the file open dialog or the ImageMet Explorer. For files containing more multiple channels all channels may be processed, but in cases where it is desirable only to process specific channels you can use the ImageMet Explorer for limiting the selecting to the channels of interest.

To avoid the Batch Processing Dialog to overlap the SPIP image data windows it is a good idea to set the "Minimize while processing" checkbox on.

Setting the checkbox "Reset statistics on new batch" will cause all generated statistics from, e.g. roughness and grain analysis to be reset before processing a new batch of files. In situations where the Batch Processor is running one file at a time, it might be desirable not to reset the statistics so that the statistics of a larger group of files can be reported together. Such a setup may be relevant when using the Sniffer to send files generated by your microscope to the Batch Processor whenever a new file is generated.

When setting “Process topographic data only” only images which have a length unit as z-unit and therefore considered as a topographic image will be processed. This is particular useful when processing files containing more types of images, such as phase images, which are not relevant for e.g. roughness analysis.

The Load / Save buttons allows you to save and retrieve the designed sequences. A default processing sequence can be defined by saving the settings into the Default.batch file. SPIP comes with a number of sample files, which can be loaded by the Load… button

Note, that during the batch process current defined reference parameters for calibration will be applied. You can in the corresponding menus store your preferences as the default settings, which will be loaded at program start.

The different analytical operations available in the Batch Processing menu applies mainly to the Main Image Window, but it is possible to put the image from the most recent generated window for example a gradient images into the Main Window and then process with all the optional batch operations.

When running, the information box will inform about the status of the batch process.

Quick Launch of Batch Processes

SPIP comes with a number of predefined batch processes all including active reports which you can use for processing and generating a report for the active data window. These batch processes are available from the Quick Launch menu together with the batch processes you have created:

The Quick Launch tool for batch processes are therefore a convenient productivity tool for processing and reporting single data set, while the batch processor dialog is a strong tool for processing many data files and creating statistical results.

Available Batch Functions

The following lists the currently available Batch Functions. To get an up-to-date li st of available functions in your version of SPIP click the “Function button.

Active Reporting in Batch Process

To set up a batch process containing MS Word or HTML reports select Active Report by Template. You will then be prompted for an existing template with extension doc, htm or html. You may see how to create a template in How to create an ActiveReporter template

There are two ActiveReport Items dedicated for batch processing, Preface End and Summary Begin

See also the chapter on ActiveReport Items

Preface End Tag

The Preface End Tag is suitable for defining the page layout and labeling names for tabular outputs.

Summary Begin Tag

After the Summary Begin tag you may report statistical results like mean and standard deviations accumulated during a batch process.

Body Area

The template area between the Preface End and the Summary Begin tags willl be processed for each data file and the final report will contain results associated with the SPIP ActiveReport items given in this section for all processed files.

If the Preface End Tag is missing SPIP the final report will not contain any preface likewise if the Summary Begin tag is missing the report will not contain any summary

When selecting a template function you will be asked to specify the template file (HTML or MS Word format). The template can hereafter be opened by use of the Settings button or exchanged by another template.

Note that it is possible to run a batch process containing nothing else as a word template because the template will instruct SPIP which processes to perform.

Save modes:

Use the Save Mode Combo box to select the name of the report to be generated:

Autogenerated filename: The report will be written to a new file with a unique name. The folder for the file is selected by the "Directory" field.-

Overwrite file (prompt):The report will be written to the specified file. If it already exists it will only be generated if you confirm SPIP to do so.

Overwrite file:The report will be written to the specified file. If it already exists it will be overwritten without notification.

Append to file: The report will be appended to the specified file. If it does not exist it will be generated.

Write Mode:

The Write Mode options are only applicable when the batch scrip contains more than one active reporter item and defines how to combine the sections defined in the template. There are two options:

Merge Report Sections

This mode will merge the three sections types so that they are grouped together. In such case the summary parts will always appear at the end of the report.

Append Report Sections

This mode will append the sections such that all sections belonging to a template will stay together. In this case there will be one or more summary sections for each data set, which may be followed by a preface section for the following data set.

Running Batch Script on File Open

In the File > Open Options you may define a specific batch script to run whenever a file is opened. This is used for processing and displaying data the same way every time a data file is opened without having to activate the Batch Processing dialog. You may for example always want to have a 2D image shown next to a 3D rendered image and with profile and histogram windows shown below.

To assure that the windows will appear with certain size and position you may do the following:

• Turn On Window > Auto Tile

• Turn Off "Close All Data Windows when Opening a File"

• Open a data file and for each of the automatically generated data windows stretch and position them as desired.

• For each data window click Window > Favorite > Apply and check Window > Tiling > Use Favorite Size. You may also use the Window > Favorite > Teach for opening the Window Size dialog for adjusting the window size.

• You may change the order of appearance by modifying the batch script in the Batch Processing dialog.

Save and Load

You can save and load your batch scripts and you may also take advantage or the predefined Built-in scripts.

As more advanced batch scripts may be using various settings files it is also important to provide these settings files in case you want to share it with other SPIP™ users. For this purpose you can use the Save-->Distribute function. This function will pack all used settings files along with the batch script file into a zip file. This zip file should be unpacked in the ...Documents\SPIP\Custom Settings folder to make all settings files easily accessible from SPIP™.

Batch Processing Trouble Shooting

The big advantage of Batch Processing is the large amount of data that can be processed automatically. This also means that large amount of results can be generated. Therefore you should always make sure that you have sufficiently disk space available before activating a large batch process.

Resource leak in Windows XP SP2

There is a known error in the Windows XP Service Pack 2 operating system, which may create resource leaks such that only approximately 800 data windows can be created during a session. This error is described with at hot fix by Microsoft article Q319740

The error is related to the Windows theme interface and can be solved by turning it off. To do this, follow these steps:

1. Click Start, and then click Control Panel.

2. Click Appearance and Themes, and then click Display.

3. On the Themes tab of the Display Properties dialog box, click Windows Classic in the Theme list.

4. Click Apply, and then click OK.