Class SpectralIndexValues

Inheritance
Object
ResultBase
SpectralIndexBase
SpectralIndexValues
Inherited Members
Namespace: AudioAnalysisTools.Indices
Assembly: AudioAnalysisTools.dll
Syntax
public class SpectralIndexValues : SpectralIndexBase, IComparable<ResultBase>, IComparable

Constructors

| Improve this Doc View Source

SpectralIndexValues()

Declaration
public SpectralIndexValues()
| Improve this Doc View Source

SpectralIndexValues(Int32, Dictionary<String, IndexProperties>, IndexCalculateConfig)

Declaration
public SpectralIndexValues(int spectrumLength, Dictionary<string, IndexProperties> indexProperties, IndexCalculateConfig configuration)
Parameters
Type Name Description
Int32 spectrumLength
Dictionary<String, IndexProperties> indexProperties
IndexCalculateConfig configuration

Properties

| Improve this Doc View Source

ACI

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

BGN

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

CachedSelectors

Declaration
public static Dictionary<string, Func<SpectralIndexBase, double[]>> CachedSelectors { get; }
Property Value
Type Description
Dictionary<String, Func<SpectralIndexBase, Double[]>>
| Improve this Doc View Source

CachedSetters

Declaration
public static Dictionary<string, Action<SpectralIndexValues, double[]>> CachedSetters { get; }
Property Value
Type Description
Dictionary<String, Action<SpectralIndexValues, Double[]>>
| Improve this Doc View Source

Configuration

Gets the configuration used to generate these results.

Declaration
public IndexCalculateConfig Configuration { get; }
Property Value
Type Description
IndexCalculateConfig
Remarks

This property was added when we started generating lots of results that used different parameters - we needed a way to disambiguate them.

| Improve this Doc View Source

CVR

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

DIF

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

ENT

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

EVN

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

Keys

Declaration
public static string[] Keys { get; }
Property Value
Type Description
String[]
| Improve this Doc View Source

OSC

Gets or sets the oscillation spectral index index. Created October 2018. 6.

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

PMN

Gets or sets PMN = Power Minus Noise. 7: PMN is measured in decibels but should replace POW as the average decibel spectrogram.

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

RHZ

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

RNG

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

RPS

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

RVT

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

SPT

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

SUM

Declaration
public double[] SUM { get; set; }
Property Value
Type Description
Double[]

Methods

| Improve this Doc View Source

CheckExistenceOfSpectralIndexValues(Dictionary<String, IndexProperties>)

Used to check that the keys in the indexProperties dictionary correspond to Properties in the SpectralIndexValues class. Call this method before entering a loop because do not want the error message at every iteration through loop.

Declaration
public static void CheckExistenceOfSpectralIndexValues(Dictionary<string, IndexProperties> indexProperties)
Parameters
Type Name Description
Dictionary<String, IndexProperties> indexProperties
| Improve this Doc View Source

CreateImageOfSpectralIndices(SpectralIndexValues)

Declaration
public static Image<Rgb24> CreateImageOfSpectralIndices(SpectralIndexValues spectralIndices)
Parameters
Type Name Description
SpectralIndexValues spectralIndices
Returns
Type Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>
| Improve this Doc View Source

GetSelectors()

Declaration
public override Dictionary<string, Func<SpectralIndexBase, double[]>> GetSelectors()
Returns
Type Description
Dictionary<String, Func<SpectralIndexBase, Double[]>>
Overrides
| Improve this Doc View Source

ImportFromDictionary(Dictionary<String, Double[,]>)

Imports a dictionary of spectra. Assumes CheckExistenceOfSpectralIndexValues has already been called. Assumes frequency component is in fist index (i.e. frequency is rows) and time in second index (time is columns).

Declaration
public static SpectralIndexValues[] ImportFromDictionary(Dictionary<string, double[, ]> dictionaryOfSpectra)
Parameters
Type Name Description
Dictionary<String, Double[,]> dictionaryOfSpectra

The dictionary to convert to spectral index base.
Returns
Type Description
SpectralIndexValues[]

Implements

Extension Methods