Package schrodinger :: Package application :: Package canvas :: Module topo_descriptors :: Class TopologicalDescriptors
[hide private]
[frames] | no frames]

Class TopologicalDescriptors

object --+
         |
        TopologicalDescriptors

Instance Methods [hide private]
 
__init__(self, default_descriptor_value=None)
Initializes valid topological descriptors, and creates an empty cached property dictionary.
structure.Structure
calculateTopologicalDescriptors(self, st, descriptor_strings)
Calculates a set of topological descriptors for a given structure.
str
m2ioPropertyName(self, descriptor)
Create descriptor m2io property name for a Descriptor.
structure.Structure
_cleanStructureCopy(self, st)
Creates a copy of the structure with all hydrogens removed; such heavy atom only structures are required for certain properties.
Descriptor
_findDescriptorEntry(self, desc_str)
Locates the corresponding Descriptor in the class tuple of Descriptors.
str
_makeFullLabel(self, descriptor)
Create complete descriptor label-key string
one of {float, int, bool, str}
_evaluateDescriptor(self, descriptor, st)
Evalulates a descriptor for a given structure.
 
_getDescriptorEntries(self)
Returns set of valid descriptor tuples in the form of: (descriptor key, descriptor label, function mapping)
dict
_getHydrogenCount(self, st)
Collect the number of hydrogens connected to each heavy atom
 
_getAtomIndices(self, st)
 
_getAdjacencyMatrix(self, st)
Build adjacency matrix for structure
 
_getValenceCount(self, st, atom_type, atom_index)
 
_getValenceVertex(self, st, atom_index)
 
_get_zagreb_m1(self, st)
 
_get_zagreb_m1_valence_vertex_degree(self, st)
 
_get_zagreb_m2(self, st)
 
_get_zagreb_m2_valence_vertex_degree(self, st)
 
_getDistanceGraph(self, st)
Build distance matrix for structure
 
_getShortestPath(self, st)
 
_getDistanceMatrix(self, st)
 
_get_polarity(self, st)
 
_get_simple_topological(self, st)
 
_get_harmonic_topological(self, st)
 
_get_geometric_topological(self, st)
 
_get_total_structure_connectivity(self, st)
 
_get_wiener(self, st)
 
_get_mean_wiener(self, st)
 
_get_xu(self, st)
 
_get_qindex(self, st)
 
_get_radial_centric(self, st)
 
_get_mean_square_distance_balaban(self, st)
 
_get_superpendentic(self, st)
 
_get_harary(self, st)
 
_get_lprs(self, st)
 
_get_pogliani(self, st)
 
_get_smt(self, st)
 
_get_smt_valence_vertex_degree(self, st)
 
_get_mean_distance_degree_deviation(self, st)
 
_get_ramification(self, st)
 
_get_gutman_molecular_topological(self, st)
 
_get_gutman_mti_valence_vertex_degrees(self, st)
 
_get_average_vertex_distance_degree(self, st)
 
_get_unipolarity(self, st)
 
_get_centralization(self, st)
 
_get_variation(self, st)
 
_getIntrinsicState(self, st)
 
_getFieldEffect(self, st)
 
_get_mev(self, st)
 
_get_mepv(self, st)
 
_get_menv(self, st)
 
_get_eccentric_connectivity(self, st)
 
_get_eccentricity(self, st)
 
_get_average_eccentricity(self, st)
 
_get_eccentric(self, st)
 
_getNeighbors(self, st)
 
_get_valence_connectivity_chi(self, st, n)
 
_get_AvX(self, st, n)
 
_getEigenvalues(self, st)
Laplacian eigenvalues
 
_get_quasi_wiener(self, st)
 
_get_first_mohar(self, st)
 
_get_second_mohar(self, st)
 
_get_spanning_tree_number(self, st)
 
_get_kier_benzene_likeliness(self, st)
 
_getChargeTermMatrix(self, st)
 
_get_topological_charge_index(self, st, n)
 
_getTotalDistanceParticipants(self, st, n)
 
_get_MTCI(self, st, n)
 
_get_global_topological_charge(self, st)
 
_get_hyper_distance_path(self, st)
 
_get_reciprocal_hyper_distance_path(self, st)
 
_get_square_reciprocal_distance_sum(self, st)
 
_get_modified_randic_connectivity(self, st)
 
_get_balaban_centric_index(self, st)
 
_get_looping_centric_index(self, st)
 
