include » liblas » capi

liblas.h File Reference

#include "las_version.h"
#include "las_config.h"
#include <liblas/cstdint.hpp>

Include dependency graph for liblas.h:

Go to the source code of this file.


Classes

struct  LASPointSummary

Defines

#define LIBLAS_C_API   1
#define LAS_MODE_READ   0
#define LAS_MODE_WRITE   1
#define LAS_MODE_APPEND   2

Typedefs

typedef LASWriterHS * LASWriterH
typedef LASReaderHS * LASReaderH
typedef LASPointHS * LASPointH
typedef LASHeaderHS * LASHeaderH
typedef LASGuidHS * LASGuidH
typedef LASVLRHS * LASVLRH

Enumerations

enum  LASError {
  LE_None = 0, LE_Debug = 1, LE_Warning = 2, LE_Failure = 3,
  LE_Fatal = 4
}

Functions

LAS_DLL char * LAS_GetVersion ()
 Returns the version string for this library.
LAS_DLL void LASError_Reset (void)
 Resets the error stack for the libLAS C API.
LAS_DLL void LASError_Pop (void)
 Pops the top error off of the error stack for the libLAS C API.
LAS_DLL LASError LASError_GetLastErrorNum (void)
 Returns the error number of the last error on the error stack.
LAS_DLL char * LASError_GetLastErrorMsg (void)
 Returns the name of the method the last error message happened in.
LAS_DLL char * LASError_GetLastErrorMethod (void)
 Returns the name of the method the last error message happened in.
LAS_DLL int LASError_GetErrorCount (void)
 Returns the number of error messages on the error stack.
LAS_DLL void LASError_Print (const char *message)
 Prints the last error message in the error stack to stderr.
LAS_DLL LASReaderH LASReader_Create (const char *filename)
 Creates a LASReaderH object that can be used to read LASHeaderH and LASPointH objects with.
LAS_DLL LASPointH LASReader_GetNextPoint (const LASReaderH hReader)
 Reads the next available point on the LASReaderH instance.
LAS_DLL LASPointH LASReader_GetPointAt (const LASReaderH hReader, uint32_t position)
 Reads a LASPointH from the given position in the LAS file represented by the LASReaderH instance.
LAS_DLL void LASReader_Destroy (LASReaderH hReader)
 Closes the file for reading operations represented by the LASReaderH instance.
LAS_DLL LASHeaderH LASReader_GetHeader (const LASReaderH hReader)
 Returns a LASHeaderH representing the header for the file.
LAS_DLL double LASPoint_GetX (const LASPointH hPoint)
 Returns the X value for the point.
LAS_DLL LASError LASPoint_SetX (LASPointH hPoint, double value)
 Sets the X value for the point.
LAS_DLL double LASPoint_GetY (const LASPointH hPoint)
 Returns the Y value for the point.
LAS_DLL LASError LASPoint_SetY (LASPointH hPoint, double value)
 Sets the Y value for the point.
LAS_DLL double LASPoint_GetZ (const LASPointH hPoint)
 Returns the Z value for the point.
LAS_DLL LASError LASPoint_SetZ (LASPointH hPoint, double value)
 Sets the Z value for the point.
LAS_DLL uint16_t LASPoint_GetIntensity (const LASPointH hPoint)
 Returns the intensity value for the point.
LAS_DLL LASError LASPoint_SetIntensity (LASPointH hPoint, uint16_t value)
 Sets the intensity value for the point.
LAS_DLL uint16_t LASPoint_GetReturnNumber (const LASPointH hPoint)
 Returns the return number for the point.
LAS_DLL LASError LASPoint_SetReturnNumber (LASPointH hPoint, uint16_t value)
 Sets the return number for the point.
LAS_DLL uint16_t LASPoint_GetNumberOfReturns (const LASPointH hPoint)
 Returns the total number of returns for a given pulse.
LAS_DLL LASError LASPoint_SetNumberOfReturns (LASPointH hPoint, uint16_t value)
 Sets the number of returns for the point.
LAS_DLL uint16_t LASPoint_GetScanDirection (const LASPointH hPoint)
 Returns the scan direction for a given pulse.
LAS_DLL LASError LASPoint_SetScanDirection (LASPointH hPoint, uint16_t value)
 Sets the scan direction for a given pulse.
