NICE Toolbox
  • Project Overview
  • Changelog
    • 0.2.2
    • 0.2.1
    • 0.2.0
    • 0.1.0
  • Installation
    • Docker
    • Prerequisites
      • Python 3.10
      • Conda
      • Cuda 11.8
      • FFmpeg
      • Git
      • On Windows: Microsoft Visual C++
      • On Windows: Turn developer mode on
      • On Windows: Make
    • Clone the repository
    • Makefile installation
      • On Linux
    • Additional notes
  • Getting started
    • 1. Machine-specific config
    • 2. Example dataset
    • 3. Check the dataset’s properties
    • 4. Add an experiment to run
    • 5. Run the NICE Toolbox
    • 6. Visualize the results
    • 7. Run the NICE Toolbox Evaluation
  • Tutorials
    • Include a dataset with a single camera view
      • 1. Create your machine-specific config
      • 2. Prepare the dataset
        • Folder structure
        • Dataset properties
        • Example
      • 3. Create a calibration file
        • Calibration toml file
        • Toml to npz file
      • 4. Define the experiment to run
      • 5. Run the toolbox
    • Include a dataset with multiple camera views
      • 1. Create your machine-specific config
      • 2. Prepare the multi-view dataset
        • Update the dataset properties
        • Example
      • 3. Create a multi-view calibration file
      • 4. Define the experiments and run the toolbox
    • Calibration conversion
    • Visualizations in rerun
      • Starting rerun
      • Visualizer config
      • Configuring component data display in rerun windows
        • Configuring algorithm display
        • Configuring appearance
      • Configuring rerun viewer and blueprint in rerun
    • NICE Toolbox Evaluation Overview
      • Table of Contents
      • Overview
      • Configuration Setup
        • Machine Specific Paths
        • Evaluation Config
      • Running the Evaluation
        • Step 1: Input selection
        • Step 2: Configure Metrics
        • Step 3: Run Evaluation
        • Step 4: Monitor Progress and check the results
      • Summary Generation
        • Customizing Summaries
        • Regenerating Summaries
      • Understanding Results
        • Output Structure
        • What is inside a single .npz file?
        • Result Files
      • Evaluation Results Wrapper (python)
    • Evaluation Results Wrapper Tutorial (python)
      • Table of Contents
      • Overview
      • Quick Start
      • Core Operations
        • Loading Results
        • Inspecting Data
        • Reset to Original View:
        • Querying / Filtering
        • Aggregation
        • Exporting Results
        • Chainable operations
      • Common Use Cases
        • Use Case 1: Compare Algorithms Across Cameras
        • Use Case 2: Multi-Statistic Summary for a Dataset
        • Use Case 3: Export Subset for External Analysis
        • Use Case 4: Identify Problematic Labels
      • Best Practices
        • Questions or Issues?
  • Wiki
    • Understanding the config files
      • Placeholders
      • Machine specifics
      • Run file
        • General properties
        • Choosing algorithms per component
        • Defining the experiments
        • Input and output files
      • Dataset properties
      • Detectors config
        • Method detectors
        • Feature detectors
      • Predictions mapping
      • Visualizer Config
        • Configuring Component Data Display in Rerun Windows
        • Configuring Rerun Viewer and Blueprint in Rerun
    • Understanding the Calibration files
    • Components
      • Output files
        • Numpy arrays
        • Data description
        • Python code
      • Body joints
      • Hand joints
      • Face landmarks
      • Gaze Individual
      • Gaze Multiview
      • Gaze Interaction
      • Kinematics
      • Proximity
      • Emotion Detection
        • Detector Configuration
      • Head Orientation
    • Algorithms
      • HrNet & VitPose
      • Multiview_eth_xgaze
      • Py-FEAT (Facial Expression Analysis Toolbox)
        • Face Detection & Pose Estimation
        • Action Unit (AU) Detection
        • Emotion Detection
        • Identity Detection
      • SPIGA (Shape Preserving Facial Landmarks with Graph Attention)
        • Landmark Localization & Head Pose Estimation
    • Evaluation Metrics
      • Grouping of Metrics - Metric Types
      • Available Metric Types
        • Point Cloud Metrics
        • Keypoint Metrics
        • Categorical Metrics
  • API
    • nicetoolbox.configs
      • nicetoolbox.configs.config_handler
        • nicetoolbox.configs.config_handler.load_config
        • nicetoolbox.configs.config_handler.load_validated_config_raw
        • nicetoolbox.configs.config_handler.ConfigValidationError
        • ConfigValidationError
        • load_config()
        • load_validated_config_raw()
      • nicetoolbox.configs.config_loader
        • nicetoolbox.configs.config_loader.ConfigLoader
        • ConfigLoader
      • nicetoolbox.configs.placeholders
        • nicetoolbox.configs.placeholders.get_placeholders
        • nicetoolbox.configs.placeholders.get_placeholders_str
        • nicetoolbox.configs.placeholders.resolve_placeholders
        • nicetoolbox.configs.placeholders.resolve_placeholders_dict_mut
        • nicetoolbox.configs.placeholders.resolve_placeholders_str
        • nicetoolbox.configs.placeholders.resolve_placeholders_str_strict
        • get_placeholders()
        • get_placeholders_str()
        • resolve_placeholders()
        • resolve_placeholders_dict_mut()
        • resolve_placeholders_str()
        • resolve_placeholders_str_strict()
      • nicetoolbox.configs.utils
        • nicetoolbox.configs.utils.default_auto_placeholders
        • nicetoolbox.configs.utils.default_runtime_placeholders
        • nicetoolbox.configs.utils.dict_to_model
        • nicetoolbox.configs.utils.get_latest_expirement_config_path
        • nicetoolbox.configs.utils.keys_collision_dict
        • nicetoolbox.configs.utils.merge_dicts
        • nicetoolbox.configs.utils.model_to_dict
        • dict_to_model()
        • keys_collision_dict()
        • merge_dicts()
        • model_to_dict()
    • nicetoolbox.detectors
      • nicetoolbox.detectors.config_handler
        • nicetoolbox.detectors.config_handler.add_to_filename
        • nicetoolbox.detectors.config_handler.flatten_dict
        • nicetoolbox.detectors.config_handler.flatten_list
        • nicetoolbox.detectors.config_handler.Configuration
      • nicetoolbox.detectors.data
        • nicetoolbox.detectors.data.Data
        • Data
      • nicetoolbox.detectors.feature_detectors
        • nicetoolbox.detectors.feature_detectors.base_feature
        • nicetoolbox.detectors.feature_detectors.gaze_interaction
        • nicetoolbox.detectors.feature_detectors.gaze_multiview
        • nicetoolbox.detectors.feature_detectors.kinematics
        • nicetoolbox.detectors.feature_detectors.leaning
        • nicetoolbox.detectors.feature_detectors.proximity
      • nicetoolbox.detectors.in_out
        • nicetoolbox.detectors.in_out.IO
        • IO
      • nicetoolbox.detectors.main
        • nicetoolbox.detectors.main.entry_point
        • nicetoolbox.detectors.main.main
        • entry_point()
        • main()
      • nicetoolbox.detectors.method_detectors
        • nicetoolbox.detectors.method_detectors.base_detector
        • nicetoolbox.detectors.method_detectors.body_joints
        • nicetoolbox.detectors.method_detectors.emotion_individual
        • nicetoolbox.detectors.method_detectors.filters
        • nicetoolbox.detectors.method_detectors.gaze_individual
        • nicetoolbox.detectors.method_detectors.head_orientation
    • nicetoolbox.evaluation
      • nicetoolbox.evaluation.auto_summaries
        • nicetoolbox.evaluation.auto_summaries.create_auto_summaries
        • create_auto_summaries()
      • nicetoolbox.evaluation.config_handler
        • nicetoolbox.evaluation.config_handler.ConfigHandler
      • nicetoolbox.evaluation.config_schema
        • nicetoolbox.evaluation.config_schema.FinalEvaluationConfig
        • FinalEvaluationConfig
      • nicetoolbox.evaluation.data
        • nicetoolbox.evaluation.data.dataset
        • nicetoolbox.evaluation.data.discovery
        • nicetoolbox.evaluation.data.loaders
      • nicetoolbox.evaluation.engine
        • nicetoolbox.evaluation.engine.EvaluationEngine
      • nicetoolbox.evaluation.in_out
        • nicetoolbox.evaluation.in_out.IO
        • IO
      • nicetoolbox.evaluation.main
        • nicetoolbox.evaluation.main.entry_point
        • nicetoolbox.evaluation.main.main_evaluation_run
        • entry_point()
        • main_evaluation_run()
      • nicetoolbox.evaluation.metrics
        • nicetoolbox.evaluation.metrics.base_metric
        • nicetoolbox.evaluation.metrics.categorical
        • nicetoolbox.evaluation.metrics.evaluate
        • nicetoolbox.evaluation.metrics.keypoint
        • nicetoolbox.evaluation.metrics.point_cloud
        • nicetoolbox.evaluation.metrics.results_schema
      • nicetoolbox.evaluation.results_wrapper
        • nicetoolbox.evaluation.results_wrapper.core
        • nicetoolbox.evaluation.results_wrapper.initialize
      • nicetoolbox.evaluation.runner
        • nicetoolbox.evaluation.runner.DatasetRunner
        • DatasetRunner
    • nicetoolbox.utils
      • nicetoolbox.utils.calibration_gui
        • nicetoolbox.utils.calibration_gui.calib_io
        • nicetoolbox.utils.calibration_gui.calibration_converter
        • nicetoolbox.utils.calibration_gui.constants
        • nicetoolbox.utils.calibration_gui.initialization
        • nicetoolbox.utils.calibration_gui.make_forms
        • nicetoolbox.utils.calibration_gui.matrix_utils
      • nicetoolbox.utils.check_and_exception
        • nicetoolbox.utils.check_and_exception.check_options
        • nicetoolbox.utils.check_and_exception.check_token_in_filepath
        • nicetoolbox.utils.check_and_exception.check_value_bounds
        • nicetoolbox.utils.check_and_exception.check_zeros
        • nicetoolbox.utils.check_and_exception.error_log_and_raise
        • nicetoolbox.utils.check_and_exception.file_exists
        • check_options()
        • check_token_in_filepath()
        • check_value_bounds()
        • check_zeros()
        • error_log_and_raise()
        • file_exists()
      • nicetoolbox.utils.comparison
        • nicetoolbox.utils.comparison.compare_npz_files
        • nicetoolbox.utils.comparison.DifferentKeysError
        • nicetoolbox.utils.comparison.DifferentShapeError
        • nicetoolbox.utils.comparison.DifferentValuesError
        • DifferentKeysError
        • DifferentShapeError
        • DifferentValuesError
      • nicetoolbox.utils.config
        • nicetoolbox.utils.config.config_fill_auto
        • nicetoolbox.utils.config.config_fill_placeholders
        • nicetoolbox.utils.config.default
        • nicetoolbox.utils.config.save_config
        • config_fill_auto()
        • config_fill_placeholders()
        • save_config()
      • nicetoolbox.utils.error_handling
        • nicetoolbox.utils.error_handling.manage_error_scope
        • manage_error_scope()
      • nicetoolbox.utils.filehandling
        • nicetoolbox.utils.filehandling.find_npz_files
        • nicetoolbox.utils.filehandling.load_json_file
        • nicetoolbox.utils.filehandling.load_toml
        • nicetoolbox.utils.filehandling.read_npz_file
        • find_npz_files()
        • load_json_file()
        • load_toml()
        • read_npz_file()
      • nicetoolbox.utils.git_utils
        • nicetoolbox.utils.git_utils.try_get_toolbox_git_metadata
        • nicetoolbox.utils.git_utils.GitMetadata
        • GitMetadata
        • try_get_toolbox_git_metadata()
      • nicetoolbox.utils.in_out
        • nicetoolbox.utils.in_out.delete_files_into_list
        • nicetoolbox.utils.in_out.list_files_under_root
        • delete_files_into_list()
        • list_files_under_root()
      • nicetoolbox.utils.linear_algebra
        • nicetoolbox.utils.linear_algebra.distance_line_point
        • distance_line_point()
      • nicetoolbox.utils.logging_utils
        • nicetoolbox.utils.logging_utils.assert_and_log
        • nicetoolbox.utils.logging_utils.log_configs
        • nicetoolbox.utils.logging_utils.setup_custom_logging
        • nicetoolbox.utils.logging_utils.setup_logging
        • assert_and_log()
        • log_configs()
        • setup_custom_logging()
        • setup_logging()
      • nicetoolbox.utils.system
        • nicetoolbox.utils.system.detect_os_type
        • detect_os_type()
      • nicetoolbox.utils.to_csv
        • nicetoolbox.utils.to_csv.convert_npz_to_csv_files
        • nicetoolbox.utils.to_csv.results_to_csv
        • convert_npz_to_csv_files()
        • results_to_csv()
      • nicetoolbox.utils.triangulation
        • nicetoolbox.utils.triangulation.triangulate_stereo
        • nicetoolbox.utils.triangulation.undistort_points_pinhole
        • triangulate_stereo()
        • undistort_points_pinhole()
      • nicetoolbox.utils.video
        • nicetoolbox.utils.video.cut_length
        • nicetoolbox.utils.video.equal_splits_by_frames
        • nicetoolbox.utils.video.frames_to_video
        • nicetoolbox.utils.video.get_ffmpeg_input_string
        • nicetoolbox.utils.video.get_fps
        • nicetoolbox.utils.video.get_number_of_frames
        • nicetoolbox.utils.video.json_to_video_info
        • nicetoolbox.utils.video.probe_video
        • nicetoolbox.utils.video.read_segments_list_from_file
        • nicetoolbox.utils.video.remove_last_segment_from_file
        • nicetoolbox.utils.video.sequential2frame_number
        • nicetoolbox.utils.video.split_into_frames
        • nicetoolbox.utils.video.VideoInfo
        • VideoInfo
        • cut_length()
        • equal_splits_by_frames()
        • frames_to_video()
        • get_ffmpeg_input_string()
        • get_fps()
        • get_number_of_frames()
        • json_to_video_info()
        • probe_video()
        • read_segments_list_from_file()
        • remove_last_segment_from_file()
        • sequential2frame_number()
        • split_into_frames()
      • nicetoolbox.utils.visual_utils
        • nicetoolbox.utils.visual_utils.get_cam_para_studio
        • nicetoolbox.utils.visual_utils.load_calibration
        • nicetoolbox.utils.visual_utils.reproject_gaze_to_camera_view_vectorized
        • nicetoolbox.utils.visual_utils.return_2d_vector
        • nicetoolbox.utils.visual_utils.vector_to_pitchyaw
    • nicetoolbox.version
    • nicetoolbox.visual
      • nicetoolbox.visual.config_handler
        • nicetoolbox.visual.config_handler.Configuration
      • nicetoolbox.visual.in_out
        • nicetoolbox.visual.in_out.IO
      • nicetoolbox.visual.media
        • nicetoolbox.visual.media.viewer
NICE Toolbox
  • Search

© Copyright 2025, oslab.

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