pylas.point.format module¶
-
class
pylas.point.format.
PointFormat
(point_format_id, extra_dims=None)[source]¶ Bases:
object
Class that handles all the information about a point format
Most of the methods/properties will throw a pylas.errors.PointFormatNotSupported if the point format id is not supported
-
composed_fields
¶ Returns the dict of composed fields defined for the point format
Returns: maps a composed field name to its sub_fields Return type: Dict[str, List[SubFields]]
-
dimension_names
¶ Returns the names of the dimensions contained in the point format
Returns: the names of the dimensions defined by this point format Return type: list of str
-
dtype
¶ Returns the numpy.dtype used to store the point records in a numpy array
Note
The dtype corresponds to the dtype with sub_fields packed into their composed fields
-
extra_dimension_names
¶ Returns the list of extra dimensions attached to this point format
-
has_waveform_packet
¶ Returns True if the point format has waveform packet dimensions
-
num_extra_bytes
¶ Returns the number of extra bytes
-
sub_fields
¶ Returns a dict of the sub fields for this point format
Returns: maps a sub field name to its composed dimension with additional information Return type: Dict[str, Tuple[str, SubField]]
-
unpacked_dtype
¶ Returns the numpy.dtype used to store the point records in a numpy array
Note
The dtype corresponds to the dtype with sub_fields unpacked
-