Class EventCommon

Inheritance
Object
ResultBase
EventBase
EventCommon
InstantEvent
SpectralEvent
TemporalEvent
Inherited Members
Namespace: AudioAnalysisTools.Events
Assembly: AudioAnalysisTools.dll
Syntax
public abstract class EventCommon : EventBase, IComparable<ResultBase>, IComparable, IDrawableEvent

Properties

| Improve this Doc View Source

ComponentName

Gets the component name for this event. The component name should indicate what type of event this. E.g. a click, a whistle, a stacked harmonic, ...

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

DecibelDetectionThreshold

Gets or sets the Decibel threshold at which the event was detected. This is used during post-processing to group events according to the threshold of their detection..

Declaration
public double? DecibelDetectionThreshold { get; set; }
Property Value
Type Description
Nullable<Double>
| Improve this Doc View Source

Name

Gets or sets the name for this event. The name should be a friendly name.

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

Profile

Gets or sets the profile used to create this event. If a profile was not used this value should be null.

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

ResultStartSeconds

Declaration
public override double ResultStartSeconds { get; }
Property Value
Type Description
Double
Overrides
| Improve this Doc View Source

Score

Gets or sets the event score. This is a score in absolute units as determined by context. ScoreRange determines the scale.

Declaration
public override double Score { get; set; }
Property Value
Type Description
Double
Overrides
| Improve this Doc View Source

ScoreNormalized

Gets a score in the range [0, 1]. Up to user to determine a suitable range maximum.

Declaration
public virtual double ScoreNormalized { get; }
Property Value
Type Description
Double
| Improve this Doc View Source

ScoreRange

Gets or sets a min-max range of values for the score for this event. This is used to establish a score scale and thereby normalize the score. By default the minimum value of range = zero.

Declaration
public Interval<double> ScoreRange { get; set; }
Property Value
Type Description
Interval<Double>

Methods

| Improve this Doc View Source

Draw(IImageProcessingContext, EventRenderingOptions)

Draw this event on an image.

Declaration
public abstract void Draw(IImageProcessingContext graphics, EventRenderingOptions options)
Parameters
Type Name Description
SixLabors.ImageSharp.Processing.IImageProcessingContext graphics

The image prcessing context to draw an event on.
EventRenderingOptions options

The options associated with this render request.

Implements

Extension Methods