Package schrodinger :: Package application :: Package desmond :: Package packages :: Module analysis :: Class Rdf
[hide private]
[frames] | no frames]

Class Rdf

      object --+    
               |    
GeomAnalyzerBase --+
                   |
                  Rdf

Calculate radial distribution function (RDF) of provided selection.

Instance Methods [hide private]
 
__init__(self, msys_model, cms_model, asl0, asl1=None, pos_type0='atom', pos_type1='atom', dr=0.1, rmax=12.0)
This analyzer calculates the radial distribution function [RDF, also known as g(r)] of specified positions in the system.
 
_asl2gids(self, asl, pos_type)
 
_precalc(self, calc)
 
_postcalc(self, _, pbc, fr)
(list, list)
reduce(self, *_, **__)
Aggregates the frame-based results (histograms) and returns the final RDF results.
 
bins(self)

Inherited from GeomAnalyzerBase: __call__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods [hide private]
 
_get_slice_volumes(bins)
Calculate slice volumes between the adjacent bins
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, msys_model, cms_model, asl0, asl1=None, pos_type0='atom', pos_type1='atom', dr=0.1, rmax=12.0)
(Constructor)

 

This analyzer calculates the radial distribution function [RDF, also known as g(r)] of specified positions in the system.

In general, we need two groups of positions. The first group are the reference positions, whereas the second the distance group. For example, say we want to calculate the RDF of the distances of water hydrogen atoms with respect to water oxygen atoms, the first group will be all water oxygen atoms' positions, and the second group all water hydrogen atoms' positions. The reference and distance groups can be the same, for example, in the case of the RDF of water oxygen atoms.

Each position doesn't have to be an atom's position, and it could be a derived position such the center of mass of the molecule.

Parameters:
  • asl0 (str) - Atom selection for the reference group
  • asl1 (str or None) - Atom selection for the distance group. If it's None, it will default to asl0.
  • pos_type0 (str) - Type of positions of the reference group: "atom" : Use atom's position directly "com" : Use molecular center of mass "coc" : Use molecular center of charge "centroid": Use molecular centroid
  • pos_type1 (str) - Type of positions of the distance group. Values are the same as those of pos_type0
  • dr (float) - Bin width in the unit of Angstroms
  • rmax (float) - Maximum distance in the unit in Angstroms. The RDF will be calculated until rmax.
  • cms_model (cms.Cms)
  • msys_model (msys.System)
Overrides: object.__init__

_precalc(self, calc)

 
Overrides: GeomAnalyzerBase._precalc
(inherited documentation)

_postcalc(self, _, pbc, fr)

 
Overrides: GeomAnalyzerBase._postcalc
(inherited documentation)

reduce(self, *_, **__)

 

Aggregates the frame-based results (histograms) and returns the final RDF results.

Returns: (list, list)
Returns the RDF (the first list), and the integral (the second list).