PalletDataGenerator
User Guide
Installation Guide
π System Requirements
Recommended Versions (Tested & Optimized)
Minimum Requirements
π¦ Installation Methods
Method 1: PyPI Installation (Recommended)
Method 2: Development Installation
Method 3: Using the Built-in Setup Command
π¨ Blender Setup
Installing Blender
macOS
Linux (Ubuntu/Debian)
Windows
Verifying Blender Installation
π§ Virtual Environment Setup
Creating a Virtual Environment
Activating the Virtual Environment
Linux/macOS
Windows
Installing Dependencies
π§ͺ Verification
Quick Test
Blender Integration Test
CLI Test
π Troubleshooting
Common Issues
1. Python Version Compatibility
2. Blender Python Path Issues
3. GPU Issues
4. Import Errors
Platform-Specific Issues
macOS
Linux
Windows
π Next Steps
π Getting Help
Quick Start Guide
πββοΈ 5-Minute Quick Start
Step 1: Create Virtual Environment
Step 2: Prepare Your Blender Scene
Step 3: Generate Your First Dataset
With Blender (Recommended)
Direct Python (Limited)
Step 4: Check Your Results
π― Common Use Cases
Single Pallet Scene
Warehouse Environment
With Custom Configuration
π Understanding the Output
Directory Structure
Annotation Formats
YOLO Format
COCO Format
π§ CLI Command Reference
Basic Commands
Generation Options
π¨ Blender Integration
Scene Setup Requirements
Launch Commands
Environment Variables
π¨ Troubleshooting Quick Fixes
Common Issues
1. βNo pallet objects foundβ
2. βModule not foundβ errors
3. GPU not detected
4. Empty output directory
π Performance Tips
Speed Optimization
Quality Optimization
π― Next Steps
π‘ Pro Tips
Keypoints Generation Feature
Overview
Keypoints Layout
Configuration
Output Format
Keypoints Labels (YOLO Format)
Example Keypoints File
Analysis Images
Usage Example
Face Detection
Visibility Detection
3D Debug Visualization
Debug Output Structure
Coordinate Files
Interactive HTML Figures
Debug Images
Using Debug 3D Features
Interactive HTML Visualization
Coordinate Analysis
Example Usage
Integration with Existing Features
Troubleshooting
No keypoints generated
All keypoints marked as hidden
Keypoints in wrong positions
Advanced Configuration
API Reference
palletdatagenerator
palletdatagenerator package
Subpackages
palletdatagenerator.modes package
Submodules
palletdatagenerator.blender_runner module
palletdatagenerator.cli module
palletdatagenerator.config module
palletdatagenerator.generator module
palletdatagenerator.utils module
Module contents
PalletDataGenerator
DefaultConfig
setup_logging()
PalletDataGenerator
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
L
|
M
|
P
|
R
|
S
|
U
|
V
|
W
_
__getattr__() (palletdatagenerator.config.DefaultConfig method)
(palletdatagenerator.DefaultConfig method)
__init__() (palletdatagenerator.blender_runner.BlenderEnvironmentManager method)
(palletdatagenerator.config.DefaultConfig method)
(palletdatagenerator.DefaultConfig method)
(palletdatagenerator.generator.PalletDataGenerator method)
(palletdatagenerator.modes.base_generator.BaseGenerator method)
(palletdatagenerator.modes.single_pallet.SinglePalletMode method)
(palletdatagenerator.modes.warehouse.WarehouseMode method)
(palletdatagenerator.PalletDataGenerator method)
(palletdatagenerator.utils.ProgressTracker method)
__setattr__() (palletdatagenerator.config.DefaultConfig method)
(palletdatagenerator.DefaultConfig method)
A
apply_initial_transform() (palletdatagenerator.modes.single_pallet.SinglePalletMode method)
apply_pallet_movement() (palletdatagenerator.modes.single_pallet.SinglePalletMode method)
apply_random_background() (in module palletdatagenerator.blender_runner)
ATTACHED_GROUP_PREFIX (palletdatagenerator.modes.single_pallet.SinglePalletMode attribute)
auto_expose_frame() (palletdatagenerator.modes.base_generator.BaseGenerator method)
(palletdatagenerator.modes.single_pallet.SinglePalletMode method)
B
BaseGenerator (class in palletdatagenerator.modes.base_generator)
bbox_3d_oriented() (palletdatagenerator.modes.base_generator.BaseGenerator method)
BlenderEnvironmentManager (class in palletdatagenerator.blender_runner)
build_folders() (in module palletdatagenerator.generator)
C
calculate_face_normal() (palletdatagenerator.modes.base_generator.BaseGenerator method)
check_2d_middle_view() (palletdatagenerator.modes.base_generator.BaseGenerator method)
check_2d_surface_quality() (palletdatagenerator.modes.base_generator.BaseGenerator method)
check_face_behind_primary() (palletdatagenerator.modes.base_generator.BaseGenerator method)
check_faces_adjacent() (palletdatagenerator.modes.base_generator.BaseGenerator method)
check_geometric_adjacency_only() (palletdatagenerator.modes.base_generator.BaseGenerator method)
check_keypoint_visibility() (palletdatagenerator.modes.base_generator.BaseGenerator method)
cleanup_generated_boxes() (palletdatagenerator.modes.warehouse.WarehouseMode method)
configure_render() (in module palletdatagenerator.generator)
(palletdatagenerator.modes.base_generator.BaseGenerator method)
create_3d_debug_visualization() (palletdatagenerator.modes.base_generator.BaseGenerator method)
create_3d_debug_visualization_with_faces() (palletdatagenerator.modes.base_generator.BaseGenerator method)
create_analysis_image_multi() (in module palletdatagenerator.generator)
(palletdatagenerator.modes.base_generator.BaseGenerator method)
create_dataset_manifest() (in module palletdatagenerator.utils)
create_floor_plane() (palletdatagenerator.modes.base_generator.BaseGenerator method)
create_interactive_3d_figure() (palletdatagenerator.modes.base_generator.BaseGenerator method)
create_parser() (in module palletdatagenerator.cli)
create_random_lights() (palletdatagenerator.modes.base_generator.BaseGenerator method)
(palletdatagenerator.modes.single_pallet.SinglePalletMode method)
D
DefaultConfig (class in palletdatagenerator)
(class in palletdatagenerator.config)
detect_faces_in_scene() (palletdatagenerator.modes.base_generator.BaseGenerator method)
detect_overlapping_keypoints() (palletdatagenerator.modes.base_generator.BaseGenerator method)
draw_3d_bbox_edges() (in module palletdatagenerator.generator)
(palletdatagenerator.modes.base_generator.BaseGenerator method)
draw_overlapping_keypoint_circles() (palletdatagenerator.modes.base_generator.BaseGenerator method)
draw_overlapping_keypoint_labels() (palletdatagenerator.modes.base_generator.BaseGenerator method)
draw_single_keypoint_labels() (palletdatagenerator.modes.base_generator.BaseGenerator method)
duplicate_pallets_if_needed() (palletdatagenerator.modes.single_pallet.SinglePalletMode method)
E
enable_gpu() (in module palletdatagenerator.generator)
ensure() (in module palletdatagenerator.generator)
ensure_dependencies() (in module palletdatagenerator.generator)
ensure_directory() (in module palletdatagenerator.utils)
F
filter_side_faces() (palletdatagenerator.modes.base_generator.BaseGenerator method)
find_blender_executable() (in module palletdatagenerator.cli)
find_nearest_pallet() (palletdatagenerator.modes.warehouse.WarehouseMode method)
find_pallet_box_relationships() (palletdatagenerator.modes.warehouse.WarehouseMode method)
find_warehouse_objects() (palletdatagenerator.modes.warehouse.WarehouseMode method)
finish() (palletdatagenerator.utils.ProgressTracker method)
format_file_size() (in module palletdatagenerator.utils)
G
generate() (palletdatagenerator.generator.PalletDataGenerator method)
(palletdatagenerator.PalletDataGenerator method)
generate_face_2d_boxes() (palletdatagenerator.modes.base_generator.BaseGenerator method)
generate_face_3d_coordinates() (palletdatagenerator.modes.base_generator.BaseGenerator method)
generate_face_keypoints() (palletdatagenerator.modes.base_generator.BaseGenerator method)
generate_frames() (palletdatagenerator.modes.single_pallet.SinglePalletMode method)
(palletdatagenerator.modes.warehouse.WarehouseMode method)
generate_keypoints_for_frame() (palletdatagenerator.modes.base_generator.BaseGenerator method)
generate_pallet_box_group() (palletdatagenerator.modes.warehouse.WarehouseMode method)
generate_warehouse_path() (palletdatagenerator.modes.warehouse.WarehouseMode method)
get() (palletdatagenerator.config.DefaultConfig method)
(palletdatagenerator.DefaultConfig method)
get_all_faces_from_bbox() (palletdatagenerator.modes.base_generator.BaseGenerator method)
get_bbox_2d_accurate() (palletdatagenerator.modes.base_generator.BaseGenerator method)
get_blender_version() (in module palletdatagenerator.utils)
get_detections() (palletdatagenerator.modes.single_pallet.SinglePalletMode method)
get_next_batch_folder() (in module palletdatagenerator.config)
get_scene_info() (palletdatagenerator.blender_runner.BlenderEnvironmentManager method)
get_system_info() (in module palletdatagenerator.utils)
get_visible_pallets() (palletdatagenerator.modes.warehouse.WarehouseMode method)
H
handle_attached_boxes() (palletdatagenerator.modes.single_pallet.SinglePalletMode method)
hole_bboxes_3d() (palletdatagenerator.modes.base_generator.BaseGenerator method)
L
load_config() (in module palletdatagenerator.utils)
M
main() (in module palletdatagenerator.cli)
main_single_pallet() (in module palletdatagenerator.generator)
main_warehouse() (in module palletdatagenerator.generator)
module
palletdatagenerator
palletdatagenerator.blender_runner
palletdatagenerator.cli
palletdatagenerator.config
palletdatagenerator.generator
palletdatagenerator.modes
palletdatagenerator.modes.base_generator
palletdatagenerator.modes.single_pallet
palletdatagenerator.modes.warehouse
palletdatagenerator.utils
P
palletdatagenerator
module
PalletDataGenerator (class in palletdatagenerator)
(class in palletdatagenerator.generator)
palletdatagenerator.blender_runner
module
palletdatagenerator.cli
module
palletdatagenerator.config
module
palletdatagenerator.generator
module
palletdatagenerator.modes
module
palletdatagenerator.modes.base_generator
module
palletdatagenerator.modes.single_pallet
module
palletdatagenerator.modes.warehouse
module
palletdatagenerator.utils
module
position_camera_for_side_face() (palletdatagenerator.modes.single_pallet.SinglePalletMode method)
position_camera_on_path() (palletdatagenerator.modes.warehouse.WarehouseMode method)
position_pallets() (palletdatagenerator.modes.single_pallet.SinglePalletMode method)
prepare_pallets() (palletdatagenerator.modes.single_pallet.SinglePalletMode method)
ProgressTracker (class in palletdatagenerator.utils)
project_holes_and_write_labels() (palletdatagenerator.modes.single_pallet.SinglePalletMode method)
project_points() (palletdatagenerator.modes.base_generator.BaseGenerator method)
project_points_accurate() (in module palletdatagenerator.generator)
(palletdatagenerator.modes.base_generator.BaseGenerator method)
R
randomize_lighting() (palletdatagenerator.modes.warehouse.WarehouseMode method)
randomize_object_material() (palletdatagenerator.modes.base_generator.BaseGenerator method)
randomize_scene_objects() (palletdatagenerator.modes.warehouse.WarehouseMode method)
restore_scene_objects() (palletdatagenerator.modes.warehouse.WarehouseMode method)
run_in_blender() (in module palletdatagenerator.cli)
run_with_blender_args() (in module palletdatagenerator.blender_runner)
S
save_config() (in module palletdatagenerator.utils)
save_final_outputs() (palletdatagenerator.modes.single_pallet.SinglePalletMode method)
save_frame() (palletdatagenerator.modes.single_pallet.SinglePalletMode method)
save_generated_scene() (palletdatagenerator.modes.single_pallet.SinglePalletMode method)
(palletdatagenerator.modes.warehouse.WarehouseMode method)
save_keypoints_labels() (palletdatagenerator.modes.base_generator.BaseGenerator method)
save_warehouse_frame_outputs() (palletdatagenerator.modes.warehouse.WarehouseMode method)
select_faces_by_camera_proximity() (palletdatagenerator.modes.base_generator.BaseGenerator method)
set_random_seed() (in module palletdatagenerator.utils)
setup_background_images() (in module palletdatagenerator.blender_runner)
setup_blender_preferences() (palletdatagenerator.blender_runner.BlenderEnvironmentManager method)
setup_compositor_nodes() (in module palletdatagenerator.generator)
(palletdatagenerator.modes.base_generator.BaseGenerator method)
setup_environment() (palletdatagenerator.modes.base_generator.BaseGenerator method)
setup_folders() (palletdatagenerator.modes.base_generator.BaseGenerator method)
setup_lighting() (palletdatagenerator.modes.single_pallet.SinglePalletMode method)
setup_logging() (in module palletdatagenerator)
(in module palletdatagenerator.utils)
setup_random_background() (palletdatagenerator.modes.base_generator.BaseGenerator method)
SinglePalletMode (class in palletdatagenerator.modes.single_pallet)
start() (palletdatagenerator.utils.ProgressTracker method)
U
update() (palletdatagenerator.config.DefaultConfig method)
(palletdatagenerator.DefaultConfig method)
(palletdatagenerator.utils.ProgressTracker method)
V
validate_blender_environment() (in module palletdatagenerator.utils)
(palletdatagenerator.blender_runner.BlenderEnvironmentManager method)
verify_dataset_integrity() (in module palletdatagenerator.utils)
W
WarehouseMode (class in palletdatagenerator.modes.warehouse)
write_warehouse_annotations() (palletdatagenerator.modes.warehouse.WarehouseMode method)