Class BaseSonogram

Base Sonogram.

Inheritance

Object

BaseSonogram

AmplitudeSonogram

SpectrogramCepstral

SpectrogramMelScale

SpectrogramOctaveScale

SpectrogramSobelEdge

SpectrogramStandard

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: AudioAnalysisTools.StandardSpectrograms

Assembly: AudioAnalysisTools.dll

Syntax

public abstract class BaseSonogram

Constructors

BaseSonogram(SonogramConfig)

Initializes a new instance of the BaseSonogram class. BASE CONSTRUCTOR: Use this when want to extract time segment of existing sonogram.

Declaration

public BaseSonogram(SonogramConfig config)

Parameters

Type	Name	Description
SonogramConfig	config	config file to use.

BaseSonogram(SonogramConfig, WavReader)

Initializes a new instance of the BaseSonogram class. BASE CONSTRUCTOR.

Declaration

public BaseSonogram(SonogramConfig config, WavReader wav)

Parameters

Type	Name	Description
SonogramConfig	config	config file to use.
WavReader	wav	wav.

BaseSonogram(SonogramConfig, FrequencyScale, WavReader)

Initializes a new instance of the BaseSonogram class. BASE CONSTRUCTOR.

Declaration

public BaseSonogram(SonogramConfig config, FrequencyScale freqScale, WavReader wav)

Parameters

Type	Name	Description
SonogramConfig	config	config file to use.
FrequencyScale	freqScale
WavReader	wav	wav.

BaseSonogram(SonogramConfig, Double[,])

Initializes a new instance of the BaseSonogram class. Use this BASE CONSTRUCTOR when already have the amplitude spectrogram in matrix. Init normalised signal energy array but do nothing with it. This has to be done from outside.

Declaration

public BaseSonogram(SonogramConfig config, double[, ] amplitudeSpectrogramData)

Parameters

Type	Name	Description
SonogramConfig	config	the spectrogram config.
Double[,]	amplitudeSpectrogramData	data of an amplitude Spectrogram.

Properties

Configuration

Gets or sets the config information. The Configuration object should contain all the parameters required to construct an amplitude spectrogram given a recording.

Declaration

public SonogramConfig Configuration { get; set; }

Property Value

Type	Description
SonogramConfig

Data

Gets or sets the spectrogram data matrix of doubles.

Declaration

public double[, ] Data { get; set; }

Property Value

Type	Description
Double[,]

DecibelReference

Gets or sets decibel reference with which to NormaliseMatrixValues the dB values for MFCCs.

Declaration

public double DecibelReference { get; protected set; }

Property Value

Type	Description
Double

DecibelsNormalised

Gets or sets the array of frame log-energy values normalised 0,1. This is derived from the array variable DecibelsPerFrame[].

Declaration

public double[] DecibelsNormalised { get; set; }

Property Value

Type	Description
Double[]

DecibelsPerFrame

Gets or sets decibels per signal frame. i.e. log frame energy.

Declaration

public double[] DecibelsPerFrame { get; set; }

Property Value

Type	Description
Double[]

Duration

Declaration

public TimeSpan Duration { get; protected set; }

Property Value

Type	Description
TimeSpan

FBinWidth

Declaration

public double FBinWidth { get; }

Property Value

Type	Description
Double

FrameCount

Declaration

public int FrameCount { get; protected set; }

Property Value

Type	Description
Int32

FrameDuration

Declaration

public double FrameDuration { get; }

Property Value

Type	Description
Double

FramesPerSecond

Declaration

public double FramesPerSecond { get; }

Property Value

Type	Description
Double

FrameStep

Declaration

public double FrameStep { get; }

Property Value

Type	Description
Double

FreqScale

Gets or sets the frequency scale information. The FreqScale object should contain all the parameters required to convert the linear frquency scale of the amplitude spectrogram into any reduced or non-linear frequency scale required.

Declaration

public FrequencyScale FreqScale { get; set; }

Property Value

Type	Description
FrequencyScale

MaxAmplitude

Declaration

public double MaxAmplitude { get; set; }

Property Value

Type	Description
Double

ModalNoiseProfile

Gets or sets the Noise profile in decibels.

Declaration

public double[] ModalNoiseProfile { get; set; }

Property Value

Type	Description
Double[]

NyquistFrequency

Declaration

public int NyquistFrequency { get; }

Property Value

Type	Description
Int32

SampleRate

Declaration

public int SampleRate { get; set; }

Property Value

