Class ConcatenateIndexFiles.Arguments

Inheritance
Object
SubCommandBase
ConcatenateIndexFiles.Arguments
Inherited Members
Namespace: AnalysisPrograms
Assembly: AnalysisPrograms.dll
Syntax
[Command("ConcatenateIndexFiles", Description = "[BETA] Concatenates multiple consecutive AcousticIndex.csv files. Caution required!!")]
public class Arguments : SubCommandBase

Properties

| Improve this Doc View Source

ColorMap1

Declaration
[Option(Description = "The mapping of indices to color channel in false-color spectrogram 1", ShortName = "")]
public string ColorMap1 { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

ColorMap2

Declaration
[Option(Description = "The mapping of indices to color channel in false-color spectrogram 2", ShortName = "")]
public string ColorMap2 { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

ConcatenateEverythingYouCanLayYourHandsOn

Declaration
[Option(CommandOptionType.NoValue, Description = "Set true only when concatenating more than 24-hours of data into one image", LongName = "concatenate-everything", ShortName = "")]
public bool ConcatenateEverythingYouCanLayYourHandsOn { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

DirectoryFilter

Declaration
[Option(Description = "Used to get the required data.csv files, which are assumed to be in a matching dir or sub-directory. E.g. use name of audio file suffix e.g.: `*.wav`. The default is `*.wav`")]
public string DirectoryFilter { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

DrawImages

Declaration
[Option(CommandOptionType.NoValue, Description = "Draw false-color spectrograms after concatenating index files", ShortName = "")]
public bool DrawImages { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

EndDate

Declaration
[Option(CommandOptionType.SingleValue, Description = "DateTimeOffset (exclusive) at which concatenation ends. If null, then will be set = today's date or last available file. Can parse an ISO8601 date.")]
public DateTimeOffset? EndDate { get; set; }
Property Value
Type Description
Nullable<DateTimeOffset>
| Improve this Doc View Source

EventDataDirectories

Declaration
[Option(Description = "One or more directories where the RECOGNIZER event scores are located in csv files. This is optional", ShortName = "")]
public string[] EventDataDirectories { get; set; }
Property Value
Type Description
String[]
| Improve this Doc View Source

EventFilePattern

Declaration
[Option(Description = "Used only to get Event Recognizer files.", ShortName = "")]
public string EventFilePattern { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

FalseColourSpectrogramConfig

Declaration
[Option(Description = "Config file for drawing the false colour spectrograms.", ShortName = "fcs")]
[ExistingFile(false, true, Extension = ".yml")]
[LegalFilePath]
public string FalseColourSpectrogramConfig { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

FileStemName

Declaration
[Option(CommandOptionType.SingleValue, Description = "File stem name for output files.")]
public string FileStemName { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

GapRendering

Declaration
[Option(Description = "How to render gaps in a recording. Valid options: `TimedGaps` (default), `NoGaps`, `EchoGaps`")]
public ConcatMode GapRendering { get; set; }
Property Value
Type Description
ConcatMode
| 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

InputDataDirectories

Declaration
[Argument(0, Description = "One or more directories where the original csv files are located.")]
public DirectoryInfo[] InputDataDirectories { get; set; }
Property Value
Type Description
DirectoryInfo[]
| Improve this Doc View Source

InputDataDirectory

Declaration
[Obsolete("Originally hack to get around power-args limitation, can probably be removed soon")]
[Option(CommandOptionType.SingleValue, Description = "One directory where the original csv files are located. This option exists as an alternative to input data directories")]
public DirectoryInfo InputDataDirectory { get; set; }
Property Value
Type Description
DirectoryInfo
| Improve this Doc View Source

OutputDirectory

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

StartDate

Declaration
[Option(CommandOptionType.SingleValue, Description = "DateTimeOffset (inclusive) at which concatenation begins. If null, then start with earliest available file. Can parse an ISO8601 date.")]
public DateTimeOffset? StartDate { get; set; }
Property Value
Type Description
Nullable<DateTimeOffset>
| Improve this Doc View Source

TimeSpanOffsetHint

Declaration
[Option(CommandOptionType.SingleValue, Description = "TimeSpan offset hint required if file names do not contain time zone info. NO DEFAULT IS SET", ShortName = "z")]
public TimeSpan? TimeSpanOffsetHint { get; set; }
Property Value
Type Description
Nullable<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