OpEnvironment (ImageJ2 Javadocs 0-SNAPSHOT API)

All Superinterfaces:

Contextual

All Known Subinterfaces:

OpService

All Known Implementing Classes:

CachedOpEnvironment, CustomOpEnvironment, DefaultOpService
```
public interface OpEnvironment
extends Contextual
```
An op environment is the top-level entry point into op execution. It provides all the built-in functionality of ops in a single place, including:
- The pool of available ops, from which candidates are chosen.
- Type-safe, built-in method signatures for all op implementations.
- Selection (a.k.a. "matching") of op implementations from OpRef descriptors.
Customizing the OpEnvironment allows customization of any or all of the above. Potential use cases include:
- Limiting or extending the pool of available op implementations.
- Caching op outputs to improve subsequent time performance.
- Configuration of environment "hints" to improve performance in time or space.
The default—but not necessarily only—op environment is the OpService of the application. The environment can be modified by using a CustomOpEnvironment, or by implementing this interface directly.
Author:

Curtis Rueden

See Also:

OpService, CustomOpEnvironment

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default ColocNamespace`	`coloc()` Gateway into ops of the "coloc" namespace.
`default ConvertNamespace`	`convert()` Gateway into ops of the "convert" namespace.
`default CopyNamespace`	`copy()` Gateway into ops of the "copy" namespace.
`default CreateNamespace`	`create()` Gateway into ops of the "create" namespace.
`default DeconvolveNamespace`	`deconvolve()` Gateway into ops of the "deconvolve" namespace.
`default Object`	`eval(String expression)` Executes the "eval" operation on the given arguments.
`default Object`	`eval(String expression, Map<String,Object> vars)` Executes the "eval" operation on the given arguments.
`default FilterNamespace`	`filter()` Gateway into ops of the "filter" namespace.
`default GeomNamespace`	`geom()` Gateway into ops of the "geom" namespace.
`default int`	`getMaxThreads()` Gets the maximum number of threads any single op is allowed to use.
`default HaralickNamespace`	`haralick()` Gateway into ops of the "haralick" namespace.
`default String`	`help()` Executes the "help" operation on the given arguments.
`default String`	`help(Namespace namespace)` Executes the "help" operation on the given arguments.
`default String`	`help(Op op)` Executes the "help" operation on the given arguments.
`default String`	`help(String name)` Executes the "help" operation on the given arguments.
`default String`	`help(String name, Class<? extends Op> opType)` Executes the "help" operation on the given arguments.
`default String`	`help(String name, Class<? extends Op> opType, Integer arity)` Executes the "help" operation on the given arguments.
`default String`	`help(String name, Class<? extends Op> opType, Integer arity, SpecialOp.Flavor flavor)` Executes the "help" operation on the given arguments.
`default <A> A`	`identity(A arg)` Executes the "identity" operation on the given arguments.
`default ImageNamespace`	`image()` Gateway into ops of the "image" namespace.
`default ImageMomentsNamespace`	`imagemoments()` Gateway into ops of the "imagemoments" namespace.
`OpInfo`	`info(Class<? extends Op> type)` Gets the metadata for a given `Op` class.
`default OpInfo`	`info(Op op)` Gets the metadata for a given `Op`.
`Collection<OpInfo>`	`infos()` The available ops for the context, including those of the parent.
`default <A> A`	`join(A out, A in, List<? extends UnaryComputerOp<A,A>> ops, UnaryOutputFactory<A,A> outputFactory)` Executes the "join" operation on the given arguments.
`default <AI,AO extends AI,B> B`	`join(B out, AO in, UnaryInplaceOp<AI,AO> first, UnaryComputerOp<AO,B> second)` Executes the "join" operation on the given arguments.
`default <A,BI,BO extends BI> BO`	`join(BO out, A in, UnaryComputerOp<A,BO> first, UnaryInplaceOp<BI,BO> second)` Executes the "join" operation on the given arguments.
`default <A,B,C> C`	`join(C out, A in, UnaryComputerOp<A,B> first, UnaryComputerOp<B,C> second, UnaryOutputFactory<A,B> outputFactory)` Executes the "join" operation on the given arguments.
`default <A,B extends A,C extends B> C`	`join(C arg, UnaryInplaceOp<A,B> first, UnaryInplaceOp<B,C> second)` Executes the "join" operation on the given arguments.
`default <I,O extends I> O`	`join(O arg, List<? extends UnaryInplaceOp<I,O>> ops)` Executes the "join" operation on the given arguments.
`default LabelingNamespace`	`labeling()` Gateway into ops of the "labeling" namespace.
`default LBPNamespace`	`lbp()` Gateway into ops of the "lbp" namespace.
`default LinAlgNamespace`	`linalg()` Gateway into ops of the "linalg" namespace
`default LogicNamespace`	`logic()` Gateway into ops of the "logic" namespace.
`default <A> A`	`loop(A out, A in, UnaryComputerOp<A,A> op, UnaryOutputFactory<A,A> outputFactory, int n)` Executes the "loop" operation on the given arguments.
`default <I,O extends I> O`	`loop(O arg, UnaryInplaceOp<I,O> op, int n)` Executes the "loop" operation on the given arguments.
`default <EI,EO> Iterable<EO>`	`map(Iterable<EO> out, Iterable<EI> in, UnaryComputerOp<EI,EO> op)` Executes the "map" operation on the given arguments.
`default <EO> Iterable<EO>`	`map(Iterable<EO> out, NullaryComputerOp<EO> op)` Executes the "map" operation on the given arguments.
`default <EI,EO extends EI> Iterable<EO>`	`map(Iterable<EO> arg, UnaryInplaceOp<EI,EO> op)` Executes the "map" operation on the given arguments.
`default <EI,EO extends Type<EO>> IterableInterval<EO>`	`map(IterableInterval<EI> input, UnaryComputerOp<EI,EO> op, EO type)` Executes the "map" operation on the given arguments.
`default <EI,EO> IterableInterval<EO>`	`map(IterableInterval<EO> out, IterableInterval<EI> in, UnaryComputerOp<EI,EO> op)` Executes the "map" operation on the given arguments.
`default <EI1,EI2,EO> IterableInterval<EO>`	`map(IterableInterval<EO> out, IterableInterval<EI1> in1, IterableInterval<EI2> in2, BinaryComputerOp<EI1,EI2,EO> op)` Executes the "map" operation on the given arguments.
`default <EI1,EI2,EO> IterableInterval<EO>`	`map(IterableInterval<EO> out, IterableInterval<EI1> in1, RandomAccessibleInterval<EI2> in2, BinaryComputerOp<EI1,EI2,EO> op)` Executes the "map" operation on the given arguments.
`default <EI1,EI2,EO extends EI1> IterableInterval<EO>`	`map(IterableInterval<EO> arg, IterableInterval<EI2> in, BinaryInplace1Op<EI1,EI2,EO> op)` Executes the "map" operation on the given arguments.
`default <EI,EO extends EI> IterableInterval<EO>`	`map(IterableInterval<EO> arg, IterableInterval<EO> in, BinaryInplaceOp<EI,EO> op)` Executes the "map" operation on the given arguments.
`default <EO> Iterable<EO>`	`map(IterableInterval<EO> out, NullaryComputerOp<EO> op)` Executes the "map" operation on the given arguments.
`default <EI,EO> IterableInterval<EO>`	`map(IterableInterval<EO> out, RandomAccessibleInterval<EI> in, Shape shape, CenterAwareComputerOp<EI,EO> func)` Executes the "map" operation on the given arguments.
`default <EI,EO> IterableInterval<EO>`	`map(IterableInterval<EO> out, RandomAccessibleInterval<EI> in, Shape shape, UnaryComputerOp<Iterable<EI>,EO> op)` Executes the "map" operation on the given arguments.
`default <EI,EO> IterableInterval<EO>`	`map(IterableInterval<EO> out, RandomAccessibleInterval<EI> in, UnaryComputerOp<EI,EO> op)` Executes the "map" operation on the given arguments.
`default <EI1,EI2,EO> IterableInterval<EO>`	`map(IterableInterval<EO> out, RandomAccessibleInterval<EI1> in1, IterableInterval<EI2> in2, BinaryComputerOp<EI1,EI2,EO> op)` Executes the "map" operation on the given arguments.
`default <EI1,EI2,EO> IterableInterval<EO>`	`map(IterableInterval<EO> out, RandomAccessibleInterval<EI1> in1, RandomAccessibleInterval<EI2> in2, BinaryComputerOp<EI1,EI2,EO> op)` Executes the "map" operation on the given arguments.
`default <EI1,EI2,EO extends EI1> IterableInterval<EO>`	`map(IterableInterval<EO> arg, RandomAccessibleInterval<EI2> in, BinaryInplace1Op<EI1,EI2,EO> op)` Executes the "map" operation on the given arguments.
`default <EI,EO extends EI> IterableInterval<EO>`	`map(IterableInterval<EO> arg, UnaryInplaceOp<EI,EO> op)` Executes the "map" operation on the given arguments.
`default <EI,EO extends Type<EO>> RandomAccessible<EO>`	`map(RandomAccessible<EI> input, UnaryComputerOp<EI,EO> op, EO type)` Executes the "map" operation on the given arguments.
`default <EI,EO extends Type<EO>> RandomAccessibleInterval<EO>`	`map(RandomAccessibleInterval<EI> input, UnaryComputerOp<EI,EO> op, EO type)` Executes the "map" operation on the given arguments.
`default <EI,EO> RandomAccessibleInterval<EO>`	`map(RandomAccessibleInterval<EO> out, IterableInterval<EI> in, UnaryComputerOp<EI,EO> op)` Executes the "map" operation on the given arguments.
`default <EI1,EI2,EO> RandomAccessibleInterval<EO>`	`map(RandomAccessibleInterval<EO> out, IterableInterval<EI1> in1, IterableInterval<EI2> in2, BinaryComputerOp<EI1,EI2,EO> op)` Executes the "map" operation on the given arguments.
`default <EI1,EI2,EO> RandomAccessibleInterval<EO>`	`map(RandomAccessibleInterval<EO> out, IterableInterval<EI1> in1, RandomAccessibleInterval<EI2> in2, BinaryComputerOp<EI1,EI2,EO> op)` Executes the "map" operation on the given arguments.
`default <EI1,EI2,EO extends EI1> RandomAccessibleInterval<EO>`	`map(RandomAccessibleInterval<EO> arg, IterableInterval<EI2> in, BinaryInplace1Op<EI1,EI2,EO> op)` Executes the "map" operation on the given arguments.
`default <EI1,EI2,EO> RandomAccessibleInterval<EO>`	`map(RandomAccessibleInterval<EO> out, RandomAccessibleInterval<EI1> in1, IterableInterval<EI2> in2, BinaryComputerOp<EI1,EI2,EO> op)` Executes the "map" operation on the given arguments.
`OpMatchingService`	`matcher()`
`default MathNamespace`	`math()` Gateway into ops of the "math" namespace.
`default Module`	`module(Class<? extends Op> type, Object... args)` Gets the best `Op` to use for the given operation type and arguments, wrapping it as a `Module` with populated inputs.
`default Module`	`module(Op op, Object... args)` Wraps the given `Op` as a `Module`, populating its inputs.
`default Module`	`module(String name, Object... args)` Gets the best `Op` to use for the given operation and arguments, wrapping it as a `Module` with populated inputs.
`default MorphologyNamespace`	`morphology()` Gateway into ops of the "morphology" namespace.
`<NS extends Namespace> NS`	`namespace(Class<NS> nsClass)` Gets the namespace of the given class.
`default <OP extends Op> OP`	`op(Class<OP> type, Object... args)` Gets the best `Op` to use for the given operation type and arguments, populating its inputs.
`default Op`	`op(List<OpRef> refs)` Looks up an op whose constraints are specified by the given list of `OpRef` descriptor.
`default Op`	`op(OpRef ref)` Looks up an op whose constraints are specified by the given `OpRef` descriptor.
`default Op`	`op(String name, Object... args)` Gets the best `Op` to use for the given operation and arguments, populating its inputs.
`default Collection<String>`	`ops()` Gets the fully qualified names of all available operations.
`default OpEnvironment`	`parent()` The parent context, if any.
`default Object`	`run(Class<? extends Op> type, Object... args)` Executes the operation of the given type with the specified arguments.
`static Object`	`run(Module module)`
`default Object`	`run(Op op, Object... args)` Executes the given `Op` with the specified arguments.
`default Object`	`run(String name, Object... args)` Executes the given operation with the specified arguments.
`default void`	`setMaxThreads(int maxThreads)` Sets the maximum number of threads any single op is allowed to use.
`default <I,O> RandomAccessibleInterval<O>`	`slice(RandomAccessibleInterval<O> out, RandomAccessibleInterval<I> in, UnaryComputerOp<RandomAccessibleInterval<I>,RandomAccessibleInterval<O>> op, int... axisIndices)` Executes the "slicewise" operation on the given arguments.
`default <I,O> RandomAccessibleInterval<O>`	`slice(RandomAccessibleInterval<O> out, RandomAccessibleInterval<I> in, UnaryComputerOp<RandomAccessibleInterval<I>,RandomAccessibleInterval<O>> op, int[] axisIndices, boolean dropSingleDimensions)` Executes the "slicewise" operation on the given arguments.
`default StatsNamespace`	`stats()` Gateway into ops of the "stats" namespace.
`default TamuraNamespace`	`tamura()` Gateway into ops of the "tamura" namespace.
`default ThreadNamespace`	`thread()` Gateway into ops of the "thread" namespace.
`default ThresholdNamespace`	`threshold()` Gateway into ops of the "threshold" namespace.
`default TopologyNamespace`	`topology()` Gateway into ops of the "topology" namespace
`default TransformNamespace`	`transform()` Gateway into ops of the "transform" namespace.
`default ZernikeNamespace`	`zernike()` Gateway into ops of the "zernike" namespace.

Methods inherited from interface org.scijava.Contextual
context, getContext, setContext

Method Detail

matcher
```
OpMatchingService matcher()
```

run
```
default Object run(String name,
                   Object... args)
