ImgLibBandPassFilter (Fiji Javadocs 0-SNAPSHOT API)

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

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

public class ImgLibBandPassFilter<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

ImgLibBandPassFilter()

Constructors
Constructor and Description
`ImgLibBandPassFilter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`void`	`run(Stack stack)`

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
toString

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

- Constructor Detail
  - ImgLibBandPassFilter
```
public ImgLibBandPassFilter()
```
- Method Detail
  - run
```
public void run(Stack stack)
         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
  - 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.
    
    Specified by:
    
    getDocumentationString in interface ImgLibFunction<T extends RealType<T>>
  - 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", ...
    
    Specified by:
    
    getFunctionString in interface ImgLibFunction<T extends RealType<T>>

Class ImgLibBandPassFilter<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

ImgLibBandPassFilter

Method Detail

run

getDocumentationString

Gaussian convolution

getFunctionString