java.lang.Object
- org.esa.snap.rcp.imgfilter.model.Filter

```
public class Filter
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Filter.Listener

static class Filter.Operation

Constructor Summary

Constructors
Constructor	Description
`Filter(String name, String shorthand, int kernelWidth, int kernelHeight, double[] kernelElements, double kernelQuotient, String... tags)`
`Filter(String name, String shorthand, Filter.Operation operation, int kernelWidth, int kernelHeight, double[] kernelElements, double kernelQuotient, String... tags)`
`Filter(String name, String shorthand, Filter.Operation operation, int kernelWidth, int kernelHeight, String... tags)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addListener(Filter.Listener listener)`
`void`	`adjustKernelQuotient()`
`static Filter`	`create(int kernelSize, String... tags)`
`static Filter`	`create(Filter.Operation operation, int kernelSize, String... tags)`
`static com.thoughtworks.xstream.XStream`	`createXStream()`
`void`	`fill(org.esa.snap.rcp.imgfilter.model.Filter.FillFunction fillFunction)`
`void`	`fillEllipse(double fillValue)`
`void`	`fillGaussian()`
`void`	`fillLaplacian()`
`void`	`fillRandom()`
`void`	`fillRectangle(double fillValue)`
`void`	`fireChange(String propertyName)`
`static String`	`formatKernelElements(double[] kernelElements, Dimension dim, String sep)`
`double`	`getKernelElement(int index)`
`double`	`getKernelElement(int i, int j)`
`double[]`	`getKernelElements()`
`String`	`getKernelElementsAsText()`
`int`	`getKernelHeight()`
`int`	`getKernelOffsetX()`
`int`	`getKernelOffsetY()`
`double`	`getKernelQuotient()`
`int`	`getKernelWidth()`
`String`	`getName()`
`Filter.Operation`	`getOperation()`
`String`	`getShorthand()`
`Set<String>`	`getTags()`
`boolean`	`isEditable()`
`static boolean`	`isKernelDataText(String text)`
`protected static double[]`	`parseKernelElementsFromText(String text, Dimension dim)`
`void`	`removeListener(Filter.Listener listener)`
`void`	`setEditable(boolean editable)`
`void`	`setKernelElement(int index, double value)`
`void`	`setKernelElement(int i, int j, double value)`
`void`	`setKernelElements(double[] kernelElements)`
`void`	`setKernelElementsFromText(String text)`
`void`	`setKernelOffset(int kernelOffsetX, int kernelOffsetY)`
`void`	`setKernelQuotient(double kernelQuotient)`
`void`	`setKernelSize(int width, int height)`
`void`	`setName(String name)`
`void`	`setOperation(Filter.Operation operation)`
`void`	`setShorthand(String shorthand)`
`void`	`setTags(String... tags)`
`static String[][]`	`tokenizeKernelElements(String text)`
`String`	`toString()`

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

Constructor Detail

Filter

public Filter(String name,
              String shorthand,
              int kernelWidth,
              int kernelHeight,
              double[] kernelElements,
              double kernelQuotient,
              String... tags)

Filter

public Filter(String name,
              String shorthand,
              Filter.Operation operation,
              int kernelWidth,
              int kernelHeight,
              String... tags)

Filter

public Filter(String name,
              String shorthand,
              Filter.Operation operation,
              int kernelWidth,
              int kernelHeight,
              double[] kernelElements,
              double kernelQuotient,
              String... tags)

Method Detail

create

public static Filter create(int kernelSize,
                            String... tags)

create

public static Filter create(Filter.Operation operation,
                            int kernelSize,
                            String... tags)

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getShorthand
```
public String getShorthand()
```

setShorthand

public void setShorthand(String shorthand)

getOperation

public Filter.Operation getOperation()

setOperation

public void setOperation(Filter.Operation operation)

isEditable
```
public boolean isEditable()
```

setEditable

public void setEditable(boolean editable)

getTags
```
public Set<String> getTags()
```

setTags

public void setTags(String... tags)

getKernelElement

public double getKernelElement(int i,
                               int j)

getKernelElement

public double getKernelElement(int index)

setKernelElement

public void setKernelElement(int i,
                             int j,
                             double value)

setKernelElement

public void setKernelElement(int index,
                             double value)

getKernelElements
```
public double[] getKernelElements()
```

setKernelElements

public void setKernelElements(double[] kernelElements)

getKernelWidth
```
public int getKernelWidth()
```

getKernelHeight
```
public int getKernelHeight()
```

setKernelSize

public void setKernelSize(int width,
                          int height)

fill

public void fill(org.esa.snap.rcp.imgfilter.model.Filter.FillFunction fillFunction)

fillRectangle

public void fillRectangle(double fillValue)

fillEllipse

public void fillEllipse(double fillValue)

fillGaussian
```
public void fillGaussian()
```

fillLaplacian
```
public void fillLaplacian()
```

fillRandom
```
public void fillRandom()
```

getKernelQuotient
```
public double getKernelQuotient()
```

setKernelQuotient

public void setKernelQuotient(double kernelQuotient)

adjustKernelQuotient
```
public void adjustKernelQuotient()
```

getKernelOffsetX
```
public int getKernelOffsetX()
```

getKernelOffsetY
```
public int getKernelOffsetY()
```

setKernelOffset

public void setKernelOffset(int kernelOffsetX,
                            int kernelOffsetY)

getKernelElementsAsText

public String getKernelElementsAsText()

setKernelElementsFromText

public void setKernelElementsFromText(String text)

parseKernelElementsFromText

protected static double[] parseKernelElementsFromText(String text,
                                                      Dimension dim)

tokenizeKernelElements

public static String[][] tokenizeKernelElements(String text)

formatKernelElements

public static String formatKernelElements(double[] kernelElements,
                                          Dimension dim,
                                          String sep)

createXStream

public static com.thoughtworks.xstream.XStream createXStream()

toString
```
public String toString()
```
Overrides:

toString in class Object

isKernelDataText

public static boolean isKernelDataText(String text)

fireChange

public void fireChange(String propertyName)

addListener

public void addListener(Filter.Listener listener)

removeListener

public void removeListener(Filter.Listener listener)

Modifier and Type	Class	Description
`static interface`	`Filter.Listener`
`static class`	`Filter.Operation`

Class Filter

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Filter

Filter

Filter

Method Detail

create

create

getName

setName

getShorthand

setShorthand

getOperation

setOperation

isEditable

setEditable

getTags

setTags

getKernelElement

getKernelElement

setKernelElement

setKernelElement

getKernelElements

setKernelElements

getKernelWidth

getKernelHeight

setKernelSize

fill

fillRectangle

fillEllipse

fillGaussian

fillLaplacian

fillRandom

getKernelQuotient

setKernelQuotient

adjustKernelQuotient

getKernelOffsetX

getKernelOffsetY

setKernelOffset

getKernelElementsAsText

setKernelElementsFromText

parseKernelElementsFromText

tokenizeKernelElements

formatKernelElements

createXStream

toString

isKernelDataText

fireChange

addListener

removeListener