Method Detail

• toString

  String toString()

  Return a String describing this operator. Example: "Addition of two operands", "Gaussian convolution", "Element-wise cosine", ...

  Overrides:

  toString in class Object

• getFunctionString

  String getFunctionString()

  Return a String containing the function name, that is, how this function must be represented in an expression to be called. Examples: "+", "gauss", "cos", ...

• getDocumentationString

  String getDocumentationString()

  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.