Class IndexProperties

This class stores the properties of a particular index. THIS CLASS DOES NOT STORE THE VALUE OF THE INDEX - the value is stored in class IndexValues. This class stores default values, normalisation bounds and provides methods for the correct display of a SUMMARY INDEX in a tracks image. Display of SPECTRAL INDICES is handled in the class LDSpectrogramRGB.

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

Constructors

| Improve this Doc View Source

IndexProperties()

Initializes a new instance of the IndexProperties class. constructor sets default values.

Declaration
public IndexProperties()

Properties

| Improve this Doc View Source

CalculateNormBounds

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

Comment

Declaration
[JsonIgnore]
public string Comment { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

DataType

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

DefaultValue

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

DefaultValueCasted

Declaration
[YamlIgnore]
[JsonIgnore]
public object DefaultValueCasted { get; }
Property Value
Type Description
Object
| Improve this Doc View Source

DoDisplay

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

IsSpectralIndex

Declaration
[YamlIgnore]
[JsonIgnore]
public bool IsSpectralIndex { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Key

Declaration
[JsonIgnore]
public string Key { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

Name

Declaration
[JsonIgnore]
public string Name { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

NormMax

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

NormMin

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

Order

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

ProjectId

Declaration
[JsonIgnore]
public string ProjectId { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

Units

Declaration
[JsonIgnore]
public string Units { get; set; }
Property Value
Type Description
String

Methods

| Improve this Doc View Source

Find(IIndexPropertyReferenceConfiguration)

Loads the IndexProperties config file, specified by the property IndexPropertiesConfig defined on configuration which may be found relative to the original parent config file ConfigPath.

Declaration
public static FileInfo Find(IIndexPropertyReferenceConfiguration configuration)
Parameters
Type Name Description
IIndexPropertyReferenceConfiguration configuration

The configuration object that has the IndexPropertiesConfig key defined. If IndexPropertiesConfig is not rooted it is treated as relative to the parent config file ConfigPath's directory.
Returns
Type Description
FileInfo 
null
if configuration is null or empty, otherwise a reference to

the desired config file.
Remarks

This method is intended for use when a config file references another config file, in this case an IndexProperties config files, as a string property in the config file.

Exceptions
Type Condition
ConfigFileException

if configuration is not null or empty, and does not exist.
| Improve this Doc View Source

Find(String, FileInfo)

Loads the IndexProperties config file, specified by relativePath which may be found relative to the original config file originalConfigFile.

Declaration
public static FileInfo Find(string relativePath, FileInfo originalConfigFile)
Parameters
Type Name Description
String relativePath

The path to the config file to find. If it is not rooted it is treated as relative to the originalConfigFile's directory.
FileInfo originalConfigFile

The config file were the path to relativePath was originally extracted.
Returns
Type Description
FileInfo 
null
if relativePath is null or empty, otherwise a reference to

the desired config file.
Remarks

This method is intended for use when a config file references another config file, in this case an IndexProperties config files, as a string property in the config file.

Exceptions
Type Condition
ConfigFileException

if relativePath is not null or empty, and does not exist.
| Improve this Doc View Source

GetIndexProperties(FileInfo)

Returns a cached set of configuration properties. WARNING CACHED!.

Declaration
public static IndexPropertiesCollection GetIndexProperties(FileInfo configFile)
Parameters
Type Name Description
FileInfo configFile
Returns
Type Description
IndexPropertiesCollection
| Improve this Doc View Source

GetPlotAnnotation()

Units for indices include: dB, ms, % and dimensionless.

Declaration
public string GetPlotAnnotation()
Returns
Type Description
String
| Improve this Doc View Source

GetPlotImage(Double[], Color, List<GapsAndJoins>)

This method called from Indexdisplay.DrawImageOfSummaryIndices(). It draws a single plot/track of one summary index.

Declaration
public Image<Rgb24> GetPlotImage(double[] array, Color backgroundColour, List<GapsAndJoins> errors = null)
Parameters
Type Name Description
Double[] array
SixLabors.ImageSharp.Color backgroundColour
List<GapsAndJoins> errors
Returns
Type Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>
| Improve this Doc View Source

GetPlotImage(Double[], List<GapsAndJoins>)

Declaration
public Image<Rgb24> GetPlotImage(double[] array, List<GapsAndJoins> errors = null)
Parameters
Type Name Description
Double[] array
List<GapsAndJoins> errors
Returns
Type Description
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>
| Improve this Doc View Source

NormaliseValue(Double)

Declaration
public double NormaliseValue(double value)
Parameters
Type Name Description
Double value
Returns
Type Description
Double

Extension Methods