Skip to content

Commit

Permalink
More descriptions added to AnalysisPrograms classes
Browse files Browse the repository at this point in the history
  • Loading branch information
towsey committed Jun 21, 2018
1 parent e9d305b commit 722f166
Show file tree
Hide file tree
Showing 10 changed files with 10 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public partial class AnalyseLongRecording

[Command(
CommandName,
Description = "Analyses long recordings by breaking them up into 1-min blocks",
Description = "[BETA] Analyses long recordings, cutting them into 1-minute blocks. Performs the analysis specified in Config file.",
ExtendedHelpText = AdditionalNotes)]
public class Arguments : SourceConfigOutputDirArguments
{
Expand Down
2 changes: 1 addition & 1 deletion src/AnalysisPrograms/AnalysesAvailable.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ namespace AnalysisPrograms

[Command(
"AnalysesAvailable",
Description = "List available IAnalyzers available for use with audio2csv or eventRecognizer")]
Description = "Lists all IAnalyzers available for use with audio2csv or eventRecognizer")]
public class AnalysesAvailable
: SubCommandBase
{
Expand Down
2 changes: 1 addition & 1 deletion src/AnalysisPrograms/ConcatenateIndexFiles.cs
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public static class ConcatenateIndexFiles

[Command(
CommandName,
Description = "[BETA] Concatenates multiple consecutive index.csv files. Caution required!!")]
Description = "[BETA] Concatenates multiple consecutive AcousticIndex.csv files. Caution required!!")]
public class Arguments : SubCommandBase
{
[Argument(
Expand Down
2 changes: 1 addition & 1 deletion src/AnalysisPrograms/Create4Sonograms.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public static class Create4Sonograms

[Command(
CommandName,
Description = "[BETA] Creates a set of four standard spectrograms derived using different algorithms. For short recordings only.")]
Description = "[BETA] Creates a set of four standard-scale spectrograms derived using different algorithms. For short recordings only.")]
public class Arguments : SourceAndConfigArguments
{
[Option(Description = "A file path to write output to")]
Expand Down
2 changes: 1 addition & 1 deletion src/AnalysisPrograms/DifferenceSpectrogram.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public static class DifferenceSpectrogram

[Command(
CommandName,
Description = "[INOPERABLE] Produces a false-colour spectrogram that show only the differences between two spectrograms.")]
Description = "[INOPERABLE] Produces a spectrogram that displays statistical differences between two LDFC spectrograms.")]
public class Arguments : SubCommandBase
{
[Option(Description = "Path to configuration file in YAML format")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public static partial class DrawZoomingSpectrograms

[Command(
CommandName,
Description = "Produces long-duration false-colour spectrograms on different time scales.",
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
{
Expand Down
2 changes: 1 addition & 1 deletion src/AnalysisPrograms/DrawEasyImage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public static class DrawEasyImage

[Command(
CommandName,
Description = "Concatenates multiple consecutive index results into a format suitable for years of data.")]
Description = "[UNMAINTAINED] Produces image derived from concatenation of multiple consecutive index files. Suitable for years of recorded data.")]
public class Arguments : SubCommandBase
{
[Option(
Expand Down
2 changes: 1 addition & 1 deletion src/AnalysisPrograms/DrawLongDurationSpectrograms.cs
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ public static class DrawLongDurationSpectrograms

[Command(
CommandName,
Description = "[BETA] Produces long - duration false - colour spectrograms from matrices of spectral indices.")]
Description = "[BETA] Produces long-duration, false-colour spectrograms from matrices of spectral indices.")]
public class Arguments : SubCommandBase
{
[Option(Description = "Directory where the input data is located.")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public class EventStatisticsAnalysis : AbstractStrongAnalyser

public override string Identifier { get; } = "Ecosounds.EventStatistics";

public override string Description { get; } = "Event statistics calculation analysis used to extract critical statistics (features) from an acoustic event";
public override string Description { get; } = "[BETA] Event statistics calculation analysis used to extract critical statistics (features) from an acoustic event";

public override AnalysisSettings DefaultSettings { get; } = new AnalysisSettings
{
Expand Down
2 changes: 1 addition & 1 deletion src/AnalysisPrograms/Recognizers/Base/RecognizerEntry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public class RecognizerEntry
{
public const string CommandName = "EventRecognizer";
private const string Description =
"The entry point for all species or event recognizers.Only to be used on short recordings(< 2 mins)." +
"The entry point for all species or event recognizers. Only to be used on short recordings (< 2 mins)." +
"This recognizer runs any IEventRecognizer. The recognizer run is based on the " +
"Identifier field and parsed from the AnalysisName field in the config file of the same name";

Expand Down

0 comments on commit 722f166

Please sign in to comment.