```
Executes the given operation with the specified arguments. The best Op implementation to use will be selected automatically from the operation name and arguments.

Parameters:

name - The operation to execute. If multiple Ops share this name, then the best Op implementation to use will be selected automatically from the name and arguments. If a name without namespace is given, then ops from all namespaces with that name will be included in the match; e.g., "and" will match both "logic.and" and "math.and" ops.

args - The operation's arguments.

Returns:

The result of the execution. If the Op has no outputs, this will return null. If exactly one output, it will be returned verbatim. If more than one, a List<Object> of the outputs will be given.

run
```
default Object run(Class<? extends Op> type,
                   Object... args)
```
Executes the operation of the given type with the specified arguments. The best Op implementation to use will be selected automatically from the operation type and arguments.

Parameters:

type - The Class of the operation to execute. If multiple Ops share this type (e.g., the type is an interface which multiple Ops implement), then the best Op implementation to use will be selected automatically from the type and arguments.

args - The operation's arguments.

Returns:

The result of the execution. If the Op has no outputs, this will return null. If exactly one output, it will be returned verbatim. If more than one, a List<Object> of the outputs will be given.

run
```
default Object run(Op op,
                   Object... args)
```
Executes the given Op with the specified arguments.

Parameters:

op - The Op to execute.

args - The operation's arguments.

Returns:

The result of the execution. If the Op has no outputs, this will return null. If exactly one output, it will be returned verbatim. If more than one, a List<Object> of the outputs will be given.

op
```
default Op op(String name,
              Object... args)
