Added documentation

Author: IOExcept10n

source/AnimaFiltering/AnimaFiltering/Services/AnimalFilteringService.cs

@@ -1,20 +1,30 @@
-using SkiaSharp;
+// Copyright 2024 (c) MIDIFrogs (contact https://github.com/MIDIFrogs)
+// Distributed under AGPL v3.0 license. See LICENSE.md file in the project root for more information
+using SkiaSharp;
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
 using System.Linq;
-using System.Text;
 using System.Threading.Tasks;
-using YoloDotNet;
 
 namespace AnimaFiltering.Services
 {
+    /// <summary>
+    /// Represents a service that filters animal images.
+    /// </summary>
+    /// <param name="yolo">An instance of the YOLO model provider.</param>
+    /// <param name="filters">Set of custom filters to test an image.</param>
     public class AnimalFilteringService(YoloProvider yolo, UserFilters filters)
     {
         public const string GoodClassName = "good";
         public const string BadClassName = "bad";
 
+        /// <summary>
+        /// Filters all images in given directory.
+        /// </summary>
+        /// <param name="datasetPath">Path to a directory to filter.</param>
+        /// <returns>An enumerable of detection results with their classes.</returns>
         public async IAsyncEnumerable<AnimalDetectInfo> FilterAnimalsAsync(string datasetPath)
         {
             var files = Directory.EnumerateFiles(datasetPath, "*.jpg");
@@ -29,7 +39,7 @@ public async IAsyncEnumerable<AnimalDetectInfo> FilterAnimalsAsync(string datase
                 var result = await Task.Run(() => yolo.Yolo.RunObjectDetection(image, iou: 0.5));
 #if DEBUG
                 if (++i % 20 == 0)
-                   Debug.WriteLine($"Processing image {i}/{count}...");
+                    Debug.WriteLine($"Processing image {i}/{count}...");
 #endif
                 foreach (var animal in result)
                 {
@@ -41,4 +51,4 @@ public async IAsyncEnumerable<AnimalDetectInfo> FilterAnimalsAsync(string datase
 #endif
         }
     }
-}
+}

source/AnimaFiltering/AnimaFiltering/Services/AppPreferences.cs

@@ -1,18 +1,30 @@
-// Copyright 2024 (c) IOExcept10n (contact https://github.com/IOExcept10n)
-// Distributed under APGL v3.0 license. See LICENSE.md file in the project root for more information
+// Copyright 2024 (c) MIDIFrogs (contact https://github.com/MIDIFrogs)
+// Distributed under AGPL v3.0 license. See LICENSE.md file in the project root for more information
 using Newtonsoft.Json;
 using System.IO;
 
 namespace AnimaFiltering.Services
 {
+    /// <summary>
+    /// Represents preferences for the application.
+    /// </summary>
     public record class AppPreferences
     {
         private readonly string filePath = "Options.json";
 
+        /// <summary>
+        /// Minimal detection width to check.
+        /// </summary>
         public int MinWidth { get; set; }
 
+        /// <summary>
+        /// Minimal detection height to check.
+        /// </summary>
         public int MinHeight { get; set; }
 
+        /// <summary>
+        /// Determines whether the GPU with CUDA is preferred (CudNN is required).
+        /// </summary>
         public bool PreferGPU { get; set; }
 
         public AppPreferences()
@@ -32,11 +44,19 @@ private AppPreferences(AppPreferences prototype, string path) : this(prototype)
             filePath = path;
         }
 
+        /// <summary>
+        /// Saves app settings.
+        /// </summary>
         public void Save()
         {
             File.WriteAllText(filePath, JsonConvert.SerializeObject(this));
         }
 
+        /// <summary>
+        /// Loads app settings or initializes new ones.
+        /// </summary>
+        /// <param name="filePath">File path to save.</param>
+        /// <returns>An instance of the <see cref="AppPreferences"/>.</returns>
         public static AppPreferences LoadOrCreate(string filePath)
         {
             if (File.Exists(filePath))

source/AnimaFiltering/AnimaFiltering/Services/CameraManager.cs

@@ -1,4 +1,4 @@
-// Copyright 2024 (c) IOExcept10n (contact https://github.com/IOExcept10n)
+// Copyright 2024 (c) MIDIFrogs (contact https://github.com/MIDIFrogs)
 // Distributed under AGPL v3.0 license. See LICENSE.md file in the project root for more information
 using Newtonsoft.Json;
 using System.Collections.Generic;
@@ -7,6 +7,9 @@
 
 namespace AnimaFiltering.Services
 {
+    /// <summary>
+    /// Represents a collection of camera stats.
+    /// </summary>
     public class CameraManager : ObservableCollection<CameraStats>
     {
         private readonly string filePath;
@@ -22,20 +25,25 @@ private CameraManager(IEnumerable<CameraStats> items, string path)
 
         public CameraManager()
         {
-
         }
 
         public CameraManager(string path)
         {
             filePath = path;
         }
 
+        /// <summary>
+        /// Loads camera stats of initializes a new ones.
+        /// </summary>
+        /// <param name="filePath">Path to a file with camera stats.</param>
+        /// <returns>An instance of the <see cref="CameraManager"/>.</returns>
         public static CameraManager LoadOrCreate(string filePath)
         {
             if (File.Exists(filePath))
             {
                 return new(JsonConvert.DeserializeObject<CameraManager>(File.ReadAllText(filePath))!, filePath);
             }
+            // HACK
             return new(filePath)
             {
                 new(){ Name = "Камера 1"},

source/AnimaFiltering/AnimaFiltering/Services/CameraStats.cs

@@ -1,22 +1,30 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
-
+// Copyright 2024 (c) MIDIFrogs (contact https://github.com/MIDIFrogs)
+// Distributed under AGPL v3.0 license. See LICENSE.md file in the project root for more information
 namespace AnimaFiltering.Services
 {
+    /// <summary>
+    /// Represents configurable stats for the camera.
+    /// </summary>
     public class CameraStats
     {
+        /// <summary>
+        /// Name of the camera.
+        /// </summary>
         public required string Name { get; set; }
 
+        /// <summary>
+        /// Number of images processed for all the time.
+        /// </summary>
         public int ProcessedImages { get; set; }
 
+        /// <summary>
+        /// Number of good images from the selected ones.
+        /// </summary>
         public int GoodImages { get; set; }
 
         public override string ToString()
         {
             return Name;
         }
     }
-}
+}

source/AnimaFiltering/AnimaFiltering/Services/Filters/HeadFilter.cs

@@ -1,11 +1,17 @@
-using Avalonia.Logging;
+// Copyright 2024 (c) MIDIFrogs (contact https://github.com/MIDIFrogs)
+// Distributed under AGPL v3.0 license. See LICENSE.md file in the project root for more information
+using Avalonia.Logging;
 using SkiaSharp;
 using System;
 using YoloDotNet;
 using YoloDotNet.Models;
 
 namespace AnimaFiltering.Services.Filters
 {
+    /// <summary>
+    /// Represents a filter that checks if animal's head is inside the bounding box.
+    /// </summary>
+    /// <param name="preferences"></param>
     internal class HeadFilter(AppPreferences preferences) : IPostProcessingFilter
     {
         public const string ModelPath = "head.onnx";
@@ -20,6 +26,11 @@ public bool CheckDetection(ObjectDetection detection, SKImage image)
             return results.Count == 1 && results[0].BoundingBox.Width > preferences.MinWidth / 8 && results[0].BoundingBox.Height > preferences.MinHeight / 8;
         }
 
+        /// <summary>
+        /// Initializes YOLO model for head detection.
+        /// </summary>
+        /// <param name="preferences">App preferences to initialize.</param>
+        /// <returns>YOLO model that finds heads in image BBoxes.</returns>
         private static Yolo InitYolo(AppPreferences preferences)
         {
             if (preferences.PreferGPU)
@@ -48,4 +59,4 @@ private static Yolo InitYolo(AppPreferences preferences)
             });
         }
     }
-}
+}

source/AnimaFiltering/AnimaFiltering/Services/Filters/SizeFilter.cs

@@ -1,18 +1,19 @@
-using SkiaSharp;
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
+// Copyright 2024 (c) MIDIFrogs (contact https://github.com/MIDIFrogs)
+// Distributed under AGPL v3.0 license. See LICENSE.md file in the project root for more information
+using SkiaSharp;
 using YoloDotNet.Models;
 
 namespace AnimaFiltering.Services.Filters
 {
+    /// <summary>
+    /// Filter that checks if the bounding box size is correct.
+    /// </summary>
+    /// <param name="preferences">App preferences for filtering.</param>
     internal class SizeFilter(AppPreferences preferences) : IPostProcessingFilter
     {
         public bool CheckDetection(ObjectDetection detection, SKImage image)
         {
             return detection.BoundingBox.Width >= preferences.MinWidth && detection.BoundingBox.Height >= preferences.MinHeight;
         }
     }
-}
+}

source/AnimaFiltering/AnimaFiltering/Services/Filters/UnFocusFilter.cs

@@ -1,12 +1,23 @@
-using OpenCvSharp;
+// Copyright 2024 (c) MIDIFrogs (contact https://github.com/MIDIFrogs)
+// Distributed under AGPL v3.0 license. See LICENSE.md file in the project root for more information
+using OpenCvSharp;
 using SkiaSharp;
-using YoloDotNet.Extensions;
 using YoloDotNet.Models;
 
 namespace AnimaFiltering.Services.Filters
 {
+    /// <summary>
+    /// Filter that checks for image focus value.
+    /// </summary>
+    /// <param name="preferences"></param>
     internal class UnFocus(AppPreferences preferences) : IPostProcessingFilter
     {
+        /// <summary>
+        /// Converts SkiaSharp image to OpenCV Mat. Also clips an image by given clip rect.
+        /// </summary>
+        /// <param name="skImage">An image to clip and convert.</param>
+        /// <param name="clipRect">Clipping rectangle.</param>
+        /// <returns>Converted OpenCV Mat.</returns>
         public Mat ConvertSkiaSharpImageToMat(SKImage skImage, SKRectI clipRect)
         {
             // Step 1: Create a new SKImage from the clipped area
@@ -57,4 +68,4 @@ public bool CheckDetection(ObjectDetection detection, SKImage image)
             return focusMeasure > 70;
         }
     }
-}
+}

source/AnimaFiltering/AnimaFiltering/Services/IPostProcessingFilter.cs

@@ -1,10 +1,21 @@
-using SkiaSharp;
+// Copyright 2024 (c) MIDIFrogs (contact https://github.com/MIDIFrogs)
+// Distributed under AGPL v3.0 license. See LICENSE.md file in the project root for more information
+using SkiaSharp;
 using YoloDotNet.Models;
 
 namespace AnimaFiltering.Services
 {
+    /// <summary>
+    /// Represents an interface for the postprocessing filter.
+    /// </summary>
     public interface IPostProcessingFilter
     {
+        /// <summary>
+        /// Checks if the detection result is valid.
+        /// </summary>
+        /// <param name="detection">Detection instance to check.</param>
+        /// <param name="image">Source image to validate.</param>
+        /// <returns><see langword="true"/> if the detection is valid; otherwise <see langword="false"/>.</returns>
         bool CheckDetection(ObjectDetection detection, SKImage image);
     }
 }

source/AnimaFiltering/AnimaFiltering/Services/ReportBuilder.cs

@@ -1,14 +1,24 @@
-using System;
+// Copyright 2024 (c) MIDIFrogs (contact https://github.com/MIDIFrogs)
+// Distributed under AGPL v3.0 license. See LICENSE.md file in the project root for more information
+using System;
 using System.Collections.Generic;
 using System.IO;
-using System.Linq;
-using System.Text;
 using System.Threading.Tasks;
 
 namespace AnimaFiltering.Services
 {
+    /// <summary>
+    /// Represents a builder for the CSV reports.
+    /// </summary>
     internal class ReportBuilder
     {
+        /// <summary>
+        /// Writes filtering results into CSV file.
+        /// </summary>
+        /// <param name="detections">Set of detections to log.</param>
+        /// <param name="selectedCamera">A camera to save stats for.</param>
+        /// <param name="path">Path to save CSV to.</param>
+        /// <param name="progress">Progress handler to notify about image processing.</param>
         public async Task WriteToCsvAsync(IAsyncEnumerable<AnimalDetectInfo> detections, CameraStats selectedCamera, string path, IProgress<int> progress)
         {
             using var writer = new StreamWriter(path);
@@ -28,4 +38,4 @@ public async Task WriteToCsvAsync(IAsyncEnumerable<AnimalDetectInfo> detections,
             }
         }
     }
-}
+}

