Skip to content

Commit

Permalink
Initial deprecation of Dev methods
Browse files Browse the repository at this point in the history
Dev methods for cli commands are problematic and are scheduled for deprecation. This is the first step in removing these methods.

See #134
  • Loading branch information
atruskie committed Nov 29, 2017
1 parent 409d315 commit 69a7c8b
Show file tree
Hide file tree
Showing 50 changed files with 54 additions and 5 deletions.
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/AED.cs
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,7 @@ public static AcousticEvent[] CallAed(BaseSonogram sonogram, AedConfiguration ae
return events;
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev(object obj)
{
throw new NotImplementedException();
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/AcousticIndices.cs
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ public string Identifier
public string Description
=> "Generates all our default acoustic indices, including summary indices and spectral indices. Also generates false color spectrograms IFF IndexCalculationDuration==60.0";

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static void Dev(Arguments arguments)
{
if (arguments == null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ namespace AnalysisPrograms.AnalyseLongRecordings

public partial class AnalyseLongRecording
{
[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{
// TO GET TO HERE audio2csv MUST BE ONLY COMMAND LINE ARGUMENT
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/Audio2InputForConvCNN.cs
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ public static string AdditionalNotes()
}
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
private static Arguments Dev()
{
DateTime time = DateTime.Now;
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/Audio2Sonogram.cs
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ public static string AdditionalNotes()
}
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
private static Arguments Dev()
{
return new Arguments
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/CanetoadOld_OBSOLETE.cs
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ public override string Identifier

#region Public Methods and Operators

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static void Dev(Arguments arguments)
{
bool executeDev = arguments == null;
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/ConcatenateIndexFiles.cs
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ public class Arguments
/// <summary>
/// To get to this DEV method, the FIRST AND ONLY command line argument must be "concatenateIndexFiles"
/// </summary>
[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{
// set the default values here
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/Create4Sonograms.cs
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ public static string AdditionalNotes()
}
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
private static Arguments Dev()
{
return new Arguments
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/Crow.cs
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ public override string Identifier
get { return "Towsey." + AnalysisName; }
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static void Dev(Arguments arguments)
{
var executeDev = arguments == null;
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/DifferenceSpectrogram.cs
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ public static string AdditionalNotes()
}
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{
//SET VERBOSITY
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/Dong.Felt.Main.cs
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,7 @@ public static string AdditionalNotes()
/// <param name="arguments">
/// The arguments.
/// </param>
[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static void Dev(Arguments arguments)
{
if (arguments == null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ public static partial class DrawZoomingSpectrograms
/// <returns>
/// The <see cref="Arguments"/>.
/// </returns>
[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{
// INPUT and OUTPUT DIRECTORIES
Expand Down Expand Up @@ -92,7 +93,7 @@ public static Arguments Dev()
string config = @"C:\Work\GitHub\audio-analysis\AudioAnalysis\AnalysisConfigFiles\SpectrogramZoomingConfig.yml";
//string config = @"C:\Work\GitHub\audio-analysis\AudioAnalysis\AnalysisConfigFiles\SpectrogramHiResConfig.yml";

return new Arguments
return null; /*new Arguments
{
// use the default set of index properties in the AnalysisConfig directory.
SourceDirectory = ipdir.ToDirectoryInfo(),
Expand All @@ -103,9 +104,9 @@ public static Arguments Dev()
//ZoomAction = Arguments.ZoomActionType.Tile,
ZoomAction = Arguments.ZoomActionType.Focused,
//FocusMinute = 1,
FocusMinute = 60,
};
FocusMinute = 1,
//FocusMinute = 61,
};*/
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ public static void Execute(Arguments arguments)
{
if (arguments == null)
{
throw new NotSupportedException();
arguments = Dev();
}

Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/DrawEasyImage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ public TimeSpan? TimeSpanOffsetHint {
/// <summary>
/// To get to this DEV method, the FIRST AND ONLY command line argument must be "drawEasyImage"
/// </summary>
[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{
DateTimeOffset? dtoStart = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ public class Arguments
/// audiocutter - Cuts audio into segments of desired length and format
/// createfoursonograms
/// </summary>
[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{
// the default ld fc spectrogram config file
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/DrawSummaryIndexTracks.cs
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ public class Arguments
/// To get to this DEV method, the FIRST AND ONLY command line argument must be "indicescsv2image"
/// </summary>
/// <returns></returns>
[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
private static Arguments Dev()
{
//use the following for the command line for the <indicesCsv2Image> task.
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/EPR.cs
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ public class Arguments : SourceAndConfigArguments

}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{

Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/FeltTemplate_Create.cs
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ The user can then edit the image file to produce a number of templates.
public static string key_LINE_LENGTH = "SPR_LINE_LENGTH"; // Used when preparing syntactic PR template.
public static string key_DRAW_SONOGRAMS = "DRAW_SONOGRAMS";

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{
throw new NotImplementedException();
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/FeltTemplate_Edit.cs
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ public class Arguments
// LEWINS RAIL
// edittemplate_felt C:\SensorNetworks\Output\FELT_LewinsRail1\FELT_LewinsRail1_params.txt

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{
throw new NotImplementedException();
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/FeltTemplates_Use.cs
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ public class Arguments : SourceConfigOutputDirArguments

// felt "C:\SensorNetworks\WavFiles\Currawongs\Currawong_JasonTagged\West_Knoll_Bees_20091102-050000.wav" C:\SensorNetworks\Output\FELT_MultiOutput_5templates\templateList.txt C:\SensorNetworks\Output\FELT_MultiOutput_5templates

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{
throw new NotImplementedException();
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/FrogRibit_OBSOLETE.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ public class Arguments : SourceConfigOutputDirArguments
{
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static void Dev(Arguments arguments)
{
if (arguments == null)
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/Frogs_OBSOLETE.cs
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ public override string Identifier
get { return "Towsey." + AnalysisName; }
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static void Dev(Arguments arguments)
{
Log.Verbosity = 1;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ public class Arguments : SourceConfigOutputDirArguments
{
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{
//string recordingPath = @"C:\SensorNetworks\WavFiles\Human\DM420036_min465Speech.wav";
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/GroundParrotRecogniser.cs
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ public static Tuple<BaseSonogram, List<AcousticEvent>> Detect(FileInfo wavFilePa
/// <param name="args">
/// The args passed into executable.
/// </param>
[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static void Dev(Arguments arguments)
{
if (arguments == null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ public static class HighResolutionAcousticIndices
/// audiocutter - Cuts audio into segments of desired length and format
/// createfoursonograms
/// </summary>
[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{

Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/Human1.cs
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ public string Identifier
get { return "Towsey." + AnalysisName; }
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static void Dev(Arguments arguments)
{
var executeDev = arguments == null;
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/KoalaMale.cs
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ public override string Identifier

#region Public Methods and Operators

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static void Dev(Arguments arguments)
{
bool executeDev = arguments == null;
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/LSKiwi3.cs
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ public string Identifier
get { return "Towsey." + AnalysisName; }
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static void Dev(Arguments arguments)
{
var executeDev = arguments == null;
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/LewinsRail3OBSOLETE.cs
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ public string Identifier
get { return "Towsey." + AnalysisName; }
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static void Dev(Arguments arguments)
{
var executeDev = arguments == null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ public class LimnodynastesConvex_OBSOLETE : AbstractStrongAnalyser

#region Public Methods and Operators

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static void Dev(Arguments arguments)
{
bool executeDev = arguments == null;
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/OscillationRecogniser.cs
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ public class Arguments : SourceConfigOutputDirArguments
{
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{
throw new NotImplementedException();
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/OscillationsGeneric.cs
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ public static string AdditionalNotes()
}
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
private static Arguments Dev()
{

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ public string Identifier
get { return "Towsey." + AnalysisName; }
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static void Dev(Arguments arguments)
{
var executeDev = arguments == null;
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/Rain_OBSOLETE.cs
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ public class Arguments : AnalyserArguments
{
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static void Dev(Arguments arguments)
{
Log.Verbosity = 1;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ public static string AdditionalNotes()

private static readonly ILog Log = LogManager.GetLogger(nameof(RecognizerEntry));

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{
Log.Info("Runnung Event Recognizer through the RecognizerEntry.Dev() method.");
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/RheobatrachusSilus.cs
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ public class Arguments : AnalyserArguments
{
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static void Dev(Arguments arguments)
{
Log.Verbosity = 1;
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/SPR_OBSOLETE.cs
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ public class Arguments : SourceConfigOutputDirArguments
{
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{
//WHIPBIRD
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/SURFAnalysis.cs
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ public static string AdditionalNotes()
}
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
private static Arguments Dev()
{
DateTime time = DateTime.Now;
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/Sandpit.cs
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ public class Arguments
{
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static void Dev(Arguments arguments)
{
var tStart = DateTime.Now;
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/Segment.cs
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ public class Arguments : SourceConfigOutputDirArguments
{
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{
//Following lines are used for the debug command line.
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/SnrAnalysis.cs
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ public static string AdditionalNotes()
}
}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
private static Arguments Dev()
{
// COMMAND LINES FOR SnrAnalysis.exe
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/SpeciesAccumulationCurve.cs
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ public class Arguments
/// <summary>
/// Note to michael, consider returning true false to indicate program exit - never use Environment.Exit
/// </summary>
[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static void Dev()
{

Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/Spt.cs
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ public class Arguments

}

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{
//spt C:\SensorNetworks\WavFiles\BridgeCreek\cabin_GoldenWhistler_file0127_extract1.mp3 C:\SensorNetworks\Output\SPT\ 2.0
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AnalysisPrograms/XiesAnalysis.cs
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ public static string AdditionalNotes()

private static readonly ILog Log = LogManager.GetLogger(typeof(XiesAnalysis));

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
internal static Arguments Dev()
{
throw new NotImplementedException();
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AudioAnalysisTools/BirdClefExperiment1.cs
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ public static class BirdClefExperiment1
/// audiocutter - Cuts audio into segments of desired length and format
/// createfoursonograms
/// </summary>
[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{
// INPUT and OUTPUT DIRECTORIES
Expand Down
1 change: 1 addition & 0 deletions AudioAnalysis/AudioAnalysisTools/ChannelIntegrity.cs
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ namespace AudioAnalysisTools

public static class ChannelIntegrity
{
[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
public static Arguments Dev()
{
//FileInfo audioFile = new FileInfo(@"C:\SensorNetworks\WavFiles\Gympie\20151029_064553_Gympie_bad.wav");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ public static class LdSpectrogram3D
public const int TotalMinutesInDay = 1440;
public const int TotalDaysInYear = 365;

[Obsolete("See https://github.com/QutBioacoustics/audio-analysis/issues/134")]
private static Arguments Dev()
{
DateTime time = DateTime.Now;
Expand Down
Loading

0 comments on commit 69a7c8b

Please sign in to comment.