Class EventPostProcessing.SyllableSequenceConfig

The properties in this config class are required to combine a sequence of similar syllables into a single event. The first three properties concern the combining of syllables into a sequence or stroph. The next four properties concern the filtering/removal of sequences that do not satisfy expected properties.

Use SyllableSequence where you want to combine possible syllable sequences. A typical example is a sequence of chirps in a honeyeater call.

SyllableStartDifference and SyllableHertzGap set the allowed tolerances when combining events into sequences

• SyllableStartDifference sets the maximum allowed time difference (in seconds) between the starts of two events
• SyllableHertzGap sets the maximum allowed frequency difference (in Hertz) between the minimum frequencies of two events.

Once you have combined possible sequences, you may wish to remove sequences that do not satisfy the parameters for your target call. Set FilterSyllableSequence true if you want to filter (remove) sequences that do not fall within the constraints defined by SyllableMaxCount and ExpectedPeriod.

• SyllableMaxCount sets an upper limit of the number of events that are combined to form a sequence -ExpectedPeriod sets a limit on the average period (in seconds) of the combined events.

Inheritance

Object

EventPostProcessing.SyllableSequenceConfig

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: AudioAnalysisTools.Events.Types

Assembly: AudioAnalysisTools.dll

Syntax

public class SyllableSequenceConfig

Properties

ExpectedPeriod

Gets or sets a value indicating the expected periodicity in seconds. This value is used only where FilterSyllableSequence = true. Important Note: This property interacts with SyllableStartDifference. When setting ExpectedPeriod, you are actually setting a permissible range of values for the Period. The maximum permitted period will be the value assigned to SyllableStartDifference. The minimum period will be the ExpectedPeriod minus (SyllableStartDifference - ExpectedPeriod). For example: if SyllableStartDifference = 3 seconds and ExpectedPeriod = 2.5 seconds, then the minimum allowed period will be 2 seconds. THese bounds are hard bounds.

Declaration

public double ExpectedPeriod { get; set; }

Property Value

Type	Description
Double

FilterSyllableSequence

Gets or sets a value indicating Whether or not to remove/filter sequences having incorrect properties.

Declaration

public bool FilterSyllableSequence { get; set; }

Property Value

Type	Description
Boolean

PeriodStandardDeviation

Gets a value indicating the stadndard deviation of the expected period in seconds. This value is used only where FilterSyllableSequence = true. Important Note: This property is derived from two of the above properties. SD of the period = (SyllableStartDifference - ExpectedPeriod) / 3. The intent is that the maximum allowable syllable period is the expected value plus three times its standard deviation.

Declaration

public double PeriodStandardDeviation { get; }

Property Value

Type	Description
Double

SyllableHertzGap

Gets or sets a value indicating the maximum allowable difference (in Hertz) between the frequency bands of two events. I.e. events should be in similar frequency band. NOTE: SIMILAR frequency band means the differences between two top Hertz values and the two low Hertz values are less than hertzDifference. This value is used only where CombinePossibleSyllableSequence = true.

Declaration

public double SyllableHertzGap { get; set; }

Property Value

Type	Description
Double

SyllableMaxCount

Gets or sets a value indicating the maximum allowable number of syllables in a sequence. This value is used only where FilterSyllableSequence = true.

Declaration

public int SyllableMaxCount { get; set; }

Property Value

Type	Description
Int32

SyllableStartDifference

Gets or sets a value indicating the maximum allowable start time gap (seconds) between events within the same strophe. The gap between successive syllables is the "period" of the sequence. This value is used only where CombinePossibleSyllableSequence = true.

Declaration

public double SyllableStartDifference { get; set; }

Property Value

Type	Description
Double

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)