ConvolveFilter (MeteoInfoLib 1.8 API)

java.lang.Object
- org.meteoinfo.image.filter.AbstractBufferedImageOp
- - org.meteoinfo.image.filter.ConvolveFilter

所有已实现的接口:

BufferedImageOp, Cloneable

直接已知子类:

AverageFilter, BlurFilter, BumpFilter, GaussianFilter, SharpenFilter
```
public class ConvolveFilter
extends AbstractBufferedImageOp
```
A filter which applies a convolution kernel to an image.

作者:

Jerry Huxtable

字段概要

字段
限定符和类型	字段	说明
`protected boolean`	`alpha`	Whether to convolve alpha.
`static int`	`CLAMP_EDGES`	Clamp pixels off the edge to the nearest edge.
`protected Kernel`	`kernel`	The convolution kernel.
`protected boolean`	`premultiplyAlpha`	Whether to promultiply the alpha before convolving.
`static int`	`WRAP_EDGES`	Wrap pixels off the edge to the opposite edge.
`static int`	`ZERO_EDGES`	Treat pixels off the edge as zero.

构造器概要

构造器
构造器	说明
`ConvolveFilter()`	Construct a filter with a null kernel.
`ConvolveFilter(float[] matrix)`	Construct a filter with the given 3x3 kernel.
`ConvolveFilter(int rows, int cols, float[] matrix)`	Construct a filter with the given kernel.
`ConvolveFilter(Kernel kernel)`	Construct a filter with the given 3x3 kernel.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`static void`	`convolve(Kernel kernel, int[] inPixels, int[] outPixels, int width, int height, boolean alpha, int edgeAction)`	Convolve a block of pixels.
`static void`	`convolve(Kernel kernel, int[] inPixels, int[] outPixels, int width, int height, int edgeAction)`	Convolve a block of pixels.
`static void`	`convolveH(Kernel kernel, int[] inPixels, int[] outPixels, int width, int height, boolean alpha, int edgeAction)`	Convolve with a kernel consisting of one row.
`static void`	`convolveHV(Kernel kernel, int[] inPixels, int[] outPixels, int width, int height, boolean alpha, int edgeAction)`	Convolve with a 2D kernel.
`static void`	`convolveV(Kernel kernel, int[] inPixels, int[] outPixels, int width, int height, boolean alpha, int edgeAction)`	Convolve with a kernel consisting of one column.
`BufferedImage`	`createCompatibleDestImage(BufferedImage src, ColorModel dstCM)`
`BufferedImage`	`filter(BufferedImage src, BufferedImage dst)`
`Rectangle2D`	`getBounds2D(BufferedImage src)`
`int`	`getEdgeAction()`	Get the action to perfomr for pixels off the image edges.
`Kernel`	`getKernel()`	Get the convolution kernel.
`Point2D`	`getPoint2D(Point2D srcPt, Point2D dstPt)`
`boolean`	`getPremultiplyAlpha()`	Get whether to premultiply the alpha channel.
`RenderingHints`	`getRenderingHints()`
`boolean`	`getUseAlpha()`	Get whether to convolve the alpha channel.
`void`	`setEdgeAction(int edgeAction)`	Set the action to perfomr for pixels off the image edges.
`void`	`setKernel(Kernel kernel)`	Set the convolution kernel.
`void`	`setPremultiplyAlpha(boolean premultiplyAlpha)`	Set whether to premultiply the alpha channel.
`void`	`setUseAlpha(boolean useAlpha)`	Set whether to convolve the alpha channel.
`String`	`toString()`

从类继承的方法 org.meteoinfo.image.filter.AbstractBufferedImageOp
clone, getRGB, setRGB

从类继承的方法 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - ZERO_EDGES
```
public static int ZERO_EDGES
```
    Treat pixels off the edge as zero.
  - CLAMP_EDGES
```
public static int CLAMP_EDGES
```
    Clamp pixels off the edge to the nearest edge.
  - WRAP_EDGES
```
public static int WRAP_EDGES
```
    Wrap pixels off the edge to the opposite edge.
  - kernel
```
protected Kernel kernel
```
    The convolution kernel.
  - alpha
```
protected boolean alpha
```
    Whether to convolve alpha.
  - premultiplyAlpha
```
protected boolean premultiplyAlpha
```
    Whether to promultiply the alpha before convolving.
- 构造器详细资料
  - ConvolveFilter
```
public ConvolveFilter()
```
    Construct a filter with a null kernel. This is only useful if you're going to change the kernel later on.
  - ConvolveFilter
```
public ConvolveFilter(float[] matrix)
```
    Construct a filter with the given 3x3 kernel.
    
    参数:
    
    matrix - an array of 9 floats containing the kernel
  - ConvolveFilter
```
public ConvolveFilter(int rows,
                      int cols,
                      float[] matrix)
```
    Construct a filter with the given kernel.
    
    参数:
    
    rows - the number of rows in the kernel
    
    cols - the number of columns in the kernel
    
    matrix - an array of rows*cols floats containing the kernel
  - ConvolveFilter
```
public ConvolveFilter(Kernel kernel)
```
    Construct a filter with the given 3x3 kernel.
    
    参数:
    
    kernel - the convolution kernel
- 方法详细资料
  - setKernel
```
public void setKernel(Kernel kernel)
```
    Set the convolution kernel.
    
    参数:
    
    kernel - the kernel
    
    另请参阅:
    
    getKernel()
  - getKernel
```
public Kernel getKernel()
```
    Get the convolution kernel.
    
    返回:
    
    the kernel
    
    另请参阅:
    
    setKernel(java.awt.image.Kernel)
  - setEdgeAction
