Class IndexCalculate
Core class that calculates indices.
Inherited Members
Namespace: AudioAnalysisTools.Indices
Assembly: AudioAnalysisTools.dll
Syntax
public class IndexCalculateMethods
| Improve this Doc View SourceAnalysis(AudioRecording, TimeSpan, Dictionary<String, IndexProperties>, Int32, TimeSpan, IndexCalculateConfig, Boolean)
Extracts summary and spectral acoustic indices from the entire segment of the passed recording or a subsegment of it.
Declaration
public static IndexCalculateResult Analysis(AudioRecording recording, TimeSpan subsegmentOffsetTimeSpan, Dictionary<string, IndexProperties> indexProperties, int sampleRateOfOriginalAudioFile, TimeSpan segmentStartOffset, IndexCalculateConfig config, bool returnSonogramInfo = false)Parameters
| Type | Name | Description |
|---|---|---|
| AudioRecording | recording | an audio recording. IMPORTANT NOTE: This is a segment of the larger total recording. |
| TimeSpan | subsegmentOffsetTimeSpan | The start time of the required subsegment relative to start of SOURCE audio recording. i.e. SegmentStartOffset + time duration from Segment start to subsegment start. |
| Dictionary<String, IndexProperties> | indexProperties | info about index value distributions. Used when drawing false-colour spectrograms. |
| Int32 | sampleRateOfOriginalAudioFile | That is, prior to being resample to the default of 22050. |
| TimeSpan | segmentStartOffset | Time elapsed from absolute start of total recording and start of the passed recording segment i.e. line37. |
| IndexCalculateConfig | config | Config variable containing info about the configuration for index calculation. |
| Boolean | returnSonogramInfo | boolean with default value = false. |
Returns
| Type | Description |
|---|---|
| IndexCalculateResult | An IndexCalculateResult. |