@deck.gl/aggregation-layers 8.10.0-alpha.1 → 8.10.0-alpha.4

package/typed/screen-grid-layer/screen-grid-layer.js

@@ -1,216 +0,0 @@
-// Copyright (c) 2015 - 2017 Uber Technologies, Inc.
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in
-// all copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-// THE SOFTWARE.
-import { log } from '@deck.gl/core';
-import GL from '@luma.gl/constants';
-import GPUGridAggregator from '../utils/gpu-grid-aggregation/gpu-grid-aggregator';
-import { AGGREGATION_OPERATION, getValueFunc } from '../utils/aggregation-operation-utils';
-import ScreenGridCellLayer from './screen-grid-cell-layer';
-import GridAggregationLayer from '../grid-aggregation-layer';
-import { getFloatTexture } from '../utils/resource-utils.js';
-const defaultProps = {
-    ...ScreenGridCellLayer.defaultProps,
-    getPosition: { type: 'accessor', value: d => d.position },
-    getWeight: { type: 'accessor', value: 1 },
-    gpuAggregation: true,
-    aggregation: 'SUM'
-};
-const POSITION_ATTRIBUTE_NAME = 'positions';
-const DIMENSIONS = {
-    data: {
-        props: ['cellSizePixels']
-    },
-    weights: {
-        props: ['aggregation'],
-        accessors: ['getWeight']
-    }
-};
-export default class ScreenGridLayer extends GridAggregationLayer {
-    initializeState() {
-        const { gl } = this.context;
-        if (!ScreenGridCellLayer.isSupported(gl)) {
-            // max aggregated value is sampled from a float texture
-            this.setState({ supported: false });
-            log.error(`ScreenGridLayer: ${this.id} is not supported on this browser`)();
-            return;
-        }
-        super.initializeAggregationLayer({
-            dimensions: DIMENSIONS,
-            // @ts-expect-error
-            getCellSize: props => props.cellSizePixels // TODO
-        });
-        const weights = {
-            count: {
-                size: 1,
-                operation: AGGREGATION_OPERATION.SUM,
-                needMax: true,
-                maxTexture: getFloatTexture(gl, { id: `${this.id}-max-texture` })
-            }
-        };
-        this.setState({
-            supported: true,
-            projectPoints: true,
-            weights,
-            subLayerData: { attributes: {} },
-            maxTexture: weights.count.maxTexture,
-            positionAttributeName: 'positions',
-            posOffset: [0, 0],
-            translation: [1, -1]
-        });
-        const attributeManager = this.getAttributeManager();
-        attributeManager.add({
-            [POSITION_ATTRIBUTE_NAME]: {
-                size: 3,
-                accessor: 'getPosition',
-                type: GL.DOUBLE,
-                fp64: this.use64bitPositions()
-            },
-            // this attribute is used in gpu aggregation path only
-            count: { size: 3, accessor: 'getWeight' }
-        });
-    }
-    shouldUpdateState({ changeFlags }) {
-        return this.state.supported && changeFlags.somethingChanged;
-    }
-    updateState(opts) {
-        super.updateState(opts);
-    }
-    renderLayers() {
-        if (!this.state.supported) {
-            return [];
-        }
-        const { maxTexture, numRow, numCol, weights } = this.state;
-        const { updateTriggers } = this.props;
-        const { aggregationBuffer } = weights.count;
-        const CellLayerClass = this.getSubLayerClass('cells', ScreenGridCellLayer);
-        return new CellLayerClass(this.props, this.getSubLayerProps({
-            id: 'cell-layer',
-            updateTriggers
-        }), {
-            data: { attributes: { instanceCounts: aggregationBuffer } },
-            maxTexture,
-            numInstances: numRow * numCol
-        });
-    }
-    finalizeState(context) {
-        super.finalizeState(context);
-        const { aggregationBuffer, maxBuffer, maxTexture } = this.state;
-        aggregationBuffer?.delete();
-        maxBuffer?.delete();
-        maxTexture?.delete();
-    }
-    getPickingInfo({ info }) {
-        const { index } = info;
-        if (index >= 0) {
-            const { gpuGridAggregator, gpuAggregation, weights } = this.state;
-            // Get count aggregation results
-            const aggregationResults = gpuAggregation
-                ? gpuGridAggregator.getData('count')
-                : weights.count;
-            // Each instance (one cell) is aggregated into single pixel,
-            // Get current instance's aggregation details.
-            info.object = GPUGridAggregator.getAggregationData({
-                pixelIndex: index,
-                ...aggregationResults
-            });
-        }
-        return info;
-    }
-    // Aggregation Overrides
-    updateResults({ aggregationData, maxData }) {
-        const { count } = this.state.weights;
-        count.aggregationData = aggregationData;
-        count.aggregationBuffer.setData({ data: aggregationData });
-        count.maxData = maxData;
-        count.maxTexture.setImageData({ data: maxData });
-    }
-    /* eslint-disable complexity, max-statements */
-    updateAggregationState(opts) {
-        const cellSize = opts.props.cellSizePixels;
-        const cellSizeChanged = opts.oldProps.cellSizePixels !== cellSize;
-        const { viewportChanged } = opts.changeFlags;
-        let gpuAggregation = opts.props.gpuAggregation;
-        if (this.state.gpuAggregation !== opts.props.gpuAggregation) {
-            if (gpuAggregation && !GPUGridAggregator.isSupported(this.context.gl)) {
-                log.warn('GPU Grid Aggregation not supported, falling back to CPU')();
-                gpuAggregation = false;
-            }
-        }
-        const gpuAggregationChanged = gpuAggregation !== this.state.gpuAggregation;
-        this.setState({
-            gpuAggregation
-        });
-        const positionsChanged = this.isAttributeChanged(POSITION_ATTRIBUTE_NAME);
-        const { dimensions } = this.state;
-        const { data, weights } = dimensions;
-        const aggregationDataDirty = positionsChanged ||
-            gpuAggregationChanged ||
-            viewportChanged ||
-            this.isAggregationDirty(opts, {
-                compareAll: gpuAggregation,
-                dimension: data
-            });
-        const aggregationWeightsDirty = this.isAggregationDirty(opts, { dimension: weights });
-        this.setState({
-            aggregationDataDirty,
-            aggregationWeightsDirty
-        });
-        const { viewport } = this.context;
-        if (viewportChanged || cellSizeChanged) {
-            const { width, height } = viewport;
-            const numCol = Math.ceil(width / cellSize);
-            const numRow = Math.ceil(height / cellSize);
-            this.allocateResources(numRow, numCol);
-            this.setState({
-                // transformation from clipspace to screen(pixel) space
-                scaling: [width / 2, -height / 2, 1],
-                gridOffset: { xOffset: cellSize, yOffset: cellSize },
-                width,
-                height,
-                numCol,
-                numRow
-            });
-        }
-        if (aggregationWeightsDirty) {
-            this._updateAccessors(opts);
-        }
-        if (aggregationDataDirty || aggregationWeightsDirty) {
-            this._resetResults();
-        }
-    }
-    /* eslint-enable complexity, max-statements */
-    // Private
-    _updateAccessors(opts) {
-        const { getWeight, aggregation, data } = opts.props;
-        const { count } = this.state.weights;
-        if (count) {
-            count.getWeight = getWeight;
-            count.operation = AGGREGATION_OPERATION[aggregation];
-        }
-        this.setState({ getValue: getValueFunc(aggregation, getWeight, { data }) });
-    }
-    _resetResults() {
-        const { count } = this.state.weights;
-        if (count) {
-            count.aggregationData = null;
-        }
-    }
-}
-ScreenGridLayer.layerName = 'ScreenGridLayer';
-ScreenGridLayer.defaultProps = defaultProps;