```
public void setEdgeAction(int edgeAction)
```
    Set the action to perfomr for pixels off the image edges.
    
    参数:
    
    edgeAction - the action
    
    另请参阅:
    
    getEdgeAction()
  - getEdgeAction
```
public int getEdgeAction()
```
    Get the action to perfomr for pixels off the image edges.
    
    返回:
    
    the action
    
    另请参阅:
    
    setEdgeAction(int)
  - setUseAlpha
```
public void setUseAlpha(boolean useAlpha)
```
    Set whether to convolve the alpha channel.
    
    参数:
    
    useAlpha - true to convolve the alpha
    
    另请参阅:
    
    getUseAlpha()
  - getUseAlpha
```
public boolean getUseAlpha()
```
    Get whether to convolve the alpha channel.
    
    返回:
    
    true to convolve the alpha
    
    另请参阅:
    
    setUseAlpha(boolean)
  - setPremultiplyAlpha
```
public void setPremultiplyAlpha(boolean premultiplyAlpha)
```
    Set whether to premultiply the alpha channel.
    
    参数:
    
    premultiplyAlpha - true to premultiply the alpha
    
    另请参阅:
    
    getPremultiplyAlpha()
  - getPremultiplyAlpha
```
public boolean getPremultiplyAlpha()
```
    Get whether to premultiply the alpha channel.
    
    返回:
    
    true to premultiply the alpha
    
    另请参阅:
    
    setPremultiplyAlpha(boolean)
  - filter
```
public BufferedImage filter(BufferedImage src,
                            BufferedImage dst)
```
  - createCompatibleDestImage
```
public BufferedImage createCompatibleDestImage(BufferedImage src,
                                               ColorModel dstCM)
```
    指定者:
    
    createCompatibleDestImage 在接口中 BufferedImageOp
    
    覆盖:
    
    createCompatibleDestImage 在类中 AbstractBufferedImageOp
  - getBounds2D
```
public Rectangle2D getBounds2D(BufferedImage src)
```
    指定者:
    
    getBounds2D 在接口中 BufferedImageOp
    
    覆盖:
    
    getBounds2D 在类中 AbstractBufferedImageOp
  - getPoint2D
```
public Point2D getPoint2D(Point2D srcPt,
                          Point2D dstPt)
```
    指定者:
    
    getPoint2D 在接口中 BufferedImageOp
    
    覆盖:
    
    getPoint2D 在类中 AbstractBufferedImageOp
  - getRenderingHints
```
public RenderingHints getRenderingHints()
```
    指定者:
    
    getRenderingHints 在接口中 BufferedImageOp
    
    覆盖:
    
    getRenderingHints 在类中 AbstractBufferedImageOp
  - convolve
```
public static void convolve(Kernel kernel,
                            int[] inPixels,
                            int[] outPixels,
                            int width,
                            int height,
                            int edgeAction)
```
    Convolve a block of pixels.
    
    参数:
    
    kernel - the kernel
    
    inPixels - the input pixels
    
    outPixels - the output pixels
    
    width - the width
    
    height - the height
    
    edgeAction - what to do at the edges
  - convolve
```
public static void convolve(Kernel kernel,
                            int[] inPixels,
                            int[] outPixels,
                            int width,
                            int height,
                            boolean alpha,
                            int edgeAction)
```
    Convolve a block of pixels.
    
    参数:
    
    kernel - the kernel
    
    inPixels - the input pixels
    
    outPixels - the output pixels
    
    width - the width
    
    height - the height
    
    alpha - include alpha channel
    
    edgeAction - what to do at the edges
  - convolveHV
```
public static void convolveHV(Kernel kernel,
                              int[] inPixels,
                              int[] outPixels,
                              int width,
                              int height,
                              boolean alpha,
                              int edgeAction)
```
    Convolve with a 2D kernel.
    
    参数:
    
    kernel - the kernel
    
    inPixels - the input pixels
    
    outPixels - the output pixels
    
    width - the width
    
    height - the height
    
    alpha - include alpha channel
    
    edgeAction - what to do at the edges
  - convolveH
```
public static void convolveH(Kernel kernel,
                             int[] inPixels,
                             int[] outPixels,
                             int width,
                             int height,
                             boolean alpha,
                             int edgeAction)
```
    Convolve with a kernel consisting of one row.
    
    参数:
    
    kernel - the kernel
    
    inPixels - the input pixels
    
    outPixels - the output pixels
    
    width - the width
    
    height - the height
    
    alpha - include alpha channel
    
    edgeAction - what to do at the edges
  - convolveV
```
public static void convolveV(Kernel kernel,
                             int[] inPixels,
                             int[] outPixels,
                             int width,
                             int height,
                             boolean alpha,
                             int edgeAction)
```
    Convolve with a kernel consisting of one column.
    
    参数:
    
    kernel - the kernel
    
    inPixels - the input pixels
    
    outPixels - the output pixels
    
    width - the width
    
    height - the height
    
    alpha - include alpha channel
    
    edgeAction - what to do at the edges
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 ConvolveFilter

字段概要

构造器概要

方法概要

从类继承的方法 org.meteoinfo.image.filter.AbstractBufferedImageOp

从类继承的方法 java.lang.Object

字段详细资料

ZERO_EDGES

CLAMP_EDGES

WRAP_EDGES

kernel

alpha

premultiplyAlpha

构造器详细资料

ConvolveFilter

ConvolveFilter

ConvolveFilter

ConvolveFilter

方法详细资料

setKernel

getKernel

setEdgeAction

getEdgeAction

setUseAlpha

getUseAlpha

setPremultiplyAlpha

getPremultiplyAlpha

filter

createCompatibleDestImage

getBounds2D

getPoint2D

getRenderingHints

convolve

convolve

convolveHV

convolveH

convolveV

toString