@saber-usa/node-common 1.7.7 → 1.7.9-alpha.1

package/src/udl.js

@@ -1,116 +1,231 @@
-import {fixDate} from "./fixDate.js";
-import {calcRegime, getElsetUdlFromTle, getLonAndDrift, getRaanPrecession} from "./astro.js";
-import {lowerCaseObjectKeys} from "./transform.js";
-import {isDefined} from "./utils.js";
-import _ from "lodash";
-
-const udlToNpsElset = (udlRow) => {
-    let derivedElset;
-    try {
-        derivedElset = getElsetUdlFromTle(udlRow.line1, udlRow.line2, udlRow.dataMode);
-    } catch {
-        // invalid TLE
-        derivedElset = null;
-    }
-    const enrichedUdlFields = [];
-    const enrichField = (field) => {
-        if (derivedElset && (derivedElset[field] || derivedElset[field] === 0)) {
-            enrichedUdlFields.push(field);
-            return derivedElset[field];
-        }
-        return null;
-    };
-    const lonAndDrift = getLonAndDrift(udlRow.line1, udlRow.line2);
-
-    const getElsetValue = (value, defaultValueFunc) => {
-        return (isDefined(value)) ? value : defaultValueFunc();
-    };
-
-    const npsElset = lowerCaseObjectKeys({
-        Satno: getElsetValue(udlRow.satNo, ()=>enrichField("satNo")),
-        Epoch: fixDate(getElsetValue(udlRow.epoch, ()=>enrichField("epoch"))),
-        MeanMotion: getElsetValue(udlRow.meanMotion, ()=>enrichField("meanMotion")),
-        Eccentricity: getElsetValue(udlRow.eccentricity, ()=>enrichField("eccentricity")),
-        Inclination: getElsetValue(udlRow.inclination, ()=>enrichField("inclination")),
-        Raan: getElsetValue(udlRow.raan, ()=>enrichField("raan")),
-        ArgOfPerigee: getElsetValue(udlRow.argOfPerigee, ()=>enrichField("argOfPerigee")),
-        MeanAnomaly: getElsetValue(udlRow.meanAnomaly, ()=>enrichField("meanAnomaly")),
-        BStar: getElsetValue(udlRow.bStar, ()=>enrichField("bStar")),
-        SemiMajorAxis: getElsetValue(udlRow.semiMajorAxis, ()=>enrichField("semiMajorAxis")),
-        Period: getElsetValue(udlRow.period, ()=>enrichField("period")),
-        Apogee: getElsetValue(udlRow.apogee, ()=>enrichField("apogee")),
-        Perigee: getElsetValue(udlRow.perigee, ()=>enrichField("perigee")),
-        Line1: getElsetValue(udlRow.line1, ()=>null),
-        Line2: getElsetValue(udlRow.line2, ()=>null),
-        Source: getElsetValue(udlRow.source, ()=>null),
-        DataMode: getElsetValue(udlRow.dataMode, ()=>null),
-        CreatedAt: fixDate(getElsetValue(udlRow.createdAt, ()=>null)),
-        Origin: getElsetValue(udlRow.origin, ()=>null),
-        Algorithm: getElsetValue(udlRow.algorithm, ()=>null),
-        Descriptor: getElsetValue(udlRow.descriptor, ()=>null),
-        ClassificationMarking: getElsetValue(udlRow.classificationMarking, ()=>null),
-        Latitude: lonAndDrift.latitude,
-        Longitude: lonAndDrift.longitude,
-        LonDriftDegreesPerDay: lonAndDrift.lonDriftDegreesPerDay,
-        RaanPrecessionDegreesPerDay: getRaanPrecession(udlRow.line1, udlRow.line2),
-        // Ensure we reset all the derived calcs so we know if they have been updated by Sentinel or not.
-        MinEccentricity: 0,
-        MaxEccentricity: 0,
-        MinInclination: 0,
-        MaxInclination: 0,
-        MinRaan: 0,
-        MaxRaan: 0,
-        MinArgOfPerigee: 0,
-        MaxArgOfPerigee: 0,
-        MinSemiMajorAxis: 0,
-        MaxSemiMajorAxis: 0,
-    });
-    npsElset.regime = calcRegime(npsElset);
-    npsElset.enrichedudlfields = enrichedUdlFields.join(",");
-    return npsElset;
-};
-
-const udlToNpsGroundSite = (udlRow) => ({
-    SensorId: _.get(udlRow, "idSensor", null),
-    Number: _.get(udlRow, "sensorNumber", null),
-    Name: _.get(udlRow, "sensorName", null),
-    Source: _.get(udlRow, "source", null),
-    Description: null,
-    LastObsTime: _.get(udlRow, "sensorStats[0].lastObTime", null),
-    CountryCode: _.get(udlRow, "entity.countryCode", "None"),
-    Taskable: _.get(udlRow, "entity.taskable", 0),
-    Type: _.get(udlRow, "sensorType.id", 0),
-    Latitude: _.get(udlRow, "entity.location.lat", 0),
-    Longitude: _.get(udlRow, "entity.location.lon", 0),
-    KmAboveSeaLevel: _.get(udlRow, "entity.location.altitude", 0),
-    MinRangeKm: _.get(udlRow, "sensorcharacteristics[0].minRangeLimit", null),
-    MaxRangeKm: _.get(udlRow, "sensorcharacteristics[0].maxRangeLimit", null),
-    ClassificationLevel: _.get(
-        udlRow,
-        "sensorcharacteristics[0].classificationMarking",
-        "",
-    ),
-    createdAt: fixDate(_.get(udlRow, "createdAt")),
-});
-
-/**
- * Formats the response data based on the topic
- *
- * @param {String} topic
- * @param {Object[]} udlData
- * @return {Object[]}
- */
-export function formatUdlData(topic, udlData) {
-    switch (topic) {
-        case "Elsets":
-            return _.map(udlData, udlToNpsElset);
-
-        case "GroundSites":
-            return _.map(udlData, udlToNpsGroundSite);
-
-        default:
-            return udlData;
-    }
-}
-
-export {udlToNpsElset, udlToNpsGroundSite};
+import {fixDate} from "./fixDate.js";
+import {
+    calcRegime,
+    getElsetUdlFromTle,
+    getLonAndDrift,
+    getRaanPrecession,
+    raDecToAzEl,
+    azElToRaDec,
+    raDecToGeodetic,
+    estimateSlantRange,
+} from "./astro.js";
+import {lowerCaseObjectKeys} from "./transform.js";
+import {isDefined} from "./utils.js";
+import _ from "lodash";
+
+const udlToNpsElset = (udlRow) => {
+    let derivedElset;
+    try {
+        derivedElset = getElsetUdlFromTle(udlRow.line1, udlRow.line2, udlRow.dataMode);
+    } catch {
+        // invalid TLE
+        derivedElset = null;
+    }
+    const enrichedUdlFields = [];
+    const enrichField = (field) => {
+        if (derivedElset && (derivedElset[field] || derivedElset[field] === 0)) {
+            enrichedUdlFields.push(field);
+            return derivedElset[field];
+        }
+        return null;
+    };
+    const lonAndDrift = getLonAndDrift(udlRow.line1, udlRow.line2);
+
+    const getElsetValue = (value, defaultValueFunc) => {
+        return (isDefined(value)) ? value : defaultValueFunc();
+    };
+
+    const npsElset = lowerCaseObjectKeys({
+        Satno: getElsetValue(udlRow.satNo, ()=>enrichField("satNo")),
+        Epoch: fixDate(getElsetValue(udlRow.epoch, ()=>enrichField("epoch"))),
+        MeanMotion: getElsetValue(udlRow.meanMotion, ()=>enrichField("meanMotion")),
+        Eccentricity: getElsetValue(udlRow.eccentricity, ()=>enrichField("eccentricity")),
+        Inclination: getElsetValue(udlRow.inclination, ()=>enrichField("inclination")),
+        Raan: getElsetValue(udlRow.raan, ()=>enrichField("raan")),
+        ArgOfPerigee: getElsetValue(udlRow.argOfPerigee, ()=>enrichField("argOfPerigee")),
+        MeanAnomaly: getElsetValue(udlRow.meanAnomaly, ()=>enrichField("meanAnomaly")),
+        BStar: getElsetValue(udlRow.bStar, ()=>enrichField("bStar")),
+        SemiMajorAxis: getElsetValue(udlRow.semiMajorAxis, ()=>enrichField("semiMajorAxis")),
+        Period: getElsetValue(udlRow.period, ()=>enrichField("period")),
+        Apogee: getElsetValue(udlRow.apogee, ()=>enrichField("apogee")),
+        Perigee: getElsetValue(udlRow.perigee, ()=>enrichField("perigee")),
+        Line1: getElsetValue(udlRow.line1, ()=>null),
+        Line2: getElsetValue(udlRow.line2, ()=>null),
+        Source: getElsetValue(udlRow.source, ()=>null),
+        DataMode: getElsetValue(udlRow.dataMode, ()=>null),
+        CreatedAt: fixDate(getElsetValue(udlRow.createdAt, ()=>null)),
+        Origin: getElsetValue(udlRow.origin, ()=>null),
+        Algorithm: getElsetValue(udlRow.algorithm, ()=>null),
+        Descriptor: getElsetValue(udlRow.descriptor, ()=>null),
+        ClassificationMarking: getElsetValue(udlRow.classificationMarking, ()=>null),
+        Latitude: lonAndDrift.latitude,
+        Longitude: lonAndDrift.longitude,
+        LonDriftDegreesPerDay: lonAndDrift.lonDriftDegreesPerDay,
+        RaanPrecessionDegreesPerDay: getRaanPrecession(udlRow.line1, udlRow.line2),
+        // Ensure we reset all the derived calcs so we know if they have been updated by Sentinel or not.
+        MinEccentricity: 0,
+        MaxEccentricity: 0,
+        MinInclination: 0,
+        MaxInclination: 0,
+        MinRaan: 0,
+        MaxRaan: 0,
+        MinArgOfPerigee: 0,
+        MaxArgOfPerigee: 0,
+        MinSemiMajorAxis: 0,
+        MaxSemiMajorAxis: 0,
+    });
+    npsElset.regime = calcRegime(npsElset);
+    npsElset.enrichedudlfields = enrichedUdlFields.join(",");
+    return npsElset;
+};
+
+const udlToNpsGroundSite = (udlRow) => ({
+    SensorId: _.get(udlRow, "idSensor", null),
+    Number: _.get(udlRow, "sensorNumber", null),
+    Name: _.get(udlRow, "sensorName", null),
+    Source: _.get(udlRow, "source", null),
+    Description: null,
+    LastObsTime: _.get(udlRow, "sensorStats[0].lastObTime", null),
+    CountryCode: _.get(udlRow, "entity.countryCode", "None"),
+    Taskable: _.get(udlRow, "entity.taskable", 0),
+    Type: _.get(udlRow, "sensorType.id", 0),
+    Latitude: _.get(udlRow, "entity.location.lat", 0),
+    Longitude: _.get(udlRow, "entity.location.lon", 0),
+    KmAboveSeaLevel: _.get(udlRow, "entity.location.altitude", 0),
+    MinRangeKm: _.get(udlRow, "sensorcharacteristics[0].minRangeLimit", null),
+    MaxRangeKm: _.get(udlRow, "sensorcharacteristics[0].maxRangeLimit", null),
+    ClassificationLevel: _.get(
+        udlRow,
+        "sensorcharacteristics[0].classificationMarking",
+        "",
+    ),
+    createdAt: fixDate(_.get(udlRow, "createdAt")),
+});
+
+/**
+ * Formats the response data based on the topic
+ *
+ * @param {String} topic
+ * @param {Object[]} udlData
+ * @return {Object[]}
+ */
+export function formatUdlData(topic, udlData) {
+    switch (topic) {
+        case "Elsets":
+            return _.map(udlData, udlToNpsElset);
+
+        case "GroundSites":
+            return _.map(udlData, udlToNpsGroundSite);
+
+        default:
+            return udlData;
+    }
+}
+
+/**
+ * Enriches the Azimuth and Elevation fields of the given object, if needed.
+ *
+ * @param {object} npsOb - The object to be enriched.
+ * @param {array} enrichedFields - The array of already enriched fields.
+ * @return {array} The updated array of enriched fields.
+ */
+const enrichAzimuthAndElevation = (npsOb, enrichedFields) => {
+    const azel = raDecToAzEl(npsOb.ObTime, npsOb.Ra, npsOb.Dec, npsOb.SenLat, npsOb.SenLon);
+    const {Az, El} = azel;
+    if (Az && !npsOb.Azimuth) {
+        npsOb.Azimuth = Az;
+        enrichedFields.push("Azimuth");
+    }
+    if (El && !npsOb.Elevation) {
+        npsOb.Elevation = El;
+        enrichedFields.push("Elevation");
+    }
+    return enrichedFields;
+};
+
+/**
+ * Enriches the Ra and Dec fields of the given object, if needed.
+ *
+ * @param {object} npsOb - The object to be enriched.
+ * @param {array} enrichedFields - The array of already enriched fields.
+ * @return {array} The updated array of enriched fields.
+ */
+const enrichRaAndDec = (npsOb, enrichedFields) => {
+    const radec = azElToRaDec(
+        npsOb.ObTime,
+        npsOb.Azimuth,
+        npsOb.Elevation,
+        npsOb.SenLat,
+        npsOb.SenLon,
+    );
+    const {ra, dec} = radec;
+    if (ra && !npsOb.Ra) {
+        npsOb.Ra = ra;
+        enrichedFields.push("Ra");
+    }
+    if (dec && !npsOb.Dec) {
+        npsOb.Dec = dec;
+        enrichedFields.push("Dec");
+    }
+    return enrichedFields;
+};
+
+/**
+ * Enriches the GeoLon field of the given object, if needed.
+ *
+ * @param {object} npsOb - The object to be enriched.
+ * @param {array} enrichedFields - The array of already enriched fields.
+ * @return {array} The updated array of enriched fields.
+ */
+const enrichGeoLon = (npsOb, enrichedFields) => {
+    // In the absence of range, we estimate the slant range from the sensor to the sat
+    const slantRange = npsOb.Range ?? npsOb.GeoRange ?? estimateSlantRange(
+        npsOb.ObTime,
+        npsOb.Ra, npsOb.Dec,
+        npsOb.SenLat, npsOb.SenLon, npsOb.SenAlt,
+    );
+    const geodetic= raDecToGeodetic(
+        npsOb.ObTime,
+        npsOb.Ra,
+        npsOb.Dec,
+        npsOb.SenLat,
+        npsOb.SenLon,
+        npsOb.SenAlt,
+        slantRange,
+    );
+    npsOb.GeoLon = geodetic.Longitude;
+    npsOb.GeoLat = geodetic.Latitude;
+    npsOb.GeoRange = slantRange;
+    if (!npsOb.Range && !npsOb.GeoRange) enrichedFields.push("GeoRange");
+    if (npsOb.GeoLon) enrichedFields.push("GeoLon");
+    if (npsOb.GeoLat) enrichedFields.push("GeoLat");
+    return enrichedFields;
+};
+
+/**
+ * Enriches the given object by adding missing fields.
+ * This is the main function that uses helper functions to enrich different fields of the object.
+ *
+ * @param {object} npsOb - The object to be enriched.
+ * @return {object} The enriched object.
+ */
+const enrichUdlFields = (npsOb) => {
+    let enrichedFields = [];
+
+    if (!npsOb.Azimuth || !npsOb.Elevation) {
+        enrichedFields = enrichAzimuthAndElevation(npsOb, enrichedFields);
+    }
+
+    if (!npsOb.Ra || !npsOb.Dec) {
+        enrichedFields = enrichRaAndDec(npsOb, enrichedFields);
+    }
+
+    if (!npsOb.GeoLon) {
+        enrichedFields = enrichGeoLon(npsOb, enrichedFields);
+    }
+
+    npsOb.EnrichedFields = enrichedFields.join(",");
+    return npsOb;
+};
+
+export {udlToNpsElset, udlToNpsGroundSite, enrichUdlFields};