Home | Trees | Indices | Help |
|
---|
|
Analysis.Analysis --+ | MeanSquareDisplacement
Sets up a Mean Square Displacement analysis. A Subclass of nMOLDYN.Analysis.Analysis. Constructor: MeanSquareDisplacement(|parameters| = None) Arguments: - |parameters| -- a dictionnary of the input parameters, or 'None' to set up the analysis without parameters. * trajectory -- a trajectory file name or an instance of MMTK.Trajectory.Trajectory class. * timeinfo -- a string of the form 'first:last:step' where 'first' is an integer specifying the first frame number to consider, 'last' is an integer specifying the last frame number to consider and 'step' is an integer specifying the step number between two frames. * projection -- a string of the form 'vx,vy,vz' specifying the vector along which the analysis will be computed. 'vx', 'vy', and 'vz' are floats specifying respectively the x, y and z value of that vector. * subset -- a selection string specifying the atoms to consider for the analysis. * deuteration -- a selection string specifying the hydrogen atoms whose atomic parameters will be those of the deuterium. * weights -- a string equal to 'equal', 'mass', 'coherent' , 'incoherent' or 'atomicNumber' that specifies the weighting scheme to use. * msd -- the output NetCDF file name. A CDL version of this file will also be generated with the '.cdl' extension instead of the '.nc' extension. * pyroserver -- a string specifying if Pyro will be used and how to run the analysis. Running modes: - To run the analysis do: a.runAnalysis() where a is the analysis object. - To estimate the analysis do: a.estimateAnalysis() where a is the analysis object. - To save the analysis to 'file' file name do: a.saveAnalysis(file) where a is the analysis object. Comments: - The algorithm is based on the Fast Correlation Algorithm (FCA) algorithm
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Numpy array |
|
||
Inherited from |
|
|||
inputParametersNames = 'trajectory', 'timeinfo', 'projection',
|
|||
shortName = 'MSD'
|
|||
canBeEstimated = True
|
|
The constructor. Insures that the class can not be instanciated directly from here.
|
Initializes the analysis (e.g. parses and checks input parameters, set some variables ...). |
Calculates the atomic term.
|
Finalizes the calculations (e.g. averaging the total term, output files creations ...). |
Returns the atomic Mean-Square-Displacement.
|
|
inputParametersNames
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Thu Oct 8 16:56:55 2009 | http://epydoc.sourceforge.net |