Class AcousticIndices

Inheritance
Object
AcousticIndices
Inherited Members
Namespace: AnalysisPrograms
Assembly: AnalysisPrograms.dll
Syntax
public class AcousticIndices : IAnalyser2, ICiteable, IHasStatus

Fields

| Improve this Doc View Source

AnalysisName

Declaration
public const string AnalysisName = "Acoustic"
Field Value
Type Description
String
| Improve this Doc View Source

TaskAnalyse

Declaration
public const string TaskAnalyse = "Acoustic"
Field Value
Type Description
String
| Improve this Doc View Source

TaskLoadCsv

Declaration
public const string TaskLoadCsv = "loadCsv"
Field Value
Type Description
String
| Improve this Doc View Source

TowseyAcoustic

Declaration
public const string TowseyAcoustic = "Towsey.Acoustic"
Field Value
Type Description
String

Properties

| Improve this Doc View Source

DefaultSettings

Declaration
public AnalysisSettings DefaultSettings { get; }
Property Value
Type Description
AnalysisSettings
| Improve this Doc View Source

Description

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

DisplayName

Declaration
public string DisplayName { get; }
Property Value
Type Description
String
| Improve this Doc View Source

Identifier

Declaration
public string Identifier { get; }
Property Value
Type Description
String
| Improve this Doc View Source

Status

Declaration
public Status Status { get; }
Property Value
Type Description
Status

Methods

| Improve this Doc View Source

Analyze<T>(AnalysisSettings, SegmentSettings<T>)

Declaration
public AnalysisResult2 Analyze<T>(AnalysisSettings analysisSettings, SegmentSettings<T> segmentSettings)
Parameters
Type Name Description
AnalysisSettings analysisSettings
SegmentSettings<T> segmentSettings
Returns
Type Description
AnalysisResult2
Type Parameters
Name Description
T
| Improve this Doc View Source

BeforeAnalyze(AnalysisSettings)

Declaration
public void BeforeAnalyze(AnalysisSettings analysisSettings)
Parameters
Type Name Description
AnalysisSettings analysisSettings
| Improve this Doc View Source

CalculateIndicesInSubsegments(AudioRecording, TimeSpan, TimeSpan, TimeSpan, Dictionary<String, IndexProperties>, Int32, IndexCalculateConfig)

Declaration
public static IndexCalculateResult[] CalculateIndicesInSubsegments(AudioRecording recording, TimeSpan segmentStartOffset, TimeSpan segmentDuration, TimeSpan indexCalculationDuration, Dictionary<string, IndexProperties> indexProperties, int sampleRateOfOriginalAudioFile, IndexCalculateConfig config)
Parameters
Type Name Description
AudioRecording recording
TimeSpan segmentStartOffset
TimeSpan segmentDuration
TimeSpan indexCalculationDuration
Dictionary<String, IndexProperties> indexProperties
Int32 sampleRateOfOriginalAudioFile
IndexCalculateConfig config
Returns
Type Description
IndexCalculateResult[]
| Improve this Doc View Source

ConvertEventsToSummaryIndices(IEnumerable<EventBase>, TimeSpan, TimeSpan, Double)

Declaration
public SummaryIndexBase[] ConvertEventsToSummaryIndices(IEnumerable<EventBase> events, TimeSpan unitTime, TimeSpan duration, double scoreThreshold)
Parameters
Type Name Description
IEnumerable<EventBase> events
TimeSpan unitTime
TimeSpan duration
Double scoreThreshold
Returns
Type Description
SummaryIndexBase[]
| Improve this Doc View Source

ParseConfig(FileInfo)

Declaration
public AnalyzerConfig ParseConfig(FileInfo file)
Parameters
Type Name Description
FileInfo file
Returns
Type Description
AnalyzerConfig
| Improve this Doc View Source

SummariseResults(AnalysisSettings, FileSegment, EventBase[], SummaryIndexBase[], SpectralIndexBase[], AnalysisResult2[])

Declaration
public void SummariseResults(AnalysisSettings settings, FileSegment inputFileSegment, EventBase[] events, SummaryIndexBase[] indices, SpectralIndexBase[] spectralIndices, AnalysisResult2[] results)
Parameters
Type Name Description
AnalysisSettings settings
FileSegment inputFileSegment
EventBase[] events
SummaryIndexBase[] indices
SpectralIndexBase[] spectralIndices
AnalysisResult2[] results
| Improve this Doc View Source

WriteEventsFile(FileInfo, IEnumerable<EventBase>)

Declaration
public void WriteEventsFile(FileInfo destination, IEnumerable<EventBase> results)
Parameters
Type Name Description
FileInfo destination
IEnumerable<EventBase> results
| Improve this Doc View Source

WriteSpectrumIndicesFiles(DirectoryInfo, String, IEnumerable<SpectralIndexBase>)

Declaration
public List<FileInfo> WriteSpectrumIndicesFiles(DirectoryInfo destination, string fileNameBase, IEnumerable<SpectralIndexBase> results)
Parameters
Type Name Description
DirectoryInfo destination
String fileNameBase
IEnumerable<SpectralIndexBase> results
Returns
Type Description
List<FileInfo>
| Improve this Doc View Source

WriteSpectrumIndicesFilesCustom(DirectoryInfo, String, IEnumerable<SpectralIndexBase>)

Declaration
public static List<FileInfo> WriteSpectrumIndicesFilesCustom(DirectoryInfo destination, string fileNameBase, IEnumerable<SpectralIndexBase> results)
Parameters
Type Name Description
DirectoryInfo destination
String fileNameBase
IEnumerable<SpectralIndexBase> results
Returns
Type Description
List<FileInfo>
| Improve this Doc View Source

WriteSummaryIndicesFile(FileInfo, IEnumerable<SummaryIndexBase>)

Declaration
public void WriteSummaryIndicesFile(FileInfo destination, IEnumerable<SummaryIndexBase> results)
Parameters
Type Name Description
FileInfo destination
IEnumerable<SummaryIndexBase> results

Implements

Extension Methods