Class IndexGenerationData

Inheritance
Object
IndexGenerationData
Inherited Members
Namespace: AudioAnalysisTools.Indices
Assembly: AudioAnalysisTools.dll
Syntax
public class IndexGenerationData

Fields

| Improve this Doc View Source

FileNameFragment

Declaration
public const string FileNameFragment = "IndexGenerationData"
Field Value
Type Description
String

Properties

| Improve this Doc View Source

AnalysisStartOffset

Gets or sets how far into the recording the analysis was started.

Declaration
public TimeSpan AnalysisStartOffset { get; set; }
Property Value
Type Description
TimeSpan
| Improve this Doc View Source

BackgroundFilterCoeff

Gets or sets backgroundFilterCoeff is used to adjust colour contrast of false-colour images. Default = 0.75.

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

BgNoiseNeighbourhood

Gets or sets the default is the entire segment i.e. typically of one minute duration. However, as of January 2015, this is not fixed. User must enter the time span over which indices are calculated. If IndexCalculationDuration is set to a brief duration such as 0.2 seconds, then the backgroundnoise will be calculated from N seconds before the current subsegment to N seconds after => N secs + subseg duration + N secs.

Declaration
public TimeSpan BgNoiseNeighbourhood { get; set; }
Property Value
Type Description
TimeSpan
| Improve this Doc View Source

FrameLength

Gets or sets default value for frame width from which spectrogram was derived.

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

FrameStep

Gets or sets default value for frame step from which spectrogram was derived. There may be overlap.

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

IndexCalculationDuration

Gets or sets the default is one minute spectra i.e. 60 per hour. However, as of January 2015, this is not fixed. User must enter the time span over which indices are calculated. This TimeSpan is used to calculate a tic interval that is appropriate to the time scale of the spectrogram.

Declaration
public TimeSpan IndexCalculationDuration { get; set; }
Property Value
Type Description
TimeSpan
| Improve this Doc View Source

LongDurationSpectrogramConfig

Gets or sets the configuration options used to draw long duration spectrograms.

Declaration
public LdSpectrogramConfig LongDurationSpectrogramConfig { get; set; }
Property Value
Type Description
LdSpectrogramConfig
| Improve this Doc View Source

MaximumSegmentDuration

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

RecordingBasename

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

RecordingDuration

Declaration
public TimeSpan RecordingDuration { get; set; }
Property Value
Type Description
TimeSpan
| Improve this Doc View Source

RecordingExtension

Gets or sets the extension of the original audio file.

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

RecordingStartDate

Gets or sets the date the audio was recorded. Originally parsed from the file name by FileDateHelpers.

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

SampleRateOriginal

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

SampleRateResampled

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

Source

Declaration
[JsonIgnore]
public FileInfo Source { get; }
Property Value
Type Description
FileInfo

Methods

| Improve this Doc View Source

FindAll(DirectoryInfo)

Declaration
public static IEnumerable<FileInfo> FindAll(DirectoryInfo directory)
Parameters
Type Name Description
DirectoryInfo directory
Returns
Type Description
IEnumerable<FileInfo>
| Improve this Doc View Source

FindFile(DirectoryInfo)

Declaration
public static FileInfo FindFile(DirectoryInfo directory)
Parameters
Type Name Description
DirectoryInfo directory
Returns
Type Description
FileInfo
| Improve this Doc View Source

GetIndexGenerationData(DirectoryInfo)

Returns the index generation data from file in passed directory.

Declaration
public static IndexGenerationData GetIndexGenerationData(DirectoryInfo directory)
Parameters
Type Name Description
DirectoryInfo directory
Returns
Type Description
IndexGenerationData
| Improve this Doc View Source

Load(FileInfo)

Declaration
public static IndexGenerationData Load(FileInfo info)
Parameters
Type Name Description
FileInfo info
Returns
Type Description
IndexGenerationData

Extension Methods