PSeries
PSeries is an OOP-like representation of a time-index data series from a particular data source and single location (if the data source has multiple locations).
E.g. Each series displayed on a graph (from our data query interface) is a PSeries. A PSeries may contain data directly from the database, data that has been transformed in some way (changed units, vector decomposition) or modeled data.
Each PSeries contains 3 single-dimension PDLs (or piddles) containing gmts, values, and a mask of good/NA/removed values.
Core Attributes
Here are [some of] the named arguments you can specify when creating a PSeries object:
- corrections: Apply corrections to data? Anything but an n means "yes, apply corrections".
- elev: Datum to apply to the data. I think this is navgd88, etc. Not really sure how this affects data.
- gmt0: Starting time, in seconds since the epoch
- gmt1: Ending time, seconds since the epoch
- id: "Source ID" (not six minute) or "Station ID" (read: unique 3-digit CBI label for a particular data collection platform)
- interval: Return data points in the given interval (in seconds). I'm not really sure of the effect of this parameter.
- msg: Message appended to (graph) series legend (see
pd.cgi).
- ser: Data series (e.g., pwl, wsd, wtp). See
~pharosdb/etc/serunits.conf.
- unit: Return data in the specified units. Some possible values: english, metric, dnr, or (a specific unit type) mm, km, cm, etc.
PDL Attributes
All PDL (piddles) are one-dimensional arrays with aligned indexes (e.g., gmt[n], v[n], and mask[n] all represent the n'th element).
- v: Values
- gmt: GMT in seconds since the epoch
- mask: determines whether or not an indexed value is available, unavailable or removed
NSM Attributes
- offset: NSM Only data values with the specified offset will be returned. Offset between the time the predicted data represents and the time it was predicted (in hours), presently applicable only to forecasted data. Positive values mean predictions, negative values are for collected data. E.g., offset=3 === return only 3 hour predictions.
- maxoffset: NSM Maximum offset permitted for data values. If all available data values for a particular gmt have an offset greater than maxoffset, then no data value will be returned for that gmt.
- location: Location information for given source ID. This can be either the text name of the location or at lat,lon pair (decimal degrees).
NSM stands for a "not six minute" (the new database format) parameter.
Tau Attributes
- phi: If
ser=tau, you can specify an angle offset (in degrees) from N. This will return the wind pseudo-stress along that line.