liblas.h

Go to the documentation of this file.

/******************************************************************************
 * $Id$
 *
 * Project:  libLAS - http://liblas.org - A BSD library for LAS format data.
 * Purpose:  Main prototypes for the libLAS C API
 * Author:   Howard Butler, hobu.inc@gmail.com
 *
 ******************************************************************************
 * Copyright (c) 2008, Howard Butler
 *
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following 
 * conditions are met:
 * 
 *     * Redistributions of source code must retain the above copyright 
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright 
 *       notice, this list of conditions and the following disclaimer in 
 *       the documentation and/or other materials provided 
 *       with the distribution.
 *     * Neither the name of the Martin Isenburg or Iowa Department 
 *       of Natural Resources nor the names of its contributors may be 
 *       used to endorse or promote products derived from this software 
 *       without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
 * OF SUCH DAMAGE.
 ****************************************************************************/
 
#ifndef LIBLAS_H_INCLUDED
#define LIBLAS_H_INCLUDED

#define LIBLAS_C_API 1

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

typedef struct LASWriterHS *LASWriterH;
typedef struct LASReaderHS *LASReaderH;
typedef struct LASPointHS *LASPointH;
typedef struct LASHeaderHS *LASHeaderH;
typedef struct LASGuidHS *LASGuidH;
typedef struct LASVLRHS *LASVLRH;
typedef struct LASColorHS *LASColorH;
typedef struct LASSRSHS *LASSRSH;
typedef struct LASSchemaHS *LASSchemaH;


LAS_C_START


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

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



LAS_DLL char* LAS_GetVersion(void);
LAS_DLL char* LAS_GetFullVersion(void);

LAS_DLL int LAS_IsLibGeoTIFFEnabled(void);

LAS_DLL int LAS_IsGDALEnabled(void);

LAS_DLL int LAS_IsLibSpatialIndexEnabled(void);
/****************************************************************************/
/* Error handling                                                           */
/****************************************************************************/

LAS_DLL void LASError_Reset(void);

LAS_DLL void LASError_Pop(void);

LAS_DLL LASError LASError_GetLastErrorNum(void);

LAS_DLL char * LASError_GetLastErrorMsg(void);

LAS_DLL char * LASError_GetLastErrorMethod(void);

LAS_DLL int LASError_GetErrorCount(void);

LAS_DLL void LASError_Print(const char* message);

/****************************************************************************/
/* Reader operations                                                        */
/****************************************************************************/

LAS_DLL LASReaderH LASReader_Create(const char * filename);

LAS_DLL LASReaderH LASReader_CreateWithHeader(  const char * filename, 
                                                LASHeaderH hHeader);

LAS_DLL LASPointH LASReader_GetNextPoint(const LASReaderH hReader);

LAS_DLL LASPointH LASReader_GetPointAt(const LASReaderH hReader, unsigned int position);

LAS_DLL void LASReader_Destroy(LASReaderH hReader);

LAS_DLL LASHeaderH LASReader_GetHeader(const LASReaderH hReader);

LAS_DLL void LASReader_SetHeader(  LASReaderH hReader, const LASHeaderH hHeader);

LAS_DLL LASError LASReader_SetSRS(LASReaderH hReader, const LASSRSH hSRS);
LAS_DLL LASError LASReader_SetInputSRS(LASReaderH hReader, const LASSRSH hSRS);
LAS_DLL LASError LASReader_SetOutputSRS(LASReaderH hReader, const LASSRSH hSRS);

LAS_DLL LASError LASReader_Seek(LASReaderH hReader, unsigned int position);

LAS_DLL char* LASReader_GetSummaryXML(const LASReaderH hReader);

/****************************************************************************/
/* Point operations                                                         */
/****************************************************************************/

LAS_DLL double LASPoint_GetX(const LASPointH hPoint);

LAS_DLL LASError LASPoint_SetX(LASPointH hPoint, double value);

LAS_DLL long LASPoint_GetRawX(const LASPointH hPoint);

LAS_DLL LASError LASPoint_SetRawX(LASPointH hPoint, long value);