package/typed/types.js

@@ -1 +0,0 @@
-export {};

package/typed/utils/aggregation-operation-utils.js

@@ -1,94 +0,0 @@
-// Copyright (c) 2015 - 2019 Uber Technologies, Inc.
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in
-// all copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-// THE SOFTWARE.
-export const AGGREGATION_OPERATION = {
-    SUM: 1,
-    MEAN: 2,
-    MIN: 3,
-    MAX: 4
-};
-function sumReducer(accu, cur) {
-    return accu + cur;
-}
-function maxReducer(accu, cur) {
-    return cur > accu ? cur : accu;
-}
-function minReducer(accu, cur) {
-    return cur < accu ? cur : accu;
-}
-export function getMean(pts, accessor) {
-    if (Number.isFinite(accessor)) {
-        return pts.length ? accessor : null;
-    }
-    const filtered = pts.map(accessor).filter(Number.isFinite);
-    return filtered.length ? filtered.reduce(sumReducer, 0) / filtered.length : null;
-}
-export function getSum(pts, accessor) {
-    if (Number.isFinite(accessor)) {
-        return pts.length ? pts.length * accessor : null;
-    }
-    const filtered = pts.map(accessor).filter(Number.isFinite);
-    return filtered.length ? filtered.reduce(sumReducer, 0) : null;
-}
-export function getMax(pts, accessor) {
-    if (Number.isFinite(accessor)) {
-        return pts.length ? accessor : null;
-    }
-    const filtered = pts.map(accessor).filter(Number.isFinite);
-    return filtered.length ? filtered.reduce(maxReducer, -Infinity) : null;
-}
-export function getMin(pts, accessor) {
-    if (Number.isFinite(accessor)) {
-        return pts.length ? accessor : null;
-    }
-    const filtered = pts.map(accessor).filter(Number.isFinite);
-    return filtered.length ? filtered.reduce(minReducer, Infinity) : null;
-}
-// Function to convert from aggregation/accessor props (like colorAggregation and getColorWeight) to getValue prop (like getColorValue)
-export function getValueFunc(aggregation, accessor, context) {
-    const op = AGGREGATION_OPERATION[aggregation] || AGGREGATION_OPERATION.SUM;
-    accessor = wrapAccessor(accessor, context);
-    switch (op) {
-        case AGGREGATION_OPERATION.MIN:
-            return pts => getMin(pts, accessor);
-        case AGGREGATION_OPERATION.SUM:
-            return pts => getSum(pts, accessor);
-        case AGGREGATION_OPERATION.MEAN:
-            return pts => getMean(pts, accessor);
-        case AGGREGATION_OPERATION.MAX:
-            return pts => getMax(pts, accessor);
-        default:
-            return null;
-    }
-}
-function wrapAccessor(accessor, context = {}) {
-    if (Number.isFinite(accessor)) {
-        return accessor;
-    }
-    return pt => {
-        context.index = pt.index;
-        return accessor(pt.source, context);
-    };
-}
-export function wrapGetValueFunc(getValue, context = {}) {
-    return pts => {
-        context.indices = pts.map(pt => pt.index);
-        return getValue(pts.map(pt => pt.source), context);
-    };
-}

