Package qupath.lib.scripting

Class ScriptAttributes

java.lang.Object

qupath.lib.scripting.ScriptAttributes

public class ScriptAttributes
extends Object

Default attributes that can be set when running scripts. Script implementations should try to set these where possible using ScriptParameters.

The intention is that, where supported, scripts can then access the information, e.g. for Groovy

 var filePath = getProperty(ScriptAttributes.FILE_PATH)
 

Since:

v0.4.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ARGS	Optional string args passed to the script.
static final String	BATCH_INDEX	Index of the current run when batch processing (starting at 0).
static final String	BATCH_LAST	Boolean flag to indicate if the current script is the last in a batch.
static final String	BATCH_SAVE	Boolean flag to indicate whether changes to the image data should automatically be saved.
static final String	BATCH_SIZE	Size of the current batch processing batch.
static final String	FILE_PATH	File path of the running script file.

Constructor Summary

Constructors

Constructor	Description
ScriptAttributes()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ARGS

public static final String ARGS

Optional string args passed to the script.

See Also:

• Constant Field Values

FILE_PATH

public static final String FILE_PATH

File path of the running script file.

See Also:

• Constant Field Values

BATCH_SIZE

public static final String BATCH_SIZE

Size of the current batch processing batch. Running a single script in isolation should be seen as batch processing with a batch size of 1.

See Also:

• Constant Field Values

BATCH_INDEX

public static final String BATCH_INDEX

Index of the current run when batch processing (starting at 0).

See Also:

• Constant Field Values

BATCH_LAST

public static final String BATCH_LAST

Boolean flag to indicate if the current script is the last in a batch.

See Also:

• Constant Field Values

BATCH_SAVE

public static final String BATCH_SAVE

Boolean flag to indicate whether changes to the image data should automatically be saved.

See Also:

• Constant Field Values

Constructor Details

ScriptAttributes

public ScriptAttributes()