Skip to content

Interactive interface for browsing global, full-resolution satellite imagery

WV-3235-Support Time-Limited Display of TEMPO Imagery (#5363)

Patrick Moulden903b2e83718a
diff --git a/web/js/components/timeline/timeline-coverage/timeline-coverage.js b/web/js/components/timeline/timeline-coverage/timeline-coverage.js
index cb31c37a4..be3450029 100644
--- a/web/js/components/timeline/timeline-coverage/timeline-coverage.js
+++ b/web/js/components/timeline/timeline-coverage/timeline-coverage.js
@@ -19,97 +19,6 @@ import Switch from '../../util/switch';
import LayerCoverageInfoModal from './info-modal';
import CoverageItemList from './coverage-item-list';
-function makeTime(date) {
- return new Date(date).getTime();
-}
-
-function mergeSortedGranuleDateRanges(granules) {
- return granules.reduce((acc, [start, end]) => {
- if (!acc.length) return [[start, end]];
- const startTime = makeTime(start);
- const endTime = makeTime(end);
- const lastRangeEndTime = makeTime(acc.at(-1)[1]);
- const lastRangeStartTime = makeTime(acc.at(-1)[0]);
- if ((startTime >= lastRangeStartTime && startTime <= lastRangeEndTime) && (endTime >= lastRangeStartTime && endTime <= lastRangeEndTime)) { // within current range, ignore
- return acc;
- }
- if (startTime > lastRangeEndTime) { // discontinuous, add new range
- return [...acc, [start, end]];
- }
- if (startTime <= lastRangeEndTime && endTime > lastRangeEndTime) { // intersects current range, merge
- return acc.with(-1, [acc.at(-1)[0], end]);
- }
- return acc;
- }, []);
-}
-
-async function requestGranules(params) {
- const {
- shortName,
- extent,
- startDate,
- endDate,
- } = params;
- const granules = [];
- let hits = Infinity;
- let searchAfter = false;
- const url = `https://cmr.earthdata.nasa.gov/search/granules.json?shortName=${shortName}&bounding_box=${extent.join(',')}&temporal=${startDate}/${endDate}&sort_key=start_date&pageSize=2000`;
- /* eslint-disable no-await-in-loop */
- do { // run the query at least once
- const headers = searchAfter ? { 'Cmr-Search-After': searchAfter, 'Client-Id': 'Worldview' } : { 'Client-Id': 'Worldview' };
- const res = await fetch(url, { headers });
- searchAfter = res.headers.get('Cmr-Search-After');
- hits = parseInt(res.headers.get('Cmr-Hits'), 10);
- const data = await res.json();
- granules.push(...data.feed.entry);
- } while (searchAfter || hits > granules.length); // searchAfter will not be present if there are no more results https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html#search-after
-
- return granules;
-}
-
-async function getLayerGranuleRanges(layer) {
- const extent = [-180, -90, 180, 90];
- const startDate = new Date(layer.startDate).toISOString();
- const endDate = layer.endDate ? new Date(layer.endDate).toISOString() : new Date().toISOString();
- const shortName = layer.conceptIds?.[0]?.shortName;
- const nrtParams = {
- shortName,
- extent,
- startDate,
- endDate,
- };
- const nrtGranules = await requestGranules(nrtParams);
- let nonNRTGranules = [];
- if (shortName.includes('_NRT')) { // if NRT, also get non-NRT granules
- const nonNRTShortName = shortName.replace('_NRT', '');
- const nonNRTParams = {
- shortName: nonNRTShortName,
- extent,
- startDate,
- endDate,
- };
- nonNRTGranules = await requestGranules(nonNRTParams);
- }
- const granules = [...nonNRTGranules, ...nrtGranules];
- const granuleDateRanges = granules.map(({ time_start: timeStart, time_end: timeEnd }) => [timeStart, timeEnd]);
- const mergedGranuleDateRanges = mergeSortedGranuleDateRanges(granuleDateRanges); // merge overlapping granule ranges to simplify rendering
-
- return mergedGranuleDateRanges;
-}
-
-async function mapGranulesToLayers(layers) {
- const promises = layers.map(async (layer) => {
- if (!layer.cmrAvailability) return layer;
-
- const ranges = await getLayerGranuleRanges(layer);
-
- return { ...layer, granules: ranges };
- });
- const cmrLayers = await Promise.all(promises);
-
- return cmrLayers;
-}
-
/*
* Timeline Layer Coverage Panel for temporal coverage.
*
@@ -120,7 +29,6 @@ class TimelineLayerCoveragePanel extends Component {
constructor(props) {
super(props);
this.state = {
- cmrLayers: [],
activeLayers: [],
shouldIncludeHiddenLayers: false,
};
@@ -226,8 +134,8 @@ class TimelineLayerCoveragePanel extends Component {
futureTime, ongoing,
} = layer;
- if (layer.granules?.length) {
- return layer.granules.map(([startDate, endDate]) => {
+ if (layer.granuleDateRanges?.length) {
+ return layer.granuleDateRanges.map(([startDate, endDate]) => {
const { gridWidth } = timeScaleOptions[timeScale].timeAxis;
const axisFrontDate = new Date(frontDate).getTime();
const axisBackDate = new Date(backDate).getTime();
@@ -357,11 +265,9 @@ class TimelineLayerCoveragePanel extends Component {
// eslint-disable-next-line react/destructuring-assignment
addMatchingCoverageToTimeline = async (isChecked, layers) => {
const { setMatchingTimelineCoverage } = this.props;
- const cmrLayers = await mapGranulesToLayers(layers);
- const dateRange = this.getNewMatchingDatesRange(cmrLayers);
+ const dateRange = this.getNewMatchingDatesRange(layers);
setMatchingTimelineCoverage(dateRange, isChecked);
this.setState({
- cmrLayers,
activeLayers: layers,
shouldIncludeHiddenLayers: isChecked,
});
@@ -379,12 +285,12 @@ class TimelineLayerCoveragePanel extends Component {
appNow,
} = this.props;
if (layers.length > 0) {
- return layers.flatMap(({ granules, startDate, endDate }) => {
- if (!granules?.length) {
+ return layers.flatMap(({ granuleDateRanges, startDate, endDate }) => {
+ if (!granuleDateRanges?.length) {
return [{ startDate, endDate: endDate || appNow }];
}
- return granules.map(([start, end]) => ({ startDate: start, endDate: end }));
+ return granuleDateRanges.map(([start, end]) => ({ startDate: start, endDate: end }));
});
}
};
@@ -481,7 +387,6 @@ class TimelineLayerCoveragePanel extends Component {
timeScale,
} = this.props;
const {
- cmrLayers,
activeLayers,
shouldIncludeHiddenLayers,
} = this.state;
@@ -536,7 +441,7 @@ class TimelineLayerCoveragePanel extends Component {
</header>
<Scrollbars style={scrollbarStyle}>
<CoverageItemList
- activeLayers={cmrLayers}
+ activeLayers={activeLayers}
appNow={appNow}
axisWidth={axisWidth}
backDate={backDate}
diff --git a/web/js/map/granule/granule-layer-builder.js b/web/js/map/granule/granule-layer-builder.js
index b50e8a09e..3c5038ebe 100644
--- a/web/js/map/granule/granule-layer-builder.js
+++ b/web/js/map/granule/granule-layer-builder.js
@@ -2,7 +2,7 @@ import OlLayerGroup from 'ol/layer/Group';
import { throttle as lodashThrottle } from 'lodash';
import OlCollection from 'ol/Collection';
import { DEFAULT_NUM_GRANULES } from '../../modules/layers/constants';
-import { updateGranuleLayerState } from '../../modules/layers/actions';
+import { updateGranuleLayerState, addGranuleDateRanges } from '../../modules/layers/actions';
import { getGranuleLayer } from '../../modules/layers/selectors';
import {
startLoading,
@@ -21,6 +21,7 @@ import {
datelineShiftGranules,
transformGranulesForProj,
} from './util';
+import { getLayerGranuleRanges } from '../util';
import util from '../../util/util';
const { toISOStringSeconds } = util;
@@ -138,6 +139,14 @@ export default function granuleLayerBuilder(cache, store, createLayerWMTS) {
});
};
+ /**
+ * Check if date is within a range
+ * @param {Date} date - date to check
+ * @param {array} ranges - array of date ranges
+ * @returns {boolean} - true if date is within a range
+ */
+ const isWithinRanges = (date, ranges) => ranges.some(([start, end]) => date >= new Date(start) && date <= new Date(end));
+
/**
* Get granuleCount number of granules that have visible imagery based on
* predetermined longitude bounds.
@@ -147,19 +156,21 @@ export default function granuleLayerBuilder(cache, store, createLayerWMTS) {
* @param {Date} leadingEdgeDate - timeline date
* @returns {array}
*/
- const getVisibleGranules = (availableGranules, granuleCount, leadingEdgeDate) => {
+ const getVisibleGranules = (availableGranules, granuleCount, leadingEdgeDate, granuleDateRanges) => {
const { proj: { selected: { crs } } } = store.getState();
const granules = [];
const availableCount = availableGranules?.length;
if (!availableCount) return granules;
const count = granuleCount > availableCount ? availableCount : granuleCount;
const sortedAvailableGranules = availableGranules.sort((a, b) => new Date(b.date) - new Date(a.date));
-
for (let i = 0; granules.length < count; i += 1) {
const item = sortedAvailableGranules[i];
if (!item) break;
const { date } = item;
- if (new Date(date) <= leadingEdgeDate && isWithinBounds(crs, item)) {
+ const dateDate = new Date(date);
+ const leadingEdgeDateUTC = new Date(leadingEdgeDate.toUTCString());
+ const isWithinRange = isWithinRanges(leadingEdgeDateUTC, granuleDateRanges);
+ if (dateDate <= leadingEdgeDateUTC && isWithinRange && isWithinBounds(crs, item)) {
granules.unshift(item);
}
}
@@ -182,16 +193,27 @@ export default function granuleLayerBuilder(cache, store, createLayerWMTS) {
const { granuleCount, date, group } = options;
const { count: currentCount } = getGranuleLayer(state, def.id) || {};
const count = currentCount || granuleCount || def.count || DEFAULT_NUM_GRANULES;
+ let granuleDateRanges = null;
// get granule dates waiting for CMR query and filtering (if necessary)
const availableGranules = await getQueriedGranuleDates(def, date, group);
- const visibleGranules = getVisibleGranules(availableGranules, count, date);
+ // if opted in to CMR availability, get granule date ranges if needed
+ if (def.cmrAvailability) {
+ if (!def.granuleDateRanges) {
+ granuleDateRanges = await getLayerGranuleRanges(def);
+ store.dispatch(addGranuleDateRanges(def, granuleDateRanges));
+ } else {
+ granuleDateRanges = def.granuleDateRanges;
+ }
+ }
+ const visibleGranules = getVisibleGranules(availableGranules, count, date, granuleDateRanges);
const transformedGranules = transformGranulesForProj(visibleGranules, crs);
return {
count,
granuleDates: transformedGranules.map((g) => g.date),
visibleGranules: transformedGranules,
+ granuleDateRanges,
};
};
diff --git a/web/js/map/layerbuilder.js b/web/js/map/layerbuilder.js
index 68b0d9224..01b6dedca 100644
--- a/web/js/map/layerbuilder.js
+++ b/web/js/map/layerbuilder.js
@@ -33,7 +33,9 @@ import {
createVectorUrl,
getGeographicResolutionWMS,
mergeBreakpointLayerAttributes,
+ getLayerGranuleRanges,
} from './util';
+import { addGranuleDateRanges } from '../modules/layers/actions';
import { datesInDateRanges, prevDateInDateRange } from '../modules/layers/util';
import { getSelectedDate } from '../modules/date/selectors';
import {
@@ -1033,6 +1035,7 @@ export default function mapLayerBuilder(config, cache, store) {
const proj = state.proj.selected;
const {
breakPointLayer,
+ cmrAvailability,
id,
opacity,
period,
@@ -1045,6 +1048,17 @@ export default function mapLayerBuilder(config, cache, store) {
let { date } = dateOptions;
let layer = cache.getItem(key);
const isGranule = type === 'granule';
+ let granuleDateRanges = null;
+
+ // if opted in to CMR availability, get granule date ranges if needed
+ if (cmrAvailability) {
+ if (!def.granuleDateRanges) {
+ granuleDateRanges = await getLayerGranuleRanges(def);
+ store.dispatch(addGranuleDateRanges(def, granuleDateRanges));
+ } else {
+ granuleDateRanges = def.granuleDateRanges;
+ }
+ }
if (!layer || isGranule || def.type === 'titiler') {
if (!date) date = options.date || getSelectedDate(state);
diff --git a/web/js/map/util.js b/web/js/map/util.js
index 6048e0780..8b7eea616 100644
--- a/web/js/map/util.js
+++ b/web/js/map/util.js
@@ -274,3 +274,109 @@ export function extractDateFromTileErrorURL(url) {
console.error('Date not found in the URL.');
return null;
}
+
+/**
+ * @method makeTime
+ * @param {string} date
+ * @returns {number} time
+ * @description
+ * Convert date to time
+*/
+function makeTime(date) {
+ return new Date(date).getTime();
+}
+
+/**
+ * @method mergeSortedGranuleDateRanges
+ * @param {array} granules
+ * @returns {array} mergedGranuleDateRanges
+ * @description
+ * Merge overlapping granule date ranges
+*/
+function mergeSortedGranuleDateRanges(granules) {
+ return granules.reduce((acc, [start, end]) => {
+ if (!acc.length) return [[start, end]];
+ // round start time down and end time up by 1 minute to account for small range gaps
+ const startTime = makeTime(start) - 60000;
+ const endTime = makeTime(end) + 60000;
+ const lastRangeEndTime = makeTime(acc.at(-1)[1]);
+ const lastRangeStartTime = makeTime(acc.at(-1)[0]);
+ if ((startTime >= lastRangeStartTime && startTime <= lastRangeEndTime) && (endTime >= lastRangeStartTime && endTime <= lastRangeEndTime)) { // within current range, ignore
+ return acc;
+ }
+ if (startTime > lastRangeEndTime) { // discontinuous, add new range
+ return [...acc, [start, end]];
+ }
+ if (startTime <= lastRangeEndTime && endTime > lastRangeEndTime) { // intersects current range, merge
+ return acc.with(-1, [acc.at(-1)[0], end]);
+ }
+ return acc;
+ }, []);
+}
+
+/**
+ * @method requestGranules
+ * @param {object} params
+ * @returns {array} granules
+ * @description
+ * Request granules from CMR
+*/
+async function requestGranules(params) {
+ const {
+ shortName,
+ extent,
+ startDate,
+ endDate,
+ } = params;
+ const granules = [];
+ let hits = Infinity;
+ let searchAfter = false;
+ const url = `https://cmr.earthdata.nasa.gov/search/granules.json?shortName=${shortName}&bounding_box=${extent.join(',')}&temporal=${startDate}/${endDate}&sort_key=start_date&pageSize=2000`;
+ /* eslint-disable no-await-in-loop */
+ do { // run the query at least once
+ const headers = searchAfter ? { 'Cmr-Search-After': searchAfter, 'Client-Id': 'Worldview' } : { 'Client-Id': 'Worldview' };
+ const res = await fetch(url, { headers });
+ searchAfter = res.headers.get('Cmr-Search-After');
+ hits = parseInt(res.headers.get('Cmr-Hits'), 10);
+ const data = await res.json();
+ granules.push(...data.feed.entry);
+ } while (searchAfter || hits > granules.length); // searchAfter will not be present if there are no more results https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html#search-after
+
+ return granules;
+}
+/**
+ * @method getLayerGranuleRanges
+ * @param {object} layer
+ * @returns {array} granuleDateRanges
+ * @description
+ * Get granule date ranges for a given layer
+*/
+export async function getLayerGranuleRanges(layer) {
+ const extent = [-180, -90, 180, 90];
+ const startDate = new Date(layer.startDate).toISOString();
+ const endDate = layer.endDate ? new Date(layer.endDate).toISOString() : new Date().toISOString();
+ const shortName = layer.conceptIds?.[0]?.shortName;
+ const nrtParams = {
+ shortName,
+ extent,
+ startDate,
+ endDate,
+ };
+ const nrtGranules = await requestGranules(nrtParams);
+ let nonNRTGranules = [];
+ if (shortName.includes('_NRT')) { // if NRT, also get non-NRT granules
+ const nonNRTShortName = shortName.replace('_NRT', '');
+ const nonNRTParams = {
+ shortName: nonNRTShortName,
+ extent,
+ startDate,
+ endDate,
+ };
+ nonNRTGranules = await requestGranules(nonNRTParams);
+ }
+ const granules = [...nonNRTGranules, ...nrtGranules];
+ const granuleDateRanges = granules.map(({ time_start: timeStart, time_end: timeEnd }) => [timeStart, timeEnd]);
+ const mergedGranuleDateRanges = mergeSortedGranuleDateRanges(granuleDateRanges); // merge overlapping granule ranges to simplify rendering
+
+ return mergedGranuleDateRanges;
+}
diff --git a/web/js/modules/layers/actions.js b/web/js/modules/layers/actions.js
index 4b9ad285e..9b76ded15 100644
--- a/web/js/modules/layers/actions.js
+++ b/web/js/modules/layers/actions.js
@@ -33,6 +33,7 @@ import {
CHANGE_GRANULE_SATELLITE_INSTRUMENT_GROUP,
UPDATE_COLLECTION,
UPDATE_DDV_LAYER,
+ ADD_GRANULE_DATE_RANGES,
} from './constants';
import { updateRecentLayers } from '../product-picker/util';
import { getOverlayGroups, getLayersFromGroups } from './util';
@@ -346,6 +347,21 @@ export function updateGranuleLayerState(layer) {
};
}
+export function addGranuleDateRanges(layer, granuleDateRanges) {
+ return (dispatch, getState) => {
+ const state = getState();
+ const { activeString } = state.compare;
+ const { id } = layer;
+
+ dispatch({
+ type: ADD_GRANULE_DATE_RANGES,
+ activeString,
+ id,
+ granuleDateRanges,
+ });
+ };
+}
+
export function updateGranuleLayerOptions(dates, def, count) {
return (dispatch, getState) => {
const state = getState();
diff --git a/web/js/modules/layers/constants.js b/web/js/modules/layers/constants.js
index 661406487..86f6e504e 100644
--- a/web/js/modules/layers/constants.js
+++ b/web/js/modules/layers/constants.js
@@ -21,3 +21,4 @@ export const DEFAULT_NUM_GRANULES = 10;
export const MIN_GRANULES = 1;
export const MAX_GRANULES = 30;
export const UPDATE_DDV_LAYER = 'LAYERS/UPDATE_DDV_LAYER';
+export const ADD_GRANULE_DATE_RANGES = 'LAYERS/ADD_GRANULE_DATE_RANGES';
diff --git a/web/js/modules/layers/reducers.js b/web/js/modules/layers/reducers.js
index 847e9497c..f25ec7a36 100644
--- a/web/js/modules/layers/reducers.js
+++ b/web/js/modules/layers/reducers.js
@@ -22,6 +22,7 @@ import {
REMOVE_GROUP,
UPDATE_DDV_LAYER,
UPDATE_COLLECTION,
+ ADD_GRANULE_DATE_RANGES,
} from './constants';
import {
SET_CUSTOM as SET_CUSTOM_PALETTE,
@@ -296,6 +297,23 @@ export function layerReducer(state = initialState, action) {
});
}
+ case ADD_GRANULE_DATE_RANGES: {
+ const {
+ granuleDateRanges,
+ } = action;
+ const layerIndex = getLayerIndex();
+
+ return update(state, {
+ [compareState]: {
+ layers: {
+ [layerIndex]: {
+ granuleDateRanges: { $set: granuleDateRanges },
+ },
+ },
+ },
+ });
+ }
+
case UPDATE_GRANULE_LAYER_OPTIONS: {
const {
id, activeKey, count, dates,