copc-rs 0.5.0

Cloud Optimized Point Cloud (COPC) reader and writer.
Documentation 
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

use thiserror::Error;

/// crate specific Result type
pub type Result<T> = std::result::Result<T, Error>;

/// crate specific Error enum
#[derive(Error, Debug)]
pub enum Error {
    /// When trying to add points to a writer that already been closed
    #[error("This writer has already been closed")]
    ClosedWriter,

    /// When trying to close an empty copc file
    #[error("There are no points added to this file")]
    EmptyCopcFile,

    /// [las::Error]
    #[error(transparent)]
    LasError(#[from] las::Error),

    /// [laz::LasZipError]
    #[error(transparent)]
    LasZipError(#[from] laz::LasZipError),

    /// The input file-path does not end in .copc.laz
    #[error("The extension of the file to write does not match .copc.laz")]
    WrongCopcExtension,

    /// The requested resolution is either negative or not normal
    #[error("The requested error is not possible: {}", .0)]
    InvalidResolution(f64),

    /// [std::io::Error]
    #[error(transparent)]
    Io(#[from] std::io::Error),

    /// The Copc Info vlr was not found, octree can not be built
    #[error("The source to be read does not contain a COPC info vlr")]
    CopcInfoVlrNotFound,

    /// The Ept hierarchy evlr was not found, octree can not be built
    #[error("The source to be read does not contain a EPT hierarchy vlr")]
    EptHierarchyVlrNotFound,

    /// The laszip vlr was not found, the points cannot be decompressed.
    #[error("laszip vlr not found")]
    LasZipVlrNotFound,

    /// The provided iterator for writing points to copc did not contain any points
    #[error("The provided iterator for writing points to copc did not contain any points")]
    EmptyIterator,

    /// Should not be possible
    #[error("The point could not be added to any node in the octree")]
    PointNotAddedToAnyNode,

    /// If the bounds in the passed in header is invalid
    #[error("the bounds in the passed in header is not normal: {:?}", .0)]
    InvalidBounds(las::Bounds),

    /// If a point fails to be added to the copc
    #[error(transparent)]
    InvalidPoint(crate::PointAddError),

    /// If a copc writer is created with invalid max or min node cound bounds
    #[error("the set min or max sizes for point in node is invalid")]
    InvalidNodeSize,

    /// [las_crs::CrsError]
    #[error(transparent)]
    InvalidCrs(#[from] las_crs::CrsError),

    /// Unsupported epsg
    #[error("the found epsg-code is not defined in the crs-definitions library")]
    InvalidEPSGCode(u16),
}

/// crate specific Error enum related to adding points to the writer
#[derive(Error, Debug)]
pub enum PointAddError {
    /// A point in the iterator passed to [write] did not
    /// match the format specified by the `header` passed to [new]
    ///
    /// [new]: crate::writer::CopcWriter::new
    /// [write]: crate::writer::CopcWriter::write
    #[error("The point attributes of a point in the iterator don't match the header: {:?}", .0)]
    PointAttributesDoNotMatch(las::point::Format),

    /// A point in the iterator passed to [write] was not
    /// inside the bounds of the header passed to [new]
    ///
    /// [new]: crate::writer::CopcWriter::new
    /// [write]: crate::writer::CopcWriter::write
    #[error("A point in the iterator was not inside the bounds of the header")]
    PointNotInBounds,
}