mock_stream¶
-
gala.dynamics.mockstream.
mock_stream
(hamiltonian, prog_orbit, prog_mass, k_mean, k_disp, release_every=1, Integrator=<class 'gala.integrate.pyintegrators.dopri853.DOPRI853Integrator'>, Integrator_kwargs={}, snapshot_filename=None, output_every=1, seed=None)[source]¶ Generate a mock stellar stream in the specified potential with a progenitor system that ends up at the specified position.
Parameters: - hamiltonian :
Hamiltonian
The system Hamiltonian.
- prog_orbit :
Orbit
The orbit of the progenitor system.
- prog_mass : numeric, array_like
A single mass or an array of masses if the progenitor mass evolves with time.
- k_mean :
numpy.ndarray
Array of mean \(k\) values (see Fardal et al. 2015). These are used to determine the exact prescription for generating the mock stream. The components are for: \((R,\phi,z,v_R,v_\phi,v_z)\). If 1D, assumed constant in time. If 2D, time axis is axis 0.
- k_disp :
numpy.ndarray
Array of \(k\) value dispersions (see Fardal et al. 2015). These are used to determine the exact prescription for generating the mock stream. The components are for: \((R,\phi,z,v_R,v_\phi,v_z)\). If 1D, assumed constant in time. If 2D, time axis is axis 0.
- release_every : int (optional)
Release particles at the Lagrange points every X timesteps.
- Integrator :
Integrator
(optional) Integrator to use.
- Integrator_kwargs : dict (optional)
Any extra keyword argumets to pass to the integrator function.
- snapshot_filename : str (optional)
Filename to save all incremental snapshots of particle positions and velocities. Warning: this can make very large files if you are not careful!
- output_every : int (optional)
If outputing snapshots (i.e., if snapshot_filename is specified), this controls how often to output a snapshot.
- seed : int (optional)
A random number seed for initializing the particle positions.
Returns: - stream :
PhaseSpacePosition
- hamiltonian :