LAS_DLL uint16_t LASPoint_GetFlightLineEdge (const LASPointH hPoint)
 Returns whether or not a given pulse is an edge point.
LAS_DLL LASError LASPoint_SetFlightLineEdge (LASPointH hPoint, uint16_t value)
 Sets the edge marker for a given pulse.
LAS_DLL uint8_t LASPoint_GetScanFlags (const LASPointH hPoint)
 Returns all of the scan flags for the point -- Return number, number of returns, flightline edge, scan direction, and scan angle rank.
LAS_DLL LASError LASPoint_SetScanFlags (LASPointH hPoint, uint8_t value)
 Sets all of the scan flags for the point.
LAS_DLL uint8_t LASPoint_GetClassification (const LASPointH hPoint)
 Returns the classification for the point.
LAS_DLL LASError LASPoint_SetClassification (LASPointH hPoint, uint8_t value)
 Sets the classification for the point.
LAS_DLL double LASPoint_GetTime (const LASPointH hPoint)
 Returns the time for the point.
LAS_DLL LASError LASPoint_SetTime (LASPointH hPoint, double value)
 Sets the time for the point.
LAS_DLL int8_t LASPoint_GetScanAngleRank (const LASPointH hPoint)
 Returns the scan angle for the point.
LAS_DLL LASError LASPoint_SetScanAngleRank (LASPointH hPoint, int8_t value)
 Sets the scan angle for the point.
LAS_DLL uint8_t LASPoint_GetUserData (const LASPointH hPoint)
 Returns the arbitrary user data for the point.
LAS_DLL LASError LASPoint_SetUserData (LASPointH hPoint, uint8_t value)
 Sets the arbitrary user data for the point.
LAS_DLL int LASPoint_Validate (LASPointH hPoint)
 Returns a bitfield representing the validity of various members enum DataMemberFlag { eReturnNumber = 1, eNumberOfReturns = 2, eScanDirection = 4, eFlightLineEdge = 8, eClassification = 16, eScanAngleRank = 32, eTime = 64 };.
LAS_DLL int LASPoint_IsValid (LASPointH hPoint)
 Returns a boolean whether or not the point is valid.
LAS_DLL LASPointH LASPoint_Create (void)
 Creates a new empty LASPointH instance.
LAS_DLL LASPointH LASPoint_Copy (const LASPointH)
 Creates a copy of a LASPointH instance.
LAS_DLL void LASPoint_Destroy (LASPointH hPoint)
 Destroys/deletes a LASPointH instance.
LAS_DLL LASHeaderH LASHeader_Copy (const LASHeaderH hHeader)
 Copies a LASHeaderH instance.
LAS_DLL LASHeaderH LASHeader_Create (void)
 Creates an empty LASHeaderH with default values.
LAS_DLL void LASHeader_Destroy (LASHeaderH hHeader)
 Destroys/deletes a LASHeader instance.
LAS_DLL char * LASHeader_GetFileSignature (const LASHeaderH hHeader)
 Returns the file signature the the file.
LAS_DLL uint16_t LASHeader_GetFileSourceId (const LASHeaderH hHeader)
 Returns the file source id for the file.
LAS_DLL LASError LASHeader_SetFileSourceId (LASHeaderH hHeader, uint16_t value)
 Sets the FileSource ID value for the header.
LAS_DLL char * LASHeader_GetProjectId (const LASHeaderH hHeader)
 Returns the project id for the header as a GUID string.
LAS_DLL LASError LASHeader_SetProjectId (LASHeaderH hHeader, const char *value)
 Sets the project id/GUID for the header.
LAS_DLL LASError LASHeader_SetGUID (LASHeaderH hHeader, LASGuidH hId)
 Sets the project id/GUID for the header.
LAS_DLL uint8_t LASHeader_GetVersionMajor (const LASHeaderH hHeader)
 Returns the major version number for the header.
LAS_DLL LASError LASHeader_SetVersionMajor (LASHeaderH hHeader, uint8_t value)
 Sets the major version number for the header.
LAS_DLL uint8_t LASHeader_GetVersionMinor (const LASHeaderH hHeader)
 Returns the min version number for the header.