package/typed/utils/bin-sorter.js

@@ -1,167 +0,0 @@
-// Copyright (c) 2015 - 2017 Uber Technologies, Inc.
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in
-// all copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-// THE SOFTWARE.
-// getValue takes an array of points returns a value to sort the bins on.
-// by default it returns the number of points
-// this is where to pass in a function to color the bins by
-// avg/mean/max of specific value of the point
-const defaultGetValue = points => points.length;
-import { clamp, getQuantileDomain, getOrdinalDomain } from './scale-utils';
-const MAX_32_BIT_FLOAT = 3.402823466e38;
-// access array of points in each bin
-const defaultGetPoints = bin => bin.points;
-// access index of each bin
-const defaultGetIndex = bin => bin.index;
-// d3-scending
-const ascending = (a, b) => (a < b ? -1 : a > b ? 1 : a >= b ? 0 : NaN);
-const defaultProps = {
-    getValue: defaultGetValue,
-    getPoints: defaultGetPoints,
-    getIndex: defaultGetIndex,
-    filterData: null
-};
-export default class BinSorter {
-    constructor(bins = [], props = defaultProps) {
-        this.aggregatedBins = this.getAggregatedBins(bins, props);
-        this._updateMinMaxValues();
-        this.binMap = this.getBinMap();
-    }
-    /**
-     * Get an array of object with aggregated values and index of bins
-     * Array object will be sorted by value optionally.
-     * @param {Array} bins
-     * @param {Function} getValue
-     * @return {Array} array of values and index lookup
-     */
-    getAggregatedBins(bins, props) {
-        const { getValue = defaultGetValue, getPoints = defaultGetPoints, getIndex = defaultGetIndex, filterData } = props;
-        const hasFilter = typeof filterData === 'function';
-        const binCount = bins.length;
-        const aggregatedBins = [];
-        let index = 0;
-        for (let binIndex = 0; binIndex < binCount; binIndex++) {
-            const bin = bins[binIndex];
-            const points = getPoints(bin);
-            const i = getIndex(bin);
-            const filteredPoints = hasFilter ? points.filter(filterData) : points;
-            bin.filteredPoints = hasFilter ? filteredPoints : null;
-            const value = filteredPoints.length ? getValue(filteredPoints) : null;
-            if (value !== null && value !== undefined) {
-                // filter bins if value is null or undefined
-                aggregatedBins[index] = {
-                    i: Number.isFinite(i) ? i : binIndex,
-                    value,
-                    counts: filteredPoints.length
-                };
-                index++;
-            }
-        }
-        return aggregatedBins;
-    }
-    _percentileToIndex(percentileRange) {
-        const len = this.sortedBins.length;
-        if (len < 2) {
-            return [0, 0];
-        }
-        const [lower, upper] = percentileRange.map(n => clamp(n, 0, 100));
-        const lowerIdx = Math.ceil((lower / 100) * (len - 1));
-        const upperIdx = Math.floor((upper / 100) * (len - 1));
-        return [lowerIdx, upperIdx];
-    }
-    /**
-     * Get a mapping from cell/hexagon index to sorted bin
-     * This is used to retrieve bin value for color calculation
-     * @return {Object} bin index to aggregatedBins
-     */
-    getBinMap() {
-        const binMap = {};
-        for (const bin of this.aggregatedBins) {
-            binMap[bin.i] = bin;
-        }
-        return binMap;
-    }
-    // Private
-    /**
-     * Get ths max count of all bins
-     */
-    _updateMinMaxValues() {
-        let maxCount = 0;
-        let maxValue = 0;
-        let minValue = MAX_32_BIT_FLOAT;
-        let totalCount = 0;
-        for (const x of this.aggregatedBins) {
-            maxCount = maxCount > x.counts ? maxCount : x.counts;
-            maxValue = maxValue > x.value ? maxValue : x.value;
-            minValue = minValue < x.value ? minValue : x.value;
-            totalCount += x.counts;
-        }
-        this.maxCount = maxCount;
-        this.maxValue = maxValue;
-        this.minValue = minValue;
-        this.totalCount = totalCount;
-    }
-    /**
-     * Get range of values of all bins
-     * @param {Number[]} range
-     * @param {Number} range[0] - lower bound
-     * @param {Number} range[1] - upper bound
-     * @return {Array} array of new value range
-     */
-    getValueRange(percentileRange) {
-        if (!this.sortedBins) {
-            this.sortedBins = this.aggregatedBins.sort((a, b) => ascending(a.value, b.value));
-        }
-        if (!this.sortedBins.length) {
-            // @ts-expect-error
-            return [];
-        }
-        let lowerIdx = 0;
-        let upperIdx = this.sortedBins.length - 1;
-        if (Array.isArray(percentileRange)) {
-            const idxRange = this._percentileToIndex(percentileRange);
-            lowerIdx = idxRange[0];
-            upperIdx = idxRange[1];
-        }
-        return [this.sortedBins[lowerIdx].value, this.sortedBins[upperIdx].value];
-    }
-    getValueDomainByScale(scale, [lower = 0, upper = 100] = []) {
-        if (!this.sortedBins) {
-            this.sortedBins = this.aggregatedBins.sort((a, b) => ascending(a.value, b.value));
-        }
-        if (!this.sortedBins.length) {
-            return [];
-        }
-        const indexEdge = this._percentileToIndex([lower, upper]);
-        return this._getScaleDomain(scale, indexEdge);
-    }
-    _getScaleDomain(scaleType, [lowerIdx, upperIdx]) {
-        const bins = this.sortedBins;
-        switch (scaleType) {
-            case 'quantize':
-            case 'linear':
-                return [bins[lowerIdx].value, bins[upperIdx].value];
-            case 'quantile':
-                return getQuantileDomain(bins.slice(lowerIdx, upperIdx + 1), d => d.value);
-            case 'ordinal':
-                return getOrdinalDomain(bins, d => d.value);
-            default:
-                return [bins[lowerIdx].value, bins[upperIdx].value];
-        }
-    }
-}

