.. include:: ../dynamics/references.txt

StreaklineStreamDF
==================

.. currentmodule:: gala.dynamics.mockstream

.. autoclass:: StreaklineStreamDF
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~StreaklineStreamDF.lead
      ~StreaklineStreamDF.random_state
      ~StreaklineStreamDF.trail

   .. rubric:: Methods Summary

   .. autosummary::

      ~StreaklineStreamDF.sample

   .. rubric:: Attributes Documentation

   .. autoattribute:: lead
   .. autoattribute:: random_state
   .. autoattribute:: trail

   .. rubric:: Methods Documentation

   .. automethod:: sample