/// <summary>
/// Creates a band-pass filter.
/// </summary>
/// <param name="settings">Filter settings.</param>
/// <param name="lowFrequency">Low cutoff frequency.</param>
/// <param name="highFrequency">High cutoff frequency.</param>
/// <returns>The required filter.</returns>
/// <exception cref="NotSupportedException">
/// This designer cannot create the required filter layout.
/// </exception>
protected internal virtual IOnlineFilter CreateBandPass(FilterDesignSettings settings, double lowFrequency, double highFrequency)
{
// Default implementation if there is not a better designer-specific version, if one of required
// filters (for example one designer implements low-pass but not high-pass) isn't supported then it will
// still throw a NotSupportedException for the missing layout.
return(new FilterCascade(
CreateHighPass(settings, lowFrequency),
CreateLowPass(settings, highFrequency)));
}
/// <summary>
/// Creates a designer specific filter (<see cref="FilterKind.Other"/>).
/// </summary>
/// <param name="design">Designer used to build the filter (it must support creation of a designer specific filter).</param>
/// <param name="settings">
/// Settings for the filter (base class <see cref="FilterDesignSettings"/> may be used if you do not want to specify
/// any of extra settings supported by designer for this specific type of filter).
/// </param>
/// <returns>
/// An on-line filter with specified type and characteristics.
/// </returns>
/// <exception cref="ArgumentNullException">
/// If <paramref name="design"/> is <see langword="null"/>.
/// <br/>-or-<br/>
/// If <paramref name="settings"/> is <see langword="null"/>.
/// </exception>
/// <exception cref="NotSupportedException">
/// If specified <paramref name="design"/> does not support required filter <see cref="FilterKind.Other"/>.
/// </exception>
/// <exception cref="ArithmeticException">
/// If filter cannot be designed as required (but parameters are all OK).
/// </exception>
public static IOnlineFilter Create(OnlineFilterDesigner design, FilterDesignSettings settings)
{
return(Create(FilterKind.Other, design, settings));
}
/// <overload>
/// Creates a new filter.
/// </overload>
/// <summary>
/// Creates a new all-pass filter or a designer specific filter.
/// </summary>
/// <param name="type">Type of the filter, it must be <see cref="FilterKind.AllPass"/>.</param>
/// <param name="design">Designer used to build the filter (it must support creation of an all-pass filter).</param>
/// <param name="settings">
/// Settings for the filter (base class <see cref="FilterDesignSettings"/> may be used if you do not want to specify
/// any of extra settings supported by designer for this specific type of filter).
/// </param>
/// <returns>
/// An on-line filter with specified type and characteristics.
/// </returns>
/// <exception cref="ArgumentNullException">
/// If <paramref name="design"/> is <see langword="null"/>.
/// <br/>-or-<br/>
/// If <paramref name="settings"/> is <see langword="null"/>.
/// </exception>
/// <exception cref="ArgumentException">
/// If <paramref name="type"/> is not <see cref="FilterKind.AllPass"/> or <see cref="FilterKind.Other"/>.
/// </exception>
/// <exception cref="NotSupportedException">
/// If specified <paramref name="design"/> does not support required filter <paramref name="type"/>.
/// </exception>
/// <exception cref="ArithmeticException">
/// If filter cannot be designed as required (but parameters are all OK).
/// </exception>
public static IOnlineFilter Create(FilterKind type, OnlineFilterDesigner design, FilterDesignSettings settings)
{
ValidateSettingsWithDesigner(design, settings);
if (type == FilterKind.Other)
{
return(design.CreateOther(settings));
}
if (type == FilterKind.AllPass)
{
return(design.CreateAllPass(settings, 0.0, settings.SamplingRate / 2));
}
throw new ArgumentException("This overload can be used only to create all pass/other filters.", "type");
}
private static void ValidateSettingsWithDesigner(OnlineFilterDesigner design, FilterDesignSettings settings)
{
if (design == null)
{
throw new ArgumentNullException("design");
}
if (settings == null)
{
throw new ArgumentNullException("settings");
}
// Add here more (generic) validation when required...
}
/// <summary>
/// Creates a new band filter.
/// </summary>
/// <param name="type">
/// Type of the filter, it must be a band filter with a single cutoff frequency (not <see cref="FilterKind.AllPass"/>
/// or another single cutoff frequency filter).
/// </param>
/// <param name="design">Designer used to build the filter (it must support creation of required filter).</param>
/// <param name="settings">
/// Settings for the filter (base class <see cref="FilterDesignSettings"/> may be used if you do not want to specify
/// any of extra settings supported by designer for this specific type of filter).
/// </param>
/// <param name="band">Frequency band of this filter.</param>
/// <returns>
/// An on-line filter with specified type and characteristics.
/// </returns>
/// <exception cref="ArgumentNullException">
/// If <paramref name="design"/> is <see langword="null"/>.
/// <br/>-or-<br/>
/// If <paramref name="settings"/> is <see langword="null"/>.
/// </exception>
/// <exception cref="ArgumentOutOfRangeException">
/// If one of the frequencies is 0 or less or <see cref="Double.NaN"/> or <see cref="Double.PositiveInfinity"/>.
/// <br/>-or-<br/>
/// If <c>band.Minimum</c> is greater than <c>band.Maximum</c>.
/// </exception>
/// <exception cref="ArgumentException">
/// If <paramref name="type"/> is not a band filter.
/// </exception>
/// <exception cref="NotSupportedException">
/// If specified <paramref name="design"/> does not support required filter <paramref name="type"/>.
/// </exception>
/// <exception cref="ArithmeticException">
/// If filter cannot be designed as required (but parameters are all OK).
/// </exception>
public static IOnlineFilter Create(FilterKind type, OnlineFilterDesigner design, FilterDesignSettings settings, Range <double> band)
{
ValidateSettingsWithDesigner(design, settings);
ValidateFrequency(band.Minimum);
ValidateFrequency(band.Maximum);
if (band.Maximum < band.Minimum)
{
throw new ArgumentOutOfRangeException("band");
}
if (type == FilterKind.BandPass)
{
return(design.CreateBandPass(settings, band.Minimum, band.Maximum));
}
else if (type == FilterKind.BandStop)
{
return(design.CreateBandPass(settings, band.Minimum, band.Maximum));
}
else if (type == FilterKind.AllPass)
{
return(design.CreateAllPass(settings, band.Minimum, band.Maximum));
}
throw new ArgumentException("This overload can be used only to create band filters.", "type");
}
/// <summary>
/// Creates a new filter with specified cutoff frequency.
/// </summary>
/// <param name="type">
/// Type of the filter, it must be a filter with a single cutoff frequency (not <see cref="FilterKind.AllPass"/>
/// or another band filter).
/// </param>
/// <param name="design">Designer used to build the filter (it must support creation of required filter).</param>
/// <param name="settings">
/// Settings for the filter (base class <see cref="FilterDesignSettings"/> may be used if you do not want to specify
/// any of extra settings supported by designer for this specific type of filter).
/// </param>
/// <param name="frequency">Cutoff frequency for this filter.</param>
/// <returns>
/// An on-line filter with specified type and characteristics.
/// </returns>
/// <exception cref="ArgumentNullException">
/// If <paramref name="design"/> is <see langword="null"/>.
/// <br/>-or-<br/>
/// If <paramref name="settings"/> is <see langword="null"/>.
/// </exception>
/// <exception cref="ArgumentOutOfRangeException">
/// If <paramref name="frequency"/> is 0 or less or <see cref="Double.NaN"/> or <see cref="Double.PositiveInfinity"/>.
/// </exception>
/// <exception cref="ArgumentException">
/// If <paramref name="type"/> is not a filter with a single cutoff frequency (<see cref="FilterKind.AllPass"/>,
/// <see cref="FilterKind.BandPass"/> and <see cref="FilterKind.BandStop"/> cannot be created with this function).
/// </exception>
/// <exception cref="NotSupportedException">
/// If specified <paramref name="design"/> does not support required filter <paramref name="type"/>.
/// </exception>
/// <exception cref="ArithmeticException">
/// If filter cannot be designed as required (but parameters are all OK).
/// </exception>
public static IOnlineFilter Create(FilterKind type, OnlineFilterDesigner design, FilterDesignSettings settings, double frequency)
{
ValidateSettingsWithDesigner(design, settings);
ValidateFrequency(frequency);
switch (type)
{
case FilterKind.BandPass:
case FilterKind.BandStop:
case FilterKind.Other:
case FilterKind.AllPass:
throw new ArgumentException("This overload can be used only to create filters with a cutoff frequency.", "type");
case FilterKind.LowPass:
return(design.CreateLowPass(settings, frequency));
case FilterKind.HighPass:
return(design.CreateHighPass(settings, frequency));
case FilterKind.LowShelf:
return(design.CreateLowShelf(settings, frequency));
case FilterKind.HighShelf:
return(design.CreateHighShelf(settings, frequency));
case FilterKind.Notch:
return(design.CreateNotch(settings, frequency));
case FilterKind.Peak:
return(design.CreatePeak(settings, frequency));
default:
throw new InvalidEnumArgumentException("type", (int)type, typeof(FilterKind));
}
}
/// <summary>
/// Creates a band-stop filter.
/// </summary>
/// <param name="settings">Filter settings.</param>
/// <param name="lowFrequency">Low cutoff frequency.</param>
/// <param name="highFrequency">High cutoff frequency.</param>
/// <returns>The required filter.</returns>
/// <exception cref="NotSupportedException">
/// This designer cannot create the required filter layout.
/// </exception>
protected internal virtual IOnlineFilter CreateBandStop(FilterDesignSettings settings, double lowFrequency, double highFrequency)
{
return(NotSupported());
}
/// <summary>
/// Creates a high-pass filter.
/// </summary>
/// <param name="settings">Filter settings.</param>
/// <param name="frequency">Cutoff frequency.</param>
/// <returns>The required filter.</returns>
/// <exception cref="NotSupportedException">
/// This designer cannot create the required filter layout.
/// </exception>
protected internal virtual IOnlineFilter CreateHighPass(FilterDesignSettings settings, double frequency)
{
return(NotSupported());
}
/// <summary>
/// Creates a designer specific filter.
/// </summary>
/// <param name="settings">Filter settings.</param>
/// <returns>The required filter.</returns>
/// <exception cref="NotSupportedException">
/// This designer cannot create the required filter layout.
/// </exception>
protected internal virtual IOnlineFilter CreateOther(FilterDesignSettings settings)
{
return(NotSupported());
}
