Class IndexMatrices

Inheritance

Object

IndexMatrices

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: AudioAnalysisTools.Indices

Assembly: AudioAnalysisTools.dll

Syntax

public static class IndexMatrices

Fields

| Improve this Doc View Source

MissingRowString

Declaration

public const string MissingRowString = "<missing row>"

Field Value

Type	Description
String

Methods

| Improve this Doc View Source

AddDerivedIndices(Dictionary<String, Double[]>)

DO NOT DELETE THIS METHOD DESPITE NO REFERENCES It can be useful in future.

Declaration

public static Dictionary<string, double[]> AddDerivedIndices(Dictionary<string, double[]> summaryIndices)

Parameters

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

Returns

Type	Description
Dictionary<String, Double[]>

| Improve this Doc View Source

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

Declaration

public static Dictionary<string, double[, ]> AddDerivedIndices(Dictionary<string, double[, ]> spectrogramMatrices)

Parameters

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

Returns

Type	Description
Dictionary<String, Double[,]>

| Improve this Doc View Source

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

Declaration

public static Dictionary<string, double[]> AddNDSI_GageGauge(Dictionary<string, double[]> dictionaryOfCsvColumns, string newKey)

Parameters

Type	Name	Description
Dictionary<String, Double[]>	dictionaryOfCsvColumns
String	newKey

Returns

Type	Description
Dictionary<String, Double[]>

| Improve this Doc View Source

CompressIndexSpectrograms(Dictionary<String, Double[,]>, TimeSpan, TimeSpan, Func<Double, Double>)

Compresses the spectral index data in the temporal direction by a factor derived from the data scale and required image scale. In most cases, the compression is done by taking the average. ACI, ENT, BGN, and PMN are special cases, requiring a special form of averaging. This method got more complicated in June 2016 when it was refactored to cope with recording blocks less than one minute long.

Declaration

public static Dictionary<string, double[, ]> CompressIndexSpectrograms(Dictionary<string, double[, ]> spectra, TimeSpan imageScale, TimeSpan dataScale, Func<double, double> roundingFunc = null)

Parameters

Type	Name	Description
Dictionary<String, Double[,]>	spectra	The spectra to compress as a dictionary of spectrogram matrices.
TimeSpan	imageScale	The scale (time resolution) of the compressed output spectrogram.
TimeSpan	dataScale	The scale (time resolution) of the input spectral indices. See `spectra`.
Func<Double, Double>	roundingFunc	How fractional spectra should be dealt with. It should be one of or similar to Round(Double), Floor(Double), or Ceiling(Double).

Returns

Type	Description
Dictionary<String, Double[,]>

| Improve this Doc View Source

ConcatenateSpectralIndexFilesWithTimeCheck(FileInfo[], TimeSpan, String)

Concatenates a series of Spectral Index files with a time check, i.e. check elapse time in file names against accumulated rows of indices.

Declaration

public static List<double[, ]> ConcatenateSpectralIndexFilesWithTimeCheck(FileInfo[] files, TimeSpan indexCalcDuration, string key)

Parameters

Type	Name	Description
FileInfo[]	files	All the passed files will be concatenated. Filtering needs to be done somewhere else.
TimeSpan	indexCalcDuration	used to match rows of indices to elapsed time in file names.
String	key	this is used only in case need to write an error message. It identifies the key.

Returns

Type	Description
List<Double[,]>

| Improve this Doc View Source

ConcatenateSummaryIndexFilesWithTimeCheck(FileInfo[], TimeSpan)

All the passed files will be concatenated. Filtering needs to be done somewhere else.

Declaration

public static List<SummaryIndexValues> ConcatenateSummaryIndexFilesWithTimeCheck(FileInfo[] files, TimeSpan indexCalcDuration)

Parameters

Type	Name	Description
FileInfo[]	files	array of file names.
TimeSpan	indexCalcDuration	used to match rows of indices to elapsed time in file names.

Returns

Type	Description
List<SummaryIndexValues>

