Class IndexCalculateConfig

CONFIG CLASS FOR the class IndexCalculate.cs.

Inheritance
Object
Config
AnalyzerConfig
AnalyzerConfigIndexProperties
IndexCalculateConfig
AcousticIndices.AcousticIndicesConfig
StandardizedFeatureExtractionConfig
Inherited Members
Namespace: AudioAnalysisTools.Indices
Assembly: AudioAnalysisTools.dll
Syntax
public class IndexCalculateConfig : AnalyzerConfigIndexProperties, IIndexPropertyReferenceConfiguration, IConfig, IEquatable<IndexCalculateConfig>, ICloneable

Constructors

| Improve this Doc View Source

IndexCalculateConfig()

Initializes a new instance of the IndexCalculateConfig class. CONSTRUCTOR.

Declaration
public IndexCalculateConfig()

Fields

| Improve this Doc View Source

DefaultBgNoiseNeighborhood

Declaration
public const double DefaultBgNoiseNeighborhood = 5
Field Value
Type Description
Double
| Improve this Doc View Source

DefaultFrequencyScaleType

Declaration
public const FreqScaleType DefaultFrequencyScaleType = FreqScaleType.Linear
Field Value
Type Description
FreqScaleType
| Improve this Doc View Source

DefaultHighFreqBound

Declaration
public const int DefaultHighFreqBound = 11000
Field Value
Type Description
Int32
| Improve this Doc View Source

DefaultIndexCalculationDurationInSeconds

Declaration
public const int DefaultIndexCalculationDurationInSeconds = 60
Field Value
Type Description
Int32
| Improve this Doc View Source

DefaultLowFreqBound

Declaration
public const int DefaultLowFreqBound = 1000
Field Value
Type Description
Int32
| Improve this Doc View Source

DefaultMaxBandWidth

Declaration
public const double DefaultMaxBandWidth = 1
Field Value
Type Description
Double
| Improve this Doc View Source

DefaultMelScale

Declaration
public const int DefaultMelScale = 0
Field Value
Type Description
Int32
| Improve this Doc View Source

DefaultMidFreqBound

Declaration
public const int DefaultMidFreqBound = 8000
Field Value
Type Description
Int32
| Improve this Doc View Source

DefaultMinBandWidth

Declaration
public const double DefaultMinBandWidth = 0
Field Value
Type Description
Double
| Improve this Doc View Source

DefaultResampleRate

Declaration
public const int DefaultResampleRate = 22050
Field Value
Type Description
Int32
| Improve this Doc View Source

DefaultWindowSize

Declaration
public const int DefaultWindowSize = 512
Field Value
Type Description
Int32

Properties

| Improve this Doc View Source

BgNoiseBuffer

Gets bG noise for any location is calculated by extending the region of index calculation from 5 seconds before start to 5 sec after end of current index interval.

Declaration
[YamlIgnore]
[JsonIgnore]
public TimeSpan BgNoiseBuffer { get; }
Property Value
Type Description
TimeSpan
| Improve this Doc View Source

BgNoiseNeighborhood

Gets or sets the amount of audio either side of the required subsegment from which to derive an estimate of background noise. Units = seconds As an example: IF (IndexCalculationDuration = 1 second) AND (BGNNeighborhood = 10 seconds) THEN BG noise estimate will be derived from 21 seconds of audio centred on the subsegment. In case of edge effects, the BGnoise neighborhood will be truncated to start or end of the audio segment (typically expected to be one minute long).

Declaration
public double BgNoiseNeighborhood { get; set; }
Property Value
Type Description
Double
Remarks

Ten seconds is considered a minimum interval to obtain a reliable estimate of BG noise. The BG noise interval is not extended beyond start or end of recording segment. Consequently for a 60sec Index calculation duration, the BG noise is calculated form the 60sec segment only. Default=5 seconds.

| Improve this Doc View Source

FrameLength

Gets or sets the FrameWidth - the number of samples to use per FFT window. FrameWidth is used WITHOUT overlap to calculate the spectral indices. Default value = 512. Units=samples.

Declaration
public int FrameLength { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

FrequencyScale

Gets or sets frequency scale is Linear or Octave.

Declaration
public FreqScaleType FrequencyScale { get; set; }
Property Value
Type Description
FreqScaleType
| Improve this Doc View Source

IndexCalculationDuration

Gets or sets the duration of the sub-segment for which indices are calculated. Default = 60 seconds i.e. same duration as the Segment.

Declaration
public double IndexCalculationDuration { get; protected set; }
Property Value
Type Description
Double
| Improve this Doc View Source

IndexCalculationDurationTimeSpan

Gets or sets the Timespan (in seconds) over which summary and spectral indices are calculated Default=60.0 Units=seconds.

Declaration
[YamlIgnore]
[JsonIgnore]
public TimeSpan IndexCalculationDurationTimeSpan { get; set; }
Property Value
Type Description
TimeSpan
| Improve this Doc View Source

LowFreqBound

Gets or sets the LowFreqBound. Default value = 1000. Units=Herz.

Declaration
public int LowFreqBound { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

MaxBandWidth

Gets or sets the fraction-valued maximum to be used in a pseudo-bandpass filter.

Declaration
public double MaxBandWidth { get; set; }
Property Value
Type Description
Double
| Improve this Doc View Source

MelScale

Gets or sets the number of Mel-scale filter banks to use.

Declaration
public int MelScale { get; set; }
Property Value
Type Description
Int32
Remarks

The default, 0, implies no operation.

| Improve this Doc View Source

MidFreqBound

Gets or sets the MidFreqBound. Default value = 8000. Units=Herz.

Declaration
public int MidFreqBound { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

MinBandWidth

Gets or sets the fraction-valued minimum to be used in a pseudo-bandpass filter.

Declaration
public double MinBandWidth { get; set; }
Property Value
Type Description
Double

Methods

| Improve this Doc View Source

Equals(IndexCalculateConfig)

Declaration
public bool Equals(IndexCalculateConfig other)
Parameters
Type Name Description
IndexCalculateConfig other
Returns
Type Description
Boolean
| Improve this Doc View Source

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides

Explicit Interface Implementations

| Improve this Doc View Source

ICloneable.Clone()

Declaration
object ICloneable.Clone()
Returns
Type Description
Object

Implements

Extension Methods