com.webkitchen.eeg.analysis.filterdesign
Class FilterSpecification

java.lang.Object
  com.webkitchen.eeg.analysis.filterdesign.FilterSpecification

public class FilterSpecification
extends java.lang.Object

Contains the filter specification information required for the FilterDesigner to create an IIRFilter.

See Also:

FilterAlgorithm, FilterRange, FilterDesigner, IIRFilter

Constructor Summary

FilterSpecification()

Method Summary

FilterSpecification	copy() Returns an exact copy of this FilterSpecification
FilterAlgorithm	getAlgorithmType() Gets the algorithm/function type used to design the filter
java.lang.String	getDescription() Gets the text description of the filter
double	getFrequency0() Gets the low end of our frequency range
double	getFrequency1() Gets the high end of our frequency range
int	getOrder() Gets the order of the filter - the number of previous input or output values required to calculate an output
FilterRange	getRangeType() Gets the filter range type used to design the filter
int	getRate() Gets the sample rate for the filter
boolean	isAutoAdjust() Gets the auto-adjust attribute used to design the filter.
boolean	isEditable() Gets the editable state of this FilterSpecification
void	setAlgorithmType(FilterAlgorithm algorithmType) Sets the algorithm/function type to use when designing the filter
void	setAutoAdjust(boolean autoAdjust) Sets the auto-adjust attribute used to design the filter.
void	setDescription(java.lang.String description) Sets the text description of the filter
void	setEditable(boolean editable) Sets the editable state of this FilterSpecification
void	setFrequency0(double frequency0) Sets the low end of our frequency range
void	setFrequency1(double frequency1) Sets the high end of our frequency range
void	setOrder(int order) Sets the order of the filter - the number of previous input or output values required to calculate an output
void	setRangeType(FilterRange rangeType) Sets the filter range type to use when designing the filter
void	setRate(int rate) Sets the sample rate for the filter

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterSpecification

public FilterSpecification()

Method Detail

setEditable

public void setEditable(boolean editable)

Sets the editable state of this FilterSpecification

Parameters:

editable - true if this FilterSpecification is editable, false if not

isEditable

public boolean isEditable()

Gets the editable state of this FilterSpecification

Returns:

true if this FilterSpecification is editable, false if not

getDescription

public java.lang.String getDescription()

Gets the text description of the filter

Returns:

the text description of the filter

setDescription

public void setDescription(java.lang.String description)

Sets the text description of the filter

Parameters:

description - the text description of the filter

getAlgorithmType

public FilterAlgorithm getAlgorithmType()

Gets the algorithm/function type used to design the filter

Returns:

the algorithm/function type used to design the filter

setAlgorithmType

public void setAlgorithmType(FilterAlgorithm algorithmType)

Sets the algorithm/function type to use when designing the filter

Parameters:

algorithmType - the algorithm/function type to use

getRangeType

public FilterRange getRangeType()

Gets the filter range type used to design the filter

Returns:

the filter range type

setRangeType

public void setRangeType(FilterRange rangeType)

Sets the filter range type to use when designing the filter

Parameters:

rangeType - the filter range type

getRate

public int getRate()

Gets the sample rate for the filter

Returns:

the sample rate

setRate

public void setRate(int rate)

Sets the sample rate for the filter

Parameters:

rate - the sample rate

getFrequency0

public double getFrequency0()

Gets the low end of our frequency range

Returns:

the low end of our frequency range

setFrequency0

public void setFrequency0(double frequency0)

Sets the low end of our frequency range

Parameters:

frequency0 - the low end of our frequency range

getFrequency1

public double getFrequency1()

Gets the high end of our frequency range

Returns:

the high end of our frequency range

setFrequency1

public void setFrequency1(double frequency1)

Sets the high end of our frequency range

Parameters:

frequency1 - the high end of our frequency range

isAutoAdjust

public boolean isAutoAdjust()

Gets the auto-adjust attribute used to design the filter. If this is true, the FilterDesigner will attempt to adjust input frequencies to give response of 50% correct to 6sf at the given frequency-points

Returns:

true if the filter will be auto-adjusted, false if not

setAutoAdjust

public void setAutoAdjust(boolean autoAdjust)

Sets the auto-adjust attribute used to design the filter. Setting this to true will instruct the FilterDesigner to attempt to adjust input frequencies to give response of 50% correct to 6sf at the given frequency-points

Parameters:

autoAdjust - true if the filter should be auto-adjusted, false if not

getOrder

public int getOrder()

Gets the order of the filter - the number of previous input or output values required to calculate an output

Returns:

the order of the filter

setOrder

public void setOrder(int order)

Sets the order of the filter - the number of previous input or output values required to calculate an output

Parameters:

order - the order of the filter

copy

public FilterSpecification copy()

Returns an exact copy of this FilterSpecification

Returns:

an exact copy of this FilterSpecification