licelfile/README.md

A Bun package for reading licel files (from lidar transient recorder)

# licelfile
Library to read licel files (lidar data files from Licel trancient recorder)



# Types
```typescript
export interface IProfile {
    active: boolean;
    photon: boolean;
    laserType: number;
    nDataPoints: number;
    reserved: [number, number, number];
    highVoltage: number;
    binWidth: number;
    wavelength: number;
    polarization: string;
    binShift: number;
    decBinShift: number;
    adcBits: number;
    nShots: number;
    discrLevel: number;
    deviceId: string;
    nCrate: number;
    data: Uint32Array;
}

export interface ILaserConfig {
    numberOfShots: number;
    frequency: number;
}


export interface ILicelFile {
    measurementSite: string
    measurementStartTime: Date
    measurementStopTime: Date
    altitudeAboveSeaLevel: number
    longitude: number
    latitude: number
    zenith: number
    laserConfig: ILaserConfig[]
    nDatasets: number
    profiles: IProfile[],
}

export interface ILicelPack {
    startTime: Date;
    data: Map<string, ILicelFile>;
}

```


```typescript
export async function loadLicelFile(path: string): Promise<ILicelFile>
export async function loadLicelFileFromArrayBuffer(rawBuffer: ArrayBuffer): Promise<ILicelFile>
export async function loadLicelPack(filePaths: string[]): Promise<ILicelPack> 
export async function loadLicelPackFromZip(zipFile: string): Promise<ILicelPack> 
```