Skip to content
This repository has been archived by the owner on Sep 1, 2023. It is now read-only.

Incorrect Documentation of Connections method #3240

Closed
cogmission opened this issue Aug 2, 2016 · 1 comment · Fixed by #3254
Closed

Incorrect Documentation of Connections method #3240

cogmission opened this issue Aug 2, 2016 · 1 comment · Fixed by #3254

Comments

@cogmission
Copy link
Contributor

cogmission commented Aug 2, 2016

The documentation for the enclosed method, states that it, "...returns the column that a segment's presynaptic cell belongs to." What it does is return the column of the Cell that owns the segment. If I'm not mistaken, Segments don't have presynaptic cells; Synapses do. I believe there may be many Cells that synapse to a segment, and each of those synapses have "presynaptic" cells (source cells).

The documentation for the method should probably read:
Returns the column of the Cell which owns the segment.

 def columnForSegment(self, segment, cellsPerColumn):
    """ Returns the column that a segment's presynapticCell belongs to

    @param segment        (int) Segment index
    @param cellsPerColumn (int) Number of cells in a column in the tm

    @return (int)
    """
    return self._segments[segment] / cellsPerColumn

As a side note, this really messed me up trying figure out how to derive a presynaptic cell from a segment, until I realized it's not possible. :-P

@andrewmalta13
Copy link
Contributor

@cogmission thanks for the heads up. Will be fixed soon.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants