Class LDSpectrogramRGB

This class generates false-color spectrograms of long duration audio recordings. Important properties are:

the color map which maps three acoustic indices to RGB.
The scale of the x and y axes which are determined by the sample rate, frame size etc. In order to create false color spectrograms, copy the method public static void DrawFalseColorSpectrograms(LDSpectrogramConfig configuration) All the arguments can be passed through a config file. Create the config file through an instance of the class LDSpectrogramConfig and then call config.WritConfigToYAML(FileInfo path). Then pass that path to the above static method.

Inheritance

Object

LDSpectrogramRGB

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: AudioAnalysisTools.LongDurationSpectrograms

Assembly: AudioAnalysisTools.dll

Syntax

public class LDSpectrogramRGB

Constructors

| Improve this Doc View Source

LDSpectrogramRGB()

Initializes a new instance of the LDSpectrogramRGB class. No Arguments CONSTRUCTOR.

Declaration

public LDSpectrogramRGB()

| Improve this Doc View Source

LDSpectrogramRGB(LdSpectrogramConfig, IndexGenerationData, String)

Declaration

public LDSpectrogramRGB(LdSpectrogramConfig config, IndexGenerationData indexGenerationData, string colorMap)

Parameters

Type	Name	Description
LdSpectrogramConfig	config
IndexGenerationData	indexGenerationData
String	colorMap

| Improve this Doc View Source

LDSpectrogramRGB(TimeSpan, Int32, String)

Initializes a new instance of the LDSpectrogramRGB class. CONSTRUCTOR.

Declaration

public LDSpectrogramRGB(TimeSpan xScale, int sampleRate, string colorMap)

Parameters

Type	Name	Description
TimeSpan	xScale
Int32	sampleRate
String	colorMap

| Improve this Doc View Source

LDSpectrogramRGB(TimeSpan, TimeSpan, Int32, Int32, String)

Initializes a new instance of the LDSpectrogramRGB class. CONSTRUCTOR WARNING: Ths will create a linear Hertz scale spectrogram.

Declaration

public LDSpectrogramRGB(TimeSpan minuteOffset, TimeSpan xScale, int sampleRate, int frameWidth, string colorMap)

Parameters

Type	Name	Description
TimeSpan	minuteOffset	minute of day at which the spectrogram starts.
TimeSpan	xScale	time scale : pixels per hour.
Int32	sampleRate	recording sample rate which also determines scale of Y-axis.
Int32	frameWidth	frame size - which also determines scale of Y-axis.
String	colorMap	acoustic indices used to assign the three color mapping.

Fields

| Improve this Doc View Source

DefaultColorMap1

Declaration

public static readonly string DefaultColorMap1

Field Value

Type	Description
String

| Improve this Doc View Source

DefaultColorMap2

Declaration

public static readonly string DefaultColorMap2

Field Value

Type	Description
String

| Improve this Doc View Source

SpectrogramMatrices

Declaration

public Dictionary<string, double[, ]> SpectrogramMatrices

Field Value

Type	Description
Dictionary<String, Double[,]>

| Improve this Doc View Source

TrackHeight

Declaration

public const int TrackHeight = 18

Field Value

Type	Description
Int32

Properties

| Improve this Doc View Source

BackgroundFilter

Declaration

public double BackgroundFilter { get; set; }

Property Value

Type	Description
Double

| Improve this Doc View Source

ColorMap

Gets or sets the ColorMap within current recording.

Declaration

public string ColorMap { get; set; }

Property Value

Type	Description
String

| Improve this Doc View Source

ColorMode

Gets or sets POSITIVE or NEGATIVE.

Declaration

public string ColorMode { get; set; }

Property Value

Type	Description
String

| Improve this Doc View Source

ErroneousSegments

Declaration

public List<GapsAndJoins> ErroneousSegments { get; }

Property Value

Type	Description
List<GapsAndJoins>

| Improve this Doc View Source

FileName

Declaration

public string FileName { get; set; }

Property Value

Type	Description
String

| Improve this Doc View Source

FrameWidth

Gets or sets the frame width. Used only to calculate scale of Y-axis to draw grid lines.

Declaration

