main.ts

import {classicPathDistance} from "./src/classicDistance";
import {ErrorVector} from "@indoor-analytics/entities";
import {Feature, LineString} from "@turf/helpers";
import {distanceWithTime} from "./src/distanceWithTime";


/**
 * Compares a path to another by projecting its positions on the reference path.
 *
 * This encapsulates two different algorithms:
 *     - a classical algorithm only compares paths locations;
 *     - a timed algorithm also compares path locations reception times to checkpoints timestamps.
 *
 * To trigger the timed algorithm, you should provide an array of checkpoints timestamps (representing times when reference
 * path checkpoints have been reached) as third argument of this method, and the comparedPath LineString object should
 * feature a locationsTimestamps attribute (containing compared path locations acquisition timestamps).
 *
 *
 * @param referencePath ground truth path
 * @param comparedPath path to compare to ground truth
 * @param checkpointsTimestamps times (in milliseconds since Unix Epoch) when reference path checkpoints have been reached
 */
function pathDistance (
    referencePath: Feature<LineString>,
    comparedPath: Feature<LineString>,
    checkpointsTimestamps: number[] = []
): ErrorVector[] {
    return checkpointsTimestamps.length !== 0 && comparedPath.properties !== null && comparedPath.properties.hasOwnProperty('locationsTimestamps')
        ? distanceWithTime(referencePath, comparedPath as Feature<LineString, {locationsTimestamps: number[]}>, checkpointsTimestamps)
        : classicPathDistance(referencePath, comparedPath);
}

export {pathDistance};