orbithunter.core.Orbit._populate_state

Orbit._populate_state(**kwargs)

Should only be accessed through Orbit.populate()

Parameters

kwargsdict

seed : str

Notes

Must populate and set attributes ‘state’, ‘discretization’ and ‘basis’. The state is required to be a numpy array, the discretization is required to be its shape (tuple) in the basis specified by self.bases_labels()[0]. Discretization is coupled to the state and its specific basis, hence why it is populated here.

Historically, for the KSe, the strategy to define a specific state was to provide a keyword argument ‘spectrum’ which controlled a spectrum modulation strategy. This is not included in the base signature, because it is terminology specific to spectral methods.