public int FrameWidth { get; set; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

FreqScale

Gets or sets the ColorMap within current recording.

Declaration

public FrequencyScale FreqScale { get; set; }

Property Value

Type	Description
FrequencyScale

| Improve this Doc View Source

GetYinterval

Gets the 1 kHz intervals.

Declaration

public int GetYinterval { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

IndexCalculationDuration

Gets or sets the temporal duration of one sub-segment interval for which indices are calculated.

Declaration

public TimeSpan IndexCalculationDuration { get; set; }

Property Value

Type	Description
TimeSpan

| Improve this Doc View Source

IndexStats

Gets index distribution statistics are now calulated after the indices have been calculated.

Declaration

public Dictionary<string, IndexDistributions.SpectralStats> IndexStats { get; }

Property Value

Type	Description
Dictionary<String, IndexDistributions.SpectralStats>

| Improve this Doc View Source

Latitude

Declaration

public double? Latitude { get; set; }

Property Value

Type	Description
Nullable<Double>

| Improve this Doc View Source

Longitude

Declaration

public double? Longitude { get; set; }

Property Value

Type	Description
Nullable<Double>

| Improve this Doc View Source

RecordingStartDate

Gets or sets the date and time at which the current LDspectrogram starts This can be used to correctly.

Declaration

public DateTimeOffset RecordingStartDate { get; set; }

Property Value

Type	Description
DateTimeOffset

| Improve this Doc View Source

SampleCount

Gets or sets used where the spectrograms are derived from averages and want to do t-test of difference.

Declaration

public int SampleCount { get; set; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

SampleRate

Gets or sets the sample rate.

Declaration

public int SampleRate { get; set; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

SiteName

Declaration

public string SiteName { get; set; }

Property Value

Type	Description
String

| Improve this Doc View Source

SpectrogramKeys

Declaration

public string[] SpectrogramKeys { get; }

Property Value

Type	Description
String[]

| Improve this Doc View Source

StartOffset

Gets or sets the time at which the current LDFC spectrogram starts.

Declaration

public TimeSpan StartOffset { get; set; }

Property Value

Type	Description
TimeSpan

| Improve this Doc View Source

SunriseDataFile

Gets or sets a file from which can be obtained information about sunrise and sunset times for the recording site. The csv file needs to be in the correct format and typically should contain 365 lines. Have not attempted to deal with leap years!.

Declaration

[Obsolete]
public FileInfo SunriseDataFile { get; set; }

Property Value

Type	Description
FileInfo

| Improve this Doc View Source

XTicInterval

Declaration

public TimeSpan XTicInterval { get; set; }

Property Value

Type	Description
TimeSpan

Methods

| Improve this Doc View Source

ColourChart2Array(Dictionary<String, Color>)

Declaration

public static Color[] ColourChart2Array(Dictionary<string, Color> chart)

Parameters

Type	Name	Description
Dictionary<String, SixLabors.ImageSharp.Color>	chart

Returns

Type	Description
SixLabors.ImageSharp.Color[]

| Improve this Doc View Source

ContainsMatrixForKey(String)

Declaration

public bool ContainsMatrixForKey(string key)

Parameters

Type	Name	Description
String	key

Returns

Type	Description
Boolean

| Improve this Doc View Source

ContainsMatrixForKeys(String)

Declaration

public bool ContainsMatrixForKeys(string keys)

Parameters

Type	Name	Description
String	keys

Returns

Type	Description
Boolean

| Improve this Doc View Source

DrawBlendedFalseColourSpectrogram(String, String, Double, Double)

Declaration

public Image<Rgb24> DrawBlendedFalseColourSpectrogram(string colorMap1, string colorMap2, double blendWt1, double blendWt2)

Parameters

Type	Name	Description
String	colorMap1
String	colorMap2
Double	blendWt1
Double	blendWt2

Returns

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

| Improve this Doc View Source

DrawColourScale(Int32, Int32)

Returns an image of an array of color patches. It shows the three primary colors and pairwise combinations.

Declaration

public static Image DrawColourScale(int maxScaleLength, int ht)

Parameters

Type	Name	Description
Int32	maxScaleLength
Int32	ht

Returns

Type	Description
SixLabors.ImageSharp.Image

| Improve this Doc View Source

DrawDoubleSpectrogram(Image, Image, String)

Declaration

public Image<Rgb24> DrawDoubleSpectrogram(Image bmp1, Image bmp2, string colorMode)

Parameters

Type	Name	Description
SixLabors.ImageSharp.Image	bmp1
SixLabors.ImageSharp.Image	bmp2
String	colorMode

Returns

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

| Improve this Doc View Source

DrawFalseColorSpectrogramChromeless(String, String, Double)

Draw a chromeless false colour spectrogram. Chromeless means WITHOUT all the trimmings, such as title bar axis labels, grid lines etc. However it does add in notated error segments.

Declaration

public Image<Rgb24> DrawFalseColorSpectrogramChromeless(string colorMode, string colorMap, double blueEnhanceParameter)

Parameters

Type	Name	Description
String	colorMode
String	colorMap
Double	blueEnhanceParameter

Returns

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

| Improve this Doc View Source

DrawFourColorSpectrogram(Double[,], Double[,], Double[,], Double[,], Boolean)

A technique to derive a spectrogram from four different indices same as above method but multiply index value by the amplitude value instead of squaring the value.

Declaration

public static Image DrawFourColorSpectrogram(double[, ] redM, double[, ] grnM, double[, ] bluM, double[, ] greM, bool doReverseColor)

Parameters

Type	Name	Description
Double[,]	redM
Double[,]	grnM
Double[,]	bluM
Double[,]	greM
Boolean	doReverseColor

Returns

Type	Description
SixLabors.ImageSharp.Image

| Improve this Doc View Source

DrawGreyscaleSpectrogramOfIndex(String, ImageChrome)

Assume calling method has done all the reality checks.

Declaration

public Image<Rgb24> DrawGreyscaleSpectrogramOfIndex(string key, ImageChrome chrome = ImageChrome.With)

Parameters

Type	Name	Description
String	key
ImageChrome	chrome

Returns

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

| Improve this Doc View Source

DrawGreyscaleSpectrogramOfIndex(String, Double[,])

Assume calling method has done all the reality checks. Assume the Index Calculation Duration = 60 seconds.

Declaration

public static Image DrawGreyscaleSpectrogramOfIndex(string key, double[, ] matrix)

Parameters

Type	Name	Description
String	key
Double[,]	matrix

Returns

Type	Description
SixLabors.ImageSharp.Image

| Improve this Doc View Source

DrawGreyScaleSpectrograms(DirectoryInfo, String, String[], ImageChrome)

draws only those spectrograms in the passed array of keys.

Declaration

public void DrawGreyScaleSpectrograms(DirectoryInfo opdir, string opFileName, string[] keys, ImageChrome chrome = ImageChrome.With)

Parameters

Type	Name	Description
DirectoryInfo	opdir
String	opFileName
String[]	keys
ImageChrome	chrome

| Improve this Doc View Source

DrawNegativeFalseColorSpectrogram(DirectoryInfo, String, Double)

Declaration

public void DrawNegativeFalseColorSpectrogram(DirectoryInfo outputDirectory, string outputFileName, double blueEnhanceParameter)

Parameters

Type	Name	Description
DirectoryInfo	outputDirectory
String	outputFileName
Double	blueEnhanceParameter

| Improve this Doc View Source

DrawRgbColorMatrix(Double[,], Double[,], Double[,], Boolean, Double)

This method assumes that all the passed matrices are normalised and of the same dimensions. The method implements a hack to enhance the blue color because the human eye is less sensitive to blue. If there is a problem with one or more of the three rgb values, a gray pixel is substituted not a black pixel. Black is a frequent color in LDFC spectrograms, but gray is highly unlikely, and therefore its presence stands out as indicating an error in one or more of the rgb values.

Declaration

public static Image<Rgb24> DrawRgbColorMatrix(double[, ] redM, double[, ] grnM, double[, ] bluM, bool doReverseColor, double blueEnhanceParameter)

Parameters

Type	Name	Description
Double[,]	redM
Double[,]	grnM
Double[,]	bluM
Boolean	doReverseColor
Double	blueEnhanceParameter

Returns

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

| Improve this Doc View Source

DrawSpectrogramsFromSpectralIndices(DirectoryInfo, DirectoryInfo, LdSpectrogramConfig, FileInfo, IndexGenerationData, String, String, Dictionary<String, Double[,]>, SummaryIndexBase[], Dictionary<String, IndexDistributions.SpectralStats>, SiteDescription, FileInfo, List<GapsAndJoins>)

This IS THE MAJOR STATIC METHOD FOR CREATING LD SPECTROGRAMS IT CAN BE COPIED AND APPROPRIATELY MODIFIED BY ANY USER FOR THEIR OWN PURPOSE. WARNING: Make sure the parameters in the CONFIG file are consistent with the CSV files.

Declaration

public static Tuple<Image<Rgb24>, string>[] DrawSpectrogramsFromSpectralIndices(DirectoryInfo inputDirectory, DirectoryInfo outputDirectory, LdSpectrogramConfig ldSpectrogramConfig, FileInfo indexPropertiesConfigPath, IndexGenerationData indexGenerationData, string basename, string analysisType, Dictionary<string, double[, ]> indexSpectrograms = null, SummaryIndexBase[] summaryIndices = null, Dictionary<string, IndexDistributions.SpectralStats> indexStatistics = null, SiteDescription siteDescription = null, FileInfo sunriseDataFile = null, List<GapsAndJoins> segmentErrors = null)

Parameters

Type	Name	Description
DirectoryInfo	inputDirectory	inputDirectory.
DirectoryInfo	outputDirectory	outputDirectory.
LdSpectrogramConfig	ldSpectrogramConfig	config for drawing FCSs.
FileInfo	indexPropertiesConfigPath	The indices Config Path.
IndexGenerationData	indexGenerationData	indexGenerationData.
String	basename	stem name of the original recording.
String	analysisType	will usually be "Towsey.Acoustic".
Dictionary<String, Double[,]>	indexSpectrograms	Optional spectra to pass in. If specified the spectra will not be loaded from disk.
SummaryIndexBase[]	summaryIndices	an array of summary index results.
Dictionary<String, IndexDistributions.SpectralStats>	indexStatistics	Info about the distributions of the spectral statistics.
SiteDescription	siteDescription	Optionally specify details about the site where the audio was recorded.
FileInfo	sunriseDataFile	This is only available for locations near Brisbane, Austalia.
List<GapsAndJoins>	segmentErrors	Note that these segment errors were derived from previous analysis of the summary indices.

Returns

Type	Description
Tuple<SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>, String>[]

| Improve this Doc View Source

DrawTitleBarOfFalseColourSpectrogram(String, Int32)

Declaration

public static Image<Rgb24> DrawTitleBarOfFalseColourSpectrogram(string title, int width)

Parameters

Type	Name	Description
String	title
Int32	width

Returns

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

| Improve this Doc View Source

DrawTitleBarOfGrayScaleSpectrogram(String, Int32)

Declaration

public static Image<Rgb24> DrawTitleBarOfGrayScaleSpectrogram(string title, int width)

Parameters

Type	Name	Description
String	title
Int32	width

Returns

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

| Improve this Doc View Source

FrameFalseColourSpectrogram(Image<Rgb24>, Image<Rgb24>, LDSpectrogramRGB)

Frames a false-colourspectrogram. That is, it creates the title bar and the time scale. Also adds frequency grid lines to the image. Note that to call this method, the field cs.Freqscale MUST NOT = null.

Declaration

public static Image<Rgb24> FrameFalseColourSpectrogram(Image<Rgb24> bmp1, Image<Rgb24> titleBar, LDSpectrogramRGB cs)

Parameters

Type	Name	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>	bmp1
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>	titleBar
LDSpectrogramRGB	cs

Returns

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

| Improve this Doc View Source

FrameLDSpectrogram(Image<Rgb24>, Image<Rgb24>, LDSpectrogramRGB, Int32, Int32)

Frames a false-color spectrogram. Creates the title bar and the time scale. Also adds frequency grid lines to the image. Note that the 'nyquist' and 'hertzGridInterval' arguments are used ONLY if the cs.FreqScale field==null. Also note that in this case, the frequency scale will be linear.

Declaration

public static Image<Rgb24> FrameLDSpectrogram(Image<Rgb24> bmp1, Image<Rgb24> titleBar, LDSpectrogramRGB cs, int nyquist, int hertzInterval)

Parameters

Type	Name	Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>	bmp1
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>	titleBar
LDSpectrogramRGB	cs
Int32	nyquist
Int32	hertzInterval

Returns

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

| Improve this Doc View Source

GetArrayOfAvailableKeys()

Declaration

public static string[] GetArrayOfAvailableKeys()

Returns

Type	Description
String[]

| Improve this Doc View Source

GetCountOfSpectrogramMatrices()

Declaration

public int GetCountOfSpectrogramMatrices()

Returns

Type	Description
Int32

| Improve this Doc View Source

GetCountOfStandardDeviationMatrices()

Declaration

public int GetCountOfStandardDeviationMatrices()

Returns

Type	Description
Int32

| Improve this Doc View Source

GetMatrix(String)

Call this method to access a spectrogram matrix.

Declaration

public double[, ] GetMatrix(string key)

Parameters

Type	Name	Description
String	key

Returns

Type	Description
Double[,]

| Improve this Doc View Source

GetNormalisedSpectrogramMatrix(String)

returns a matrix of acoustic indices whose values are normalised. In addition, small background values are reduced as per filter coefficient. 1.0 = unchanged. NOTE: The matrix is oriented as it would appear in the spectrogram image; i.e. rows = freq bins.

Declaration

public double[, ] GetNormalisedSpectrogramMatrix(string key)

Parameters

Type	Name	Description
String	key

Returns

Type	Description
Double[,]

| Improve this Doc View Source

GetSpectralIndexProperties()

Declaration

public Dictionary<string, IndexProperties> GetSpectralIndexProperties()

Returns

Type	Description
Dictionary<String, IndexProperties>

| Improve this Doc View Source

GetSpectrogramMatrix(String)

Declaration

public double[, ] GetSpectrogramMatrix(string key)

Parameters

Type	Name	Description
String	key

Returns

Type	Description
Double[,]

| Improve this Doc View Source

GetStandarDeviationMatrix(String)

Declaration

public double[, ] GetStandarDeviationMatrix(string key)

Parameters

Type	Name	Description
String	key

Returns

Type	Description
Double[,]

| Improve this Doc View Source

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

Call this method if already have a dictionary of Matrix spectorgrams and wish to load directly For example, call this method from AnalyseLongRecordings.

Declaration

public void LoadSpectrogramDictionary(Dictionary<string, double[, ]> dictionary)

Parameters

Type	Name	Description
Dictionary<String, Double[,]>	dictionary

| Improve this Doc View Source

ReadCsvFiles(DirectoryInfo, String)

Declaration

public bool ReadCsvFiles(DirectoryInfo ipdir, string fileName)

Parameters

Type	Name	Description
DirectoryInfo	ipdir
String	fileName

Returns

Type	Description
Boolean

| Improve this Doc View Source

ReadCsvFiles(DirectoryInfo, String, String[])

Declaration

public bool ReadCsvFiles(DirectoryInfo ipdir, string fileName, string[] keys)

Parameters

Type	Name	Description
DirectoryInfo	ipdir
String	fileName
String[]	keys

Returns

Type	Description
Boolean

| Improve this Doc View Source

ReadStandardDeviationSpectrogramCsvs(DirectoryInfo, String)

Declaration

public bool ReadStandardDeviationSpectrogramCsvs(DirectoryInfo ipdir, string fileName)

Parameters

Type	Name	Description
DirectoryInfo	ipdir
String	fileName

Returns

Type	Description
Boolean

| Improve this Doc View Source

SetSpectralIndexProperties(Dictionary<String, IndexProperties>)

This method sets default indices to use if passed Dictionary = null. This may not be a good idea. Trying it out. Maybe better to crash!.

Declaration

public void SetSpectralIndexProperties(Dictionary<string, IndexProperties> dictionaryOfSpectralIndexProperties)

Parameters

Type	Name	Description
Dictionary<String, IndexProperties>	dictionaryOfSpectralIndexProperties

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)