Type	Description
Int32

SigState

Gets or sets integer coded signal state ie 0=non-vocalisation, 1=vocalisation, etc.

Declaration

public int[] SigState { get; protected set; }

Property Value

Type	Description
Int32[]

SnrData

Gets or sets instance of class SNR that stores info about signal energy and dB per frame.

Declaration

public SNR SnrData { get; set; }

Property Value

Type	Description
SNR

Methods

Data2ImageData(Double[,])

converts the dB data in sonogram.Data to grey scale image of spectrogram.

Declaration

public static Tuple<double[, ], double, double> Data2ImageData(double[, ] matrix)

Parameters

Type	Name	Description
Double[,]	matrix	matrix of sonogram values.

Returns

Type	Description
Tuple<Double[,], Double, Double>

DrawTitleBarOfGrayScaleSpectrogram(String, Int32, Nullable<Color>)

Declaration

public static Image<Rgb24> DrawTitleBarOfGrayScaleSpectrogram(string title, int width, Color? tag = default(Color? ))

Parameters

Type	Name	Description
String	title
Int32	width
Nullable<SixLabors.ImageSharp.Color>	tag

Returns

Type	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>

FrameSonogram(Image<Rgb24>, Image<Rgb24>, TimeSpan, TimeSpan, TimeSpan, TimeSpan)

This method draws only top and bottom time scales and adds the title bar. It does NOT include the frequency grid lines.

Declaration

public static Image<Rgb24> FrameSonogram(Image<Rgb24> sonogramImage, Image<Rgb24> titleBar, TimeSpan minuteOffset, TimeSpan xAxisTicInterval, TimeSpan xAxisPixelDuration, TimeSpan labelInterval)

Parameters

Type	Name	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>	sonogramImage
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>	titleBar
TimeSpan	minuteOffset
TimeSpan	xAxisTicInterval
TimeSpan	xAxisPixelDuration
TimeSpan	labelInterval

Returns

Type	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>

FrameSonogram(Image<Rgb24>, Image<Rgb24>, TimeSpan, TimeSpan, TimeSpan, TimeSpan, Int32, Int32)

This method assumes that the height of the passed sonogram image is half of the original frame size. This assumption allows the frequency scale grid lines to be placed at the correct intervals.

Declaration

public static Image<Rgb24> FrameSonogram(Image<Rgb24> sonogramImage, Image<Rgb24> titleBar, TimeSpan minuteOffset, TimeSpan xAxisTicInterval, TimeSpan xAxisPixelDuration, TimeSpan labelInterval, int nyquist, int hertzInterval)

Parameters

Type	Name	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>	sonogramImage
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>	titleBar
TimeSpan	minuteOffset
TimeSpan	xAxisTicInterval
TimeSpan	xAxisPixelDuration
TimeSpan	labelInterval
Int32	nyquist
Int32	hertzInterval

Returns

Type	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>

GetAvSpectrum_HighestPercentile(Double[,], Int32)

Declaration

public static double[] GetAvSpectrum_HighestPercentile(double[, ] matrix, int highPercentile)

Parameters

Type	Name	Description
Double[,]	matrix
Int32	highPercentile

Returns

Type	Description
Double[]

GetAvSpectrum_LowestPercentile(Double[,], Int32)

Declaration

public static double[] GetAvSpectrum_LowestPercentile(double[, ] matrix, int lowPercentile)

Parameters

Type	Name	Description
Double[,]	matrix
Int32	lowPercentile

Returns

Type	Description
Double[]

GetImage()

Declaration

public Image<Rgb24> GetImage()

Returns

Type	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>

GetImage(Boolean, Boolean, Boolean)

Declaration

public Image<Rgb24> GetImage(bool doHighlightSubband, bool add1KHzLines, bool doMelScale)

Parameters

Type	Name	Description
Boolean	doHighlightSubband
Boolean	add1KHzLines
Boolean	doMelScale

Returns

Type	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>

GetImageAnnotatedWithLinearHertzScale(Image<Rgb24>, Int32, Int32, String, Nullable<Color>)

Draws Frame around image of spectrogram.

Declaration

public static Image<Rgb24> GetImageAnnotatedWithLinearHertzScale(Image<Rgb24> image, int sampleRate, int frameStep, string title, Color? tag = default(Color? ))

Parameters

Type	Name	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>	image	Image of Spectrogram.
Int32	sampleRate	sample rate of recording. Necessary for both time scale and Hertz scale.
Int32	frameStep	frame step allows correct time scale to be drawn.
String	title	Descriptive title of the spectrogram.
Nullable<SixLabors.ImageSharp.Color>	tag

