Class Aed

Acoustic Event Detection.

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

Fields

| Improve this Doc View Source

CommandName

Declaration
public const string CommandName = "AED"
Field Value
Type Description
String

Properties

| Improve this Doc View Source

DefaultSettings

Gets the initial (default) settings for the analysis.

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

Description

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

DisplayName

Gets the name to display for the analysis.

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

Identifier

Gets Identifier.

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

Status

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

Methods

| Improve this Doc View Source

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

Declaration
public override 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
Overrides
AnalysisBase.AbstractStrongAnalyser.Analyze<T>(AnalysisBase.AnalysisSettings, AnalysisBase.SegmentSettings<T>)
| Improve this Doc View Source

CallAed(BaseSonogram, Aed.AedConfiguration, TimeSpan, TimeSpan)

Declaration
public static EventCommon[] CallAed(BaseSonogram sonogram, Aed.AedConfiguration aedConfiguration, TimeSpan segmentStartOffset, TimeSpan segmentDuration)
Parameters
Type Name Description
BaseSonogram sonogram
Aed.AedConfiguration aedConfiguration
TimeSpan segmentStartOffset
TimeSpan segmentDuration
Returns
Type Description
EventCommon[]
| Improve this Doc View Source

Detect(FileInfo, Aed.AedConfiguration, TimeSpan)

Declaration
public static Tuple<EventCommon[], AudioRecording, BaseSonogram> Detect(FileInfo audioFile, Aed.AedConfiguration aedConfiguration, TimeSpan segmentStartOffset)
Parameters
Type Name Description
FileInfo audioFile
Aed.AedConfiguration aedConfiguration
TimeSpan segmentStartOffset
Returns
Type Description
Tuple<EventCommon[], AudioRecording, BaseSonogram>
| Improve this Doc View Source

DrawSonogram(BaseSonogram, IEnumerable<EventCommon>)

Declaration
public static Image DrawSonogram(BaseSonogram sonogram, IEnumerable<EventCommon> events)
Parameters
Type Name Description
BaseSonogram sonogram
IEnumerable<EventCommon> events
Returns
Type Description
SixLabors.ImageSharp.Image
| Improve this Doc View Source

Execute(Aed.Arguments)

Declaration
public static void Execute(Aed.Arguments arguments)
Parameters
Type Name Description
Aed.Arguments arguments
| Improve this Doc View Source

GetAedParametersFromConfigFileOrDefaults(Config)

Declaration
public static Aed.AedConfiguration GetAedParametersFromConfigFileOrDefaults(Config configuration)
Parameters
Type Name Description
Config configuration
Returns
Type Description
Aed.AedConfiguration
| Improve this Doc View Source

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

Declaration
public override 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
Overrides
| Improve this Doc View Source

WriteEventsFile(FileInfo, IEnumerable<EventBase>)

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

WriteEventsFileStatic(FileInfo, IEnumerable<EventBase>)

Declaration
public static void WriteEventsFileStatic(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 override 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>
Overrides
| Improve this Doc View Source

WriteSummaryIndicesFile(FileInfo, IEnumerable<SummaryIndexBase>)

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

Implements

Extension Methods