```
Gets the best Op to use for the given operation and arguments, populating its inputs.

Parameters:

name - The name of the operation. If multiple Ops share this name, then the best Op implementation to use will be selected automatically from the name and arguments.

args - The operation's arguments.

Returns:

An Op with populated inputs, ready to run.

op
```
default <OP extends Op> OP op(Class<OP> type,
                              Object... args)
```
Gets the best Op to use for the given operation type and arguments, populating its inputs.

Parameters:

type - The Class of the operation. If multiple Ops share this type (e.g., the type is an interface which multiple Ops implement), then the best Op implementation to use will be selected automatically from the type and arguments.

args - The operation's arguments.

Returns:

An Op with populated inputs, ready to run.

op
```
default Op op(OpRef ref)
```
Looks up an op whose constraints are specified by the given OpRef descriptor.
NB: While it is typically the case that the returned Op instance is of the requested type(s), it may differ in certain circumstances. For example, the CachedOpEnvironment wraps the matching Op instance in some cases so that the values it computes can be cached for performance reasons.

Parameters:

ref - The OpRef describing the op to match.

Returns:

The matched op.

op
```
default Op op(List<OpRef> refs)
```
Looks up an op whose constraints are specified by the given list of OpRef descriptor.
NB: While it is typically the case that the returned Op instance is of the requested type(s), it may differ in certain circumstances. For example, the CachedOpEnvironment wraps the matching Op instance in some cases so that the values it computes can be cached for performance reasons.

Parameters:

refs - The list of OpRefs describing the op to match.

Returns:

The matched op.

module
```
default Module module(String name,
                      Object... args)