_get_kier_hall_electronegativity_index(self, st)
 
_get_topo_dist_sum(self, st, elem1, elem2)
Sum of topological distance between atom pairs of atom types
 
_getBondOrderMatrix(self, st)
 
_getPathSumMatrix(self, st, const, v)
 
_getBaryszMatrix(self, st)
 
_get_wiener_z_matrix(self, st)
 
_getElectroNegMatrix(self, st)
 
_get_wiener_electronegativity_matrix(self, st)
 
_getMassMatrix(self, st)
 
_get_wiener_mass_matrix(self, st)
 
_getVDWMatrix(self, st)
 
_get_wiener_van_der_waals_matrix(self, st)
 
_getPolarizabilityMatrix(self, st)
 
_get_wiener_polarizability_matrix(self, st)
 
_weightedDistance(self, st, mat)
 
_get_balaban_z_matrix(self, st)
 
_get_balaban_electronegativity_matrix(self, st)
 
_get_balaban_mass_matrix(self, st)
 
_get_balaban_van_der_waals_matrix(self, st)
 
_get_balaban_polarizability_matrix(self, st)
 
_get_topological_diameter(self, st)
 
_get_topological_radius(self, st)
 
_get_petitjean_shape(self, st)
 
_getNumberRings(self, st)
 
_get_balaban_distance_connectivity(self, st)
 
_get_solvation_connectivity_indices(self, st, n)
 
_getNeighborsConnectivity(self, st)
 
_get_connectivity_chi(self, st, n)
 
_get_average_connectivity_chi(self, st, n)
 
_getReciprocalDistanceMatrix(self, st)
 
_get_reciprocal_distance_randic(self, st)
 
_get_reciprocal_distance_square_randic(self, st)
 
_get_kier_alpha_modified_shape(self, st, n)
 
_get_kier_flexbility(self, st)
 
_getNeighborsRedundant(self, st)
 
_get_path_walk(self, st, n)
 
_get_e_state(self, st)
 
_getStructWithHydrogens(self, st)
 
_get_chiral_count(self, st)
Get number of chiral atoms -- R or S for chiral category
 
_get_ringcount(self, st, n)
 
_get_atomcount(self, st)
 
_get_bondcount(self, st)
 
_get_atom_rings_count(self, st)
 
_get_bond_rings_count(self, st)
 
_get_cyclomatic(self, st)
 
_get_num_ring_systems(self, st)
 
_get_normalized_num_ring_systems(self, st)
 
_get_ring_fusion_degree(self, st)
 
_get_total_ring_size(self, st)
 
_get_ring_perimeter(self, st)
 
_get_ring_bridge(self, st)
 
_get_molecule_cyclized_degree(self, st)
 
_get_ring_fusion_density(self, st)
 
_get_ring_complexity_index(self, st)
 
_getAtomicSurfaceArea(self, st)
Van der Waals surface area of each atom, i, given as:...
 
_get_van_der_waals_surface_area(self, st)
Return van der waals surface area of a molecule vsa = sigma(vsa of each atom i)
 
_getChmMol(self, st)
 
_get_mr(self, st, n)
Return atomic contribution based on MR values.
 
_get_alogp(self, st, n)
Return atomic contributions based on Alpgp values.
 
_get_peoe(self, st, n)
Return atomic contribution based on Gasteiger charges.

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, default_descriptor_value=None)
(Constructor)

 

Initializes valid topological descriptors, and creates an empty cached property dictionary.

Overrides: object.__init__

calculateTopologicalDescriptors(self, st, descriptor_strings)

 

Calculates a set of topological descriptors for a given structure.

Parameters:
  • st (structure.Structure) - structure to consider
  • descriptor_strings (list of str) - list of descriptors to calculate
Returns: structure.Structure
Structure copy appended with successful descriptor properties

m2ioPropertyName(self, descriptor)

 

Create descriptor m2io property name for a Descriptor.

Parameters:
Returns: str
m2io formatted descriptor property name

_cleanStructureCopy(self, st)

 

Creates a copy of the structure with all hydrogens removed; such heavy atom only structures are required for certain properties.

Parameters:
Returns: structure.Structure
Structure copy without hydrogen atoms

_findDescriptorEntry(self, desc_str)

 

Locates the corresponding Descriptor in the class tuple of Descriptors. Looks for Descriptor based on matching the passed string to any of the key, label, or "label (key)" strings.

Parameters:
  • desc_str (str) - input descriptor string
