Package schrodinger :: Package trajectory :: Module lipid_analysis :: Class AreaPerLipid

Class AreaPerLipid

analysistool.AnalysisTool --+
                            |
                           AreaPerLipid

Figure out what's the area per lipid in the pure membrane system

Instance Methods

[hide private]

__init__(self, nlipids_per_leaflet=None, *args, **kwargs)
Initialize frame slicing information.

doFrameInit(self, frame)
Initialize data that requires a frame instance for reference.

processFrame(self, frame)
Collect data for the provided frame.

getFrameResults(self)
Return results as a numpy array for all values and frames with the first index being across frames.

Inherited from analysistool.AnalysisTool: getDataLabels, getLabel, getResults, plot, plot2D, postProcess, setSlice, shouldProcessFrame

Method Details

[hide private]

init(self, nlipids_per_leaflet=None, *args, **kwargs)
(Constructor)

Initialize frame slicing information.

The behavior of 'start', 'stop', 'step' is the same as the python built-in range function. That is, 'start' is included in the values to be processed, but 'stop' is not. Only the largest value satisfying 'start' and 'step' that is less than 'stop' will be processed.

Overrides: analysistool.AnalysisTool.__init__: (inherited documentation)

doFrameInit(self, frame)

Initialize data that requires a frame instance for reference.

This method will be called once, with the first frame that is processed.

Overrides: analysistool.AnalysisTool.doFrameInit: (inherited documentation)

processFrame(self, frame)

Collect data for the provided frame.

Overrides: analysistool.AnalysisTool.processFrame: (inherited documentation)

getFrameResults(self)

Return results as a numpy array for all values and frames with the first index being across frames.

So, if fr = analysis.getFrameResults(), and the analysis instance calculates three values for each frame, then fr[0] will be the three values for the first frame.

Overrides: analysistool.AnalysisTool.getFrameResults: (inherited documentation)

Class AreaPerLipid

__init__(self, nlipids_per_leaflet=None, *args, **kwargs) (Constructor)

doFrameInit(self, frame)

processFrame(self, frame)

getFrameResults(self)

init(self, nlipids_per_leaflet=None, *args, **kwargs)
(Constructor)