Skip to content

Commit

Permalink
docs: Add a docstring for the ScanHeader class
Browse files Browse the repository at this point in the history
  • Loading branch information
dancergraham committed Aug 12, 2024
1 parent 677378f commit 383d39b
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/pye57/scan_header.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
from pye57.utils import get_fields, get_node

class ScanHeader:
"""Provides summary statistics for an individual lidar scan in an E57 file.
Including the number of points, bounds and pose of the scan.
"""
def __init__(self, scan_node):
self.node = scan_node
points = self.node["points"]
Expand Down

0 comments on commit 383d39b

Please sign in to comment.