popsynth.simulated_variable module

class popsynth.simulated_variable.SimulatedVariable(observed_values: ndarray, latent_values: ndarray, selection: ndarray)[source]

Bases: ndarray

SimulatedVariables hold the observed and latent values from a population synth variable as well as its selection.

The array displays as the observed values. The latent values can be accessed with x.latent

Subsets of selected and non-selected values can be accessed:

x.selected x.non_selected

which return a SimulatedVariable that is a subset of the values.

Math operations applied to the object will be applied to the observed and latent values.

property latent: ndarray

The latent values simulated which are unobscured by measurement error

Returns

property selected: SimulatedVariable

returns the latent and observed values that were selected as a new SimulatedVariable

property non_selected: SimulatedVariable

returns the latent and observed values that were selected as a new SimulatedVariable