LAS_DLL double LASPoint_GetY(const LASPointH hPoint);

LAS_DLL LASError LASPoint_SetY(LASPointH hPoint, double value);

LAS_DLL long LASPoint_GetRawY(const LASPointH hPoint);

LAS_DLL LASError LASPoint_SetRawY(LASPointH hPoint, long value);

LAS_DLL double LASPoint_GetZ(const LASPointH hPoint);

LAS_DLL LASError LASPoint_SetZ(LASPointH hPoint, double value);

LAS_DLL long LASPoint_GetRawZ(const LASPointH hPoint);

LAS_DLL LASError LASPoint_SetRawZ(LASPointH hPoint, long value);


LAS_DLL unsigned short LASPoint_GetIntensity(const LASPointH hPoint);

LAS_DLL LASError LASPoint_SetIntensity(LASPointH hPoint, unsigned short value);

LAS_DLL unsigned short LASPoint_GetReturnNumber(const LASPointH hPoint);

LAS_DLL LASError LASPoint_SetReturnNumber(LASPointH hPoint, unsigned short value);

LAS_DLL unsigned short LASPoint_GetNumberOfReturns(const LASPointH hPoint);

LAS_DLL LASError LASPoint_SetNumberOfReturns(LASPointH hPoint, unsigned short value);

LAS_DLL unsigned short LASPoint_GetScanDirection(const LASPointH hPoint);

LAS_DLL LASError LASPoint_SetScanDirection(LASPointH hPoint, unsigned short value);

LAS_DLL unsigned short LASPoint_GetFlightLineEdge(const LASPointH hPoint);

LAS_DLL LASError LASPoint_SetFlightLineEdge(LASPointH hPoint, unsigned short value);

LAS_DLL unsigned char LASPoint_GetScanFlags(const LASPointH hPoint);

LAS_DLL LASError LASPoint_SetScanFlags(LASPointH hPoint, unsigned char value);

LAS_DLL unsigned char LASPoint_GetClassification(const LASPointH hPoint);

LAS_DLL LASError LASPoint_SetClassification(LASPointH hPoint, unsigned char value);

LAS_DLL double LASPoint_GetTime(const LASPointH hPoint);

LAS_DLL LASError LASPoint_SetTime(LASPointH hPoint, double value);

LAS_DLL char LASPoint_GetScanAngleRank(const LASPointH hPoint);

LAS_DLL LASError LASPoint_SetScanAngleRank(LASPointH hPoint, char value);

LAS_DLL LASError LASPoint_SetPointSourceId(LASPointH hPoint, unsigned short value);

LAS_DLL unsigned short LASPoint_GetPointSourceId(LASPointH hPoint);

LAS_DLL unsigned char LASPoint_GetUserData(const LASPointH hPoint);

LAS_DLL LASError LASPoint_SetUserData(LASPointH hPoint, unsigned char value);

LAS_DLL int LASPoint_Validate(LASPointH hPoint);

LAS_DLL int LASPoint_IsValid(LASPointH hPoint);

LAS_DLL LASPointH LASPoint_Create(void);

LAS_DLL LASPointH LASPoint_Copy(const LASPointH hPoint);

LAS_DLL void LASPoint_Destroy(LASPointH hPoint);

LAS_DLL LASHeaderH LASPoint_GetHeader(const LASPointH hPoint);

LAS_DLL void LASPoint_SetHeader( LASPointH hPoint, const LASHeaderH hHeader);

LAS_DLL LASError LASPoint_GetData(const LASPointH hPoint, unsigned char* data);

LAS_DLL LASError LASPoint_SetData(LASPointH hPoint, unsigned char* data);


LAS_DLL char* LASPoint_GetXML(const LASPointH hPoint);

/****************************************************************************/
/* Header operations                                                        */
/****************************************************************************/

LAS_DLL LASHeaderH LASHeader_Copy(const LASHeaderH hHeader);

LAS_DLL LASHeaderH LASHeader_Create(void);

LAS_DLL void LASHeader_Destroy(LASHeaderH hHeader);

