Data

Tools

Indexes

Applications

Experiments

Open Source Science

xrfeitoria

OpenXRLab Synthetic Data Rendering Toolbox

https://github.com/openxrlab/xrfeitoria

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.5%) to scientific vocabulary

Keywords

blender photorealistic-rendering python rendering synthetic-data unreal-engine
Last synced: 6 months ago · JSON representation ·

Repository

OpenXRLab Synthetic Data Rendering Toolbox

Basic Info
Statistics
  • Stars: 283
  • Watchers: 13
  • Forks: 21
  • Open Issues: 7
  • Releases: 8
Topics
blender photorealistic-rendering python rendering synthetic-data unreal-engine
Created over 2 years ago · Last pushed 8 months ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md


XRFeitoria


[![Documentation](https://readthedocs.org/projects/xrfeitoria/badge/?version=latest)](https://xrfeitoria.readthedocs.io/en/latest/?badge=latest) [![actions](https://github.com/openxrlab/xrfeitoria/actions/workflows/lint.yml/badge.svg)](https://github.com/openxrlab/xrfeitoria/actions) [![PyPI](https://img.shields.io/pypi/v/xrfeitoria)](https://pypi.org/project/xrfeitoria/) [![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)

Introduction

XRFeitoria is a rendering toolbox for generating synthetic data photorealistic with ground-truth annotations. It is a part of the OpenXRLab project.

https://github.com/openxrlab/xrfeitoria/assets/35397764/1e83bcd4-ae00-4c20-8188-3fe73f7c9c01

Major Features

  • Support rendering photorealistic images with ground-truth annotations.
  • Support multiple engine backends, including Unreal Engine and Blender.
  • Support assets/camera management, including import, place, export, and delete.
  • Support a CLI tool to render images from a mesh file.

Installation

bash pip install xrfeitoria

Requirements

  • Python >= 3.8
  • (optional) Unreal Engine >= 5.1
    • [x] Windows
    • [x] Linux
    • [ ] MacOS
  • (optional) Blender >= 3.0
    • [x] Windows
    • [x] Linux
    • [x] MacOS

Get-Started

CLI

```bash xf-render --help

render a mesh file

xf-render {mesh_file}

for example

wget https://graphics.stanford.edu/~mdfisher/Data/Meshes/bunny.obj xf-render bunny.obj ```

https://github.com/openxrlab/xrfeitoria/assets/35397764/430a7264-9337-4327-838d-08e9a354c277

https://github.com/openxrlab/xrfeitoria/assets/35397764/9c029eb7-a8be-4d11-890e-b2499ff22caa

Documentation

The reference documentation is available on readthedocs.

Tutorials

There are several tutorials. You can read them here.

Sample codes

There are several samples. Please follow the instructions here.

Use plugins under development

Details can be found here.

If you want to publish plugins of your own, you can use the following command:

```powershell

install xrfeitoria first

cd xrfeitoria pip install .

build plugins for UE 5.1, UE 5.2, and UE 5.3 on Windows

python -m xrfeitoria.utils.publishplugins build-unreal ` -u "C:/Program Files/Epic Games/UE5.1/Engine/Binaries/Win64/UnrealEditor-Cmd.exe" -u "C:/Program Files/Epic Games/UE_5.2/Engine/Binaries/Win64/UnrealEditor-Cmd.exe" -u "C:/Program Files/Epic Games/UE_5.3/Engine/Binaries/Win64/UnrealEditor-Cmd.exe"

build plugins for Blender

python -m xrfeitoria.utils.publish_plugins build-blender ```

Frequently Asked Questions

Please refer to FAQ.

:rocket: Amazing Projects Using XRFeitoria

| Project | Teaser | Engine | | :---: | :---: | :---: | | SynBody: Synthetic Dataset with Layered Human Models for 3D Human Perception and Modeling | | Unreal Engine / Blender | | Zolly: Zoom Focal Length Correctly for Perspective-Distorted Human Mesh Reconstruction | | Blender | | SHERF: Generalizable Human NeRF from a Single Image | | Blender | | MatrixCity: A Large-scale City Dataset for City-scale Neural Rendering and Beyond | | Unreal Engine | | HumanLiff: Layer-wise 3D Human Generation with Diffusion Model | | Blender | | PrimDiffusion: Volumetric Primitives Diffusion for 3D Human Generation | | Blender | | WHAC: World-grounded Humans and Cameras | | Unreal Engine | | SMPLest-X: Ultimate Scaling for Expressive Human Pose and Shape Estimation | | Blender |

License

The license of our codebase is Apache-2.0. Note that this license only applies to code in our library, the dependencies of which are separate and individually licensed. We would like to pay tribute to open-source implementations to which we rely on. Please be aware that using the content of dependencies may affect the license of our codebase. Refer to LICENSE to view the full license.

Citation

If you find this project useful in your research, please consider cite:

bibtex @misc{xrfeitoria, title={OpenXRLab Synthetic Data Rendering Toolbox}, author={XRFeitoria Contributors}, howpublished = {\url{https://github.com/openxrlab/xrfeitoria}}, year={2023} }

Projects in OpenXRLab

  • XRPrimer: OpenXRLab foundational library for XR-related algorithms.
  • XRSLAM: OpenXRLab Visual-inertial SLAM Toolbox and Benchmark.
  • XRSfM: OpenXRLab Structure-from-Motion Toolbox and Benchmark.
  • XRLocalization: OpenXRLab Visual Localization Toolbox and Server.
  • XRMoCap: OpenXRLab Multi-view Motion Capture Toolbox and Benchmark.
  • XRMoGen: OpenXRLab Human Motion Generation Toolbox and Benchmark.
  • XRNeRF: OpenXRLab Neural Radiance Field (NeRF) Toolbox and Benchmark.
  • XRFeitoria: OpenXRLab Synthetic Data Rendering Toolbox.
  • XRViewer: OpenXRLab Data Visualization Toolbox.
  • XRTailor: OpenXRLab GPU Cloth Simulator.

Owner

  • Name: OpenXRLab
  • Login: openxrlab
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - name: "XRFeitoria Contributors"
title: "XRFeitoria: OpenXRLab Synthetic Data Rendering Toolbox"
date-released: 2023-09-11
url: "https://github.com/openxrlab/xrfeitoria"
license: Apache-2.0

GitHub Events

Total
  • Create event: 1
  • Release event: 1
  • Issues event: 6
  • Watch event: 48
  • Delete event: 1
  • Issue comment event: 11
  • Push event: 15
  • Pull request review event: 8
  • Pull request review comment event: 4
  • Pull request event: 4
  • Fork event: 5
Last Year
  • Create event: 1
  • Release event: 1
  • Issues event: 6
  • Watch event: 48
  • Delete event: 1
  • Issue comment event: 11
  • Push event: 15
  • Pull request review event: 8
  • Pull request review comment event: 4
  • Pull request event: 4
  • Fork event: 5

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 3
  • Total pull requests: 2
  • Average time to close issues: 8 minutes
  • Average time to close pull requests: 6 days
  • Total issue authors: 3
  • Total pull request authors: 2
  • Average comments per issue: 0.33
  • Average comments per pull request: 1.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 2
  • Average time to close issues: 8 minutes
  • Average time to close pull requests: 6 days
  • Issue authors: 3
  • Pull request authors: 2
  • Average comments per issue: 0.33
  • Average comments per pull request: 1.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • chuanfushen (2)
  • Andyen512 (2)
  • NielsRogge (1)
  • dnqf11 (1)
  • TingqiaoXu (1)
  • cjfcsjt (1)
  • Guo0323 (1)
  • 3Der1999 (1)
  • stupiding (1)
  • liubinyijia (1)
  • leizhu-angus (1)
  • Time-Lord12th (1)
Pull Request Authors
  • HaiyiMei (11)
  • iimmortall (1)
  • WYK96 (1)
  • jinnan-chen (1)
Top Labels
Issue Labels
Pull Request Labels
enhancement (4) bump:patch (3) documentation (2) bug (2) tag (1) bump:minor (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 39 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 7
  • Total maintainers: 3
pypi.org: xrfeitoria

OpenXRLab Synthetic Data Rendering Toolbox

  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 39 Last month
Rankings
Dependent packages count: 7.4%
Average: 38.3%
Dependent repos count: 69.1%
Maintainers (3)
yl-1993 openxrlab HaiyiMei
Last synced: 7 months ago

Dependencies

.github/workflows/lint.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/publish-to-pypi.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v1 composite
pyproject.toml pypi
  • astunparse ==1.6.3
  • fake-bpy-module-latest *
  • loguru <1
  • numpy >=1,<2
  • packaging >=23,<24
  • psutil >=5,<6
  • pydantic >=2,<3
  • rich >=13,<14
  • typer ==0.9.0
  • typing_extensions *
  • xrprimer ==0.7.1
samples/setup.py pypi
xrfeitoria/utils/setup.py pypi
tests/setup.py pypi