Class RecognizerBase

Inheritance
Object
AbstractStrongAnalyser
RecognizerBase
MultiRecognizer
ArdeaInsignis
AtrichornisRufescens
CalyptorhynchusLathami
ClimacterisPicumnus
LewiniaPectoralis
ManorinaMelanophrys
NinoxConnivens
TytoNovaehollandiae
TytoTenebricosa
LitoriaBicolor
LitoriaCaerulea
LitoriaRothii
LitoriaRubella
GenericRecognizer
NinoxStrenua
PetaurusAustralis
PetaurusBreviceps
PetaurusNorfolcensis
Inherited Members
Namespace: AnalysisPrograms.Recognizers.Base
Assembly: AnalysisPrograms.dll
Syntax
public abstract class RecognizerBase : AbstractStrongAnalyser, IEventRecognizer, IAnalyser2, ICiteable, IHasStatus

Properties

| Improve this Doc View Source

Author

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

CommonName

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

DefaultSettings

Declaration
public override AnalysisSettings DefaultSettings { get; }
Property Value
Type Description
AnalysisSettings
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

SpeciesName

Declaration
public abstract string SpeciesName { get; }
Property Value
Type Description
String

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

BeforeAnalyze(AnalysisSettings)

Run once before each segment of analysis.

Declaration
public override void BeforeAnalyze(AnalysisSettings analysisSettings)
Parameters
Type Name Description
AnalysisSettings analysisSettings

Settings used for the analysis.
Overrides
| Improve this Doc View Source

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

Declaration
public static Image<Rgb24> DrawDebugImage(BaseSonogram sonogram, List<AcousticEvent> events, List<Plot> scores, double[, ] hits)
Parameters
Type Name Description
BaseSonogram sonogram
List<AcousticEvent> events
List<Plot> scores
Double[,] hits
Returns
Type Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>
| Improve this Doc View Source

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

Declaration
protected virtual Image DrawSonogram(BaseSonogram sonogram, double[, ] hits, List<Plot> scores, List<EventCommon> predictedEvents, double eventThreshold)
Parameters
Type Name Description
BaseSonogram sonogram
Double[,] hits
List<Plot> scores
List<EventCommon> predictedEvents
Double eventThreshold
Returns
Type Description
SixLabors.ImageSharp.Image
| 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

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 abstract 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.
| 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

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