@speleotica/frcs2breakout

Converts data from FRCS format to Breakout.

API

import {
  FrcsPlotFile,
  FrcsSurveyFile,
  FrcsTripSummaryFile,
} from '@speleotica/frcsdata'
import { Length, UnitizedNumber } from '@speleotica/unitized'

type CaveInput = {
  /**
   * Parsed survey file data
   */
  survey: FrcsSurveyFile
  /**
   * Parsed plot file data
   */
  plot?: FrcsPlotFile
  /**
   * Parsed trip summaries file data
   */
  summaries?: FrcsTripSummaryFile
  /**
   * If given, will add survey notes filenames to the output trips
   */
  surveyNotesFilePrefix?: string
  /**
   * The UTM zone of the plot.  If omitted, fixed stations won't be output
   */
  utmZone?: number
  /**
   * Offset to apply to fixed stations from the plot
   */
  zeroReference?: {
    northing: UnitizedNumber<Length>
    easting: UnitizedNumber<Length>
    elevation: UnitizedNumber<Length>
  }
}

export function convertToBreakout(data: Record<string, CaveInput>): MetacaveData