StreaklineStreamDF#
- class gala.dynamics.mockstream.StreaklineStreamDF#
Bases:
BaseStreamDFA class for representing the “streakline” distribution function for generating stellar streams based on Kuepper et al. 2012 https://ui.adsabs.harvard.edu/abs/2012MNRAS.420.2700K/abstract
- Parameters:
- leadbool (optional)
Generate a leading tail. Default: True.
- trailbool (optional)
Generate a trailing tail. Default: True.
- random_state
RandomState(optional) To control random number generation.
Attributes Summary
random_state: object
Methods Summary
sample(sample)Generate stream particle initial conditions and initial times.
Attributes Documentation
- lead#
- random_state#
random_state: object
- trail#
Methods Documentation
- sample(self, prog_orbit, prog_mass, hamiltonian=None, release_every=1, n_particles=1) sample(prog_orbit, prog_mass, hamiltonian=None, release_every=1, n_particles=1)#
- sample(prog_orbit, prog_mass, hamiltonian=None, release_every=1, n_particles=1) None
Generate stream particle initial conditions and initial times.
This method is primarily meant to be used within the
MockStreamGenerator.- Parameters:
- prog_orbit
Orbit The orbit of the progenitor system.
- prog_mass
Quantity[mass] The mass of the progenitor system, either a scalar quantity, or as an array with the same shape as the number of timesteps in the orbit to account for mass evolution.
- hamiltonian
Hamiltonian The external potential and reference frame to numerically integrate orbits in.
- release_every
int(optional) Controls how often to release stream particles from each tail. Default: 1, meaning release particles at each timestep.
- n_particles
int, array_like (optional) If an integer, this controls the number of particles to release in each tail at each release timestep. Alternatively, you can pass in an array with the same shape as the number of timesteps to release bursts of particles at certain times (e.g., pericenter).
- prog_orbit
- Returns: