Class GenericRecognizer

This class calls algorithms for generic syllable/component types.

Inheritance

Object

AbstractStrongAnalyser

RecognizerBase

GenericRecognizer

Implements

IEventRecognizer

IAnalyser2

ICiteable

IHasStatus

Inherited Members

RecognizerBase.Identifier

RecognizerBase.DisplayName

RecognizerBase.DefaultSettings

RecognizerBase.DrawDebugImage(BaseSonogram, List<AcousticEvent>, List<Plot>, Double[,])

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

RecognizerBase.WriteEventsFile(FileInfo, IEnumerable<EventBase>)

RecognizerBase.WriteSummaryIndicesFile(FileInfo, IEnumerable<SummaryIndexBase>)

RecognizerBase.WriteSpectrumIndicesFiles(DirectoryInfo, String, IEnumerable<SpectralIndexBase>)

RecognizerBase.DrawSonogram(BaseSonogram, Double[,], List<Plot>, List<EventCommon>, Double)

RecognizerBase.BeforeAnalyze(AnalysisSettings)

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

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

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: AnalysisPrograms.Recognizers

Assembly: AnalysisPrograms.dll

Syntax

public class GenericRecognizer : RecognizerBase, IEventRecognizer, IAnalyser2, ICiteable, IHasStatus

Properties

Author

Declaration

public override string Author { get; }

Property Value

Type	Description
String

Overrides

RecognizerBase.Author

CommonName

Declaration

public override string CommonName { get; }

Property Value

Type	Description
String

Overrides

RecognizerBase.CommonName

Description

Gets a user friendly string describing the analyzer. Intending for printing in the console.

Declaration

public override string Description { get; }

Property Value

Type	Description
String

Overrides

AbstractStrongAnalyser.Description

SpeciesName

Declaration

public override string SpeciesName { get; }

Property Value

Type	Description
String

Overrides

RecognizerBase.SpeciesName

Status

Declaration

public override Status Status { get; }

Property Value

Type	Description
Status

Overrides

AbstractStrongAnalyser.Status

Methods

ParseConfig(FileInfo)

Declaration

public override AnalyzerConfig ParseConfig(FileInfo file)

Parameters

Type	Name	Description
FileInfo	file

Returns

Type	Description
AnalyzerConfig

Overrides

RecognizerBase.ParseConfig(FileInfo)

Recognize(AudioRecording, Config, TimeSpan, Lazy<IndexCalculateResult[]>, DirectoryInfo, Nullable<Int32>)

Do your analysis. This method is called once per segment (typically one-minute segments).

Declaration

public override RecognizerResults Recognize(AudioRecording audioRecording, Config genericConfig, TimeSpan segmentStartOffset, Lazy<IndexCalculateResult[]> getSpectralIndexes, DirectoryInfo outputDirectory, int? imageWidth)

Parameters

Type	Name	Description
AudioRecording	audioRecording	The audio recording to process - it should be a minute or two long.
Config	genericConfig
TimeSpan	segmentStartOffset	In analyze long recording scenarios this is the time from the start of the original audio recording for this segment.
Lazy<IndexCalculateResult[]>	getSpectralIndexes	Invoke this lazy function to get indices for the current segment.
DirectoryInfo	outputDirectory	The current output directory.
Nullable<Int32>	imageWidth	The expected width of output images.

Returns

Type	Description
RecognizerResults	A recognizer results object.

Overrides

RecognizerBase.Recognize(AudioRecording, Config, TimeSpan, Lazy<IndexCalculateResult[]>, DirectoryInfo, Nullable<Int32>)

RunOneProfile(SpectrogramStandard, String, CommonParameters, Nullable<Double>, TimeSpan)

Gets the events for one profile at one decibel threshold.

Declaration

public static RecognizerResults RunOneProfile(SpectrogramStandard spectrogram, string profileName, CommonParameters profileConfig, double? decibelThreshold, TimeSpan segmentStartOffset)

Parameters

Type	Name	Description
SpectrogramStandard	spectrogram	Spectrogram derived from audio segment.
String	profileName	Profile name in the config file.
CommonParameters	profileConfig
Nullable<Double>	decibelThreshold	Threshold for this pass.
TimeSpan	segmentStartOffset	The same for any given recording segment.

Returns

Type	Description
RecognizerResults	A results object.

RunProfiles(AudioRecording, GenericRecognizer.GenericRecognizerConfig, TimeSpan)

Declaration

public static RecognizerResults RunProfiles(AudioRecording audioRecording, GenericRecognizer.GenericRecognizerConfig configuration, TimeSpan segmentStartOffset)

Parameters

Type	Name	Description
AudioRecording	audioRecording
GenericRecognizer.GenericRecognizerConfig	configuration
TimeSpan	segmentStartOffset

Returns

Type	Description
RecognizerResults

SaveDebugSpectrogram(RecognizerResults, Config, DirectoryInfo, String)

THis method can be modified if want to do something non-standard with the output spectrogram.

Declaration

public static string SaveDebugSpectrogram(RecognizerResults results, Config genericConfig, DirectoryInfo outputDirectory, string baseName)

Parameters

Type	Name	Description
RecognizerResults	results
Config	genericConfig
DirectoryInfo	outputDirectory
String	baseName

Returns

Type	Description
String

ValidateProfileTagsMatchAlgorithms(Dictionary<String, Object>, FileInfo)

Declaration

public static void ValidateProfileTagsMatchAlgorithms(Dictionary<string, object> profiles, FileInfo file)

Parameters

Type	Name	Description
Dictionary<String, Object>	profiles
FileInfo	file

Implements

IEventRecognizer

IAnalyser2

ICiteable

IHasStatus

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)