Search Results for

    Show / Hide Table of Contents

    Interface IEventRecognizer

    This interface specializes IAnalyser2 to be a species recognizer.

    Inherited Members
    IAnalyser2.DisplayName
    IAnalyser2.Identifier
    IAnalyser2.Description
    IAnalyser2.DefaultSettings
    IAnalyser2.ParseConfig(FileInfo)
    IAnalyser2.BeforeAnalyze(AnalysisSettings)
    IAnalyser2.Analyze<T>(AnalysisSettings, SegmentSettings<T>)
    IAnalyser2.WriteEventsFile(FileInfo, IEnumerable<EventBase>)
    IAnalyser2.WriteSummaryIndicesFile(FileInfo, IEnumerable<SummaryIndexBase>)
    IAnalyser2.WriteSpectrumIndicesFiles(DirectoryInfo, String, IEnumerable<SpectralIndexBase>)
    IAnalyser2.ConvertEventsToSummaryIndices(IEnumerable<EventBase>, TimeSpan, TimeSpan, Double)
    IAnalyser2.SummariseResults(AnalysisSettings, FileSegment, EventBase[], SummaryIndexBase[], SpectralIndexBase[], AnalysisResult2[])
    ICiteable.Citations
    IHasStatus.Status
    Namespace: AnalysisPrograms.Recognizers.Base
    Assembly: AnalysisPrograms.dll
    Syntax
    public interface IEventRecognizer : IAnalyser2, ICiteable, IHasStatus

    Methods

    | Improve this Doc View Source

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

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

    Declaration
    RecognizerResults Recognize(AudioRecording audioRecording, Config configuration, 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 configuration

    The configuration to use for this analysis.

    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.

    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)
    • Improve this Doc
    • View Source
    In This Article
    Generated by DocFX AP docs version: 21.7.0.4-master-e26127a50d7bd7472d47288f10e61014fb981f7f-DIRTY-CI:144 Back to top