LAS_DLL LASError LASHeader_SetVersionMinor (LASHeaderH hHeader, uint8_t value)
 Sets the minor version number for the header.
LAS_DLL char * LASHeader_GetSystemId (const LASHeaderH hHeader)
 Returns the System ID for the header.
LAS_DLL LASError LASHeader_SetSystemId (LASHeaderH hHeader, const char *value)
 Sets the System ID for the header.
LAS_DLL char * LASHeader_GetSoftwareId (const LASHeaderH hHeader)
 Returns the Software ID for the header.
LAS_DLL LASError LASHeader_SetSoftwareId (LASHeaderH hHeader, const char *value)
 Sets the Software ID for the header.
LAS_DLL uint16_t LASHeader_GetReserved (const LASHeaderH hHeader)
 Returns the reserved value for the header.
LAS_DLL LASError LASHeader_SetReserved (LASHeaderH hHeader, uint16_t value)
 Sets the Reserved value for the header.
LAS_DLL uint16_t LASHeader_GetCreationDOY (const LASHeaderH hHeader)
 Returns the file creation day of the year.
LAS_DLL LASError LASHeader_SetCreationDOY (LASHeaderH hHeader, uint16_t value)
 Sets the file creation day of the year.
LAS_DLL uint16_t LASHeader_GetCreationYear (const LASHeaderH hHeader)
 Returns the file creation year.
LAS_DLL LASError LASHeader_SetCreationYear (LASHeaderH hHeader, uint16_t value)
 Sets the file creation year.
LAS_DLL uint16_t LASHeader_GetHeaderSize (const LASHeaderH hHeader)
 Returns the size of the header for the file in bytes.
LAS_DLL uint32_t LASHeader_GetDataOffset (const LASHeaderH hHeader)
 Returns the byte offset to the start of actual point data for the file.
LAS_DLL uint32_t LASHeader_GetRecordsCount (const LASHeaderH hHeader)
 Returns the number of variable length records in the header.
LAS_DLL uint16_t LASHeader_GetDataRecordLength (const LASHeaderH hHeader)
 Returns the record length for the points based on their data format id in bytes.
LAS_DLL uint8_t LASHeader_GetDataFormatId (const LASHeaderH hHeader)
 Returns the data format id.
LAS_DLL LASError LASHeader_SetDataFormatId (const LASHeaderH hHeader, uint8_t value)
 Sets the data format id for the file.
LAS_DLL uint32_t LASHeader_GetPointRecordsCount (const LASHeaderH hHeader)
 Returns the number of point records in the file.
LAS_DLL LASError LASHeader_SetPointRecordsCount (const LASHeaderH hHeader, uint32_t value)
 Sets the number of point records for the file.
LAS_DLL uint32_t LASHeader_GetPointRecordsByReturnCount (const LASHeaderH hHeader, int index)
 Returns the number of point records by return.
LAS_DLL LASError LASHeader_SetPointRecordsByReturnCount (const LASHeaderH hHeader, int index, uint32_t value)
 Sets the number of point records for a given return.
LAS_DLL double LASHeader_GetScaleX (const LASHeaderH hHeader)
 Return the X scale factor.
LAS_DLL double LASHeader_GetScaleY (const LASHeaderH hHeader)
 Return the Y scale factor.
LAS_DLL double LASHeader_GetScaleZ (const LASHeaderH hHeader)
 Return the Z scale factor.
LAS_DLL LASError LASHeader_SetScale (LASHeaderH hHeader, double x, double y, double z)
 Sets the scale factors.
LAS_DLL double LASHeader_GetOffsetX (const LASHeaderH hHeader)
 Return the X offset.
LAS_DLL double LASHeader_GetOffsetY (const LASHeaderH hHeader)
 Return the Y offset.
LAS_DLL double LASHeader_GetOffsetZ (const LASHeaderH hHeader)
 Return the Z offset.
LAS_DLL LASError LASHeader_SetOffset (LASHeaderH hHeader, double x, double y, double z)
 Sets the offset values.
LAS_DLL double LASHeader_GetMinX (const LASHeaderH hHeader)
 Return the minimum x value.
LAS_DLL double LASHeader_GetMinY (const LASHeaderH hHeader)
 Return the minimum y value.