LAS_DLL char *LASHeader_GetFileSignature(const LASHeaderH hHeader);

LAS_DLL unsigned short LASHeader_GetFileSourceId(const LASHeaderH hHeader);

LAS_DLL LASError LASHeader_SetFileSourceId(LASHeaderH hHeader, unsigned short value);

LAS_DLL char *LASHeader_GetProjectId(const LASHeaderH hHeader);

LAS_DLL LASError LASHeader_SetProjectId(LASHeaderH hHeader, const char* value);

LAS_DLL LASError LASHeader_SetGUID(LASHeaderH hHeader, LASGuidH hId);

LAS_DLL unsigned char LASHeader_GetVersionMajor(const LASHeaderH hHeader);

LAS_DLL LASError LASHeader_SetVersionMajor(LASHeaderH hHeader, unsigned char value);

LAS_DLL unsigned char LASHeader_GetVersionMinor(const LASHeaderH hHeader);

LAS_DLL LASError LASHeader_SetVersionMinor(LASHeaderH hHeader, unsigned char value);

LAS_DLL char *LASHeader_GetSystemId(const LASHeaderH hHeader);

LAS_DLL LASError LASHeader_SetSystemId(LASHeaderH hHeader, const char* value);

LAS_DLL char *LASHeader_GetSoftwareId(const LASHeaderH hHeader);

LAS_DLL LASError LASHeader_SetSoftwareId(LASHeaderH hHeader, const char* value);

LAS_DLL unsigned short LASHeader_GetReserved(const LASHeaderH hHeader);

LAS_DLL LASError LASHeader_SetReserved(LASHeaderH hHeader, unsigned short value);

LAS_DLL unsigned short LASHeader_GetCreationDOY(const LASHeaderH hHeader);

LAS_DLL LASError LASHeader_SetCreationDOY(LASHeaderH hHeader, unsigned short value);

LAS_DLL unsigned short LASHeader_GetCreationYear(const LASHeaderH hHeader);

LAS_DLL LASError LASHeader_SetCreationYear(LASHeaderH hHeader, unsigned short value);

LAS_DLL unsigned short LASHeader_GetHeaderSize(const LASHeaderH hHeader);

LAS_DLL unsigned int LASHeader_GetDataOffset(const LASHeaderH hHeader);

 LAS_DLL LASError LASHeader_SetDataOffset(const LASHeaderH hHeader, unsigned int value);

LAS_DLL unsigned int LASHeader_GetHeaderPadding(const LASHeaderH hHeader);

 LAS_DLL LASError LASHeader_SetHeaderPadding(const LASHeaderH hHeader, unsigned int value);


LAS_DLL unsigned int LASHeader_GetRecordsCount(const LASHeaderH hHeader);

LAS_DLL unsigned short LASHeader_GetDataRecordLength(const LASHeaderH hHeader);

LAS_DLL LASError LASHeader_SetDataRecordLength(const LASHeaderH hHeader, unsigned short value);

LAS_DLL unsigned char LASHeader_GetDataFormatId(const LASHeaderH hHeader);

LAS_DLL LASError LASHeader_SetDataFormatId(const LASHeaderH hHeader, unsigned char value);

LAS_DLL unsigned int LASHeader_GetPointRecordsCount(const LASHeaderH hHeader);

LAS_DLL LASError LASHeader_SetPointRecordsCount(const LASHeaderH hHeader, unsigned int value);

LAS_DLL unsigned int LASHeader_GetPointRecordsByReturnCount(const LASHeaderH hHeader, int index);

LAS_DLL LASError LASHeader_SetPointRecordsByReturnCount(const LASHeaderH hHeader, int index, unsigned int value);

LAS_DLL double LASHeader_GetScaleX(const LASHeaderH hHeader);

LAS_DLL double LASHeader_GetScaleY(const LASHeaderH hHeader);

LAS_DLL double LASHeader_GetScaleZ(const LASHeaderH hHeader);

LAS_DLL LASError LASHeader_SetScale(LASHeaderH hHeader, double x, double y, double z);