Returns

Type	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>	The framed spectrogram image.

GetImageAnnotatedWithLinearHerzScale(Image<Rgb24>, String, Nullable<Color>)

Declaration

public Image<Rgb24> GetImageAnnotatedWithLinearHerzScale(Image<Rgb24> image, string title, Color? tag = default(Color? ))

Parameters

Type	Name	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>	image
String	title
Nullable<SixLabors.ImageSharp.Color>	tag

Returns

Type	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>

GetImageFullyAnnotated(Image<Rgb24>, String, Int32[,], Nullable<Color>)

This method fully annotates a short-time scale spectrogram. The grid-lines are drawn according to indices in gridLineLocations. Therefore the method will accept spectrograms with octave or any frequency scale. The time scale is calculated from recording duration and width of image.

Declaration

public Image<Rgb24> GetImageFullyAnnotated(Image<Rgb24> image, string title, int[, ] gridLineLocations, Color? tag = default(Color? ))

Parameters

Type	Name	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>	image	The raw spectrogram image.
String	title	To go on the title bar.
Int32[,]	gridLineLocations	A matrix of values.
Nullable<SixLabors.ImageSharp.Color>	tag	Used to identify images??.

Returns

Type	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>	The annotated spectrogram.

GetImageFullyAnnotated(String, Nullable<Color>)

This method assumes that the spectrogram has linear Herz scale.

Declaration

public Image<Rgb24> GetImageFullyAnnotated(string title, Color? tag = default(Color? ))

Parameters

Type	Name	Description
String	title	title to be added to spectrogram.
Nullable<SixLabors.ImageSharp.Color>	tag

Returns

Type	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>

GetSonogramImage(Double[,], Int32, Int32)

Returns an image of the data matrix. Normalises the values from min->max according to passed rank values. Therefore pixels in the normalised grey-scale image will range from 0 to 255.

Declaration

public static Image<Rgb24> GetSonogramImage(double[, ] data, int minPercentile, int maxPercentile)

Parameters

Type	Name	Description
Double[,]	data
Int32	minPercentile
Int32	maxPercentile

Returns

Type	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>

GetSonogramImage(Double[,], Int32, Int32, Boolean, Int32, Boolean, Int32, Int32)

Declaration

public static Image<Rgb24> GetSonogramImage(double[, ] data, int nyquistFreq, int maxFrequency, bool doMelScale, int binHeight, bool doHighlightSubband, int subBandMinHz, int subBandMaxHz)

Parameters

Type	Name	Description
Double[,]	data
Int32	nyquistFreq
Int32	maxFrequency
Boolean	doMelScale
Int32	binHeight
Boolean	doHighlightSubband
Int32	subBandMinHz
Int32	subBandMaxHz

Returns

Type	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>

Make(Double[,])

Declaration

public abstract void Make(double[, ] amplitudeM)

Parameters

Type	Name	Description
Double[,]	amplitudeM

RescaleLinearFrequencyScale(Double[,], FrequencyScale)

Declaration

public static double[, ] RescaleLinearFrequencyScale(double[, ] inputSpgram, FrequencyScale freqScale)

Parameters

Type	Name	Description
Double[,]	inputSpgram
FrequencyScale	freqScale

Returns

Type	Description
Double[,]

SaveDebugSpectrogram(Image, DirectoryInfo, String)

This method is called by unit tests that want to draw simple spectorgram images. It can be modified to do something non-standard with the output spectrogram.

Declaration

public static string SaveDebugSpectrogram(Image image, DirectoryInfo outputDirectory, string baseName)

Parameters

Type	Name	Description
SixLabors.ImageSharp.Image	image
DirectoryInfo	outputDirectory
String	baseName

Returns

Type	Description
String

Extension Methods

ObjectExtensions.NotNull(Object)

ObjectExtensions.AsArray<T>(T)

ObjectExtensions.AsList<T>(T)

ObjectExtensions.Wrap<T>(T)

SystemExtensions.BinarySerialize(Object)

ConfigFileExtensions.NotNull(Object, FileInfo, String, String)

ConfigFileExtensions.ValidateNotNull(Object, String, String)

ConfigFileExtensions.ValidateLessThan<T>(Object, Nullable<T>, String, Nullable<T>, String, String)

ExtensionsXml.SerializeObject<T>(T)