Class EventStatistics

The data class that holds event statistics.

Inheritance
Object
ResultBase
EventBase
EventStatistics
Inherited Members
Namespace: AudioAnalysisTools.EventStatistics
Assembly: AudioAnalysisTools.dll
Syntax
public class EventStatistics : EventBase, IComparable<ResultBase>, IComparable
Remarks

Note that EventBase already has getters/setters for: TimeSpan SegmentStartOffset double Score double EventStartSeconds double? MinHz .. NOTE: When MinHz equals null, this indicates that the event is broad band or has undefined frequency. The event is an instant. When MinHz has a value, this indicates the event is a point in time/frequency space.

Constructors

| Improve this Doc View Source

EventStatistics()

Declaration
public EventStatistics()

Properties

| Improve this Doc View Source

AudioEventId

Declaration
public long? AudioEventId { get; set; }
Property Value
Type Description
Nullable<Int64>
| Improve this Doc View Source

AudioRecordingId

Declaration
public long? AudioRecordingId { get; set; }
Property Value
Type Description
Nullable<Int64>
| Improve this Doc View Source

AudioRecordingRecordedDate

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

Bandwidth

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

DominantFrequency

Declaration
public int DominantFrequency { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

Error

Declaration
public bool Error { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

ErrorMessage

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

EventDurationSeconds

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

EventEndSeconds

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

EventStartDate

Declaration
public DateTimeOffset? EventStartDate { get; }
Property Value
Type Description
Nullable<DateTimeOffset>
| Improve this Doc View Source

FreqBinStdDevDecibels

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

HighFrequencyHertz

Gets or sets the top frequency bound of the acoustic event in Hertz Note: MinHz implemented in base class.

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

ListenUrl

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

LowFrequencyHertz

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

MeanDecibels

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

Order

Gets or sets a metadata field used for sorting results. Not serialized in CSV output.

Declaration
public int Order { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

SnrDecibels

Gets or sets the event's signal-to-noise ratio in decibels.

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

SpectralCentroid

Gets or sets the SpectralCentroid. The SpectralCentroid is a measure of the "brightness" of a sound event, that is, the relative amount of high freq content compared to low freq content. Note that this SpectralCentroid is calculated from a weighted average of decibel values and NOT power values.

Declaration
public int SpectralCentroid { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

SpectralEnergyDistribution

Gets or sets a measure of the distribution of energy over the frequency bins of the event. SpectralEnergyDistribution = 1 - Hf, where Hf is the spectral entropy calculated as for acoustic indices. Minimum value = 0.0, when energy is unifrom over all frequency bins. Maximum value = 1.0, when all the acoustic energy is concentrated in a single frequency bin.

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

TemporalEnergyDistribution

Gets or sets a measure of the distribution of energy over the time frames of the event. TemporalEnergyDistribution = 1 - Ht, where Ht is the temporal entropy calculated as for acoustic indices. Minimum value = 0.0, when energy is unifrom over all time frames. Maximum value = 1.0, when all the acoustic energy is concentrated in a single time frame.

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

TemporalMaxRelative

Gets or sets the relative location of the temporal max within the acoustic event. E.g. if temporal max is half way through the event then TemporalMaxRelative = 0.5.

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

TemporalStdDevDecibels

Declaration
public double TemporalStdDevDecibels { get; set; }
Property Value
Type Description
Double

Methods

| Improve this Doc View Source

CompareTo(ResultBase)

Sorts the results by their Order property if it is available otherwise reverts to the base class comparison.

Declaration
public override int CompareTo(ResultBase other)
Parameters
Type Name Description
ResultBase other

An object to compare with this instance.
Returns
Type Description
Int32

A value that indicates the relative order of the objects being compared.
Overrides
| Improve this Doc View Source

CompareTo(Object)

Declaration
public override int CompareTo(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Int32
Overrides

Implements

Extension Methods