TwoOperandsPixelBasedAbstractFunction (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.nfunk.jep.function.PostfixMathCommand
- - fiji.expressionparser.function.TwoOperandsPixelBasedAbstractFunction<T>

All Implemented Interfaces:

ImgLibFunction<T>, org.nfunk.jep.function.PostfixMathCommandI

Direct Known Subclasses:

ImgLibAdd, ImgLibArcTangent2, ImgLibComparison.Equal, ImgLibComparison.GreaterOrEqual, ImgLibComparison.GreaterThan, ImgLibComparison.LowerOrEqual, ImgLibComparison.LowerThan, ImgLibComparison.NotEqual, ImgLibDivide, ImgLibLogical.And, ImgLibLogical.Or, ImgLibModulus, ImgLibMultiply, ImgLibPower, ImgLibSubtract
```
public abstract class TwoOperandsPixelBasedAbstractFunction<T extends RealType<T>>
extends org.nfunk.jep.function.PostfixMathCommand
implements ImgLibFunction<T>
```

Field Summary
- Fields inherited from class org.nfunk.jep.function.PostfixMathCommand
  curNumberOfParameters, numberOfParameters

Constructor Summary

Constructors
Constructor and Description

TwoOperandsPixelBasedAbstractFunction()

Constructors
Constructor and Description
`TwoOperandsPixelBasedAbstractFunction()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`<R extends RealType<R>> Img<FloatType>`	`evaluate(Img<R> img1, Img<R> img2)` Evaluate this function on two images, and return result as an image.
`<R extends RealType<R>> Img<FloatType>`	`evaluate(Img<R> img, R alpha)` Right-singleton expansion.
`<R extends RealType<R>> Img<FloatType>`	`evaluate(R alpha, Img<R> img)` Left-singleton expansion.
`abstract <R extends RealType<R>> float`	`evaluate(R t1, R t2)` Evaluate this function on two numeric types.
`void`	`run(Stack inStack)`

Methods inherited from class org.nfunk.jep.function.PostfixMathCommand
checkNumberOfParameters, checkStack, getNumberOfParameters, setCurNumberOfParameters

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

Methods inherited from interface fiji.expressionparser.function.ImgLibFunction
getDocumentationString, getFunctionString, toString

Methods inherited from interface org.nfunk.jep.function.PostfixMathCommandI
checkNumberOfParameters, getNumberOfParameters, setCurNumberOfParameters

- Constructor Detail
  - TwoOperandsPixelBasedAbstractFunction
```
public TwoOperandsPixelBasedAbstractFunction()
```
- Method Detail
  - run
```
public final void run(Stack inStack)
               throws org.nfunk.jep.ParseException
```
    Specified by:
    
    run in interface org.nfunk.jep.function.PostfixMathCommandI
    
    Overrides:
    
    run in class org.nfunk.jep.function.PostfixMathCommand
    
    Throws:
    
    org.nfunk.jep.ParseException
  - evaluate
```
public final <R extends RealType<R>> Img<FloatType> evaluate(Img<R> img1,
                                                             Img<R> img2)
                                                      throws org.nfunk.jep.ParseException
```
    Evaluate this function on two images, and return result as an image.
    
    Parameters:
    
    img1 - The first image
    
    img2 - The second image
    
    Returns:
    
    The resulting image
    
    Throws:
    
    org.nfunk.jep.ParseException
  - evaluate
```
public final <R extends RealType<R>> Img<FloatType> evaluate(Img<R> img,
                                                             R alpha)
                                                      throws org.nfunk.jep.ParseException
```
    Right-singleton expansion. Evaluate this function on an image and an image that would be of same dimension but with all element being the number passed in argument.
    
    Parameters:
    
    img - The image
    
    alpha - The number to do singleton expansion on
    
    Returns:
    
    The resulting image
    
    Throws:
    
    org.nfunk.jep.ParseException
  - evaluate
```
public final <R extends RealType<R>> Img<FloatType> evaluate(R alpha,
                                                             Img<R> img)
                                                      throws org.nfunk.jep.ParseException
```
    Left-singleton expansion. Evaluate this function on an image and an image that would be of same dimension but with all element being the number passed in argument.
    
    Parameters:
    
    img - The image
    
    alpha - The number to do singleton expansion on
    
    Returns:
    
    The resulting image
    
    Throws:
    
    org.nfunk.jep.ParseException
  - evaluate
```
public abstract <R extends RealType<R>> float evaluate(R t1,
                                                       R t2)
                                                throws org.nfunk.jep.ParseException
```
    Evaluate this function on two numeric types. Argument types can be of any numeric type, but a float must be returned, so as to avoid underflow and overflow problems on bounded types (e.g. ByeType).
    
    Parameters:
    
    t1 - The first number
    
    t2 - The second number
    
    Returns:
    
    The resulting number
    
    Throws:
    
    org.nfunk.jep.ParseException

Class TwoOperandsPixelBasedAbstractFunction<T extends RealType<T>>

Field Summary

Fields inherited from class org.nfunk.jep.function.PostfixMathCommand

Constructor Summary

Method Summary

Methods inherited from class org.nfunk.jep.function.PostfixMathCommand

Methods inherited from class java.lang.Object

Methods inherited from interface fiji.expressionparser.function.ImgLibFunction

Methods inherited from interface org.nfunk.jep.function.PostfixMathCommandI

Constructor Detail

TwoOperandsPixelBasedAbstractFunction

Method Detail

run

evaluate

evaluate

evaluate

evaluate