API Reference / counterfactual · function

Function: counterfactual()

function counterfactual(
   engine, 
   base, 
   edit, 
   registry?, 
   opts?): Counterfactual;

Realize an AnchoredChart, then apply a CounterfactualEdit and diff the result -- "a real event, perturbed." A time/place edit recomputes the ephemeris; a setLongitudes edit splices the geometry.

Parameters

Parameter	Type	Description
`engine`	`Engine`	The engine.
`base`	`AnchoredChart`	The base chart to perturb (realized via realize).
`edit`	`CounterfactualEdit`	The perturbation.
`registry`	`AnchorRegistry`	Anchor lookups for the base.
`opts`	`ChartOptions`	Chart options (house system, zodiac).

Returns

Counterfactual

A Counterfactual; variant/diff are null when the base produced no chart (e.g. a constraints-only form).

Start building

Quickstart →