Package schrodinger :: Package trajectory :: Module atomselection :: Class FrameSliceSelection

[frames] | no frames]

Class FrameSliceSelection

A class for efficiently selecting a range of atoms.

Instance Methods

__init__(self, slice_)
Initialize a slice selection.

isDynamic(self)
Returns: A bool indicating whether this selection changes from frame to frame.

getArraySelection(self, frame)
Returns: An object that can be used as an index in a numpy array.

getOffsets(self, frame)
Returns: A selection as a sequence of integers, using zero based indexing so it can be used with a numpy array.

getAtomIndices(self, frame)
Returns: A selection as a sequence of integers, using one based indexing so it can be used with a Structure.

Method Details

init(self, slice_)
(Constructor)

Initialize a slice selection. Because this selection mimics behavior of the python slice object, input values are zero-based indices.

isDynamic(self)

Returns:: A bool indicating whether this selection changes from frame to frame.

getArraySelection(self, frame)

Returns:: An object that can be used as an index in a numpy array.

getOffsets(self, frame)

Returns:: A selection as a sequence of integers, using zero based indexing so it can be used with a numpy array.

getAtomIndices(self, frame)

Returns:: A selection as a sequence of integers, using one based indexing so it can be used with a Structure.