Returns: Descriptor
Descriptor namedtuple
Raises:
  • TopoError - If the descriptor entry could not be found

_makeFullLabel(self, descriptor)

 

Create complete descriptor label-key string

Parameters:
Returns: str
full descriptor label

_evaluateDescriptor(self, descriptor, st)

 

Evalulates a descriptor for a given structure. If successful, the value is cast to the expected type before returning.

Parameters:
Returns: one of {float, int, bool, str}
descriptor value, cast to the appropriate return type
Raises:
  • TopoError - If the descriptor cast-type was unrecognized

_getDescriptorEntries(self)

 

Returns set of valid descriptor tuples in the form of:
  (descriptor key, descriptor label, function mapping)

@return: set of available topological descriptor mappings
@rtype: set of tuples

_getHydrogenCount(self, st)

 

Collect the number of hydrogens connected to each heavy atom

Parameters:
Returns: dict
map of hydrogen counts indexed by renumbered heavy atom indexed
Decorators:
  • @cached_topo_descriptor

_getAtomIndices(self, st)

 
Decorators:
  • @cached_topo_descriptor

_getAdjacencyMatrix(self, st)

 

Build adjacency matrix for structure

Decorators:
  • @cached_topo_descriptor

_getValenceCount(self, st, atom_type, atom_index)

 
Decorators:
  • @cached_topo_descriptor

_getValenceVertex(self, st, atom_index)

 
Decorators:
  • @cached_topo_descriptor

