Class LdSpectrogramConfig

CONFIG CLASS FOR the class LDSpectrogramRGB.

Inheritance
Object
Config
LdSpectrogramConfig
Implements
Inherited Members
Namespace: AudioAnalysisTools.LongDurationSpectrograms
Assembly: AudioAnalysisTools.dll
Syntax
public class LdSpectrogramConfig : Config, IConfig

Constructors

| Improve this Doc View Source

LdSpectrogramConfig()

Initializes a new instance of the LdSpectrogramConfig class. CONSTRUCTOR.

Declaration
public LdSpectrogramConfig()

Properties

| Improve this Doc View Source

BlueEnhanceParameter

Gets or sets value of the blue enhancement parameter. Its value must be in 0.0 to 1.0. Current suggested value is 0.5.

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

ColorMap1

Gets or sets parameter to manipulate the color map and appearance of the false-colour spectrogram.

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

ColorMap2

Gets or sets parameter to manipulate the colour map and appearance of the false-colour spectrogram Pass two color maps because two maps convey more information.

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

ColourFilter

Gets or sets value of the color filter. Its value must be less than 1.0. Good value is 0.75.

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

FreqScale

Gets or sets the type of freq scale.

Eventual options will be: Linear, Mel, Linear62Octaves31Nyquist11025, Linear125Octaves30Nyquist11025, Octaves24Nyquist32000, Linear125Octaves28Nyquist32000

Only "Linear", "Linear125Octaves6Tones28Nyquist11025", "Linear125Octaves7Tones28Nyquist32000" work at present.

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

ImageChrome

Gets or sets a value indicating whether or not to render chrome around the FCS. Chrome is all the decoration around the data; axes, grids, titles, etc.

Declaration
public bool ImageChrome { get; set; }
Property Value
Type Description
Boolean

If true will render image chrome.
| Improve this Doc View Source

XAxisTicInterval

Gets or sets the default XAxisTicInterval. The default assumes one minute spectra i.e. 60 per hour But as of January 2015, this is not fixed. The user can adjust the tic interval to be appropriate to the time scale of the spectrogram. May 2017: XAxisTicIntervalSeconds is the new configuration option!.

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

XAxisTicIntervalSeconds

Gets or sets the default XAxisTicIntervalSeconds. The default assumes one minute spectra i.e. 60 per hour But as of January 2015, this is not fixed. The user can adjust the tic interval to be appropriate to the time scale of the spectrogram. May 2017: Now measured in seconds and usage XAxisTicIntervalSeconds is preferred.

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

YAxisTicInterval

Gets or sets YAxisTicInterval in Hertz. The vertical spacing between horizontal grid lines for the y-Axis mark 1 kHz intervals.

Declaration
public int YAxisTicInterval { get; set; }
Property Value
Type Description
Int32

Methods

| Improve this Doc View Source

CalculateYAxisTickInterval(Double, Double)

In seconds, the horizontal spacing between vertical grid lines for the x-Axis.

Declaration
public double CalculateYAxisTickInterval(double sampleRate, double frameWidth)
Parameters
Type Name Description
Double sampleRate
Double frameWidth
Returns
Type Description
Double
| Improve this Doc View Source

GetDefaultConfig()

NOTE: As of August 2015, we are using EVN (event count) in both spectrograms because CVR (cover) is too highly correlated with POW. NOTE: As of May 2017, PMN replaces POW.

Declaration
public static LdSpectrogramConfig GetDefaultConfig()
Returns
Type Description
LdSpectrogramConfig
| Improve this Doc View Source

GetDefaultConfig(String, String)

Gets a default config for long-duration false-color spectrograms. But allows caller to substitute custom color maps.

Declaration
public static LdSpectrogramConfig GetDefaultConfig(string colorMap1, string colorMap2)
Parameters
Type Name Description
String colorMap1
String colorMap2
Returns
Type Description
LdSpectrogramConfig
| Improve this Doc View Source

GetKeys()

Declaration
public string[] GetKeys()
Returns
Type Description
String[]
| Improve this Doc View Source

GetKeys(String)

Declaration
public static string[] GetKeys(string colorMap)
Parameters
Type Name Description
String colorMap
Returns
Type Description
String[]
| Improve this Doc View Source

GetKeys(String, String)

Declaration
public static string[] GetKeys(string colorMap1, string colorMap2)
Parameters
Type Name Description
String colorMap1
String colorMap2
Returns
Type Description
String[]
| Improve this Doc View Source

ReadYamlToConfig(FileInfo)

READS A YAML CONFIG FILE into a Config variable and then transfers all values into the appropriate config class.

Declaration
public static LdSpectrogramConfig ReadYamlToConfig(FileInfo path)
Parameters
Type Name Description
FileInfo path
Returns
Type Description
LdSpectrogramConfig

The LdSpectrogramConfig.

Implements

Extension Methods