ImgLibGaussConv (Fiji Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:: ImgLibFunction<T>, org.nfunk.jep.function.PostfixMathCommandI

public final class ImgLibGaussConv<T extends RealType<T>>
extends TwoOperandsAbstractFunction<T>

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

Constructor Summary

Constructors
Constructor and Description

ImgLibGaussConv()

Constructors
Constructor and Description
`ImgLibGaussConv()`

Method Summary

All Methods Instance 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 ImgLib images.
`<R extends RealType<R>> Img<FloatType>`	`evaluate(Img<R> img, R alpha)` Evaluate this function on an ImgLib images and a numeric `RealType` type, right singleton expansion.
`<R extends RealType<R>> Img<FloatType>`	`evaluate(R alpha, Img<R> img)` Evaluate this function on an ImgLib images and a numeric `RealType` type, left singleton expansion.
`<R extends RealType<R>> float`	`evaluate(R t1, R t2)` Evaluate this function on two numeric types.
`String`	`getDocumentationString()` Returns a documentation string that documents in enough details what the function does, and how.
`String`	`getFunctionString()` Return a String containing the function name, that is, how this function must be represented in an expression to be called.
`String`	`toString()` Return a String describing this operator.

Methods inherited from class fiji.expressionparser.function.TwoOperandsAbstractFunction
run

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, wait, wait, wait

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

- Constructor Detail
  - ImgLibGaussConv
```
public ImgLibGaussConv()
```
- Method Detail
  - toString
```
public String toString()
```
    Description copied from interface: ImgLibFunction
    
    Return a String describing this operator. Example: "Addition of two operands", "Gaussian convolution", "Element-wise cosine", ...
    
    Specified by:
    
    toString in interface ImgLibFunction<T extends RealType<T>>
    
    Overrides:
    
    toString in class Object
  - getDocumentationString
```
public String getDocumentationString()
```
    Description copied from interface: ImgLibFunction
    
    Returns a documentation string that documents in enough details what the function does, and how. The String can use html syntax in it for formatting.
    Example:
    
    Gaussian convolution
    This function implements the isotropic gaussian convolution, as coded in ImgLib, effectively implementing a gaussian filter. Syntax:
    >> gauss(A, sigma)
    with A an image and sigma a number. Sigma is the standard deviation of the gaussian kernel applied to image A.
    Input image is converted to FloatType then convolved. If the source image is a 3D image, the convolution will be made in 3D as well.
  - getFunctionString
```
public String getFunctionString()
```
    Description copied from interface: ImgLibFunction
    
    Return a String containing the function name, that is, how this function must be represented in an expression to be called. Examples: "+", "gauss", "cos", ...
  - evaluate
```
public final <R extends RealType<R>> Img<FloatType> evaluate(Img<R> img,
                                                             R alpha)
                                                      throws org.nfunk.jep.ParseException
```
    Description copied from class: TwoOperandsAbstractFunction
    
    Evaluate this function on an ImgLib images and a numeric RealType type, right singleton expansion. A new Img of FloatType is returned, so as to avoid underflow and overflow problems on bounded types (e.g. ByeType). This method should implement a singleton expansion of the method TwoOperandsAbstractFunction.evaluate(Img, Img), as meant by the implement function.
    
    Specified by:
    
    evaluate in class TwoOperandsAbstractFunction<T extends RealType<T>>
    
    Parameters:
    
    img - the image
    
    alpha - the numeric type
    
    Returns:
    
    The new resulting image
    
    Throws:
    
    org.nfunk.jep.ParseException
  - evaluate
```
public final <R extends RealType<R>> float evaluate(R t1,
                                                    R t2)
                                             throws org.nfunk.jep.ParseException
```
    Description copied from class: TwoOperandsAbstractFunction
    
    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).
    
    Specified by:
    
    evaluate in class TwoOperandsAbstractFunction<T extends RealType<T>>
    
    Parameters:
    
    t1 - The first number
    
    t2 - The second number
    
    Returns:
    
    The resulting number
    
    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
```
    Description copied from class: TwoOperandsAbstractFunction
    
    Evaluate this function on two ImgLib images. A new Img of FloatType is returned, so as to avoid underflow and overflow problems on bounded types (e.g. ByeType).
    
    Specified by:
    
    evaluate in class TwoOperandsAbstractFunction<T extends RealType<T>>
    
    Parameters:
    
    img1 - the first image
    
    img2 - the second image
    
    Returns:
    
    The new 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
```
    Description copied from class: TwoOperandsAbstractFunction
    
    Evaluate this function on an ImgLib images and a numeric RealType type, left singleton expansion. A new Img of FloatType is returned, so as to avoid underflow and overflow problems on bounded types (e.g. ByeType). This method should implement a singleton expansion of the method TwoOperandsAbstractFunction.evaluate(Img, Img), as meant by the implement function.
    
    Specified by:
    
    evaluate in class TwoOperandsAbstractFunction<T extends RealType<T>>
    
    Parameters:
    
    alpha - the numeric type
    
    img - the image
    
    Returns:
    
    The new resulting image
    
    Throws:
    
    org.nfunk.jep.ParseException

Class ImgLibGaussConv<T extends RealType<T>>

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class fiji.expressionparser.function.TwoOperandsAbstractFunction

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ImgLibGaussConv

Method Detail

toString

getDocumentationString

Gaussian convolution

getFunctionString

evaluate

evaluate

evaluate

evaluate