BlindDeconvolution Documentation

Фреймворк для исследования методов слепой деконволюции изображений.

Руководство пользователя

• Установка и настройка
  • Системные требования
  • Установка
  • Удаление
  • Профили зависимостей
  • Интерактивное развертывание окружения
    • Интерактивный установщик зависимостей (install.py)
    • Интерактивное удаление зависимостей (uninstall.py)
  • Настройка виртуального окружения (вручную)
  • Опциональные зависимости
    • GNU Octave (для MATLAB-обёрток)
    • CUDA / GPU (для нейросетевых методов)
  • Проверка установки
  • Решение проблем
    • ImportError: No module named 'cv2'
    • ModuleNotFoundError: No module named 'blinddeconv'
    • Ошибки при сборке документации
• Руководство пользователя
  • Автоматизация и CLI
    • Установка зависимостей CLI
  • run.py — Автоматизация через конфигурационные файлы
    • Базовый запуск
    • Аргументы командной строки
    • Структура конфигурационного файла (YAML)
    • Доступные алгоритмы (реестр)
    • Доступные фильтры
    • PSF-функции (для defocus_blur и motion_blur)
    • Готовые конфиги
    • Что генерирует run.py
  • cli.py — Интерфейс командной строки
    • Справка
    • Команды
    • Автодополнение команд (Tab completion)
  • Сборка документации (docs/tools/build_docs.py)
    • Требования
    • Запуск
    • Ручная сборка
    • Важно
  • Использование как Python-библиотеки
    • Восстановление одного изображения
    • Сравнение нескольких алгоритмов
    • Полный пайплайн (фильтры + восстановление)
    • Оптимизация гиперпараметров
    • Сохранение и загрузка состояния
    • Очистка данных
• Конфигурационные файлы
  • Обзор
  • Формат файла
  • Структура конфигурации
    • Полный пример (YAML)
  • Описание секций
    • experiment (опционально)
    • input (обязательно)
    • output (опционально)
    • processing (опционально)
    • algorithms (обязательно)
    • filters (для full_process)
    • report (опционально)
  • Валидация
  • Готовые конфиги
  • Генерация конфигов через CLI
• Поток данных (Dataflow) через Pipeline
  • Общая схема
  • Ключевые функции модуля processing
  • Режим 1: process — восстановление по связям
    • Шаг 1. Загрузка связей
    • Шаг 2. Предобработка (опционально)
    • Шаг 3. Восстановление
    • Шаг 4. Визуализация и экспорт
  • Применение фильтров отдельно от full_process
  • Режим 2: full_process — полный пайплайн
  • Автоматизация через run.py
  • Формат сохранённых связей (dataset.json)
  • Обратная гистограммная коррекция

Архитектура и API

• Архитектура системы
  • Модульная структура
  • Основные компоненты
    • 1. Processing — центральный класс (фасад)
    • 2. Image — связь изображений
    • 3. DeconvolutionAlgorithm — базовый класс алгоритмов
    • 4. FilterBase — базовый класс фильтров
    • 5. Система расширений (extensions)
  • Организация исхожного кода алгоритмов
  • Организация фильтров
  • Вспомогательные скрипты
  • Система автоматизации
  • Паттерны проектирования
• API Reference
  • blinddeconv.processing.core
    • Класс Processing
    • Функция merge
    • Функция show_from_table
  • blinddeconv.processing.utils
    • Класс Image
    • Утилитарные функции
  • blinddeconv.processing.metrics
  • blinddeconv.algorithms.base
    • Класс DeconvolutionAlgorithm (ABC)
    • Собственные реализации
  • blinddeconv.filters
    • Класс FilterBase (ABC)
    • blinddeconv.filters.blur
    • blinddeconv.filters.noise
    • blinddeconv.filters.smooth
    • blinddeconv.filters.distributions
  • blinddeconv.processing.extensions
    • Класс ProcessingExtension (ABC)
    • Класс HyperparameterOptimizer
    • Класс ParetoFrontAnalyzer
    • Вспомогательные типы
  • blinddeconv.scripts
    • Класс DatasetGenerator
    • Класс KernelGenerator
  • run.py — программный API
    • load_config(config_path) → dict
    • validate_config(config) → List[str]
    • run_pipeline(config, output_dir=None, generate_report=False, dry_run=False) → dict
    • create_algorithm(algo_config) → DeconvolutionAlgorithm
    • create_filter(filter_config) → FilterBase
    • Реестры

Теория методов

• Теоретические основы
  • Планируемые материалы

Автодокументация модулей

• src
  • blinddeconv package
    • Subpackages
      • blinddeconv.algorithms package
      • blinddeconv.filters package
      • blinddeconv.output package
      • blinddeconv.processing package
      • blinddeconv.scripts package
    • Module contents
      • Processing

Быстрый старт

from blinddeconv.processing import Processing

proc = Processing(images_folder="images/original", color=False)
proc.read_all()
proc.show()

Индексы

• Состав модуля — Индекс модулей

• Алфавитный указатель — Алфавитный индекс

• Поиск — Поиск