plyfile

Welcome to the plyfile Python module, which provides a simple facility for reading and writing ASCII and binary PLY files.

The PLY format is documented elsewhere.

Table of Contents

• Installation
• Usage
  • Reading a PLY file
    • Faster reading via memory mapping
      • Case 1: elements with no list properties
      • Case 2: elements with list properties
  • Creating a PLY file
  • Miscellaneous
    • Comments
    • Getting a two-dimensional array from a list property
    • Instance mutability
    • Text-mode streams
• FAQ
  • How do I initialize a list property from a two-dimensional array?
  • Can I save a PLY file directly to sys.stdout?
  • Can I read a PLY file from sys.stdin?
• Design philosophy and rationale
  • Familiarity
  • Simplicity
  • Generality and interpretation issues
    • Comment placement
    • Element and property names
    • Property syntax
    • Header line endings
• Information for Developers
  • Source code repository
  • How to contribute code
  • General information
  • Contribution guidelines
  • Development environment setup
    • Installing PDM
    • Installing dependencies
  • Common actions
    • Running tests
      • Quick
      • More comprehensive
      • Full
    • Generating documentation
    • Running the linter
• Information for Project Maintainers
  • Merging into master
  • Making a new release
    • Pre-release checks
    • Increment the version
      • Select a new version
      • Update the version in pyproject.toml
      • Update CHANGELOG.md
      • Make the commit
      • Tag the commit
    • Publish the new version
    • Publish the code to GitHub
• API Reference
  • PlyData
    • PlyData.__init__()
    • PlyData.read()
    • PlyData.write()
    • PlyData.header
    • PlyData.__len__()
    • PlyData.__contains__()
    • PlyData.__getitem__()
  • PlyElement
    • PlyElement.__init__()
    • PlyElement.ply_property()
    • PlyElement.dtype()
    • PlyElement.describe()
    • PlyElement.__len__()
    • PlyElement.__contains__()
    • PlyElement.__getitem__()
    • PlyElement.__setitem__()
  • PlyProperty
    • PlyProperty.__init__()
    • PlyProperty.dtype()
  • PlyListProperty
    • PlyListProperty.__init__()
    • PlyListProperty.dtype()
    • PlyListProperty.list_dtype()
  • PlyParseError
  • PlyElementParseError
    • PlyElementParseError.__init__()
  • PlyHeaderParseError
    • PlyHeaderParseError.__init__()

License

Copyright 2014-2023 Darsh Ranjan and plyfile authors.

This software is released under the terms of the GNU General Public License, version 3. See the file COPYING for details.