LAS_DLL double LASHeader_GetMinZ (const LASHeaderH hHeader)
 Return the minimum z value.
LAS_DLL LASError LASHeader_SetMin (LASHeaderH hHeader, double x, double y, double z)
 Sets the minimum values.
LAS_DLL double LASHeader_GetMaxX (const LASHeaderH hHeader)
 Return the maximum x value.
LAS_DLL double LASHeader_GetMaxY (const LASHeaderH hHeader)
 Return the maximum y value.
LAS_DLL double LASHeader_GetMaxZ (const LASHeaderH hHeader)
 Return the maximum z value.
LAS_DLL LASError LASHeader_SetMax (LASHeaderH hHeader, double x, double y, double z)
 Sets the maximum values.
LAS_DLL char * LASHeader_GetProj4 (LASHeaderH hHeader)
 Returns the proj.4 string describing the spatial reference of the header if it is available.
LAS_DLL LASError LASHeader_SetProj4 (LASHeaderH hHeader, const char *value)
 Sets the proj4 stirng describing the spatial reference of the header.
LAS_DLL LASVLRH LASHeader_GetVLR (const LASHeaderH hHeader, uint32_t i)
 Returns the VLR record for the given index.
LAS_DLL LASError LASHeader_DeleteVLR (LASHeaderH hHeader, uint32_t index)
 Deletes a VLR record from the header for the given index.
LAS_DLL LASError LASHeader_AddVLR (LASHeaderH hHeader, const LASVLRH hVLR)
 Adds a VLR record to the header.
LAS_DLL LASWriterH LASWriter_Create (const char *filename, const LASHeaderH hHeader, int mode)
 Creates a new LASWriterH for write operations on LAS files.
LAS_DLL LASError LASWriter_WritePoint (const LASWriterH hWriter, const LASPointH hPoint)
 Writes a point to the file.
LAS_DLL LASError LASWriter_WriteHeader (const LASWriterH hWriter, const LASHeaderH hHeader)
 Overwrites the header for the file represented by the LASWriterH.
LAS_DLL void LASWriter_Destroy (LASWriterH hWriter)
 Destroys the LASWriterH instance, effectively closing the file and performing housekeeping operations.
LAS_DLL LASGuidH LASHeader_GetGUID (const LASHeaderH hHeader)
 Returns the GUID value for the header as an opaque LASGuidH pointer.
LAS_DLL LASGuidH LASGuid_Create ()
 Returns a new random GUID.
LAS_DLL LASGuidH LASGuid_CreateFromString (const char *string)
 Creates a new GUID opaque pointer using the given string.
LAS_DLL void LASGuid_Destroy (LASGuidH hId)
 Destroys a GUID opaque pointer and removes it from the heap.
LAS_DLL int LASGuid_Equals (LASGuidH hId1, LASGuidH hId2)
 Determines if two GUIDs are equal.
LAS_DLL char * LASGuid_AsString (LASGuidH hId)
 Returns a string representation of the GUID opqaue pointer.
LAS_DLL LASVLRH LASVLR_Create (void)
 Creates a new VLR record.
LAS_DLL void LASVLR_Destroy (LASVLRH hVLR)
 Destroys a VLR record and removes it from the heap.
LAS_DLL char * LASVLR_GetUserId (const LASVLRH hVLR)
 Returns the User Id for the VLR.
LAS_DLL LASError LASVLR_SetUserId (LASVLRH hVLR, const char *value)
 Sets the User Id for the VLR.
LAS_DLL char * LASVLR_GetDescription (const LASVLRH hVLR)
 Gets the description for the VLR.
LAS_DLL LASError LASVLR_SetDescription (LASVLRH hVLR, const char *value)
 Sets the description for the VLR.
LAS_DLL uint16_t LASVLR_GetRecordLength (const LASVLRH hVLR)
 Returns the record length of the data stored in the VLR.
LAS_DLL LASError LASVLR_SetRecordLength (LASVLRH hVLR, uint16_t value)
 Sets the record length of the data stored in the VLR.
LAS_DLL uint16_t LASVLR_GetRecordId (const LASVLRH hVLR)
 Gets the record id for the VLR.
LAS_DLL LASError LASVLR_SetRecordId (LASVLRH hVLR, uint16_t value)
 Sets the record id for the VLR.
