Module: BatchApply_RecipePlayer ()

Description:

This is an experimental module from the Xtra Library: https://xtras.amira-avizo.com.

This module allows applying a Recipe to a list of files. For each input file, the recipe results are saved with the same filename and a file prefix '.resultN'. All outputs are saved in .am format, except for tables which are also exported as .csv files.

The recipe must use a single input, and the recipe input type must be compatible with the provided inputs. Otherwise, errors will appear in the console.

The inputs must be one file per dataset (e.g. no 3D volume represented as a stack of 2D TIFF). However, the input may be a multichannel dataset saved as a .am file.

Recipes processing multichannel datasets may be generated thanks to the accompanying module 'ChannelSelector'. Recipes processing grayscale images may be applied to a specific channel of a multichannel input using the Process Channel port.

Ports:

Recipe File

The recipe file to be applied. Only recipes using a single input may be applied using this module.

File(s) To Process

The list of inputs to be processed. Datasets must be represented as single files, as each selected file will be processed with the recipe. For grayscale images, in case the unit and/or the pixel size is not automatically recognized, only the first dataset will trigger the Image Read Parameter dialog. The same unit and the same pixel size will be re-used for all other the inputs of the batch.

Output Directory

Output folder where the recipe results will be stored. Assuming an input is named myImage.am, and the recipe generates 2 output, first an image and second a spreadsheet, the resulting files will be named myImage.result0.am for the output image, and myImage.result1.am and myImage.result1.csv for the spreadsheet.

Input Type

Specify whether your inputs are grayscale or multichannel images.

Process Channel

Visible only if 'Input Type' is multichannel.

'All' will apply the recipe to the multichannel object. Note that the recipe must accept a multichannel input - see also the 'Channel Selector' module. Otherwise, a recipe intended to grayscale images can be applied to the specific channel.

info

The port displays information about the batch: either the number of datasets to be processed, the current dataset being processed, or whether the batch analysis is finished.

elapsedTime

During or after computing the batch, this port indicates the elapsed time since Apply was last pressed.

remainingTime

This port indicates an estimate of the remaining time for the computation. This is assuming all datasets will require the same computation time.