source/AnimaFiltering/AnimaFiltering/Services/ServiceRegistration.cs

@@ -1,15 +1,22 @@
-// Copyright 2024 (c) IOExcept10n (contact https://github.com/IOExcept10n)
+// Copyright 2024 (c) MIDIFrogs (contact https://github.com/MIDIFrogs)
 // Distributed under AGPL v3.0 license. See LICENSE.md file in the project root for more information
 using AnimaFiltering.ViewModels;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace AnimaFiltering.Services
 {
+    /// <summary>
+    /// Represents an utility to register app services.
+    /// </summary>
     internal static class ServiceRegistration
     {
         private const string OptionsFileName = "Options.json";
         private const string CamerasFileName = "Cameras.json";
 
+        /// <summary>
+        /// Adds application services to the DI container.
+        /// </summary>
+        /// <param name="services">Services collection to add.</param>
         public static IServiceCollection AddServices(this IServiceCollection services)
         {
             return services
@@ -19,13 +26,19 @@ public static IServiceCollection AddServices(this IServiceCollection services)
                 .AddSingleton<YoloProvider>();
         }
 
+        /// <summary>
+        /// Adds app view models to the DI container.
+        /// </summary>
         public static IServiceCollection AddViewModels(this IServiceCollection services)
         {
             return services
                 .AddTransient<StatsViewModel>()
                 .AddTransient<MainViewModel>();
         }
 
+        /// <summary>
+        /// Adds image filters to the DI container.
+        /// </summary>
         public static IServiceCollection AddFilters(this IServiceCollection services)
         {
             return services
@@ -35,6 +48,9 @@ public static IServiceCollection AddFilters(this IServiceCollection services)
                 .AddSingleton<ReportBuilder>();
         }
 
+        /// <summary>
+        /// Adds app options to the DI container.
+        /// </summary>
         public static IServiceCollection AddOptions(this IServiceCollection services)
         {
             AppPreferences options = AppPreferences.LoadOrCreate(OptionsFileName);