LAS_DLL uint16_t LASVLR_GetReserved (const LASVLRH hVLR)
 Gets the reserved value of the VLR.
LAS_DLL LASError LASVLR_SetReserved (LASVLRH hVLR, uint16_t value)
 Sets the reserved value of the VLR.
LAS_DLL LASError LASVLR_GetData (const LASVLRH hVLR, uint8_t *data)
 Gets the data stream for the VLR as an array of bytes.
LAS_DLL LASError LASVLR_SetData (const LASVLRH hVLR, uint8_t *data, uint16_t length)
 Sets the data stream for the VLR as an array of bytes.

Define Documentation

#define LAS_MODE_APPEND   2

Definition at line 69 of file liblas.h.

#define LAS_MODE_READ   0

Definition at line 67 of file liblas.h.

#define LAS_MODE_WRITE   1

Definition at line 68 of file liblas.h.

#define LIBLAS_C_API   1

Definition at line 47 of file liblas.h.

Typedef Documentation

typedef struct LASGuidHS* LASGuidH

Definition at line 60 of file liblas.h.

typedef struct LASHeaderHS* LASHeaderH

Definition at line 59 of file liblas.h.

typedef struct LASPointHS* LASPointH

Definition at line 58 of file liblas.h.

typedef struct LASReaderHS* LASReaderH

Definition at line 57 of file liblas.h.

typedef struct LASVLRHS* LASVLRH

Definition at line 61 of file liblas.h.

typedef struct LASWriterHS* LASWriterH

Definition at line 56 of file liblas.h.

Enumeration Type Documentation

enum LASError

Todo:
to be documented
Enumerator:
LE_None 
LE_Debug 
LE_Warning 
LE_Failure 
LE_Fatal 

Definition at line 74 of file liblas.h.

Function Documentation

LAS_DLL char* LAS_GetVersion (  ) 

Returns the version string for this library.

Returns:
the version string for this library.

LAS_DLL int LASError_GetErrorCount ( void   ) 

Returns the number of error messages on the error stack.

Returns:
the number of error messages on the error stack.

LAS_DLL char* LASError_GetLastErrorMethod ( void   ) 

Returns the name of the method the last error message happened in.

Returns:
the name of the method the last error message happened in.

LAS_DLL char* LASError_GetLastErrorMsg ( void   ) 

Returns the name of the method the last error message happened in.

Returns:
the name of the method the last error message happened in.

LAS_DLL LASError LASError_GetLastErrorNum ( void   ) 

Returns the error number of the last error on the error stack.

Returns:
the error number of the last error on the error stack.

LAS_DLL void LASError_Pop ( void   ) 

Pops the top error off of the error stack for the libLAS C API.

LAS_DLL void LASError_Print ( const char *  message  ) 

Prints the last error message in the error stack to stderr.

If there is no error on the error stack, only the message is printed. The function does not alter the error stack in any way.

Parameters:
message Message to include in the stderr output

LAS_DLL void LASError_Reset ( void   ) 

Resets the error stack for the libLAS C API.

LAS_DLL char* LASGuid_AsString ( LASGuidH  hId  ) 

Returns a string representation of the GUID opqaue pointer.

The caller owns the string.

Parameters:
hId the LASGuidH pointer
Returns:
a string representation of the GUID opaque pointer.

LAS_DLL LASGuidH LASGuid_Create (  ) 

Returns a new random GUID.

Returns:
a new random GUID

LAS_DLL LASGuidH LASGuid_CreateFromString ( const char *  string  ) 

Creates a new GUID opaque pointer using the given string.

Parameters:
string A GUID string in the form "00000000-0000-0000-0000-000000000000" An example GUID might be something like '8388F1B8-AA1B-4108-BCA3-6BC68E7B062E'
Returns:
the GUID value as an opaque LASGuidH pointer.

LAS_DLL void LASGuid_Destroy ( LASGuidH  hId  ) 

Destroys a GUID opaque pointer and removes it from the heap.

Parameters:
hId the GUID value to destroy as an opaque LASGuidH pointer.

LAS_DLL int LASGuid_Equals ( LASGuidH  hId1,
LASGuidH  hId2 
)

Determines if two GUIDs are equal.

