Class EventStatisticsEntry.Arguments

Inheritance
Object
SubCommandBase
EventStatisticsEntry.Arguments
Inherited Members
Namespace: AnalysisPrograms.EventStatistics
Assembly: AnalysisPrograms.dll
Syntax
[Command("EventStatistics", Description = "[BETA] Accepts a list of acoustic events to analyze. Returns a data file of statistics", ExtendedHelpText = "\r\nAt this stage only remote analysis is supported - that means querying an Acoustic Workbench website.\r\nSupport may be added in the future for other data sources (e.g. local). If you want this, file an issue!\r\n\r\nFor remote resources, the input file needs to have either one of these sets of fields:\r\n- AudioEventId/audio_event_id\r\n- AudioRecordingId/audio_recording_id, EventStartSeconds/event_start_seconds, EventEndSeconds/event_end_seconds, LowFrequencyHertz/low_frequency_hertz, HighFrequencyHertz/high_frequency_herttz\r\n")]
public class Arguments : SubCommandBase

Properties

| Improve this Doc View Source

AuthenticationToken

Declaration
[Option(Description = "The authentication token to use for the Acoustic Workbench website. If not specified you will prompted for log in credentials.")]
public string AuthenticationToken { 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

Config

Declaration
[Argument(1, Description = "The path to the config file. If not found it will attempt to use the default config file of the same name.")]
[Required]
[LegalFilePath]
public string Config { get; set; }
Property Value
Type Description
String
| 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

Output

Declaration
[Argument(2, Description = "A directory to write output to")]
[Required]
[DirectoryExistsOrCreate(true, true)]
[LegalFilePath]
public virtual DirectoryInfo Output { get; set; }
Property Value
Type Description
DirectoryInfo
| 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")]
public bool Parallel { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Source

Declaration
[Argument(0, Description = "The source event (annotations) file to operate on")]
[ExistingFile(false, true)]
[Required]
[LegalFilePath]
public FileInfo Source { get; set; }
Property Value
Type Description
FileInfo
| 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).")]
[DirectoryExistsOrCreate(true, true)]
[LegalFilePath]
public DirectoryInfo TempDir { get; set; }
Property Value
Type Description
DirectoryInfo
| Improve this Doc View Source

WorkbenchApi

Declaration
[Option(Description = "The Acoustic Workbench website to download data from. Defaults to https://www.ecosounds.org")]
public string WorkbenchApi { get; set; }
Property Value
Type Description
String

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