```
Gets the best Op to use for the given operation and arguments, wrapping it as a Module with populated inputs.

Parameters:

name - The name of the operation.

args - The operation's arguments.

Returns:

A Module wrapping the best Op, with populated inputs, ready to run.

module
```
default Module module(Class<? extends Op> type,
                      Object... args)
```
Gets the best Op to use for the given operation type and arguments, wrapping it as a Module with populated inputs.

Parameters:

type - The required type of the operation. If multiple Ops share this type (e.g., the type is an interface which multiple Ops implement), then the best Op implementation to use will be selected automatically from the type and arguments.

args - The operation's arguments.

Returns:

A Module wrapping the best Op, with populated inputs, ready to run.

module
```
default Module module(Op op,
                      Object... args)
```
Wraps the given Op as a Module, populating its inputs.

Parameters:

op - The Op to wrap and populate.

args - The operation's arguments.

Returns:

A Module wrapping the Op, with populated inputs, ready to run.

info
```
OpInfo info(Class<? extends Op> type)
```
Gets the metadata for a given Op class.

info
```
default OpInfo info(Op op)
```
Gets the metadata for a given Op.

infos
```
Collection<OpInfo> infos()
```
The available ops for the context, including those of the parent.

See Also:

parent()

ops
```
default Collection<String> ops()
```
Gets the fully qualified names of all available operations.

parent
```
default OpEnvironment parent()
```
The parent context, if any.

namespace

<NS extends Namespace> NS namespace(Class<NS> nsClass)

Gets the namespace of the given class.

getMaxThreads
```
default int getMaxThreads()
```
Gets the maximum number of threads any single op is allowed to use.

setMaxThreads
```
default void setMaxThreads(int maxThreads)
```
Sets the maximum number of threads any single op is allowed to use.

eval
```
default Object eval(String expression)
```
Executes the "eval" operation on the given arguments.

eval

default Object eval(String expression,
                    Map<String,Object> vars)

Executes the "eval" operation on the given arguments.

help
```
default String help(Op op)
```
Executes the "help" operation on the given arguments.

help
```
default String help(Namespace namespace)
```
Executes the "help" operation on the given arguments.

help
```
default String help()
```
Executes the "help" operation on the given arguments.

help
```
default String help(String name)
```
Executes the "help" operation on the given arguments.

help

default String help(String name,
                    Class<? extends Op> opType)

Executes the "help" operation on the given arguments.

help

default String help(String name,
                    Class<? extends Op> opType,
                    Integer arity)

Executes the "help" operation on the given arguments.

help

default String help(String name,
                    Class<? extends Op> opType,
                    Integer arity,
                    SpecialOp.Flavor flavor)

Executes the "help" operation on the given arguments.

identity
```
default <A> A identity(A arg)
```
Executes the "identity" operation on the given arguments.

join

default <A,B,C> C join(C out,
                       A in,
                       UnaryComputerOp<A,B> first,
                       UnaryComputerOp<B,C> second,
                       UnaryOutputFactory<A,B> outputFactory)

Executes the "join" operation on the given arguments.

join

default <A,B extends A,C extends B> C join(C arg,
                                           UnaryInplaceOp<A,B> first,
                                           UnaryInplaceOp<B,C> second)

Executes the "join" operation on the given arguments.

join

default <A> A join(A out,
                   A in,
                   List<? extends UnaryComputerOp<A,A>> ops,
                   UnaryOutputFactory<A,A> outputFactory)

Executes the "join" operation on the given arguments.

join

default <I,O extends I> O join(O arg,
                               List<? extends UnaryInplaceOp<I,O>> ops)

Executes the "join" operation on the given arguments.

join

default <AI,AO extends AI,B> B join(B out,
                                    AO in,
                                    UnaryInplaceOp<AI,AO> first,
                                    UnaryComputerOp<AO,B> second)

Executes the "join" operation on the given arguments.

join

default <A,BI,BO extends BI> BO join(BO out,
                                     A in,
                                     UnaryComputerOp<A,BO> first,
                                     UnaryInplaceOp<BI,BO> second)

Executes the "join" operation on the given arguments.

loop

default <I,O extends I> O loop(O arg,
                               UnaryInplaceOp<I,O> op,
                               int n)

Executes the "loop" operation on the given arguments.

loop

default <A> A loop(A out,
                   A in,
                   UnaryComputerOp<A,A> op,
                   UnaryOutputFactory<A,A> outputFactory,
                   int n)

Executes the "loop" operation on the given arguments.