Class AnalysisResult2

The strong typed analysis results. DO NOT CHANGE THIS CLASS UNLESS YOU ARE TOLD TO.

Inheritance
Object
AnalysisResult2
Inherited Members
Namespace: AnalysisBase
Assembly: AnalysisBase.dll
Syntax
public class AnalysisResult2 : IComparable<AnalysisResult2>

Constructors

| Improve this Doc View Source

AnalysisResult2(AnalysisSettings, SegmentSettingsBase, TimeSpan)

Initializes a new instance of the AnalysisResult2 class. This is the standard result class for IAnalyser2 results.

Declaration
public AnalysisResult2(AnalysisSettings settingsUsed, SegmentSettingsBase segmentSettings, TimeSpan durationAnalyzed)
Parameters
Type Name Description
AnalysisSettings settingsUsed

Represents the settings used for the analysis.
SegmentSettingsBase segmentSettings

The settings for the segment that was analyzed.
TimeSpan durationAnalyzed

Records the actual duration analyzed by the analysis.

Properties

| Improve this Doc View Source

AnalysisIdentifier

Gets or sets Analysis Identifier.

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

Events

Gets or sets event results. Should typically contain many results.

Declaration
public EventBase[] Events { get; set; }
Property Value
Type Description
EventBase[]
| Improve this Doc View Source

EventsFile

Gets or sets the location of the events file for this analysis. Should be null if not written or used.

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

ImageFile

Gets or sets the debug image file for this analysis. Should be null if not written or used.

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

MiscellaneousResults

Gets a loosely typed dictionary that can store arbitrary result data. Added as a cheap form of extensibility.

Declaration
public Dictionary<string, object> MiscellaneousResults { get; }
Property Value
Type Description
Dictionary<String, Object>
| Improve this Doc View Source

NewEvents

Gets or sets event results. Should typically contain many results.

Declaration
public EventBase[] NewEvents { get; set; }
Property Value
Type Description
EventBase[]
| Improve this Doc View Source

OutputFiles

Gets a list of other files that were written (optional).

Declaration
public Dictionary<string, FileInfo> OutputFiles { get; }
Property Value
Type Description
Dictionary<String, FileInfo>
| Improve this Doc View Source

SegmentAudioDuration

Gets the duration of the analyzed segment.

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

SegmentSettings

Gets the segment settings used.

Declaration
public SegmentSettingsBase SegmentSettings { get; }
Property Value
Type Description
SegmentSettingsBase
| Improve this Doc View Source

SegmentStartOffset

Gets the offset of the segment from the original entire audio file.

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

SettingsUsed

Gets a the settings used to run the analysis.

Declaration
public AnalysisSettings SettingsUsed { get; }
Property Value
Type Description
AnalysisSettings
| Improve this Doc View Source

SpectraIndicesFiles

Gets or sets the location of the indices file for this analysis. Should be null if not written or used.

Declaration
public IEnumerable<FileInfo> SpectraIndicesFiles { get; set; }
Property Value
Type Description
IEnumerable<FileInfo>
| Improve this Doc View Source

SpectralIndices

Gets or sets spectral indices results. Should typically contain just 1 result.

Declaration
public SpectralIndexBase[] SpectralIndices { get; set; }
Property Value
Type Description
SpectralIndexBase[]
| Improve this Doc View Source

SummaryIndices

Gets or sets summary indices results. Should typically contain just 1 result.

Declaration
public SummaryIndexBase[] SummaryIndices { get; set; }
Property Value
Type Description
SummaryIndexBase[]
| Improve this Doc View Source

SummaryIndicesFile

Gets or sets the location of the indices file for this analysis. Should be null if not written or used.

Declaration
public FileInfo SummaryIndicesFile { get; set; }
Property Value
Type Description
FileInfo

Methods

| Improve this Doc View Source

CompareTo(AnalysisResult2)

Defines an innate order of Analysis results based on the SegmentStartOffset.

Declaration
public int CompareTo(AnalysisResult2 other)
Parameters
Type Name Description
AnalysisResult2 other

The other AnalysisResult to compare to.
Returns
Type Description
Int32

A integer representing the relative order between the two instances.

Implements

Extension Methods