com.aspose.imaging.imagefilters.filteroptions

Class ConvolutionFilterOptions

java.lang.Object

com.aspose.imaging.imagefilters.filteroptions.FilterOptionsBase

com.aspose.imaging.imagefilters.filteroptions.ConvolutionFilterOptions

All Implemented Interfaces:

com.aspose.internal.imagefilters.convolution.IConvolutionKernel, com.aspose.internal.imagefilters.convolution.IKernel<double[][]>

Direct Known Subclasses:

GaussianBlurFilterOptions

public class ConvolutionFilterOptions
extends FilterOptionsBase
implements com.aspose.internal.imagefilters.convolution.IConvolutionKernel

The convolution filter options.

Constructor Summary

Constructors

Constructor and Description
ConvolutionFilterOptions(double[][] kernel) Initializes a new instance of the ConvolutionFilterOptions class with factor == 1 and bias == 0.
ConvolutionFilterOptions(double[][] kernel, double factor) Initializes a new instance of the ConvolutionFilterOptions class with bias == 0.
ConvolutionFilterOptions(double[][] kernel, double factor, int bias) Initializes a new instance of the ConvolutionFilterOptions class.

Method Summary

Modifier and Type	Method and Description
int	getBias() Gets the bias.
boolean	getBordersProcessing() Gets a value indicating whether [borders processing].
double	getFactor() Gets the factor.
boolean	getIgnoreAlpha() Gets a value indicating whether [ignore alpha].
double[][]	getKernel() Gets the kernel.
void	setBias(int value) Sets the bias.
void	setBordersProcessing(boolean value) Sets a value indicating whether [borders processing].
void	setFactor(double value) Sets the factor.
void	setIgnoreAlpha(boolean value) Sets a value indicating whether [ignore alpha].

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConvolutionFilterOptions

public ConvolutionFilterOptions(double[][] kernel)

Initializes a new instance of the ConvolutionFilterOptions class with factor == 1 and bias == 0.

Parameters:

kernel - The convolution kernel for X-axis direction.

Throws:

com.aspose.ms.System.ArgumentNullException - ArgumentNullException

ConvolutionFilterOptions

public ConvolutionFilterOptions(double[][] kernel,
                                double factor)

Initializes a new instance of the ConvolutionFilterOptions class with bias == 0.

Parameters:

kernel - The convolution kernel for X-axis direction.

factor - The factor.

Throws:

com.aspose.ms.System.ArgumentNullException - ArgumentNullException

ConvolutionFilterOptions

public ConvolutionFilterOptions(double[][] kernel,
                                double factor,
                                int bias)

Initializes a new instance of the ConvolutionFilterOptions class.

Parameters:

kernel - The convolution kernel for X-axis direction.

factor - The factor.

bias - The bias value.

Throws:

com.aspose.ms.System.ArgumentNullException - ArgumentNullException

Method Detail

getKernel

public double[][] getKernel()

Gets the kernel.

Specified by:

getKernel in interface com.aspose.internal.imagefilters.convolution.IKernel<double[][]>

Returns:

the kernel.

getFactor

public final double getFactor()

Gets the factor.

Returns:

the factor.

setFactor

public final void setFactor(double value)

Sets the factor.

Parameters:

value - the factor.

getBias

public final int getBias()

Gets the bias.

Value: The bias.

Returns:

the bias.

setBias

public final void setBias(int value)

Sets the bias.

Value: The bias.

Parameters:

value - the bias.

getIgnoreAlpha

public final boolean getIgnoreAlpha()

Gets a value indicating whether [ignore alpha].

Value: true if [ignore alpha]; otherwise, false.

Returns:

a value indicating whether [ignore alpha].

setIgnoreAlpha

public final void setIgnoreAlpha(boolean value)

Sets a value indicating whether [ignore alpha].

Value: true if [ignore alpha]; otherwise, false.

Parameters:

value - a value indicating whether [ignore alpha].

getBordersProcessing

public final boolean getBordersProcessing()

Gets a value indicating whether [borders processing].

Value: true if [borders processing]; otherwise, false.

Returns:

a value indicating whether [borders processing].

setBordersProcessing

public final void setBordersProcessing(boolean value)

Sets a value indicating whether [borders processing].

Value: true if [borders processing]; otherwise, false.

Parameters:

value - a value indicating whether [borders processing].