forked from GeoNet/fits
/
observation.go
486 lines (435 loc) · 14.9 KB
/
observation.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
package main
import (
"bytes"
"database/sql"
"encoding/json"
"github.com/GeoNet/web"
"github.com/GeoNet/web/api/apidoc"
"html/template"
"net/http"
"strconv"
"time"
)
var eol []byte
func init() {
eol = []byte("\n")
}
var observationDoc = apidoc.Endpoint{Title: "Observation",
Description: `Look up observations.`,
Queries: []*apidoc.Query{
observationD,
spatialObsD,
},
}
var observationStatsDoc = apidoc.Endpoint{Title: "Observation Statistics",
Description: `Get observation statistics.`,
Queries: []*apidoc.Query{
observationStatsD,
},
}
var observationD = &apidoc.Query{
Accept: web.V1CSV,
Title: "Observation",
Description: "Observations as CSV",
Example: "/observation?typeID=e&siteID=HOLD&networkID=CG",
ExampleHost: exHost,
URI: "/observation?typeID=(typeID)&siteID=(siteID)&networkID=(networkID)&[days=int]&[methodID=(methodID)]",
Required: map[string]template.HTML{
"typeID": typeIDDoc,
"siteID": siteIDDoc,
"networkID": networkIDDoc,
},
Optional: map[string]template.HTML{
"days": `The number of days of data to select before now e.g., <code>250</code>. Maximum value is 365000.`,
"methodID": methodIDDoc + ` typeID must be specified as well.`,
},
Props: map[string]template.HTML{
"column 1": obsDTDoc,
"column 2": obsValDoc,
"column 3": obsErrDoc,
},
}
var observationStatsD = &apidoc.Query{
Accept: web.V1JSON,
Title: "Observation Statistics",
Description: "Observations statisctics as JSON",
Example: "/observation/stats?typeID=e&siteID=HOLD&networkID=CG",
ExampleHost: exHost,
URI: "/observation/stats?typeID=(typeID)&siteID=(siteID)&networkID=(networkID)&[days=int]&[methodID=(methodID)]",
Required: map[string]template.HTML{
"typeID": typeIDDoc,
"siteID": siteIDDoc,
"networkID": networkIDDoc,
},
Optional: map[string]template.HTML{
"days": `The number of days of data to select before now e.g., <code>250</code>. Maximum value is 365000.`,
"methodID": methodIDDoc + ` typeID must be specified as well.`,
},
Props: map[string]template.HTML{
"Minimum": obsMinDoc,
"maximum": obsMaxDoc,
"First": obsFirstDoc,
"Last": obsLastDoc,
"Mean": obsMeanDoc,
"StddevPopulation": obsPstdDoc,
"Unit": obsUnitDoc,
},
}
func observation(w http.ResponseWriter, r *http.Request) {
if err := observationD.CheckParams(r.URL.Query()); err != nil {
web.BadRequest(w, r, err.Error())
return
}
v := r.URL.Query()
typeID := v.Get("typeID")
networkID := v.Get("networkID")
siteID := v.Get("siteID")
if !validType(w, r, typeID) {
return
}
var days int
if v.Get("days") != "" {
var err error
days, err = strconv.Atoi(v.Get("days"))
if err != nil || days > 365000 {
web.BadRequest(w, r, "Invalid days query param.")
return
}
}
var methodID string
if v.Get("methodID") != "" {
methodID = v.Get("methodID")
if !validTypeMethod(w, r, typeID, methodID) {
return
}
}
// Find the unit for the CSV header
var unit string
err := db.QueryRow("select symbol FROM fits.type join fits.unit using (unitPK) where typeID = $1", typeID).Scan(&unit)
if err == sql.ErrNoRows {
web.NotFound(w, r, "unit not found for typeID: "+typeID)
return
}
if err != nil {
web.ServiceUnavailable(w, r, err)
return
}
var d string
var rows *sql.Rows
switch {
case days == 0 && methodID == "":
rows, err = db.Query(
`SELECT format('%s,%s,%s', to_char(time, 'YYYY-MM-DD"T"HH24:MI:SS.MS"Z"'), value, error) as csv FROM fits.observation
WHERE
sitepk = (
SELECT DISTINCT ON (sitepk) sitepk from fits.site join fits.network using (networkpk) where siteid = $2 and networkid = $1
)
AND typepk = (
SELECT typepk FROM fits.type WHERE typeid = $3
)
ORDER BY time ASC;`, networkID, siteID, typeID)
case days != 0 && methodID == "":
rows, err = db.Query(
`SELECT format('%s,%s,%s', to_char(time, 'YYYY-MM-DD"T"HH24:MI:SS.MS"Z"'), value, error) as csv FROM fits.observation
WHERE
sitepk = (
SELECT DISTINCT ON (sitepk) sitepk from fits.site join fits.network using (networkpk) where siteid = $2 and networkid = $1
)
AND typepk = (
SELECT typepk FROM fits.type WHERE typeid = $3
)
AND time > (now() - interval '`+strconv.Itoa(days)+` days')
ORDER BY time ASC;`, networkID, siteID, typeID)
case days == 0 && methodID != "":
rows, err = db.Query(
`SELECT format('%s,%s,%s', to_char(time, 'YYYY-MM-DD"T"HH24:MI:SS.MS"Z"'), value, error) as csv FROM fits.observation
WHERE
sitepk = (
SELECT DISTINCT ON (sitepk) sitepk from fits.site join fits.network using (networkpk) where siteid = $2 and networkid = $1
)
AND typepk = (
SELECT typepk FROM fits.type WHERE typeid = $3
)
AND methodpk = (
SELECT methodpk FROM fits.method WHERE methodid = $4
)
ORDER BY time ASC;`, networkID, siteID, typeID, methodID)
case days != 0 && methodID != "":
rows, err = db.Query(
`SELECT format('%s,%s,%s', to_char(time, 'YYYY-MM-DD"T"HH24:MI:SS.MS"Z"'), value, error) as csv FROM fits.observation
WHERE
sitepk = (
SELECT DISTINCT ON (sitepk) sitepk from fits.site join fits.network using (networkpk) where siteid = $2 and networkid = $1
)
AND typepk = (
SELECT typepk FROM fits.type WHERE typeid = $3
)
AND methodpk = (
SELECT methodpk FROM fits.method WHERE methodid = $4
)
AND time > (now() - interval '`+strconv.Itoa(days)+` days')
ORDER BY time ASC;`, networkID, siteID, typeID, methodID)
}
if err != nil {
web.ServiceUnavailable(w, r, err)
return
}
defer rows.Close()
// Use a buffer for reading the data from the DB. Then if a there
// is an error we can let the client know without sending
// a partial data response.
var b bytes.Buffer
b.Write([]byte("date-time, " + typeID + " (" + unit + "), error (" + unit + ")"))
b.Write(eol)
for rows.Next() {
err := rows.Scan(&d)
if err != nil {
web.ServiceUnavailable(w, r, err)
return
}
b.Write([]byte(d))
b.Write(eol)
}
rows.Close()
if methodID != "" {
w.Header().Set("Content-Disposition", `attachment; filename="FITS-`+networkID+`-`+siteID+`-`+typeID+`-`+methodID+`.csv"`)
} else {
w.Header().Set("Content-Disposition", `attachment; filename="FITS-`+networkID+`-`+siteID+`-`+typeID+`.csv"`)
}
w.Header().Set("Content-Type", web.V1CSV)
web.OkBuf(w, r, &b)
}
/**
* query end point for observation statistics including: max, min, mean, std, first and last values
* http://fits.geonet.org.nz/observation/stats?typeID=e&siteID=HOLD&networkID=CG&days=100
*/
func observationStats(w http.ResponseWriter, r *http.Request) {
//1. check query parameters
if err := observationD.CheckParams(r.URL.Query()); err != nil {
web.BadRequest(w, r, err.Error())
return
}
v := r.URL.Query()
typeID := v.Get("typeID")
networkID := v.Get("networkID")
siteID := v.Get("siteID")
if !validType(w, r, typeID) {
return
}
var days int
var err error
var tmin, tmax time.Time
if v.Get("days") != "" {
days, err = strconv.Atoi(v.Get("days"))
if err != nil || days > 365000 {
web.BadRequest(w, r, "Invalid days query param.")
return
}
tmax = time.Now().UTC()
tmin = tmax.Add(time.Duration(days*-1) * time.Hour * 24)
}
var methodID string
if v.Get("methodID") != "" {
methodID = v.Get("methodID")
if !validTypeMethod(w, r, typeID, methodID) {
return
}
}
//2. Find the unit
var unit string
err = db.QueryRow("select symbol FROM fits.type join fits.unit using (unitPK) where typeID = $1", typeID).Scan(&unit)
if err == sql.ErrNoRows {
web.NotFound(w, r, "unit not found for typeID: "+typeID)
return
}
if err != nil {
web.ServiceUnavailable(w, r, err)
return
}
// retrieve values using existing functions
values, err := loadObs(networkID, siteID, typeID, methodID, tmin)
if err != nil {
web.ServiceUnavailable(w, r, err)
return
}
mean, stdDev, err := stddevPop(networkID, siteID, typeID, methodID, tmin)
if err != nil {
web.ServiceUnavailable(w, r, err)
return
}
stats := obstats{Unit: unit,
Mean: mean,
StddevPopulation: stdDev}
//4. get maximum, minimum, first, last values
stats.First = values[0]
stats.Last = values[len(values)-1]
iMin, iMax, _ := extremes(values)
stats.Minimum = values[iMin]
stats.Maximum = values[iMax]
//5. send result response
w.Header().Set("Content-Type", web.V1JSON)
b, err := json.Marshal(stats)
if err != nil {
web.ServiceUnavailable(w, r, err)
return
}
web.Ok(w, r, &b)
}
type obstats struct {
Maximum value
Minimum value
First value
Last value
Mean float64
StddevPopulation float64
Unit string
}
/*
stddevPop finds the mean and population stddev for the networkID, siteID, and typeID query.
The start of data range can be restricted using the start parameter. To query all data pass
a zero value uninitialized Time.
*/
func stddevPop(networkID, siteID, typeID string, methodID string, start time.Time) (m, d float64, err error) {
tZero := time.Time{}
switch {
case start == tZero && methodID == "":
err = db.QueryRow(
`SELECT avg(value), stddev_pop(value) FROM fits.observation
WHERE
sitepk = (SELECT DISTINCT ON (sitepk) sitepk from fits.site join fits.network using (networkpk) where siteid = $2 and networkid = $1)
AND typepk = ( SELECT typepk FROM fits.type WHERE typeid = $3 )`,
networkID, siteID, typeID).Scan(&m, &d)
case start != tZero && methodID == "":
err = db.QueryRow(
`SELECT avg(value), stddev_pop(value) FROM fits.observation
WHERE
sitepk = (SELECT DISTINCT ON (sitepk) sitepk from fits.site join fits.network using (networkpk) where siteid = $2 and networkid = $1)
AND typepk = (SELECT typepk FROM fits.type WHERE typeid = $3 )
AND time > $4`,
networkID, siteID, typeID, start).Scan(&m, &d)
case start == tZero && methodID != "":
err = db.QueryRow(
`SELECT avg(value), stddev_pop(value) FROM fits.observation
WHERE
sitepk = (SELECT DISTINCT ON (sitepk) sitepk from fits.site join fits.network using (networkpk) where siteid = $2 and networkid = $1)
AND typepk = ( SELECT typepk FROM fits.type WHERE typeid = $3)
AND methodpk = (SELECT methodpk FROM fits.method WHERE methodid = $4 )`,
networkID, siteID, typeID, methodID).Scan(&m, &d)
case start != tZero && methodID != "":
err = db.QueryRow(
`SELECT avg(value), stddev_pop(value) FROM fits.observation
WHERE
sitepk = ( SELECT DISTINCT ON (sitepk) sitepk from fits.site join fits.network using (networkpk) where siteid = $2 and networkid = $1 )
AND typepk = ( SELECT typepk FROM fits.type WHERE typeid = $3 )
AND methodpk = ( SELECT methodpk FROM fits.method WHERE methodid = $5 )
AND time > $4`,
networkID, siteID, typeID, start, methodID).Scan(&m, &d)
}
return
}
/*
loadObs returns observation values for the networkID, siteID, and typeID query.
The start of data range can be restricted using the start parameter. To query all data pass
a zero value uninitialized Time.
Passing a non zero methodID will further restrict the result set.
[]values is ordered so the latest value will always be values[len(values) -1]
*/
func loadObs(networkID, siteID, typeID, methodID string, start time.Time) (values []value, err error) {
var rows *sql.Rows
tZero := time.Time{}
switch {
case start == tZero && methodID == "":
rows, err = db.Query(
`SELECT time, value, error FROM fits.observation
WHERE
sitepk = (
SELECT DISTINCT ON (sitepk) sitepk from fits.site join fits.network using (networkpk) where siteid = $2 and networkid = $1
)
AND typepk = (
SELECT typepk FROM fits.type WHERE typeid = $3
)
ORDER BY time ASC;`, networkID, siteID, typeID)
case start != tZero && methodID == "":
rows, err = db.Query(
`SELECT time, value, error FROM fits.observation
WHERE
sitepk = (
SELECT DISTINCT ON (sitepk) sitepk from fits.site join fits.network using (networkpk) where siteid = $2 and networkid = $1
)
AND typepk = (
SELECT typepk FROM fits.type WHERE typeid = $3
)
AND time > $4
ORDER BY time ASC;`, networkID, siteID, typeID, start)
case start == tZero && methodID != "":
rows, err = db.Query(
`SELECT time, value, error FROM fits.observation
WHERE
sitepk = (
SELECT DISTINCT ON (sitepk) sitepk from fits.site join fits.network using (networkpk) where siteid = $2 and networkid = $1
)
AND typepk = (
SELECT typepk FROM fits.type WHERE typeid = $3
)
AND methodpk = (
SELECT methodpk FROM fits.method WHERE methodid = $4
)
ORDER BY time ASC;`, networkID, siteID, typeID, methodID)
case start != tZero && methodID != "":
rows, err = db.Query(
`SELECT time, value, error FROM fits.observation
WHERE
sitepk = (
SELECT DISTINCT ON (sitepk) sitepk from fits.site join fits.network using (networkpk) where siteid = $2 and networkid = $1
)
AND typepk = (
SELECT typepk FROM fits.type WHERE typeid = $3
)
AND methodpk = (
SELECT methodpk FROM fits.method WHERE methodid = $5
)
AND time > $4
ORDER BY time ASC;`, networkID, siteID, typeID, start, methodID)
}
if err != nil {
return
}
defer rows.Close()
for rows.Next() {
v := value{}
err = rows.Scan(&v.T, &v.V, &v.E)
if err != nil {
return
}
values = append(values, v)
}
rows.Close()
return
}
/*
extremes returns the indexes for the min and max values. hasErrors will be true
if any of the values have a non zero measurement error.
*/
func extremes(values []value) (min, max int, hasErrors bool) {
minV := values[0]
maxV := values[0]
for i, v := range values {
if v.V > maxV.V {
maxV = v
max = i
}
if v.V < minV.V {
minV = v
min = i
}
if !hasErrors && v.E > 0 {
hasErrors = true
}
}
return
}
type value struct {
T time.Time `json:"DateTime"`
V float64 `json:"Value"`
E float64 `json:"Error"`
}