OmeroBlitz API

omero::grid::JobParams

Overview

class JobParams extends Internal

Complete job description with all input and output Params. JobParams contain information about who wrote a script, what its purpose is, and how it should be used, and are defined via the "omero.scripts.client" method.

c = omero.scripts.client(name="my algorithm", version="0.0.1")

Alternatively, a JobParams instance can be passed into the constructor:

params = omero.grid.JobParams()
params.authors = ["Andy", "Kathy"]
params.version = "0.0.1"
params.description = """
Clever way to count to 5
"""
c = omero.scripts.client(params)

A single JobParam instance is parsed from a script and stored by the server. Later invocations re-use this instance until the script changes.

Used By

api::IScript::getParams
InteractiveProcessor::params
Processor::parseJob
Processor::processJob

Data Member Index

name: Descriptive name for this script.
version: Author-given version number for this script.
description: A general description of a script, including documentation on how it should be used, what data it will access, and other metrics like how long it takes to execute, etc.
contact: Single, human-readable string for how to contact the script author.
authors: Information about the authors who took part in creating this script.
institutions: Information about the institutions which took part in creating this script.
authorsInstitutions: For authors[i], authorInstitutions[i] should be and array of indexes j such that author i is a member of authorsInstitutions[i][j].
inputs: Definitive list of the inputs which MAY or MUST be provided to the script, based on the "optional" flag.
outputs: Definitive list of the outputs which MAY or MUST be provided to the script, based on the "optional" flag.
stdoutFormat: {@code omero.model.Format.value} of the stdout stream produced by the script.
stderrFormat: {@code omero.model.Format.value} of the stderr stream produced by the script.
namespaces: Defines machine readable interpretations for this {@code JobParams}.

Data Members

string name;

Descriptive name for this script. This value should be unique where possible, but no assurance is provided by the server that multiple scripts with the same name are not present.

string version;

Author-given version number for this script. Please see the script authors' guide for information about choosing version numbers.

string description;

A general description of a script, including documentation on how it should be used, what data it will access, and other metrics like how long it takes to execute, etc.

string contact;

Single, human-readable string for how to contact the script author.

api::StringArray authors;

Information about the authors who took part in creating this script. No particular format is required.

api::StringArray institutions;

Information about the institutions which took part in creating this script. No particular format is required.

api::IntegerArrayArray authorsInstitutions;

For authors[i], authorInstitutions[i] should be and array of indexes j such that author i is a member of authorsInstitutions[i][j]. Example: authors = ["Jane", "Mike"] institutions = ["Acme U.", "Private Corp."] authorsInstitutions = [[1, 2], [1]] which means that Jane is a member of both "Acme U." and "Private Corp." while Mike is only a member of "Acme U." An empty authorsInstitutions array implies that all authors are from all institutions.

ParamMap inputs;

Definitive list of the inputs which MAY or MUST be provided to the script, based on the "optional" flag.

ParamMap outputs;

Definitive list of the outputs which MAY or MUST be provided to the script, based on the "optional" flag.

string stdoutFormat;

{@code omero.model.Format.value} of the stdout stream produced by the script. If this value is not otherwise set (i.e. is None), the default of "text/plain" will be set. This is typically a good idea if the script uses "print" or the logging module. If you would like to disable stdout upload, set the value to "" (the empty string). "text/html" or "application/octet-stream" might also be values of interest.

string stderrFormat;

{@code omero.model.Format.value} of the stderr stream produced by the script. If this value is not otherwise set (i.e. is None), the default of "text/plain" will be set. This is typically a good idea if the script uses "print" or the logging module. If you would like to disable stderr upload, set the value to "" (the empty string). "text/html" or "application/octet-stream" might also be values of interest.

api::StringSet namespaces;

Defines machine readable interpretations for this {@code JobParams}.

Where the description field should provide information for users, the assigned namespaces can define how clients may interpret the script, including which categories or algorithm types the script belongs to.

Home

Index