Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 25 additions & 6 deletions package/MDAnalysis/analysis/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,11 @@ class AnalysisBase(object):
All results should be stored as attributes of the
:class:`MDAnalysis.analysis.results.Results` container.

.. Note::
The instance attributes are populated during and on conclusion of
calling the :meth:`AnalysisBase.run` method.


Parameters
----------
trajectory : MDAnalysis.coordinates.base.ReaderBase
Expand All @@ -194,14 +199,28 @@ class AnalysisBase(object):
Attributes
----------
times: numpy.ndarray
array of Timestep times. Only exists after calling
:meth:`AnalysisBase.run`
Array of times of the Timesteps that were analyzed.
Only exists after calling :meth:`AnalysisBase.run`.
frames: numpy.ndarray
array of Timestep frame indices. Only exists after calling
:meth:`AnalysisBase.run`
Array of frame indices that were analyzed.
Only exists after calling :meth:`AnalysisBase.run`.
results: :class:`Results`
results of calculation are stored after call
to :meth:`AnalysisBase.run`
Results of calculation are stored here, after call
to :meth:`AnalysisBase.run`.
n_frames: int
number of *analyzed* frames, i.e., after taking into account
the `start`, `stop`, and `step` values from
:meth:`AnalysisBase.run`.
Only exists after calling :meth:`AnalysisBase.run`.
start: int
Frame index of the first trajectory frame that was analyzed.
Only exists after calling :meth:`AnalysisBase.run`.
stop: int
Frame index of the last trajectory frame that was analyzed.
Only exists after calling :meth:`AnalysisBase.run`.
step: int
Every `step` frame was analyzed, as ``trajectory[star:stop:step]``.
Only exists after calling :meth:`AnalysisBase.run`.


Example
Expand Down
Loading