Class AnalyseLongRecording.Arguments

Inheritance
Object
SubCommandBase
SourceArguments
SourceAndConfigArguments
SourceConfigOutputDirArguments
AnalyseLongRecording.Arguments
Inherited Members
Namespace: AnalysisPrograms.AnalyseLongRecordings
Assembly: AnalysisPrograms.dll
Syntax
[Command("audio2csv", Description = "Analyzes long recordings, cutting them into blocks. Performs the analysis specified in Config file.", ExtendedHelpText = "\r\nAlignToMinute Options:\r\n  - None:        does no alignment (default) \r\n  - TrimBoth:    does alignment and removes fractional sections \r\n  - TrimNeither: does alignment and keeps fractional sections \r\n  - TrimStart:   does alignment and keeps last fractional segment \r\n  - TrimEnd:     does alignment and keeps first fractional segment ")]
public class Arguments : SourceConfigOutputDirArguments

Constructors

| Improve this Doc View Source

Arguments()

Declaration
public Arguments()

Properties

| Improve this Doc View Source

AlignToMinute

Declaration
[Option(Description = "Allow advancing the start of the analysis to the nearest minute. A valid datetime must be available in the file name. See additional notes for options.", ShortName = "")]
public TimeAlignment AlignToMinute { get; set; }
Property Value
Type Description
TimeAlignment
| Improve this Doc View Source

AnalysisIdentifier

Declaration
[Option(Description = "Sets the name of the analysis to run. If not set, analysis identifier is parsed from the config file name.")]
public string AnalysisIdentifier { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

Channels

Declaration
[Option(Description = "An array of channels to select. Default is all channels.")]
public int[] Channels { get; set; }
Property Value
Type Description
Int32[]
| Improve this Doc View Source

EndOffset

Declaration
[Option(CommandOptionType.SingleValue, Description = "The end offset to stop analyzing (in seconds)")]
[InRange(0, 1.7976931348623157E+308)]
public double? EndOffset { get; set; }
Property Value
Type Description
Nullable<Double>
| Improve this Doc View Source

MixDownToMono

Declaration
[Option(CommandOptionType.SingleValue, Description = "Mix all selected input channels down into one mono channel. Default is to mixdown.")]
public bool MixDownToMono { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Parallel

Declaration
[Option(Description = "Whether or not run this analysis in parallel - multiple segments can be analyzed at the same time", ShortName = "p")]
public bool Parallel { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

StartOffset

Declaration
[Option(CommandOptionType.SingleValue, Description = "The start offset to start analyzing from (in seconds)")]
[InRange(0, 1.7976931348623157E+308)]
public double? StartOffset { get; set; }
Property Value
Type Description
Nullable<Double>
| Improve this Doc View Source

TempDir

Declaration
[Option(CommandOptionType.SingleValue, Description = "A TEMP directory where cut files will be stored. Use this option for efficiency (e.g. write to a RAM Disk).", ShortName = "t")]
[DirectoryExistsOrCreate(true, true)]
[LegalFilePath]
public DirectoryInfo TempDir { get; set; }
Property Value
Type Description
DirectoryInfo
| Improve this Doc View Source

WhenExitCopyConfig

Declaration
[Option(Description = "If true, attempts to copy the executable's config file to output directory. If it can't determine an output directory, it copies to the working directory. If it can't find a config file, nothing is copied", ShortName = "")]
public bool WhenExitCopyConfig { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

WhenExitCopyLog

Declaration
[Option(Description = "If true, attempts to copy the executable's log file to output directory. If it can't determine an output directory, it copies to the working directory.", ShortName = "")]
public bool WhenExitCopyLog { get; set; }
Property Value
Type Description
Boolean

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