| Improve this Doc View Source

GetFilesInDirectories(DirectoryInfo[], String)

Returns a unique, sorted, list of file paths, sorted on file name. IMPORTANT: Sorts on alphanumerics, NOT on date or time encoded in the file name.

Declaration

public static FileInfo[] GetFilesInDirectories(DirectoryInfo[] directories, string pattern)

Parameters

Type	Name	Description
DirectoryInfo[]	directories
String	pattern

Returns

Type	Description
FileInfo[]

| Improve this Doc View Source

GetFilesInDirectory(String, String)

Declaration

public static FileInfo[] GetFilesInDirectory(string path, string pattern)

Parameters

Type	Name	Description
String	path
String	pattern

Returns

Type	Description
FileInfo[]

| Improve this Doc View Source

GetSpectralIndexFilesAndConcatenate(DirectoryInfo[], String, String[], IndexGenerationData, Boolean)

Declaration

public static Dictionary<string, double[, ]> GetSpectralIndexFilesAndConcatenate(DirectoryInfo[] dirs, string analysisType, string[] keys, IndexGenerationData indexGenerationData, bool verbose = false)

Parameters

Type	Name	Description
DirectoryInfo[]	dirs
String	analysisType
String[]	keys
IndexGenerationData	indexGenerationData
Boolean	verbose

Returns

Type	Description
Dictionary<String, Double[,]>

| Improve this Doc View Source

ReadSpectralIndices(DirectoryInfo, String, String, String[])

Declaration

public static Dictionary<string, double[, ]> ReadSpectralIndices(DirectoryInfo ipdir, string fileName, string analysisTag, string[] keys)

Parameters

Type	Name	Description
DirectoryInfo	ipdir
String	fileName
String	analysisTag
String[]	keys

Returns

Type	Description
Dictionary<String, Double[,]>

| Improve this Doc View Source

ReadSpectrogram(FileInfo, out Int32, TwoDimensionalArray)

This method reads spectrogram csv files where the first row contains column names and the first column contains row/time names. Note: no rotation of data is done!.

Declaration

public static double[, ] ReadSpectrogram(FileInfo csvFile, out int binCount, TwoDimensionalArray transform = TwoDimensionalArray.None)

Parameters

Type	Name	Description
FileInfo	csvFile
Int32	binCount
TwoDimensionalArray	transform

Returns

Type	Description
Double[,]

| Improve this Doc View Source

ReadSpectrogramCsvFiles(DirectoryInfo, String, String, out Int32)

Declaration

public static Dictionary<string, double[, ]> ReadSpectrogramCsvFiles(DirectoryInfo ipdir, string fileName, string indexKeys, out int freqBinCount)

Parameters

Type	Name	Description
DirectoryInfo	ipdir
String	fileName
String	indexKeys
Int32	freqBinCount

Returns

Type	Description
Dictionary<String, Double[,]>

| Improve this Doc View Source

ReadSpectrogramCsvFiles(DirectoryInfo, String, String[], out Int32)

Reads a list of Spectrogram Csv Files.

Declaration

public static Dictionary<string, double[, ]> ReadSpectrogramCsvFiles(DirectoryInfo ipdir, string fileName, string[] keys, out int freqBinCount)

Parameters

Type	Name	Description
DirectoryInfo	ipdir	input dir.
String	fileName	the file name.
String[]	keys	an array of keys.
Int32	freqBinCount	number of freq bins.

Returns

Type	Description
Dictionary<String, Double[,]>

| Improve this Doc View Source

ReadSummaryIndexFiles(FileInfo[], String[])

Returns dictionary of spectral indices. Assumes both arrays of same length and keys correspond to file name. TODO: Do this better one day!.

Declaration

public static Dictionary<string, double[, ]> ReadSummaryIndexFiles(FileInfo[] files, string[] keys)

Parameters

Type	Name	Description
FileInfo[]	files
String[]	keys

Returns

Type	Description
Dictionary<String, Double[,]>