Class ScriptParameters.Builder

java.lang.Object
qupath.lib.scripting.ScriptParameters.Builder
Enclosing class:
ScriptParameters

public static class ScriptParameters.Builder extends Object
Builder class for ScriptParameters.
  • Method Details

    • setDefaultImports

      public ScriptParameters.Builder setDefaultImports(Collection<Class<?>> imports)
    • setDefaultStaticImports

      public ScriptParameters.Builder setDefaultStaticImports(Collection<Class<?>> imports)
    • setFile

      public ScriptParameters.Builder setFile(File file)
    • setScript

      public ScriptParameters.Builder setScript(String script)
    • setSystemWriters

      public ScriptParameters.Builder setSystemWriters()
      Set the output and error writers to use System.out and System.err.
      Returns:
    • useLogWriters

      public ScriptParameters.Builder useLogWriters(org.slf4j.Logger logger)
      Set the output and error writers to append to the specified logger.
      Parameters:
      logger -
      Returns:
    • useLogWriters

      public ScriptParameters.Builder useLogWriters()
      Set the output and error writers to append to the default logger.
      Returns:
    • setWriter

      public ScriptParameters.Builder setWriter(Writer writer)
      Set the main output writer.
      Parameters:
      writer -
      Returns:
    • setErrorWriter

      public ScriptParameters.Builder setErrorWriter(Writer writer)
      Set the main error writer.
      Parameters:
      writer -
      Returns:
    • setBatchSize

      public ScriptParameters.Builder setBatchSize(int batch)
      Set the batch size for batch processing (default is 1).
      Parameters:
      batch -
      Returns:
    • setBatchIndex

      public ScriptParameters.Builder setBatchIndex(int ind)
      Set the current image index for batch processing (default is 0).
      Parameters:
      ind -
      Returns:
    • setBatchSaveResult

      public ScriptParameters.Builder setBatchSaveResult(boolean doSave)
      Specify whether the script that is running should save results or not.
      Parameters:
      doSave -
      Returns:
    • setArgs

      public ScriptParameters.Builder setArgs(String[] args)
      Set optional string args to pass to the script.
      Parameters:
      args -
      Returns:
    • setProject

      public ScriptParameters.Builder setProject(qupath.lib.projects.Project<?> project)
      Set the current project for the script.
      Parameters:
      project -
      Returns:
    • setImageData

      public ScriptParameters.Builder setImageData(qupath.lib.images.ImageData<?> imageData)
      Set the current image data for the script.
      Parameters:
      imageData -
      Returns:
    • doUpdateHierarchy

      public ScriptParameters.Builder doUpdateHierarchy(boolean requestUpdate)
      Optionally request a hierarchy update event after running a script (default is true for scripts that operate on image data).
      Parameters:
      requestUpdate -
      Returns:
    • useCompiled

      public ScriptParameters.Builder useCompiled(boolean useCompiled)
      Request that the script is compiled before being evaluated, or a previously compiled version is used where available.
      Parameters:
      useCompiled -
      Returns:
    • build

      Build the ScriptParameters with the current options.
      Returns:
      Throws:
      IllegalArgumentException - if neither file nor script are set