ATK-Sharp  1.0
The ATK library for C#.
ATKSharp.Modifiers.Butterworth Class Reference

The Butterworth class. This filter has a nice frequency response. It is a bit more tempermental than other filters; use with caution. More...

Inheritance diagram for ATKSharp.Modifiers.Butterworth:
ATKSharp.Modifiers.BaseModifier ATKSharp.Modifiers.IModifier

Public Member Functions

 Butterworth (float initFreq=1000f)
 Initializes a new instance of the Butterworth class. More...
 
override float Modify (float input)
 Modifies the input. More...
 

Properties

override float Frequency [get, set]
 Gets or sets the frequency. More...
 
float Bandwidth [get, set]
 Gets or sets the bandwidth. More...
 
- Properties inherited from ATKSharp.Modifiers.BaseModifier
virtual ModifierType ModifierType [get, set]
 Gets or sets the modifier type. More...
 
virtual float Frequency [get, set]
 Gets or sets the modifier frequency. More...
 
virtual float CurrentSample [get, protected set]
 Gets or sets the current sample. More...
 
- Properties inherited from ATKSharp.Modifiers.IModifier
float CurrentSample [get]
 Gets the current sample. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ATKSharp.Modifiers.BaseModifier
 BaseModifier ()
 Initializes a new instance of the BaseModifier class. More...
 

Detailed Description

The Butterworth class. This filter has a nice frequency response. It is a bit more tempermental than other filters; use with caution.

Constructor & Destructor Documentation

◆ Butterworth()

ATKSharp.Modifiers.Butterworth.Butterworth ( float  initFreq = 1000f)

Initializes a new instance of the Butterworth class.

Parameters
initFreqThe initial frequency (Hz).

Member Function Documentation

◆ Modify()

override float ATKSharp.Modifiers.Butterworth.Modify ( float  input)
virtual

Modifies the input.

Parameters
inputThe input.
Returns
The modified input.

Reimplemented from ATKSharp.Modifiers.BaseModifier.

Property Documentation

◆ Bandwidth

float ATKSharp.Modifiers.Butterworth.Bandwidth
getset

Gets or sets the bandwidth.

◆ Frequency

override float ATKSharp.Modifiers.Butterworth.Frequency
getset

Gets or sets the frequency.


The documentation for this class was generated from the following file: