Skip to content

Commit

Permalink
minor documentation fixes [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
paulkorir committed Oct 30, 2023
1 parent 11cd0fb commit 55a4c9a
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions sfftk/readers/starreader.py
Original file line number Diff line number Diff line change
Expand Up @@ -324,15 +324,17 @@ def _infer_int(value):

@property
def header(self):
"""Return the header of the table"""
"""Return the header of the table
"""
# self._do_eval()
string = "loop_\n"
string += "\n".join(self._loop.tags)
return string

@property
def columns(self):
"""Return the columns in this block"""
"""Return the columns in this block
"""
return self._loop.tags

def __getitem__(self, item):
Expand Down Expand Up @@ -479,12 +481,12 @@ class RelionStarReader(StarReader):
- The STAR file must have **one and only one** table
- The table must have the following columns: ``_rlnCoordinateX``, ``_rlnCoordinateY``, ``_rlnCoordinateZ``,
``_rlnAngleRot``, ``_rlnAngleTilt``, ``_rlnAnglePsi``. These columns represent the position and orientation of the
particle in the tomogram.
``_rlnAngleRot``, ``_rlnAngleTilt``, ``_rlnAnglePsi``. These columns represent the position and orientation of the
particle in the tomogram.
- The STAR file must reference only one tomogram in the ``_rlnImageName`` column. This is because we are only
interested in the relationship between a single particle and a single tomogram. If the STAR file references
multiple tomograms, then a prior preparation step will need to be performed to partition the STAR file into
multiple files, each referencing a single tomogram. (more on that to come)
interested in the relationship between a single particle and a single tomogram. If the STAR file references
multiple tomograms, then a prior preparation step will need to be performed to partition the STAR file into
multiple files, each referencing a single tomogram. (more on that to come)
.. code-block:: python
Expand Down

0 comments on commit 55a4c9a

Please sign in to comment.