Class UseModel

This class is derived from AbstractStrongAnalyser. It is equivalent to AnalyseLongRecording.cs or a species recognizer. To call this class, the first argument on the commandline must be 'audio2csv'. Given a one-minute recording segment, the UseModel.Analyze() method calls AudioAnalysisTools.Indices.IndexCalculateSixOnly.Analysis(). This calculates six spectral indices, ACI, ENT, EVN, BGN, PMN, OSC. This set of 6x256 acoustic features is used for content description. The content description methods are called from UseModel.Analyze() method.

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

Fields

| Improve this Doc View Source

AnalysisName

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

TowseyContentDescription

Declaration
public const string TowseyContentDescription = "Towsey.ContentDescription"
Field Value
Type Description
String

Properties

| Improve this Doc View Source

DefaultSettings

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

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

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>)

This method calls IndexCalculateSixOnly.Analysis() to calculate six spectral indices and then calls ContentSignatures.AnalyzeOneMinute() to obtain a content description derived from those indices and an array of functional templates.

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

BeforeAnalyze(AnalysisSettings)

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

ParseConfig(FileInfo)

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

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

Declaration
public override void SummariseResults(AnalysisSettings analysisSettings, FileSegment inputFileSegment, EventBase[] events, SummaryIndexBase[] indices, SpectralIndexBase[] spectralIndices, AnalysisResult2[] results)
Parameters
Type Name Description
AnalysisSettings analysisSettings
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

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