annotate docs/modules/txt/MolecularDescriptors.txt @ 0:4816e4a8ae95 draft default tip

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 09:23:18 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
1 NAME
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
2 MolecularDescriptors - MolecularDescriptors class
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
3
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
5 use MolecularDescriptors::MolecularDescriptors;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
6
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
7 use MolecularDescriptors::MolecularDescriptors qw(:all);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
8
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
9 DESCRIPTION
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
10 MolecularDescriptors base class used to derive all other molecular
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
11 descriptors classes provides the following methods:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
12
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
13 new, AddDescriptorNames, AddDescriptorValues, GetDescriptorNames,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
14 GetDescriptorNamesAndValues, GetDescriptorValueByName,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
15 GetDescriptorValues, IsDescriptorsGenerationSuccessful,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
16 SetDescriptorNames, SetDescriptorValues, SetMolecule, SetType
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
17
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
18 MolecularDescriptors class is derived from ObjectProperty base class
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
19 which provides methods not explicitly defined in Fingerprints or
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
20 ObjectProperty classes using Perl's AUTOLOAD functionality. These
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
21 methods are generated on-the-fly for a specified object property:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
22
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
23 Set<PropertyName>(<PropertyValue>);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
24 $PropertyValue = Get<PropertyName>();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
25 Delete<PropertyName>();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
26
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
27 METHODS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
28 new
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
29 $NewMolecularDescriptors = new MolecularDescriptors::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30 MolecularDescriptors(%NamesAndValues);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32 Using specified *MolecularDescriptors* property names and values
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33 hash, new method creates a new object and returns a reference to
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34 newly created MolecularDescriptors object. By default, following
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35 properties are initialized:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37 Molecule = '';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38 Type = '';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40 AddDescriptorNames
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41 $MolecularDescriptors->AddDescriptorNames(@Name);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43 Adds specified descriptor *Names* to the list of available
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44 descriptor names and returns *MolecularDescriptors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46 AddDescriptorValues
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47 $MolecularDescriptors->AddDescriptorValues(@Values);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49 Adds specified descriptor *Values* to the list of calculated
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50 descriptor values and returns *MolecularDescriptors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52 GetDescriptorNames
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53 @Names = $MolecularDescriptors->GetDescriptorNames();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
55 Returns an array containing all available descriptor names.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
56
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
57 GetDescriptorNamesAndValues
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
58 %NamesAndValuesReturn = $MolecularDescriptors->
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
59 GetDescriptorNamesAndValues();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
60
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61 Returns a hash containing all available descriptor names and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62 calculated values.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
64 GetDescriptorValueByName
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
65 $Value = $MolecularDescriptors->
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
66 GetDescriptorValueByName($Name);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
67
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
68 Returns calculated value for a specified descriptor name. A string
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
69 None is returned for unknown descriptor names or for those
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
70 descriptors whose values haven't been calculated.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
71
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
72 GetDescriptorValues
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
73 @Values = $MolecularDescriptors->GetDescriptorValues();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
74
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
75 Returns an array containing calculated descriptor values for all
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
76 available descriptors. Unless CalculateDescriptorsValues method has
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
77 been successfully invoked on a *MolecularDescriptors* object, value
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
78 of each descriptor corresponds to string None.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
79
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
80 IsDescriptorsGenerationSuccessful
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
81 $Status = $MolecularDescriptors->
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
82 IsDescriptorsGenerationSuccessful();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
83
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
84 Returns 1 or 0 based on whether molecular descriptors generation was
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
85 successful. For a successful molecular descriptors calculation, all
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
86 available descriptors must have a values other than a string *None*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
87 which are set by CalculateDescriptorsValues method after successful
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
88 completion of descriptors calculation.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
89
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
90 SetDescriptorNames
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
91 $MolecularDescriptors->SetDescriptorNames(@Names);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
92
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
93 Sets names of available descriptors to specified names and returns
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
94 *MolecularDescriptors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
95
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
96 SetDescriptorValues
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
97 $MolecularDescriptors->SetDescriptorValues(@Values);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
98
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
99 Sets values of available descriptors to specified values and returns
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
100 *MolecularDescriptors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
101
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
102 SetMolecule
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
103 $MolecularDescriptors->SetMolecule($Molecule);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
104
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
105 Sets molecule to use during calculation of molecular descriptors and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
106 returns *MolecularDescriptors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
107
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
108 SetType
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
109 $MolecularDescriptors->SetType($Type);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
110
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
111 Sets *Type* for *MolecularDescriptors* object and returns
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
112 *MolecularDescriptors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
113
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
114 AUTHOR
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
115 Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
116
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
117 SEE ALSO
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
118 MolecularDescriptorsGenerator.pm
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
119
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
120 COPYRIGHT
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
121 Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
122
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
123 This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
124
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
125 MayaChemTools is free software; you can redistribute it and/or modify it
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
126 under the terms of the GNU Lesser General Public License as published by
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
127 the Free Software Foundation; either version 3 of the License, or (at
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
128 your option) any later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
129