LAS_DLL double LASHeader_GetOffsetX(const LASHeaderH hHeader);

LAS_DLL double LASHeader_GetOffsetY(const LASHeaderH hHeader);

LAS_DLL double LASHeader_GetOffsetZ(const LASHeaderH hHeader);

LAS_DLL LASError LASHeader_SetOffset(LASHeaderH hHeader, double x, double y, double z);

LAS_DLL double LASHeader_GetMinX(const LASHeaderH hHeader);

LAS_DLL double LASHeader_GetMinY(const LASHeaderH hHeader);

LAS_DLL double LASHeader_GetMinZ(const LASHeaderH hHeader);

LAS_DLL LASError LASHeader_SetMin(LASHeaderH hHeader, double x, double y, double z);

LAS_DLL double LASHeader_GetMaxX(const LASHeaderH hHeader);

LAS_DLL double LASHeader_GetMaxY(const LASHeaderH hHeader);

LAS_DLL double LASHeader_GetMaxZ(const LASHeaderH hHeader);

LAS_DLL LASError LASHeader_SetMax(LASHeaderH hHeader, double x, double y, double z);

LAS_DLL LASVLRH LASHeader_GetVLR(const LASHeaderH hHeader, unsigned int i);

LAS_DLL LASError LASHeader_DeleteVLR(LASHeaderH hHeader, unsigned int index);

LAS_DLL LASError LASHeader_AddVLR(LASHeaderH hHeader, const LASVLRH hVLR);

LAS_DLL char* LASHeader_GetXML(const LASHeaderH hHeader);

/****************************************************************************/
/* Writer Operations                                                        */
/****************************************************************************/

LAS_DLL LASWriterH LASWriter_Create(const char* filename, const LASHeaderH hHeader, int mode);

LAS_DLL LASError LASWriter_WritePoint(const LASWriterH hWriter, const LASPointH hPoint);

LAS_DLL LASError LASWriter_WriteHeader(const LASWriterH hWriter, const LASHeaderH hHeader);

LAS_DLL LASError LASWriter_WriteOwnedHeader(const LASWriterH hWriter);

LAS_DLL void LASWriter_Destroy(LASWriterH hWriter);

LAS_DLL LASHeaderH LASWriter_GetHeader(const LASWriterH hWriter);
LAS_DLL void LASWriter_SetHeader(  LASWriterH hWriter, const LASHeaderH hHeader) ;

LAS_DLL LASError LASWriter_SetSRS(LASWriterH hWriter, const LASSRSH hSRS);
LAS_DLL LASError LASWriter_SetInputSRS(LASWriterH hWriter, const LASSRSH hSRS);
LAS_DLL LASError LASWriter_SetOutputSRS(LASWriterH hWriter, const LASSRSH hSRS);

/****************************************************************************/
/* GUID Operations                                                          */
/****************************************************************************/

LAS_DLL LASGuidH LASHeader_GetGUID(const LASHeaderH hHeader);

LAS_DLL LASGuidH LASGuid_Create();

LAS_DLL LASGuidH LASGuid_CreateFromString(const char* string);

LAS_DLL void LASGuid_Destroy(LASGuidH hId);

LAS_DLL int LASGuid_Equals(LASGuidH hId1, LASGuidH hId2);

LAS_DLL char* LASGuid_AsString(LASGuidH hId);

/****************************************************************************/
/* VLR Operations                                                           */
/****************************************************************************/

LAS_DLL LASVLRH LASVLR_Create(void);

LAS_DLL void LASVLR_Destroy(LASVLRH hVLR);

LAS_DLL char* LASVLR_GetUserId(const LASVLRH hVLR);

LAS_DLL LASError LASVLR_SetUserId(LASVLRH hVLR, const char* value);

LAS_DLL char* LASVLR_GetDescription(const LASVLRH hVLR);

LAS_DLL LASError LASVLR_SetDescription(LASVLRH hVLR, const char* value);

LAS_DLL unsigned short LASVLR_GetRecordLength(const LASVLRH hVLR);

LAS_DLL LASError LASVLR_SetRecordLength(LASVLRH hVLR, unsigned short value);