_get_zagreb_m1(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_zagreb_m1_valence_vertex_degree(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_zagreb_m2(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_zagreb_m2_valence_vertex_degree(self, st)

 
Decorators:
  • @cached_topo_descriptor

_getDistanceGraph(self, st)

 

Build distance matrix for structure

Decorators:
  • @cached_topo_descriptor

_getShortestPath(self, st)

 
Decorators:
  • @cached_topo_descriptor

_getDistanceMatrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_polarity(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_simple_topological(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_harmonic_topological(self, st)

 
Decorators:
  • @cached_topo_descriptor
  • @requires_multiple_heavy_atoms

_get_geometric_topological(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_total_structure_connectivity(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_wiener(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_mean_wiener(self, st)

 
Decorators:
  • @cached_topo_descriptor
  • @requires_multiple_heavy_atoms

_get_xu(self, st)

 
Decorators:
  • @cached_topo_descriptor
  • @requires_multiple_heavy_atoms

_get_qindex(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_radial_centric(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_mean_square_distance_balaban(self, st)

 
Decorators:
  • @cached_topo_descriptor
  • @requires_multiple_heavy_atoms

_get_superpendentic(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_harary(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_lprs(self, st)

 
Decorators:
  • @cached_topo_descriptor
  • @requires_multiple_heavy_atoms

_get_pogliani(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_smt(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_smt_valence_vertex_degree(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_mean_distance_degree_deviation(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_ramification(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_gutman_molecular_topological(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_gutman_mti_valence_vertex_degrees(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_average_vertex_distance_degree(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_unipolarity(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_centralization(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_variation(self, st)

 
Decorators:
  • @cached_topo_descriptor

_getIntrinsicState(self, st)

 
Decorators:
  • @cached_topo_descriptor
  • @requires_multiple_heavy_atoms

_getFieldEffect(self, st)

 
Decorators:
  • @cached_topo_descriptor
  • @requires_multiple_heavy_atoms

_get_mev(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_mepv(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_menv(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_eccentric_connectivity(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_eccentricity(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_average_eccentricity(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_eccentric(self, st)

 
Decorators:
  • @cached_topo_descriptor

_getNeighbors(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_valence_connectivity_chi(self, st, n)

 
Decorators:
  • @cached_topo_descriptor
  • @requires_multiple_heavy_atoms

_get_AvX(self, st, n)

 
Decorators:
  • @cached_topo_descriptor

_getEigenvalues(self, st)

 

Laplacian eigenvalues

Decorators:
  • @cached_topo_descriptor

_get_quasi_wiener(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_first_mohar(self, st)

 
Decorators:
  • @cached_topo_descriptor
  • @requires_multiple_heavy_atoms

_get_second_mohar(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_spanning_tree_number(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_kier_benzene_likeliness(self, st)

 
Decorators:
  • @cached_topo_descriptor

_getChargeTermMatrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_topological_charge_index(self, st, n)

 
Decorators:
  • @cached_topo_descriptor

_getTotalDistanceParticipants(self, st, n)

 
Decorators:
  • @cached_topo_descriptor

_get_MTCI(self, st, n)

 
Decorators:
  • @cached_topo_descriptor

_get_global_topological_charge(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_hyper_distance_path(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_reciprocal_hyper_distance_path(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_square_reciprocal_distance_sum(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_modified_randic_connectivity(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_kier_hall_electronegativity_index(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_topo_dist_sum(self, st, elem1, elem2)

 

Sum of topological distance between atom pairs of atom types

Decorators:
  • @cached_topo_descriptor

_getBondOrderMatrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_getBaryszMatrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_wiener_z_matrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_getElectroNegMatrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_wiener_electronegativity_matrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_getMassMatrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_wiener_mass_matrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_getVDWMatrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_wiener_van_der_waals_matrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_getPolarizabilityMatrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_wiener_polarizability_matrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_balaban_z_matrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_balaban_electronegativity_matrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_balaban_mass_matrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_balaban_van_der_waals_matrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_balaban_polarizability_matrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_topological_diameter(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_topological_radius(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_petitjean_shape(self, st)

 
Decorators:
  • @cached_topo_descriptor
  • @requires_multiple_heavy_atoms

_getNumberRings(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_balaban_distance_connectivity(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_solvation_connectivity_indices(self, st, n)

 
Decorators:
  • @cached_topo_descriptor
  • @requires_multiple_heavy_atoms

_getNeighborsConnectivity(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_connectivity_chi(self, st, n)

 
Decorators:
  • @cached_topo_descriptor
  • @requires_multiple_heavy_atoms

_get_average_connectivity_chi(self, st, n)

 
Decorators:
  • @cached_topo_descriptor

_getReciprocalDistanceMatrix(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_reciprocal_distance_randic(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_reciprocal_distance_square_randic(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_kier_alpha_modified_shape(self, st, n)

 
Decorators:
  • @cached_topo_descriptor

_get_kier_flexbility(self, st)

 
Decorators:
  • @cached_topo_descriptor

_getNeighborsRedundant(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_path_walk(self, st, n)

 
Decorators:
  • @cached_topo_descriptor

_get_e_state(self, st)

 
Decorators:
  • @cached_topo_descriptor

_getStructWithHydrogens(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_chiral_count(self, st)

 

Get number of chiral atoms -- R or S for chiral category

Decorators:
  • @cached_topo_descriptor

_get_ringcount(self, st, n)

 
Decorators:
  • @cached_topo_descriptor

_get_atomcount(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_bondcount(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_atom_rings_count(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_bond_rings_count(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_cyclomatic(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_num_ring_systems(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_normalized_num_ring_systems(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_ring_fusion_degree(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_total_ring_size(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_ring_perimeter(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_ring_bridge(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_molecule_cyclized_degree(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_ring_fusion_density(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_ring_complexity_index(self, st)

 
Decorators:
  • @cached_topo_descriptor

_getAtomicSurfaceArea(self, st)

 

Van der Waals surface area of each atom, i, given as:
  4*pi*ri*ri - pi*ri*sigma((rj*rj-(ri-dij)*(ri-dij))/dij)
for j running for each bond of atom i and
ri, rj -> van der waals radius of respective atoms
dij    -> min(max(|ri-rj|,bij),ri+rj)
bij    -> ideal bond length, bij = sij - oij
sij    -> bond length of atom i and j calculated using MMFF94
oij    -> correction in bond length (0 for single, 0.1 for aromatic,
                                     0.2 for double, 0.3 for triple)

Decorators:
  • @cached_topo_descriptor

_get_van_der_waals_surface_area(self, st)

 

Return van der waals surface area of a molecule vsa = sigma(vsa of each atom i)

Decorators:
  • @cached_topo_descriptor

_getChmMol(self, st)

 
Decorators:
  • @cached_topo_descriptor

_get_mr(self, st, n)

 

Return atomic contribution based on MR values. This will help to capture polarizability.

Decorators:
  • @cached_topo_descriptor

_get_alogp(self, st, n)

 

Return atomic contributions based on Alpgp values. This is useful to capture hydrophobic and hydrophillic effect.

Decorators:
  • @cached_topo_descriptor

_get_peoe(self, st, n)

 

Return atomic contribution based on Gasteiger charges. This is useful to capture direct electrostatic interactions.

Decorators:
  • @cached_topo_descriptor