package/typed/utils/color-utils.js

@@ -1,53 +0,0 @@
-// Copyright (c) 2015 - 2017 Uber Technologies, Inc.
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in
-// all copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-// THE SOFTWARE.
-export const defaultColorRange = [
-    [255, 255, 178],
-    [254, 217, 118],
-    [254, 178, 76],
-    [253, 141, 60],
-    [240, 59, 32],
-    [189, 0, 38]
-];
-// Converts a colorRange array to a flat array with 4 components per color
-export function colorRangeToFlatArray(colorRange, normalize = false, ArrayType = Float32Array) {
-    let flatArray;
-    if (Number.isFinite(colorRange[0])) {
-        // its already a flat array.
-        flatArray = new ArrayType(colorRange);
-    }
-    else {
-        // flatten it
-        flatArray = new ArrayType(colorRange.length * 4);
-        let index = 0;
-        for (let i = 0; i < colorRange.length; i++) {
-            const color = colorRange[i];
-            flatArray[index++] = color[0];
-            flatArray[index++] = color[1];
-            flatArray[index++] = color[2];
-            flatArray[index++] = Number.isFinite(color[3]) ? color[3] : 255;
-        }
-    }
-    if (normalize) {
-        for (let i = 0; i < flatArray.length; i++) {
-            flatArray[i] /= 255;
-        }
-    }
-    return flatArray;
-}