annotate mayachemtools/docs/modules/txt/RingsCountDescriptors.txt @ 9:ab29fa5c8c1f draft default tip

Uploaded
author deepakjadmin
date Thu, 15 Dec 2016 14:18:03 -0500
parents 73ae111cf86f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
1 NAME
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 RingsCountDescriptors
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 use MolecularDescriptors::RingsCountDescriptors;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 use MolecularDescriptors::RingsCountDescriptors qw(:all);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 DESCRIPTION
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 RingsCountDescriptors class provides the following methods:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 new, GenerateDescriptors, GetDescriptorNames,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 StringifyRingsCountDescriptors
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 RingsCountDescriptors is derived from MolecularDescriptors class which
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 in turn is derived from ObjectProperty base class that provides methods
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 not explicitly defined in RingsCountDescriptors, MolecularDescriptors or
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 ObjectProperty classes using Perl's AUTOLOAD functionality. These
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 methods are generated on-the-fly for a specified object property:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 Set<PropertyName>(<PropertyValue>);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 $PropertyValue = Get<PropertyName>();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 Delete<PropertyName>();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 RingsCountDescriptors class doesn't perform any ring or aromaticity
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 detection before counting their number in a molecule. Instead, it
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 assumes ring and aromaticity detection have been performed by caller
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28 using DetectRings [Ref 31] and DetectAromaticity methods available in
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 Molecule.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 DetectAromaticity method available in Molecule class assigns aromaticity
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 to rings using Huckel rule as explained below:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 o Ring aromaticity is determined using Huckel's rule: a ring containing
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 4n + 2 pi electrons is considered aromatic.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 o Hetrocyclic rings containing N, O and S atoms fall into two classes:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 Basic aromatic and Non-basic aromatic. In Basic aromatic hetrocyclic
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 rings, heteroatom itself is involved in a double bond. (e.g. Pyridine)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 However, in non-basic hetrocyclic rings, heteroatom might have an
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 attached hydrogen atom and the remaining lone pair contribute to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 electron delocalization and contributes to 4n + 2 electrons. (e.g.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 Pyrrole, Furan)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 o For molecules containing fused rings, each fused ring set is
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 considered as one aromatic system for counting pi electrons to satisfy
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 Huckel's rule; In case of a failure, rings in fused set are treated
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 individually for aromaticity detection. Additionally, non-fused rings
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 are handled on their own during aromaticity detection.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 METHODS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 new
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 $NewRingsCountDescriptors = new MolecularDescriptors::
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 RingsCountDescriptors(
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 %NamesAndValues);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 Using specified *RingsCountDescriptors* property names and values
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 hash, new method creates a new object and returns a reference to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 newly created RingsCountDescriptors object. By default, the
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 following properties are initialized:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 Molecule = ''
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 Type = 'RingsCount'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 @DescriptorNames = ('Rings', 'AromaticRings')
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 @DescriptorValues = ('None', 'None')
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 Examples:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 $RingsCountDescriptors = new MolecularDescriptors::RingsCountDescriptors(
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 'Molecule' => $Molecule);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 $RingsCountDescriptors = new MolecularDescriptors::RingsCountDescriptors();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 $RingsCountDescriptors->SetMolecule($Molecule);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 $RingsCountDescriptors->GenerateDescriptors();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 print "RingsCountDescriptors: $RingsCountDescriptors\n";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 GenerateDescriptors
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 $RingsCountDescriptors->GenerateDescriptors();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 Calculate number of rings and aromatic rings in a molecule and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 returns *RingsCountDescriptors*.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 GetDescriptorNames
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 @DescriptorNames = $RingsCountDescriptors->GetDescriptorNames();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 @DescriptorNames = MolecularDescriptors::RingsCountDescriptors::
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 GetDescriptorNames();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 Returns all available descriptor names as an array.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 StringifyRingsCountDescriptors
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 $String = $RingsCountDescriptors->
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 StringifyRingsCountDescriptors();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 Returns a string containing information about
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 *RingsCountDescriptors* object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 AUTHOR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 SEE ALSO
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 MolecularDescriptors.pm, MolecularDescriptorsGenerator.pm
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 COPYRIGHT
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 MayaChemTools is free software; you can redistribute it and/or modify it
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 under the terms of the GNU Lesser General Public License as published by
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112 the Free Software Foundation; either version 3 of the License, or (at
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 your option) any later version.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114