Parameters:
hId1 the first GUID
hId2 the second GUID
Returns:
0 if false, 1 if true. Use the LASError_GetLastError* methods to determine if an error occured during the operation of this function.

LAS_DLL LASError LASHeader_AddVLR ( LASHeaderH  hHeader,
const LASVLRH  hVLR 
)

Adds a VLR record to the header.

Parameters:
hHeader the LASHeaderH instance
hVLR the VLR to add to the header
Returns:
LASErrorEnum

LAS_DLL LASHeaderH LASHeader_Copy ( const LASHeaderH  hHeader  ) 

Copies a LASHeaderH instance.

Parameters:
hHeader the LASHeaderH to copy
Returns:
a LASHeaderH instance or NULL on error

LAS_DLL LASHeaderH LASHeader_Create ( void   ) 

Creates an empty LASHeaderH with default values.

LAS_DLL LASError LASHeader_DeleteVLR ( LASHeaderH  hHeader,
uint32_t  index 
)

Deletes a VLR record from the header for the given index.

Parameters:
hHeader the LASHeaderH instance
index the index starting from 0 of the VLR to delete
Returns:
LASErrorEnum

LAS_DLL void LASHeader_Destroy ( LASHeaderH  hHeader  ) 

Destroys/deletes a LASHeader instance.

LAS_DLL uint16_t LASHeader_GetCreationDOY ( const LASHeaderH  hHeader  ) 

Returns the file creation day of the year.

The values start from 1, being January 1st, and end at 365 or 366 being December 31st, depending on leap year.

Returns:
the day of the year as an integer starting from 1 for the file creation.

LAS_DLL uint16_t LASHeader_GetCreationYear ( const LASHeaderH  hHeader  ) 

Returns the file creation year.

This is a four digit number representing the year for the file, ie 2003, 2008, etc.

Returns:
the creation year for the file or 0 if none is set

LAS_DLL uint8_t LASHeader_GetDataFormatId ( const LASHeaderH  hHeader  ) 

Returns the data format id.

If this value is 1, the point data have time values associated with them. If it is 0, the point data do not have time values.

Parameters:
hHeader LASHeaderH instance
Returns:
the data format id for the file.

LAS_DLL uint32_t LASHeader_GetDataOffset ( const LASHeaderH  hHeader  ) 

Returns the byte offset to the start of actual point data for the file.

Parameters:
hHeader LASHeaderH instance
Returns:
the type offset to the start of actual point data for the file

LAS_DLL uint16_t LASHeader_GetDataRecordLength ( const LASHeaderH  hHeader  ) 

Returns the record length for the points based on their data format id in bytes.

Parameters:
hHeader LASHeaderH instance
Returns:
the record length for the points based on their data format id in bytes

LAS_DLL char* LASHeader_GetFileSignature ( const LASHeaderH  hHeader  ) 

Returns the file signature the the file.

This should always be 'LASF'

Parameters:
hHeader LASHeaderH instance
Returns:
the file signature the the file. This should always be 'LASF'

LAS_DLL uint16_t LASHeader_GetFileSourceId ( const LASHeaderH  hHeader  ) 

Returns the file source id for the file.

It is a number from 1-65535

Parameters:
hHeader LASHeaderH instance
Returns:
the file source id for the file.

LAS_DLL LASGuidH LASHeader_GetGUID ( const LASHeaderH  hHeader  ) 

Returns the GUID value for the header as an opaque LASGuidH pointer.

Parameters:
hHeader the opaque pointer to the LASHeaderH
Returns:
the GUID value for the header as an opaque LASGuidH pointer.

LAS_DLL uint16_t LASHeader_GetHeaderSize ( const LASHeaderH  hHeader  ) 

Returns the size of the header for the file in bytes.

Returns:
the size of the header for the file in bytes.

LAS_DLL double LASHeader_GetMaxX ( const LASHeaderH  hHeader  ) 

Return the maximum x value.

Parameters:
hHeader LASHeaderH instance
Returns:
the maximum x value

LAS_DLL double LASHeader_GetMaxY ( const LASHeaderH  hHeader  ) 

Return the maximum y value.

Parameters:
hHeader LASHeaderH instance
Returns:
the maximum y value

