Light Field Coding Toolkit

Contents

  • JPEG Pleno LFC Toolkit
    • Limitations
    • Installation & Setup
      • Prerequisites
      • Option 1: Docker Compose (Recommended)
      • Option 2: UV
      • Option 3: Python venv
    • Running Scripts
    • Docker: Building Codecs
      • Setup
      • Disabling Docker for Build
    • Configuration File
      • Aliases
    • Available Scripts
      • 1. Run All Scripts
      • 2. Format Conversion: PPM → YUV/PGX
      • 3. Codec Execution
        • Available Codecs
        • Decoded File Conversions
      • 4. Quality Metrics
        • Available Metrics
      • 5. Rate-Distortion Plots
      • 6. Quality Heatmaps
  • CLI Reference
    • Options
      • Configuration
      • Scripts
    • Running with Docker Compose
      • Codecs in private repositories
    • Running with UV
      • Run all scripts (both lines are equivalent)
      • Run a specific script (e.g., run codecs)
      • Override paths from the configuration file
      • Override the Light Fields list from the configuration file
      • Standalone commands
      • Help command
      • To run a script directly:
    • Running with venv
      • Main Pipeline
    • Individual scripts
  • LICENSE
  • NOTICES
    • Python Dependencies from uv.lock
      • Transitive Dependencies
  • API Reference
    • cli
      • main()
    • bundle
      • Submodules
        • bundle.combine_curves
        • bundle.rd_plot_from_bundle
    • codecwrappers
      • Submodules
        • codecwrappers.codec_wrapper
        • codecwrappers.jplm_wrapper
        • codecwrappers.x265_wrapper
    • codecrepos
      • Submodules
        • codecrepos.clone_progress
        • codecrepos.docker_builder
        • codecrepos.git_repository_cloner_and_builder
    • configuration
      • Submodules
        • configuration.configuration_reader
    • converters
      • Submodules
        • converters.ffmpeg
        • converters.lightfield_converter
        • converters.pgx_from_yuv
        • converters.png_from_ppm
        • converters.ppm_from_png
        • converters.ppm_from_yuv
        • converters.yuv_from_pgx
    • ctc
      • Submodules
        • ctc.download
        • ctc.lightfield_factory
        • ctc.lightfield_preprocessing
    • data_handlers
      • Submodules
        • data_handlers.encoding_orders
        • data_handlers.formatters
        • data_handlers.lightfield
    • file
      • Submodules
        • file.custom_json
        • file.pgx_handler
        • file.ppm_handler
    • performance
      • Subpackages
        • performance.auxiliary
      • Submodules
        • performance.execute_all
        • performance.measure_time_and_memory
        • performance.speedup_performance
        • performance.statistical_significance
    • quality
      • Subpackages
        • quality.bd_adjustment
      • Submodules
        • quality.bd_wrapper
        • quality.compound_metrics
        • quality.heatmap
        • quality.profile
        • quality.quality_tool_wrapper
        • quality.rd_curve
        • quality.rd_plot
        • quality.rd_result
        • quality.vmaf_tool_wrapper
    • generate_rd_plots
      • generate_rd_plots_for_lf_and_metric()
      • generate_rd_plots_for_lf()
      • create_json()
      • create_latex_tables()
      • main()
    • run_codecs
      • get_data_from_preffix()
      • clone_and_build_repo()
      • create_codec_wrapper_instance()
      • process_codec_using_wrapper()
      • main()
    • execute_all
      • main()
    • compare_execution_logs
      • load_json()
      • compare_json_files()
    • compute_quality_metrics
      • get_wrapper_instances()
      • get_metrics_bpps()
      • main()
    • equivalence_check
      • get_rate_string()
      • md5_from_logs()
      • main()
    • generate_11x11_ppm_for_lenslets
      • get_lenslet_lf()
      • get_raw_lenslet_lf_ppm()
      • load_paths_from_json()
      • copy_and_rename_files()
      • main()
    • generate_heatmaps
      • main()
    • organize_encoded_bitstreams
      • log_bundle_copy()
      • organize_encoded_bitstreams()
      • main()
    • yuv_and_pgx_from_ppm
      • checksum_conversion()
      • get_output_log()
      • download_lightfield_if_needed()
      • convert_lightfield_to_yuv_and_pgx()
      • main()
    • zip_log_files
      • main()
  • JSON Configurations
    • Codecs
      • Properties
        • [Required] ctc-codecs-declaration
    • Configuration
      • Properties
        • [Required] aliases
        • [Required] lightfields
        • [Optional] other-lightfield-configuration-files
        • [Optional] other-quality-metrics-configuration-files
        • [Required] raw_paths
        • [Optional] force_conversions
        • [Optional] remove_yuv_from_pgx_after_check
        • [Required] codecs
        • [Required] logs
        • [Required] rd_plots
        • Items of rd_plots
        • [Required] quality_heatmaps
        • [Optional] bd_reports
        • [Optional] bundled_bitstream_path
        • [Optional] rd_plots_from_bundle
        • [Optional] equivalence_check
        • [Optional] performance
        • Items of performance
        • [Optional] vmaf_executable_path
        • [Optional] x265_target_kbps_file
    • Example Codecs
      • Properties
        • [Required] example-codec-result
    • LightField Dataset
      • Properties
        • [Required] name
        • [Required] category
        • [Required] original-format
        • [Required] url
        • [Optional] target-rates
        • [Required] original-size
        • [Optional] pre-processing
        • [Required] encode-size
    • Quality
      • Properties
        • [Required] metrics
        • Items of metrics
        • [Required] bd-adjusted-metrics
        • Items of bd-adjusted-metrics
        • [Required] weighted-metrics
        • Items of weighted-metrics
        • [Required] wrappers
        • Items of wrappers
Light Field Coding Toolkit
  • API Reference
  • View page source

API Reference

  • cli
  • bundle
  • codecwrappers
  • codecrepos
  • configuration
  • converters
  • ctc
  • data_handlers
  • file
  • performance
  • quality
  • generate_rd_plots
  • run_codecs
  • execute_all
  • compare_execution_logs
  • compute_quality_metrics
  • equivalence_check
  • generate_11x11_ppm_for_lenslets
  • generate_heatmaps
  • organize_encoded_bitstreams
  • yuv_and_pgx_from_ppm
  • zip_log_files
Previous Next

© Copyright JPEG Pleno Light Field Coding Toolkit (LFC Toolkit) Project Authors. All rights reserved. 2026..

Built with Sphinx using a theme provided by Read the Docs.