1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
|
from itertools import takewhile, zip_longest
from typing import Iterable, List, Optional, Type, Union
import numpy as np
from ..errors import LaspyException
from . import dims
Number = Union[np.number, float, int]
class ExtraBytesParams:
"""All parameters needed to create extra bytes"""
def __init__(
self,
name: str,
type: Union[str, np.dtype, Type[np.uint8]],
description: str = "",
offsets: Optional[Iterable[Number]] = None,
scales: Optional[Iterable[Number]] = None,
) -> None:
self.name = name
""" The name of the extra dimension """
if isinstance(type, str):
# Work around numpy deprecating support
# for '1type' strings
n = "".join(takewhile(lambda c: c.isdigit(), type))
if n == "1":
type = type[1:]
self.type = np.dtype(type)
""" The type of the extra dimension """
self.description = description
""" A description of the extra dimension """
self.offsets = np.array(offsets) if offsets is not None else offsets
""" The offsets to use if its a 'scaled dimension', can be none """
self.scales = np.array(scales) if scales is not None else scales
""" The scales to use if its a 'scaled dimension', can be none """
class PointFormat:
"""Class that contains the informations about the dimensions that forms a PointFormat.
A PointFormat has 'standard' dimensions (dimensions defined in the LAS standard, each
point format has its set of dimensions), but it can also have extra (non-standard) dimensions
defined by the user)
>>> fmt = PointFormat(3)
>>> all(dim.is_standard for dim in fmt.dimensions)
True
>>> dim = fmt.dimension_by_name("classification") # or fmt["classification"]
>>> dim.max
31
>>> dim.min
0
>>> dim.num_bits
5
"""
def __init__(
self,
point_format_id: int,
):
"""
Parameters
----------
point_format_id: int
point format id
"""
self.id: int = point_format_id
self.dimensions: List[dims.DimensionInfo] = []
composed_dims = dims.COMPOSED_FIELDS[self.id]
for dim_name in dims.ALL_POINT_FORMATS_DIMENSIONS[self.id]:
try:
sub_fields = composed_dims[dim_name]
except KeyError:
dimension = dims.DimensionInfo.from_dtype(
dim_name, dims.DIMENSIONS_TO_TYPE[dim_name], is_standard=True
)
self.dimensions.append(dimension)
else:
for sub_field in sub_fields:
dimension = dims.DimensionInfo.from_bitmask(
sub_field.name, sub_field.mask, is_standard=True
)
self.dimensions.append(dimension)
@property
def standard_dimensions(self) -> Iterable[dims.DimensionInfo]:
"""Returns an iterable of the standard dimensions
>>> fmt = PointFormat(0)
>>> standard_dims = list(fmt.standard_dimensions)
>>> len(standard_dims)
15
>>> standard_dims[4].name
'return_number'
"""
return (dim for dim in self.dimensions if dim.is_standard)
@property
def extra_dimensions(self) -> Iterable[dims.DimensionInfo]:
return (dim for dim in self.dimensions if dim.is_standard is False)
@property
def dimension_names(self) -> Iterable[str]:
"""Returns the names of the dimensions contained in the point format"""
return (dim.name for dim in self.dimensions)
@property
def standard_dimension_names(self) -> Iterable[str]:
"""Returns the names of the extra dimensions in this point format"""
return (dim.name for dim in self.standard_dimensions)
@property
def extra_dimension_names(self) -> Iterable[str]:
"""Returns the names of the extra dimensions in this point format"""
return (dim.name for dim in self.extra_dimensions)
@property
def size(self) -> int:
"""Returns the number of bytes (standard + extra) a point takes
>>> PointFormat(3).size
34
>>> fmt = PointFormat(3)
>>> fmt.add_extra_dimension(ExtraBytesParams("codification", "uint64"))
>>> fmt.size
42
"""
return int(sum(dim.num_bits for dim in self.dimensions) // 8)
@property
def num_standard_bytes(self) -> int:
"""Returns the number of bytes used by standard dims
>>> fmt = PointFormat(3)
>>> fmt.add_extra_dimension(ExtraBytesParams("codification", "uint64"))
>>> fmt.num_standard_bytes
34
"""
return int(sum(dim.num_bits for dim in self.standard_dimensions) // 8)
@property
def num_extra_bytes(self) -> int:
"""Returns the number of extra bytes
>>> fmt = PointFormat(3)
>>> fmt.add_extra_dimension(ExtraBytesParams("codification", "uint64"))
>>> fmt.num_extra_bytes
8
"""
return int(sum(dim.num_bits for dim in self.extra_dimensions) // 8)
@property
def has_waveform_packet(self):
"""Returns True if the point format has waveform packet dimensions"""
dimensions = set(self.dimension_names)
return all(name in dimensions for name in dims.WAVEFORM_FIELDS_NAMES)
def dimension_by_name(self, name: str) -> dims.DimensionInfo:
"""Returns the dimension info for the dimension by name
ValueError is raised if the dimension does not exist un the point format
>>> info = PointFormat(2).dimension_by_name('number_of_returns')
>>> info.name == 'number_of_returns'
True
>>> info.num_bits == 3
True
>>> info = PointFormat(2).dimension_by_name('gps_time')
Traceback (most recent call last):
...
ValueError: Dimension 'gps_time' does not exist
"""
for dim in self.dimensions:
if dim.name == name:
return dim
raise ValueError(f"Dimension '{name}' does not exist")
def add_extra_dimension(self, param: ExtraBytesParams) -> None:
"""Add an extra, user-defined dimension"""
dim_info = dims.DimensionInfo.from_extra_bytes_param(param)
# todo: this should be checked in extra bytes param ctor
if (
dim_info.num_elements > 3
and dim_info.kind != dims.DimensionKind.UnsignedInteger
):
raise LaspyException("Extra Dimensions do not support more than 3 elements")
self.dimensions.append(dim_info)
def remove_extra_dimension(self, name: str) -> None:
dimensions = [
dim for dim in self.dimensions if dim.name == name and not dim.is_standard
]
try:
dimension = dimensions[0]
except IndexError:
if name in self.standard_dimension_names:
raise LaspyException(
f"The dimension named '{name}' is not an extra dimension, "
"so it cannot be removed"
)
else:
raise LaspyException(
f"'No extra dimension named '{name}' exist"
) from None
self.dimensions = [dim for dim in self.dimensions if dim is not dimension]
def dtype(self):
"""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
"""
dtype = dims.ALL_POINT_FORMATS_DTYPE[self.id]
descr = dtype.descr
for extra_dim in self.extra_dimensions:
descr.append((extra_dim.name, extra_dim.type_str()))
return np.dtype(descr)
def __getitem__(self, item):
if isinstance(item, str):
return self.dimension_by_name(item)
return self.dimensions[item]
def __eq__(self, other):
if self.id != other.id:
return False
for my_eb, ot_eb in zip_longest(self.extra_dimensions, other.extra_dimensions):
if my_eb is None or ot_eb is None:
return False
if my_eb != ot_eb:
return False
return True
def __repr__(self):
return "<PointFormat({}, {} bytes of extra dims)>".format(
self.id, self.num_extra_bytes
)
def lost_dimensions(point_fmt_in, point_fmt_out):
"""Returns a list of the names of the dimensions that will be lost
when converting from point_fmt_in to point_fmt_out
"""
dimensions_in = set(PointFormat(point_fmt_in).dimension_names)
dimensions_out = set(PointFormat(point_fmt_out).dimension_names)
completely_lost = []
for dim_name in dimensions_in:
if dim_name not in dimensions_out:
completely_lost.append(dim_name)
return completely_lost
|