LAS_DLL double LASHeader_GetMaxZ ( const LASHeaderH  hHeader  ) 

Return the maximum z value.

Parameters:
hHeader LASHeaderH instance
Returns:
the maximum z value

LAS_DLL double LASHeader_GetMinX ( const LASHeaderH  hHeader  ) 

Return the minimum x value.

Parameters:
hHeader LASHeaderH instance
Returns:
the minimum x value

LAS_DLL double LASHeader_GetMinY ( const LASHeaderH  hHeader  ) 

Return the minimum y value.

Parameters:
hHeader LASHeaderH instance
Returns:
the minimum y value

LAS_DLL double LASHeader_GetMinZ ( const LASHeaderH  hHeader  ) 

Return the minimum z value.

Parameters:
hHeader LASHeaderH instance
Returns:
the minimum z value

LAS_DLL double LASHeader_GetOffsetX ( const LASHeaderH  hHeader  ) 

Return the X offset.

Parameters:
hHeader LASHeaderH instance
Returns:
the X offset

LAS_DLL double LASHeader_GetOffsetY ( const LASHeaderH  hHeader  ) 

Return the Y offset.

Parameters:
hHeader LASHeaderH instance
Returns:
the Y offset

LAS_DLL double LASHeader_GetOffsetZ ( const LASHeaderH  hHeader  ) 

Return the Z offset.

Parameters:
hHeader LASHeaderH instance
Returns:
the Z offset

LAS_DLL uint32_t LASHeader_GetPointRecordsByReturnCount ( const LASHeaderH  hHeader,
int  index 
)

Returns the number of point records by return.

Parameters:
hHeader LASHeaderH instance
index the return number to fetch the count for
Returns:
the number of point records for a given return

LAS_DLL uint32_t LASHeader_GetPointRecordsCount ( const LASHeaderH  hHeader  ) 

Returns the number of point records in the file.

This value may not reflect the actual number of point records in the file.

Parameters:
hHeader LASHeaderH instance
Returns:
the number of point records in the file

LAS_DLL char* LASHeader_GetProj4 ( LASHeaderH  hHeader  ) 

Returns the proj.4 string describing the spatial reference of the header if it is available.

Parameters:
hHeader LASHeaderH instance
Returns:
the proj.4 string or NULL if none is available. The caller owns the string.

LAS_DLL char* LASHeader_GetProjectId ( const LASHeaderH  hHeader  ) 

Returns the project id for the header as a GUID string.

Returns:
the project id for the header as a GUID string

LAS_DLL uint32_t LASHeader_GetRecordsCount ( const LASHeaderH  hHeader  ) 

Returns the number of variable length records in the header.

Parameters:
hHeader LASHeaderH instance
Returns:
the number of variable length records in the header

LAS_DLL uint16_t LASHeader_GetReserved ( const LASHeaderH  hHeader  ) 

Returns the reserved value for the header.

This should aways be 0.

Returns:
the reserved value for the header.

LAS_DLL double LASHeader_GetScaleX ( const LASHeaderH  hHeader  ) 

Return the X scale factor.

Parameters:
hHeader LASHeaderH instance
Returns:
the X scale factor

LAS_DLL double LASHeader_GetScaleY ( const LASHeaderH  hHeader  ) 

Return the Y scale factor.

Parameters:
hHeader LASHeaderH instance
Returns:
the Y scale factor

LAS_DLL double LASHeader_GetScaleZ ( const LASHeaderH  hHeader  ) 

Return the Z scale factor.

Parameters:
hHeader LASHeaderH instance
Returns:
the Z scale factor

LAS_DLL char* LASHeader_GetSoftwareId ( const LASHeaderH  hHeader  ) 

Returns the Software ID for the header.

The caller assumes ownership of the returned string

Returns:
the software id for the header as a character array

LAS_DLL char* LASHeader_GetSystemId ( const LASHeaderH  hHeader  ) 

Returns the System ID for the header.

The caller assumes ownership of the returned string

Returns:
the system id for the header as a character array

LAS_DLL uint8_t LASHeader_GetVersionMajor ( const LASHeaderH  hHeader  ) 

Returns the major version number for the header.

This value is expected to always be 1.

Parameters:
hHeader LASHeaderH instance
Returns:
major version number for the header.