File: node17.html

package info (click to toggle)
melting 5.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 21,836 kB
  • sloc: java: 12,710; xml: 8,395; perl: 1,581; sh: 112; makefile: 4
file content (278 lines) | stat: -rw-r--r-- 8,888 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<!--Converted with LaTeX2HTML 2002-2-1 (1.71)
original version by:  Nikos Drakos, CBLU, University of Leeds
* revised and updated by:  Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
  Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>New denaturing agent species or other species</TITLE>
<META NAME="description" CONTENT="New denaturing agent species or other species">
<META NAME="keywords" CONTENT="DeveloppersGuide">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">

<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="Generator" CONTENT="LaTeX2HTML v2002-2-1">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">

<LINK REL="STYLESHEET" HREF="DeveloppersGuide.css">

<LINK REL="previous" HREF="node16.html">
<LINK REL="up" HREF="node15.html">
<LINK REL="next" HREF="node18.html">
</HEAD>

<BODY >

<DIV CLASS="navigation"><!--Navigation Panel-->
<A NAME="tex2html257"
  HREF="node18.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
 SRC="/usr/share/latex2html/icons/next.png"></A> 
<A NAME="tex2html253"
  HREF="node15.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
 SRC="/usr/share/latex2html/icons/up.png"></A> 
<A NAME="tex2html249"
  HREF="node16.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
 SRC="/usr/share/latex2html/icons/prev.png"></A> 
<A NAME="tex2html255"
  HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
 SRC="/usr/share/latex2html/icons/contents.png"></A>  
<BR>
<B> Next:</B> <A NAME="tex2html258"
  HREF="node18.html">How to change the</A>
<B> Up:</B> <A NAME="tex2html254"
  HREF="node15.html">How to add new</A>
<B> Previous:</B> <A NAME="tex2html250"
  HREF="node16.html">New ion species</A>
 &nbsp; <B>  <A NAME="tex2html256"
  HREF="node1.html">Contents</A></B> 
<BR>
<BR></DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION00092000000000000000">
New denaturing agent species or other species</A>
</H2>

<P>
<SPAN  CLASS="textbf">1)</SPAN> If the new species is an ion which can't be included in the algorithm from Owczarzy et al. 2008
or if it is a new denaturing agent, you have to create a new instance variable of RegisterMethods in
the melting.cinfiguration package. The new <SPAN  CLASS="textit">private static HashMap&lt;String, Class&lt;? extends CorrectionMethod&#187;</SPAN>
register all the corrections for the new species.

<P>
<PRE>
/**
* HasMap formamideCorrection : contains all the methods for 
* the new species correction.
*/
	private static HashMap&lt;String, Class&lt;? extends CorrectionMethod&gt;&gt; 
	                                   newSpeciesCorrection = 
	  new HashMap&lt;String, Class&lt;? extends CorrectionMethod&gt;&gt;();
</PRE>

<P>
<SPAN  CLASS="textbf">2)</SPAN> You have to create a new method in RegisterMethods to initialise the new HasMap :

<P>
<PRE>
/**
* initialises the newSpeciesCorrectionMethod HashMap of 
* the RegisterMethods object.
*/
	private void initialiseNewSpeciesCorrectionMethod(){
		[...]
		newSpeciesCorrection.put("NewSpeciesCorrection-Name", 
		                                   ClassName.class);
	}
</PRE>

<P>
<SPAN  CLASS="textbf">3)</SPAN> You have to create a new option to give the possibility to change the correction
for the new species. You must add a new <SPAN  CLASS="textit">public static final String</SPAN> in the 
OptionManagement class to register the name of the new option. (melting.configuration package)

<P>
<PRE>
/**
* Option name for to change the default correction for the 
* new species.
*/
	public static final String newSpeciesOption = "Option-Name";
</PRE>

<P>
<SPAN  CLASS="textbf">4)</SPAN> Choose a default new species correction for each type of hybridization in
the following methods of OptionManagement :

<P>
<PRE>
/**
* initialises the DNADefaultOptions HashMap of the 
* OptionManagement object.
*/
	private void initialisesDNADefaultOptions() {
		[...]
		
		this.DNADefaultOptions.put(newSpeciesOption, 
		                    "DNAdefaultCorrection-Name");
	}
	
/**
* initialises the RNADefaultOptions HashMap of the 
* OptionManagement object.
*/
	private void initialiseRNADefaultOptions() {
		[...]
		
		this.RNADefaultOptions.put(newSpeciesOption, 
		                   "RNAdefaultCorrection-Name");

	}
	
