- Generated by
1.9.6
|
libE57Format 3.1.1
C++ library to read & write the E57 file format for point cloud data
|
Namespaces | |
| namespace | Utilities |
| namespace | Version |
Classes | |
| class | BlobNode |
| An E57 element encoding an fixed-length sequence of bytes with an opaque format. More... | |
| struct | CartesianBounds |
| Specifies an axis-aligned box in local cartesian coordinates. More... | |
| struct | ColorLimits |
| Specifies the limits for the value of red, green, and blue color that a sensor is capable of producing. More... | |
| class | CompressedVectorNode |
| An E57 element containing ordered vector of child nodes, stored in an efficient binary format. More... | |
| class | CompressedVectorReader |
| An iterator object keeping track of a read in progress from a CompressedVectorNode. More... | |
| class | CompressedVectorWriter |
| An iterator object keeping track of a write in progress to a CompressedVectorNode. More... | |
| struct | CylindricalRepresentation |
| Stores an image that is mapped from 3D using a cylindrical projection model. More... | |
| struct | Data3D |
| Stores the top-level information for a single lidar scan. More... | |
| struct | Data3DPointsData_t |
| Stores pointers to user-provided buffers. More... | |
| struct | DateTime |
| Encodes date and time. More... | |
| class | E57Exception |
| Object thrown by E57 API functions to communicate the conditions of an error. More... | |
| struct | E57Root |
| Stores the top-level information for the XML section of the file. More... | |
| class | FloatNode |
| An E57 element encoding a single or double precision IEEE floating point number. More... | |
| struct | GroupingByLine |
| Stores a set of point groups organized by the rowIndex or columnIndex attribute of the PointRecord. More... | |
| struct | Image2D |
| Stores an image from a camera. More... | |
| class | ImageFile |
| An ASTM E57 3D format file object. More... | |
| struct | IndexBounds |
| Stores the minimum and maximum of rowIndex, columnIndex, and returnIndex fields for a set of points. More... | |
| class | IntegerNode |
| An E57 element encoding an integer value. More... | |
| struct | IntensityLimits |
| Specifies the limits for the value of signal intensity that a sensor is capable of producing. More... | |
| struct | LineGroupRecord |
| Stores information about a single group of points in a row or column. More... | |
| class | Node |
| Generic handle to any of the 8 types of E57 element objects. More... | |
| struct | PinholeRepresentation |
| Stores an image that is mapped from 3D using the pinhole camera projection model. More... | |
| struct | PointGroupingSchemes |
| Supports the division of points within an Data3D into logical groupings. More... | |
| struct | PointStandardizedFieldsAvailable |
| Used to interrogate if standardized fields are available. More... | |
| struct | Quaternion |
| Represents a rigid body rotation. More... | |
| class | Reader |
| Used for reading an E57 file using E57 Simple API. More... | |
| struct | ReaderOptions |
| Options to the Reader constructor. More... | |
| struct | RigidBodyTransform |
| Defines a rigid body transform in cartesian coordinates. More... | |
| class | ScaledIntegerNode |
| An E57 element encoding a fixed point number. More... | |
| class | SourceDestBuffer |
| A memory buffer to transfer data to/from a CompressedVectorNode in a block. More... | |
| struct | SphericalBounds |
| Stores the bounds of some data in spherical coordinates. More... | |
| struct | SphericalRepresentation |
| Stores an image that is mapped from 3D using a spherical projection model. More... | |
| class | StringNode |
| An E57 element encoding a Unicode character string value. More... | |
| class | StructureNode |
| An E57 element containing named child nodes. More... | |
| struct | Translation |
| Defines a rigid body translation in Cartesian coordinates. More... | |
| class | VectorNode |
| An E57 element containing ordered vector of child nodes. More... | |
| struct | VisualReferenceRepresentation |
| Stores an image that is to be used only as a visual reference. More... | |
| class | Writer |
| Used for writing an E57 file using the E57 Simple API. More... | |
| struct | WriterOptions |
| Options to the Writer constructor. More... | |
Typedefs | |
| using | Data3DPointsData = Data3DPointsData_t< float > |
| using | Data3DPointsData_d = Data3DPointsData_t< double > |
| using | Data3DPointsDouble = Data3DPointsData_t< double > |
| using | Data3DPointsFloat = Data3DPointsData_t< float > |
| using | ReadChecksumPolicy = int |
| Specifies the percentage of checksums which are verified when reading an ImageFile (0-100%). | |
| using | ustring = std::string |
| UTF-8 encoded Unicode string. | |
Enumerations | |
| enum | ChecksumPolicy { ChecksumNone = 0 , ChecksumSparse = 25 , ChecksumHalf = 50 , ChecksumAll = 100 } |
| Default checksum policies for e57::ReadChecksumPolicy. More... | |
| enum | ErrorCode { Success = 0 , ErrorBadCVHeader = 1 , ErrorBadCVPacket = 2 , ErrorChildIndexOutOfBounds = 3 , ErrorSetTwice = 4 , ErrorHomogeneousViolation = 5 , ErrorValueNotRepresentable = 6 , ErrorScaledValueNotRepresentable = 7 , ErrorReal64TooLarge = 8 , ErrorExpectingNumeric = 9 , ErrorExpectingUString = 10 , ErrorInternal = 11 , ErrorBadXMLFormat = 12 , ErrorXMLParser = 13 , ErrorBadAPIArgument = 14 , ErrorFileReadOnly = 15 , ErrorBadChecksum = 16 , ErrorOpenFailed = 17 , ErrorCloseFailed = 18 , ErrorReadFailed = 19 , ErrorWriteFailed = 20 , ErrorSeekFailed = 21 , ErrorPathUndefined = 22 , ErrorBadBuffer = 23 , ErrorNoBufferForElement = 24 , ErrorBufferSizeMismatch = 25 , ErrorBufferDuplicatePathName = 26 , ErrorBadFileSignature = 27 , ErrorUnknownFileVersion = 28 , ErrorBadFileLength = 29 , ErrorXMLParserInit = 30 , ErrorDuplicateNamespacePrefix = 31 , ErrorDuplicateNamespaceURI = 32 , ErrorBadPrototype = 33 , ErrorBadCodecs = 34 , ErrorValueOutOfBounds = 35 , ErrorConversionRequired = 36 , ErrorBadPathName = 37 , ErrorNotImplemented = 38 , ErrorBadNodeDowncast = 39 , ErrorWriterNotOpen = 40 , ErrorReaderNotOpen = 41 , ErrorNodeUnattached = 42 , ErrorAlreadyHasParent = 43 , ErrorDifferentDestImageFile = 44 , ErrorImageFileNotOpen = 45 , ErrorBuffersNotCompatible = 46 , ErrorTooManyWriters = 47 , ErrorTooManyReaders = 48 , ErrorBadConfiguration = 49 , ErrorInvarianceViolation = 50 , ErrorInvalidNodeType = 51 , ErrorInvalidData3DValue = 52 , ErrorData3DReadInvalidZeroRecords = 53 , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success } |
| Numeric error identifiers used in E57Exception. More... | |
| enum | FloatPrecision { PrecisionSingle = 1 , PrecisionDouble = 2 , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success } |
| The IEEE floating point number precisions supported. More... | |
| enum | Image2DProjection { ProjectionNone = 0 , ProjectionVisual = 1 , ProjectionPinhole = 2 , ProjectionSpherical = 3 , ProjectionCylindrical = 4 , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success } |
| Identifies the representation for the image data. More... | |
| enum | Image2DType { ImageNone = 0 , ImageJPEG = 1 , ImagePNG = 2 , ImageMaskPNG = 3 , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success } |
| Identifies the format representation for the image data. More... | |
| enum | MemoryRepresentation { Int8 = 1 , UInt8 = 2 , Int16 = 3 , UInt16 = 4 , Int32 = 5 , UInt32 = 6 , Int64 = 7 , Bool = 8 , Real32 = 9 , Real64 = 10 , UString = 11 , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success } |
| Identifies the representations of memory elements API can transfer data to/from. More... | |
| enum | NodeType { TypeStructure = 1 , TypeVector = 2 , TypeCompressedVector = 3 , TypeInteger = 4 , TypeScaledInteger = 5 , TypeFloat = 6 , TypeString = 7 , TypeBlob = 8 , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success , DEPRECATED_ENUM =( "Will be removed in 4.0. Use Success." ) = Success } |
| Identifiers for types of E57 elements. More... | |
| enum class | NumericalNodeType { Integer = 0 , ScaledInteger , Float , Double } |
| Used to set the type of node in some PointStandardizedFieldsAvailable fields. More... | |
Functions | |
| void | _validateData3D (const Data3D &inData3D) |
| Validates a Data3D and throws on error. | |
Variables | |
| constexpr uint32_t | E57_FORMAT_MAJOR = 1 |
| constexpr uint32_t | E57_FORMAT_MINOR = 0 |
| constexpr auto | E57_V1_0_URI = VERSION_1_0_URI |
| constexpr char | VERSION_1_0_URI [] = "http://www.astm.org/COMMIT/E57/2010-e57-v1.0" |
| The URI of ASTM E57 v1.0 standard XML namespace. | |
Deprecated Checksum Policies | |
These have been replaced by the enum e57::ChecksumPolicy. | |
| constexpr ReadChecksumPolicy | CHECKSUM_POLICY_NONE = ChecksumNone |
| constexpr ReadChecksumPolicy | CHECKSUM_POLICY_SPARSE = ChecksumSparse |
| constexpr ReadChecksumPolicy | CHECKSUM_POLICY_HALF = ChecksumHalf |
| constexpr ReadChecksumPolicy | CHECKSUM_POLICY_ALL = ChecksumAll |
| using e57::Data3DPointsData = typedef Data3DPointsData_t<float> |
| using e57::Data3DPointsData_d = typedef Data3DPointsData_t<double> |
| using e57::Data3DPointsDouble = typedef Data3DPointsData_t<double> |
| using e57::Data3DPointsFloat = typedef Data3DPointsData_t<float> |
| using e57::ReadChecksumPolicy = typedef int |
Specifies the percentage of checksums which are verified when reading an ImageFile (0-100%).
| using e57::ustring = typedef std::string |
UTF-8 encoded Unicode string.
| enum e57::ChecksumPolicy |
Default checksum policies for e57::ReadChecksumPolicy.
These are some convenient default checksum policies, though you can use any value you want (0-100).
| enum e57::ErrorCode |
Numeric error identifiers used in E57Exception.
| enum e57::FloatPrecision |
The IEEE floating point number precisions supported.
Identifies the representation for the image data.
| enum e57::Image2DType |
Identifies the format representation for the image data.
Identifies the representations of memory elements API can transfer data to/from.
| enum e57::NodeType |
Identifiers for types of E57 elements.
|
strong |
Used to set the type of node in some PointStandardizedFieldsAvailable fields.
| Enumerator | |
|---|---|
| Integer | Use IntegerNode. |
| ScaledInteger | Use ScaledIntegerNode. |
| Float | Use FloatNode with floats. |
| Double | Use FloatNode with doubles. |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
The file format major version number. The value shall be 1.
|
constexpr |
The file format minor version number. The value shall be 0.
|
constexpr |
|
constexpr |
The URI of ASTM E57 v1.0 standard XML namespace.
1.9.6