|
11 | 11 |
|
12 | 12 |
|
13 | 13 | /**
|
14 |
| - * Compute the positive and negative error bar magnitudes. |
| 14 | + * Error bar computing function generator |
15 | 15 | *
|
16 | 16 | * N.B. This function does not clean the dataPt entries, non-numeric
|
17 | 17 | * entries result in undefined *error*
|
18 | 18 | *
|
19 |
| - * @param {numeric} dataPt data point from where to compute the error magnitue |
20 |
| - * @param {number} index index of dataPt in its corresponding data array |
21 | 19 | * @param {object} opts error bar attributes
|
22 | 20 | *
|
23 |
| - * @return {array of two numbers} |
24 |
| - * - error[0] : error magnitude in the negative direction |
25 |
| - * - error[1] : " " " " positive " |
| 21 | + * @return {function} : |
| 22 | + * @param {numeric} dataVal error magnitude in the negative direction |
| 23 | + * @param {number} index index of dataPt in its corresponding data array |
| 24 | + * @return {array} |
| 25 | + * - error[0] : error magnitude in the negative direction |
| 26 | + * - error[1] : " " " " positive " |
26 | 27 | */
|
27 |
| -module.exports = function computeError(dataPt, index, opts) { |
| 28 | +module.exports = function makeComputeError(opts) { |
28 | 29 | var type = opts.type,
|
29 |
| - error = new Array(2); |
| 30 | + symmetric = opts.symmetric; |
30 | 31 |
|
31 | 32 | if(type === 'data') {
|
32 |
| - error[1] = +(opts.array[index]); |
33 |
| - error[0] = (opts.symmetric || opts.arrayminus === undefined) ? |
34 |
| - error[1] : |
35 |
| - +(opts.arrayminus[index]); |
| 33 | + var array = opts.array, |
| 34 | + arrayminus = opts.arrayminus; |
| 35 | + |
| 36 | + return (symmetric || arrayminus === undefined) ? |
| 37 | + function computeError(dataPt, index) { |
| 38 | + var val = +(array[index]); |
| 39 | + return [val, val]; |
| 40 | + } : |
| 41 | + function computeError(dataPt, index) { |
| 42 | + return [+arrayminus[index], +array[index]]; |
| 43 | + }; |
36 | 44 | }
|
37 | 45 | else {
|
38 |
| - error[1] = getErrorVal(type, dataPt, opts.value); |
39 |
| - error[0] = (opts.symmetric || opts.valueminus === undefined) ? |
40 |
| - error[1] : |
41 |
| - getErrorVal(type, dataPt, opts.valueminus); |
42 |
| - } |
| 46 | + var value = opts.value, |
| 47 | + valueminus = opts.valueminus; |
43 | 48 |
|
44 |
| - |
45 |
| - return error; |
| 49 | + return (symmetric || valueminus === undefined) ? |
| 50 | + function computeError(dataPt) { |
| 51 | + var val = getErrorVal(type, dataPt, value); |
| 52 | + return [val, val]; |
| 53 | + } : |
| 54 | + function computeError(dataPt) { |
| 55 | + return [ |
| 56 | + getErrorVal(type, dataPt, valueminus), |
| 57 | + getErrorVal(type, dataPt, value) |
| 58 | + ]; |
| 59 | + }; |
| 60 | + } |
46 | 61 | };
|
47 | 62 |
|
48 |
| -// size the error bar itself (for all types except data) |
| 63 | +/** |
| 64 | + * Compute error bar magnitude (for all types except data) |
| 65 | + * |
| 66 | + * @param {string} type error bar type |
| 67 | + * @param {numeric} dataPt |
| 68 | + * data point from where to compute the error magnitude |
| 69 | + * @param {numeric} [value] error bar value |
| 70 | + * |
| 71 | + */ |
49 | 72 | function getErrorVal(type, dataPt, value) {
|
50 | 73 | if(type === 'percent') return Math.abs(dataPt * value / 100);
|
51 | 74 | if(type === 'constant') return Math.abs(value);
|
|
0 commit comments