Pretty Good Oscillator
Install and import#
npm install fintech-algorithmsimport { prettyGoodOscillator } from "fintech-algorithms/technical-indicators/momentum/pretty-good-oscillator";Signature#
prettyGoodOscillator(input)Expresses the gap between close and its period simple average in units of average true range, so readings stay comparable across volatility regimes.
Parameters#
| Name | Type | Notes |
|---|---|---|
input | TopicInput | bars is a chronological array of OHLCV rows, each with a non-empty timestamp plus finite open, high, low, close and volume. From parameters this topic reads period (integer >= 2, default 14), used for both the simple average and the Wilder-smoothed average true range. The preamble also validates fast_period (default 5) and slow_period (default 34) before branching, so a bad value for either throws even though this topic does not use them. |
Returns#
TopicResult
series and latest carry one key, value, equal to (close - period simple average) divided by the period ATR. A null warm-up prefix precedes the first reading.
Warm-up#
The first period - 1 bars (13 with the default 14) positions are null. True range is defined from the first bar, so the ATR and the simple average both complete at index period - 1 and ready_at is 13 on the canonical fixture. An ATR of exactly 0 also yields a null.
Errors#
- When
periodis not an integer >= 2 — throws Error - When a bar's
lowis above itsopen,high, orclose— throws Error
Complexity: time O(n * period),
space O(n).
Worked example#
executed Captured by running this function on the input its own test provides. Real output of real code — but not asserted against a published figure.
Input#
{
"bars": [
{
"timestamp": "2024-01-02",
"basis": "synthetic-unadjusted",
"open": 100,
"high": 101.45,
"low": 98.695,
"close": 100,
"volume": 750000,
"benchmark": 200
},
{
"timestamp": "2024-01-03",
"basis": "synthetic-unadjusted",
"open": 101.49111452,
"high": 103.38381693,
"low": 100.05480022,
"close": 101.78791214,
"volume": 795117,
"benchmark": 200.56326135
},
{
"timestamp": "2024-01-04",
"basis": "synthetic-unadjusted",
"open": 102.45519048,
"high": 104.6701838,
"low": 100.91147007,
"close": 102.9549389,
"volume": 840234,
"benchmark": 201.11020913
}
],
"parameters": {}
}Call#
prettyGoodOscillator(input)Returns#
object with 9 fields: topic_id, title, state, ready, ready_at, series, latest, parameters, …
{
"topic_id": "D07-F03-A29",
"title": "Pretty Good Oscillator",
"state": "calculated",
"ready": true,
"ready_at": 13,
"series": {
"value": [null, null, null, null, null, null]
},
"latest": {
"value": -1.4796507727206563
},
"parameters": {},
"diagnostics": {
"causal": true,
"input_count": 96
}
}Diagrams#
Calculation flow#
Pretty Good Oscillator calculation flow
flowchart LR
A["an ordered price or OHLC series, declared lookbacks, smoot"] --> B["Validate order, basis, and finite values"]
B --> C["Apply the selected Pretty Good Oscillator convention"]
C --> D["Emit value, readiness, and diagnostics"]
D --> E["Interpret descriptively; test outcomes separately"]
B -->|invalid or insufficient| X["Withhold output with a reason"]
Pretty Good Oscillator readiness and evidence states
stateDiagram-v2
[*] --> Waiting
Waiting --> Ready: enough valid causal observations
Waiting --> Rejected: malformed or unsupported input
Ready --> Calculated: selected formula applied
Calculated --> Interpreted: diagnostic and limitation retained
Interpreted --> Ready: next observation arrives
Rejected --> Waiting: corrected input and deterministic reset
How it works#
This page states the contract — how to call it correctly. The article explains the concept: why it works, and where it breaks.
References#
- TA-Lib function groups — see linked primary or authoritative record
- TA-Lib C/C++ API — see linked primary or authoritative record
- TA-Lib maintained source — see linked primary or authoritative record
- Evidence decision
- Level 1 evidence map