Class DrawLongDurationSpectrograms.Arguments

Inheritance
Object
SubCommandBase
DrawLongDurationSpectrograms.Arguments
Inherited Members
Namespace: AnalysisPrograms
Assembly: AnalysisPrograms.dll
Syntax
[Command("DrawLongDurationSpectrograms", Description = "[BETA] Produces long-duration, false-colour spectrograms from matrices of spectral indices.")]
public class Arguments : SubCommandBase

Properties

| Improve this Doc View Source

ColourMap1

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

ColourMap2

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

FalseColourSpectrogramConfig

Declaration
[Option(ShortName = "fcs", Description = "Config file specifying that contains FCS settings. `Normally named SpectrogramFalseColourConfig.yml`")]
[ExistingFile(false, true, Extension = ".yml")]
[LegalFilePath]
public string FalseColourSpectrogramConfig { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

IndexPropertiesConfig

Declaration
[Option(Description = "User specified file containing a list of indices and their properties.", ShortName = "ip")]
[ExistingFile(false, true, Extension = ".yml")]
[LegalFilePath]
public string IndexPropertiesConfig { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

InputDataDirectory

Declaration
[Option(Description = "Directory where the input data is located.")]
[DirectoryExists]
[LegalFilePath]
public string InputDataDirectory { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

OutputDirectory

Declaration
[Option(Description = "Directory where the output is to go.")]
[DirectoryExistsOrCreate(true, true)]
[LegalFilePath]
public string OutputDirectory { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

TemporalScale

Declaration
public TimeSpan TemporalScale { get; set; }
Property Value
Type Description
TimeSpan

Methods

| Improve this Doc View Source

Execute(CommandLineApplication)

Declaration
public override Task<int> Execute(CommandLineApplication app)
Parameters
Type Name Description
McMaster.Extensions.CommandLineUtils.CommandLineApplication app
Returns
Type Description
Task<Int32>
Overrides

Extension Methods