Class DrawZoomingSpectrograms.Arguments

Inheritance
Object
SubCommandBase
DrawZoomingSpectrograms.Arguments
Inherited Members
Namespace: AnalysisPrograms.Draw.Zooming
Assembly: AnalysisPrograms.dll
Syntax
[Command("DrawZoomingSpectrograms", Description = "[BETA] Produces long-duration, false-colour spectrograms on different time scales.", ExtendedHelpText = "The `Tile` option will produce a full pyramid of tiles whereas the `Focused` option produces just one image")]
public class Arguments : SubCommandBase

Properties

| Improve this Doc View Source

FocusMinute

Declaration
[Option(Description = "When doing a `Focused` stack, which minute to center on. Accepts partial minutes.")]
[InRange(0, 1.7976931348623157E+308)]
public double? FocusMinute { get; set; }
Property Value
Type Description
Nullable<Double>
| Improve this Doc View Source

Output

Declaration
[Argument(2, Description = "A destination path to write output to. The path should be a directory")]
[Required]
[LegalFilePath]
public string Output { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

OutputFormat

Declaration
[Option(Description = "If empty, will write files. If \"sqlite3\" files will be written to a Sqlite3 database.")]
[OneOfThese(new string[]{"", "sqlite3"})]
public string OutputFormat { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

SourceDirectory

Declaration
[Argument(0, Description = "The source directory of files output from Towsey.Acoustic (the Index analysis) to operate on")]
[Required]
[DirectoryExists]
public string SourceDirectory { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

SpectrogramZoomingConfig

Declaration
[Argument(1, Description = "User specified file defining valid spectrogram scales. Also should contain a reference to IndexProperties.yml and optionally a LDSpectrogramConfig object")]
[ExistingFile(false, true, Extension = ".yml")]
[Required]
public string SpectrogramZoomingConfig { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

ZoomAction

Declaration
[Option(Description = "Choose which action to execute (Focused, or Tile)")]
[Required]
public DrawZoomingSpectrograms.Arguments.ZoomActionType ZoomAction { get; set; }
Property Value
Type Description
DrawZoomingSpectrograms.Arguments.ZoomActionType

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