Compute (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- script.imglib.math.Compute

```
public class Compute
extends Object
```
Compute an IFunction into an Image. In essence, the IFunction defines an operation with one or two pixels as arguments, such as Multiply, Divide, etc. The inFloats(IFunction) evaluates the function and places the result in a new Image. To specify a different type, use the apply(IFunction, RealType, int), and for RGBALegacyType, use apply(IFunction, RGBALegacyType, int) or inRGBA(IFunction).
The underlying machinery first inspects the IFunction and all its nested IFunction instances, collecting all visible Cursor instances, using the method findImages(IFunction).
All Image instances related to the found Cursor instances are inspected to ensure that their Container are compatible. If the Container are not compatible, the content of the images would not be iterated in a way that would make sense. So an Exception will be thrown.
Finally, the results of evaluating the IFunction are stored and returned in an Image. The dimensions of the returned image are the same as those of the first image found. If the dimensions do not match, an error will eventually pop up, or the computation result in images that have unexpected data in chunks of them (for example, when there is an OutOfBoundsStrategy that prevents an early error from occurring).
An example program: correct the background illumination of an image, given the associated brighfield and a darkfield images, and the mean value of the image:
```
   public Image scriptCorrectIllumination(
            final Image> img,
            final Image> brightfield,
            final Image> darkfield,
            final double mean) throws Exception
   {
       Image corrected = Compute.inFloats(1,
           new Multiply(
               new Divide(
                   new Subtract(img, brightfield),
                   new Subtract(brightfield, darkfield)),
           mean));
       return corrected;
   }
   
```
Version:

1.0 2010-11-30

Author:

Albert Cardona

See Also:

IFunction, Image

Constructor Summary

Constructors
Constructor and Description

Compute()

Constructors
Constructor and Description
`Compute()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Image<RGBALegacyType>`	`apply(IFunction op, RGBALegacyType output, int numThreads)` Execute the given `IFunction`, which runs for each pixel, and store the results in an `Image` of type `RGBALegacyType`.
`static <R extends RealType<R>> Image<R>`	`apply(IFunction op, R output, int numThreads)` Execute the given `IFunction`, which runs for each pixel, and store the results in an `Image` with the type defined by , which has to be a subclass of `RealType`.
`static void`	`checkContainers(Collection<Image<?>> images)` Ensure that the `Container` of each `Image` of @param images is compatible with all the others.
`static Set<Image<?>>`	`findImages(IFunction op)` Find all images in @param op and nested `IFunction` instances.
`static Image<DoubleType>`	`inDoubles(IFunction op)` Execute the given `IFunction`, which runs for each pixel, and store the results in an `Image` of type `DoubleType`.
`static Image<DoubleType>`	`inDoubles(Image<? extends RealType<?>> img)` Convenience method to avoid confusion with script wrappers that are themselves `Image` rather than `IFunction`; this method ends up creating a copy of the image, in `DoubleType`.
`static Image<DoubleType>`	`inDoubles(int numThreads, IFunction op)` Execute the given `IFunction`, which runs for each pixel, and store the results in an `Image` of type `DoubleType` with as many threads as desired.
`static Image<FloatType>`	`inFloats(IFunction op)` Execute the given op `IFunction`, which runs for each pixel, and store the results in an `Image` of type `FloatType`.
`static Image<FloatType>`	`inFloats(Image<? extends RealType<?>> img)` Convenience method to avoid confusion with script wrappers that are themselves `Image` rather than `IFunction`; this method ends up creating a copy of the image, in `FloatType`.
`static Image<FloatType>`	`inFloats(int numThreads, IFunction op)` Execute the given `IFunction`, which runs for each pixel, and store the results in an `Image` of type `FloatType` with as many threads as desired.
`static Image<RGBALegacyType>`	`inRGBA(IFunction op)` Execute the given `IFunction`, which runs for each pixel, and store the results in an `Image` of type `RGBALegacyType` with as many threads as desired.
`static Image<RGBALegacyType>`	`inRGBA(Image<? extends RealType<?>> img)` Convenience method to avoid confusion with script wrappers that are themselves `Image` rather than `IFunction`; this method ends up creating a copy of the image, in `RGBALegacyType`.
`static Image<RGBALegacyType>`	`inRGBA(int numThreads, IFunction op)` Execute the given `IFunction`, which runs for each pixel, and store the results in an `Image` of type `RGBALegacyType` with as many threads as desired.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Compute
```
public Compute()
```
- Method Detail
  - checkContainers
```
public static final void checkContainers(Collection<Image<?>> images)
                                  throws Exception
```
    Ensure that the Container of each Image of @param images is compatible with all the others.
    
    Throws:
    
    Exception
  - findImages
```
public static final Set<Image<?>> findImages(IFunction op)
                                      throws Exception
```
    Find all images in @param op and nested IFunction instances.
    
    Throws:
    
    Exception
  - apply
```
public static final <R extends RealType<R>> Image<R> apply(IFunction op,
                                                           R output,
                                                           int numThreads)
                                                    throws Exception
```
    Execute the given IFunction, which runs for each pixel, and store the results in an Image with the type defined by , which has to be a subclass of RealType.
    
    Parameters:
    
    op - The IFunction to execute.
    
    output - An instance of the type of the result image returned by this method.
    
    numThreads - The number of threads for parallel execution.
    
    Throws:
    
    Exception
  - apply
```
public static final Image<RGBALegacyType> apply(IFunction op,
                                                RGBALegacyType output,
                                                int numThreads)
                                         throws Exception
```
    Execute the given IFunction, which runs for each pixel, and store the results in an Image of type RGBALegacyType.
    
    Parameters:
    
    op - The IFunction to execute.
    
    output - An instance of the RGBALegacyType type of the result image returned by this method.
    
    numThreads - The number of threads for parallel execution.
    
    Throws:
    
    Exception
  - inFloats
```
public static final Image<FloatType> inFloats(IFunction op)
                                       throws Exception
```
    Execute the given op IFunction, which runs for each pixel, and store the results in an Image of type FloatType. Uses as many concurrent threads as CPUs, defined by Runtime.availableProcessors().
    
    Parameters:
    
    op - The IFunction to execute.
    
    Throws:
    
    Exception
  - inFloats
```
public static final Image<FloatType> inFloats(int numThreads,
                                              IFunction op)
                                       throws Exception
```
    Execute the given IFunction, which runs for each pixel, and store the results in an Image of type FloatType with as many threads as desired.
    
    Parameters:
    
    numThreads - The number of threads for parallel execution.
    
    op - The IFunction to execute.
    
    Throws:
    
    Exception
  - inDoubles
```
public static final Image<DoubleType> inDoubles(int numThreads,
                                                IFunction op)
                                         throws Exception
```
    Execute the given IFunction, which runs for each pixel, and store the results in an Image of type DoubleType with as many threads as desired.
    
    Parameters:
    
    numThreads - The number of threads for parallel execution.
    
    op - The IFunction to execute.
    
    Throws:
    
    Exception
  - inDoubles
```
public static final Image<DoubleType> inDoubles(IFunction op)
                                         throws Exception
```
    Execute the given IFunction, which runs for each pixel, and store the results in an Image of type DoubleType. Uses as many concurrent threads as CPUs, defined by Runtime.availableProcessors().
    
    Parameters:
    
    op - The IFunction to execute.
    
    Throws:
    
    Exception
  - inRGBA
```
public static final Image<RGBALegacyType> inRGBA(int numThreads,
                                                 IFunction op)
                                          throws Exception
```
    Execute the given IFunction, which runs for each pixel, and store the results in an Image of type RGBALegacyType with as many threads as desired.
    
    Parameters:
    
    numThreads - The number of threads for parallel execution.
    
    op - The IFunction to execute.
    
    Throws:
    
    Exception
  - inRGBA
```
public static final Image<RGBALegacyType> inRGBA(IFunction op)
                                          throws Exception
```
    Execute the given IFunction, which runs for each pixel, and store the results in an Image of type RGBALegacyType with as many threads as desired. Uses as many concurrent threads as CPUs, defined by Runtime.availableProcessors().
    
    Parameters:
    
    op - The IFunction to execute.
    
    Throws:
    
    Exception
  - inFloats
```
public static final Image<FloatType> inFloats(Image<? extends RealType<?>> img)
                                       throws Exception
```
    Convenience method to avoid confusion with script wrappers that are themselves Image rather than IFunction; this method ends up creating a copy of the image, in FloatType.
    
    Throws:
    
    Exception
  - inDoubles
```
public static final Image<DoubleType> inDoubles(Image<? extends RealType<?>> img)
                                         throws Exception
```
    Convenience method to avoid confusion with script wrappers that are themselves Image rather than IFunction; this method ends up creating a copy of the image, in DoubleType.
    
    Throws:
    
    Exception
  - inRGBA
```
public static final Image<RGBALegacyType> inRGBA(Image<? extends RealType<?>> img)
                                          throws Exception
```
    Convenience method to avoid confusion with script wrappers that are themselves Image rather than IFunction; this method ends up creating a copy of the image, in RGBALegacyType. This method transforms an IFunction operation that returns a double for every pixel into an RGBA image, by casting each double to an int.
    
    Throws:
    
    Exception

Class Compute

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Compute

Method Detail

checkContainers

findImages

apply

apply

inFloats

inFloats

inDoubles

inDoubles

inRGBA

inRGBA

inFloats

inDoubles

inRGBA