LAS_DLL unsigned short LASVLR_GetRecordId(const LASVLRH hVLR);

LAS_DLL LASError LASVLR_SetRecordId(LASVLRH hVLR, unsigned short value);

LAS_DLL unsigned short LASVLR_GetReserved(const LASVLRH hVLR);

LAS_DLL LASError LASVLR_SetReserved(LASVLRH hVLR, unsigned short value);

LAS_DLL LASError LASVLR_GetData(const LASVLRH hVLR, unsigned char* data);

LAS_DLL LASError LASVLR_SetData(const LASVLRH hVLR, unsigned char* data, unsigned short length);


/****************************************************************************/
/* Color Operations                                                           */
/****************************************************************************/

LAS_DLL LASColorH LASColor_Create(void);

LAS_DLL void LASColor_Destroy(LASColorH hColor);

LAS_DLL unsigned short LASColor_GetRed(const LASColorH hColor);

LAS_DLL LASError LASColor_SetRed(LASColorH hColor, unsigned short value);

LAS_DLL unsigned short LASColor_GetGreen(const LASColorH hColor);

LAS_DLL LASError LASColor_SetGreen(LASColorH hColor, unsigned short value);

LAS_DLL unsigned short LASColor_GetBlue(const LASColorH hColor);

LAS_DLL LASError LASColor_SetBlue(LASColorH hColor, unsigned short value);


LAS_DLL LASColorH LASPoint_GetColor(const LASPointH hPoint);

LAS_DLL LASError LASPoint_SetColor(LASPointH hPoint, const LASColorH hColor);


/****************************************************************************/
/* SRS Operations                                                           */
/****************************************************************************/

LAS_DLL LASSRSH LASSRS_Create(void);

LAS_DLL const /*GTIF*/ void* LASSRS_GetGTIF(LASSRSH hSRS);
LAS_DLL LASError LASSRS_SetGTIF(LASSRSH hSRS, const /* GTIF */ void* pgtiff, const /* ST_TIFF */ void* ptiff);
LAS_DLL char* LASSRS_GetWKT(LASSRSH hSRS );
LAS_DLL char* LASSRS_GetWKT_CompoundOK( LASSRSH hSRS );
LAS_DLL LASError LASSRS_SetWKT(LASSRSH hSRS, const char* value);
LAS_DLL LASError LASSRS_SetFromUserInput(LASSRSH hSRS, const char* value);
LAS_DLL char* LASSRS_GetProj4(LASSRSH hSRS);
LAS_DLL LASError LASSRS_SetProj4(LASSRSH hSRS, const char* value);
LAS_DLL LASError LASSRS_SetVerticalCS(LASSRSH hSRS, int verticalCSType,
                                      const char *citation, int verticalDatum,
                                      int verticalUnits );
LAS_DLL LASSRSH LASHeader_GetSRS(const LASHeaderH hHeader);
LAS_DLL LASError LASHeader_SetSRS(LASHeaderH hHeader, const LASSRSH hSRS);
LAS_DLL void LASSRS_Destroy(LASSRSH hSRS);
LAS_DLL LASVLRH LASSRS_GetVLR(const LASSRSH hSRS, unsigned int i);
LAS_DLL unsigned int LASSRS_GetVLRCount(const LASSRSH hSRS);

LAS_DLL void LASString_Free(char* string);

LAS_DLL unsigned int LASSchema_GetByteSize( LASSchemaH hFormat);
LAS_DLL unsigned int LASSchema_GetBaseByteSize( LASSchemaH hFormat);



LAS_DLL LASSchemaH LASHeader_GetSchema( LASHeaderH hHeader );
LAS_DLL LASError LASHeader_SetSchema( LASHeaderH hHeader, LASSchemaH hFormat);

LAS_DLL void LASSchema_Destroy(LASSchemaH hFormat);

LAS_DLL int LASHeader_Compressed(const LASHeaderH hHeader);

LAS_DLL LASError LASHeader_SetCompressed(LASHeaderH hHeader, int b);

LAS_C_END
#endif