{"id":31791245,"url":"https://github.com/mfdeveloper/surface_reconstruction_python","last_synced_at":"2025-10-10T16:53:12.266Z","repository":{"id":57472483,"uuid":"345758095","full_name":"mfdeveloper/surface_reconstruction_python","owner":"mfdeveloper","description":"Import a point cloud file and perform poisson 3D surface reconstruction algorithm, integrated with third-party libraries (e.g. open3d, pymeshlab...)","archived":false,"fork":false,"pushed_at":"2021-03-23T18:21:36.000Z","size":935,"stargazers_count":46,"open_issues_count":0,"forks_count":6,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-25T04:42:39.453Z","etag":null,"topics":["3d-graphics","open3d-python","pymeshlab","python","python3d","surface-reconstruction"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/surface-reconstruction","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mfdeveloper.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-03-08T18:38:59.000Z","updated_at":"2025-09-04T07:24:43.000Z","dependencies_parsed_at":"2022-09-26T17:40:41.367Z","dependency_job_id":null,"html_url":"https://github.com/mfdeveloper/surface_reconstruction_python","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/mfdeveloper/surface_reconstruction_python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfdeveloper%2Fsurface_reconstruction_python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfdeveloper%2Fsurface_reconstruction_python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfdeveloper%2Fsurface_reconstruction_python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfdeveloper%2Fsurface_reconstruction_python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mfdeveloper","download_url":"https://codeload.github.com/mfdeveloper/surface_reconstruction_python/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfdeveloper%2Fsurface_reconstruction_python/sbom","scorecard":{"id":638723,"data":{"date":"2025-08-11","repo":{"name":"github.com/mfdeveloper/surface_reconstruction_python","commit":"d0632b14ae320f918f19c4d51b3943cbe8f403ae"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 0/7 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":5,"reason":"5 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2025-49 / GHSA-5rjg-fvgr-3xxf","Warn: Project is vulnerable to: GHSA-cx63-2mw6-8hw5","Warn: Project is vulnerable to: PYSEC-2022-43012 / GHSA-r9hx-vwmv-q579","Warn: Project is vulnerable to: GHSA-g7vv-2v7x-gj9p","Warn: Project is vulnerable to: PYSEC-2022-43017 / GHSA-qwmp-2cf2-g9g6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-21T10:02:26.203Z","repository_id":57472483,"created_at":"2025-08-21T10:02:26.203Z","updated_at":"2025-08-21T10:02:26.203Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279004684,"owners_count":26083751,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["3d-graphics","open3d-python","pymeshlab","python","python3d","surface-reconstruction"],"created_at":"2025-10-10T16:52:36.261Z","updated_at":"2025-10-10T16:53:12.259Z","avatar_url":"https://github.com/mfdeveloper.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Poisson Surface Reconstruction: 3D point cloud\r\n\r\nImport a point cloud file and perform poisson 3D surface reconstruction algorithm, \r\nintegrated with third-party libraries like [open3d](http://www.open3d.org/docs/release/tutorial/geometry/surface_reconstruction.html?highlight=surface%20reconstruction#Poisson-surface-reconstruction) and [pymeshlab](https://github.com/cnr-isti-vclab/PyMeshLab)\r\n\r\n\r\n## Dependencies\r\n\r\n- [python 3](https://www.python.org/downloads/) \u003c= *3.8.x*\r\n  \u003e **Recommended:** Use [pyenv](https://github.com/pyenv/pyenv) to install and manage Python versions\r\n- [numpy](https://numpy.org) \u003e= *1.20*\r\n- [open3d](http://www.open3d.org) \u003e= *0.12*\r\n- [pymeshlab](https://github.com/cnr-isti-vclab/PyMeshLab) \u003e= *0.2*\r\n\r\n\r\n## Development dependencies\r\n\r\n- [setuptools](https://pypi.org/project/setuptools): For installation via `setup.py`\r\n- [setuptools-scm](https://pypi.org/project/setuptools-scm): To generate version numbers from **git tags**\r\n- [wheel](https://pypi.org/project/wheel/): Built packages `.whl` to install packages with PIP \r\n- [twine](https://pypi.org/project/twine): Publish packages to https://pypi.org\r\n- [tqdm](https://pypi.org/project/tqdm): CLI progressbar when publish a package\r\n\r\n## Development guide\r\n\r\nFor local installation and develop new features for this package, follow the steps below:\r\n\r\n\r\n### Windows\r\n\r\n\u003e Run unassigned powershell scripts on Windows requires change your execution policy with `Set-ExecutionPolicy` to `AllSigned`, or `Bypass -Scope Process`. \r\n\r\n\u003eSee: [Execution Policies](https://docs.microsoft.com/pt-br/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.1)\r\n\r\nRun the script `setup.ps1` with [powershell](https://docs.microsoft.com/pt-pt/powershell/scripting/overview?view=powershell-7.1)\r\n\r\n```powershell\r\n# Default virtualenv folder is \"venv\"\r\n.\\setup.ps1\r\n\r\n# Optionally, pass a custom virtualenv folder\r\n.\\setup.ps1 -VirtualEnvFolder myenv\r\n```\r\n\r\nIf you wish run just an specific function from `setup.ps1` (e.g. `Install-Python`), execute:\r\n\r\n```powershell\r\npowershell -command \"\u0026 { . .\\setup.ps1 'venv' -Execute 0; Install-Python }\"\r\n```\r\n\r\n### Unix systems (Comming soon)\r\n\r\n```bash\r\n# Default virtualenv folder is \"venv\"\r\n./setup.sh\r\n\r\n# Optionally, pass a custom virtual enviroment folder\r\n./setup.sh --virtual-env-folder myenv\r\n```\r\n\r\nFor more detailed installation, see the Wiki pages in: [Installation Development](https://github.com/mfdeveloper/surface_reconstruction_python/wiki/Installation-Details)\r\n\r\n## Install this package\r\n\r\nQuick way:\r\n\r\n```bash\r\npip install surface_reconstruction\r\n```\r\n\r\nOr clone this repository and build the `.whl` file from the project root:\r\n\r\n```bash\r\ncd [your-project-root]\r\n\r\n# Build the .whl package file\r\npython -m build --sdist --wheel .\r\n\r\n# Install locally from the .whl file\r\n# Where: x.x.x is the generated version from git tag\r\npip install dist/surface_reconstruction-x.x.x-py3-none-any.whl\r\n```\r\n\u003e For more detailed, see the Wiki pages in: [Generate package](https://github.com/mfdeveloper/surface_reconstruction_python/wiki/Generate-package)\r\n\r\n\r\n### Run the unit tests\r\n\r\n```bash\r\n# Run all tests of the module \"surface_reconstruction_test`\r\npython -m unittest tests/surface_reconstruction_test.py\r\n```\r\n\r\n## Usage\r\n\r\nImport a `.ply` file with point cloud vertices, and generate the mesh file\r\n\r\n```python\r\nfrom surface_reconstruction import SurfaceReconstruction\r\nimport os\r\n\r\n# Pass a method/library that contains a Poisson algorithm implementation\r\nsurface = SurfaceReconstruction(\r\n  method_type='open3d',\r\n  point_cloud_file=os.path.join('files', 'point_cloud.ply'),\r\n  output_file=os.path.join('files', 'terrain_mesh.ply')\r\n)\r\n\r\n# Call the method from the specific library, and export a mesh file\r\nsurface.poisson_mesh()\r\n```\r\n\r\nYou can pass custom filters/parameters for the specific library. This is important because \r\npoisson algorithm requires some pre-filters before to be applied (e.g **estimate normals** in the point cloud)\r\n\r\n```python\r\n# ...\r\nparameters = {\r\n  'estimate_normals': {\r\n    'fast_normal_computation': False,\r\n    'normals': (1, 3)\r\n  }\r\n}\r\n\r\n# Unpack the dictionary \"parameters\" as a **kwargs\r\nsurface.poisson_mesh(**{'filters': parameters})\r\n```\r\n\u003e **PS:** See the unittests inside **[tests](./tests)** folder for more usage examples\r\n\r\n# Extending: Add new libraries\r\n\r\nIs possible create and register custom strategies to allow others libraries (`Python`, `C++` bindings...)\r\n\r\n```python\r\nfrom surface_reconstruction import SurfaceStrategy, SurfaceReconstruction \r\n\r\n# Create a class that inherit from \"SurfaceStrategy\"\r\nclass MyCustomSurface(SurfaceStrategy):\r\n  \r\n      def __init__(self, my_custom_param: dict):\r\n        \"\"\"\r\n        Custom constructor with custom parameters\r\n        \"\"\"\r\n        super().__init__()\r\n  \r\n      def load_file(self, file_path: str):\r\n        \"\"\"\r\n        Custom load point cloud file implementation here\r\n        \"\"\"\r\n        pass\r\n\r\n    def poisson_mesh(self, save_file=True, **params: {}):\r\n      \"\"\"\r\n      Generate the mesh file with faces/triangles here\r\n      \"\"\"\r\n      pass\r\n\r\n# Register your custom strategy here\r\nSurfaceReconstruction.register_type(MyCustomSurface)\r\n\r\n\r\n# Pass a method/library that contains a Poisson algorithm implementation\r\nsurface = SurfaceReconstruction(\r\n  method_type='mycustom', # Don't pass the \"surface\" suffix\r\n  my_custom_param={'extra_config': 'some_value'},\r\n)\r\n\r\n# Call the method from the specific library, and export a mesh file\r\nsurface.poisson_mesh()\r\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmfdeveloper%2Fsurface_reconstruction_python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmfdeveloper%2Fsurface_reconstruction_python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmfdeveloper%2Fsurface_reconstruction_python/lists"}