/**
* initialises the hybridDefaultOptions HashMap of the 
* OptionManagement object.
*/
	private void initialiseHybridDefaultOptions() {
		[...]
		
		this.hybridDefaultOptions.put(newSpeciesOption, 
		                  "DNARNAdefaultCorrection-Name");
		
	}
	
/**
* initialises the mRNADefaultOptions HashMap of the 
* OptionManagement object.
*/
	private void initialiseMRNADefaultOptions() {
		[...]
		
		this.mRNADefaultOptions.put(newSpeciesOption, 
		                  "mRNAdefaultCorrection-Name");

	}
</PRE>

<P>
<SPAN  CLASS="textbf">5)</SPAN> You have to register the new option in the HashMap <SPAN  CLASS="textit">registerEnvironmentOptions</SPAN>
of OptionManagement. You just have to add the following line into the method 
<SPAN  CLASS="textit">private void initialiseRegisterEnvironmentOptions()</SPAN> of OptionManagement :

<P>
<PRE>
/**
* Initialises the registerEnvironmentOptions HashMap of the 
* OptionManagement object.
*/
	private void initialiseRegisterEnvironmentOptions(){
		[...]
		
		registerEnvironmentOptions.add(newSpeciesOption);

	}
</PRE>

<P>
<SPAN  CLASS="textbf">6)</SPAN> You have to register the new species and the new corrections for it in RegisterMethods (melting.configuration package).
You must add the following line to the method <SPAN  CLASS="textit">private void initialiseOtherCorrectionMethod()</SPAN> :

<P>
<PRE>
/**
* initialises the otherCorrectionMethod HashMap of the 
* RegisterMethods object.
*/
	private void initialiseOtherCorrectionMethod(){
		[...]
		
		// create a relationship between the new option and 
		//the corrections registered for the new species.
		otherCorrection.put(OptionManagement.newSpeciesOption, 
		                                 newSpeciesCorrection);
	}
</PRE>

<P>
<SPAN  CLASS="textbf">7)</SPAN> You have to complete the method <SPAN  CLASS="textit">public ThermoResult computeOtherMeltingCorrections(Environment environment)</SPAN>
of RegisterMethods. This method is important to correct the melting temperature if another ion or denaturing agent species
are present :

<P>
<PRE>
public ThermoResult computeOtherMeltingCorrections(Environment 
                                                 environment){
		[...]
		
 // Check if the new species is present in the environment
 if (environment.getNewSpecies() &gt; 0){
 
// Get the correction associated with the option name of the 
// new species.
CorrectionMethod newSpeciesCorrection = 
getCorrectionMethod(OptionManagement.newSpeciesCorrection, 
environment.getOptions().get(OptionManagement.newSpeciesCorrection));
			
if (newSpeciesCorrection == null){
	throw new NoExistingMethodException("There is no implemented 
	                                    new species correction.");
}
else if (newSpeciesCorrection.isApplicable(environment)){
environment.setResult
    (newSpeciesCorrection.correctMeltingResults(environment));
}
else {
	throw new MethodNotApplicableException("The new species correction 
	   is not applicable with this environment 
	   (option " + OptionManagement.newSpeciesCorrection + ").");
}
}
</PRE>

<P>
<SPAN  CLASS="textbf">8)</SPAN> Create a new class for the new species corrections as it is explained in the section
<SPAN  CLASS="textit">How to add new corrections for Na, Mg, K, Tris, DMSO and/or formamide</SPAN>.

<P>

<DIV CLASS="navigation"><HR>
<!--Navigation Panel-->
<A NAME="tex2html257"
  HREF="node18.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
 SRC="/usr/share/latex2html/icons/next.png"></A> 
<A NAME="tex2html253"
  HREF="node15.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
 SRC="/usr/share/latex2html/icons/up.png"></A> 
<A NAME="tex2html249"
  HREF="node16.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
 SRC="/usr/share/latex2html/icons/prev.png"></A> 
<A NAME="tex2html255"
  HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
 SRC="/usr/share/latex2html/icons/contents.png"></A>  
<BR>
<B> Next:</B> <A NAME="tex2html258"
  HREF="node18.html">How to change the</A>
<B> Up:</B> <A NAME="tex2html254"
  HREF="node15.html">How to add new</A>
<B> Previous:</B> <A NAME="tex2html250"
  HREF="node16.html">New ion species</A>
 &nbsp; <B>  <A NAME="tex2html256"
  HREF="node1.html">Contents</A></B> </DIV>
<!--End of Navigation Panel-->
<ADDRESS>
Computational Neurobiology
2009-08-24
</ADDRESS>
</BODY>
</HTML>