Statistics
| Revision:

root / org.gvsig.toolbox / trunk / org.gvsig.toolbox / org.gvsig.toolbox.algorithm / target / apidocs / es / unex / sextante / devel / BenchmarkAlgorithm.html @ 59

History | View | Annotate | Download (14.6 KB)

1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
<!--NewPage-->
3
<HTML>
4
<HEAD>
5
<!-- Generated by javadoc (build 1.6.0_18) on Tue Apr 22 13:52:24 CEST 2014 -->
6
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
7
<TITLE>
8
BenchmarkAlgorithm (Algorithms 1.0.3-SNAPSHOT API)
9
</TITLE>
10

    
11
<META NAME="date" CONTENT="2014-04-22">
12

    
13
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
14

    
15
<SCRIPT type="text/javascript">
16
function windowTitle()
17
{
18
    if (location.href.indexOf('is-external=true') == -1) {
19
        parent.document.title="BenchmarkAlgorithm (Algorithms 1.0.3-SNAPSHOT API)";
20
    }
21
}
22
</SCRIPT>
23
<NOSCRIPT>
24
</NOSCRIPT>
25

    
26
</HEAD>
27

    
28
<BODY BGCOLOR="white" onload="windowTitle();">
29
<HR>
30

    
31

    
32
<!-- ========= START OF TOP NAVBAR ======= -->
33
<A NAME="navbar_top"><!-- --></A>
34
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36
<TR>
37
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38
<A NAME="navbar_top_firstrow"><!-- --></A>
39
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40
  <TR ALIGN="center" VALIGN="top">
41
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
42
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
43
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
44
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BenchmarkAlgorithm.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
45
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48
  </TR>
49
</TABLE>
50
</TD>
51
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52
</EM>
53
</TD>
54
</TR>
55

    
56
<TR>
57
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58
&nbsp;PREV CLASS&nbsp;
59
&nbsp;NEXT CLASS</FONT></TD>
60
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61
  <A HREF="../../../../index.html?es/unex/sextante/devel/BenchmarkAlgorithm.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62
&nbsp;<A HREF="BenchmarkAlgorithm.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63
&nbsp;<SCRIPT type="text/javascript">
64
  <!--
65
  if(window==top) {
66
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67
  }
68
  //-->
69
</SCRIPT>
70
<NOSCRIPT>
71
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
72
</NOSCRIPT>
73

    
74

    
75
</FONT></TD>
76
</TR>
77
<TR>
78
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
82
</TR>
83
</TABLE>
84
<A NAME="skip-navbar_top"></A>
85
<!-- ========= END OF TOP NAVBAR ========= -->
86

    
87
<HR>
88
<!-- ======== START OF CLASS DATA ======== -->
89
<H2>
90
<FONT SIZE="-1">
91
es.unex.sextante.devel</FONT>
92
<BR>
93
Class BenchmarkAlgorithm</H2>
94
<PRE>
95
java.lang.Object
96
  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">es.unex.sextante.core.GeoAlgorithm
97
      <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>es.unex.sextante.devel.BenchmarkAlgorithm</B>
98
</PRE>
99
<HR>
100
<DL>
101
<DT><PRE>public class <B>BenchmarkAlgorithm</B><DT>extends es.unex.sextante.core.GeoAlgorithm</DL>
102
</PRE>
103

    
104
<P>
105
<HR>
106

    
107
<P>
108
<!-- =========== FIELD SUMMARY =========== -->
109

    
110
<A NAME="field_summary"><!-- --></A>
111
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
112
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
113
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
114
<B>Field Summary</B></FONT></TH>
115
</TR>
116
<TR BGCOLOR="white" CLASS="TableRowColor">
117
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
118
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
119
<TD><CODE><B><A HREF="../../../../es/unex/sextante/devel/BenchmarkAlgorithm.html#INPUT">INPUT</A></B></CODE>
120

    
121
<BR>
122
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
123
</TR>
124
</TABLE>
125
&nbsp;<A NAME="fields_inherited_from_class_es.unex.sextante.core.GeoAlgorithm"><!-- --></A>
126
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
127
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
128
<TH ALIGN="left"><B>Fields inherited from class es.unex.sextante.core.GeoAlgorithm</B></TH>
129
</TR>
130
<TR BGCOLOR="white" CLASS="TableRowColor">
131
<TD><CODE>m_AnalysisExtent, m_bIsAutoExtent, m_bIsDeterminatedProcess, m_bUserCanDefineAnalysisExtent, m_CRS, m_OutputFactory, m_OutputObjects, m_Parameters, m_Task</CODE></TD>
132
</TR>
133
</TABLE>
134
&nbsp;
135
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
136

    
137
<A NAME="constructor_summary"><!-- --></A>
138
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
139
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
140
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
141
<B>Constructor Summary</B></FONT></TH>
142
</TR>
143
<TR BGCOLOR="white" CLASS="TableRowColor">
144
<TD><CODE><B><A HREF="../../../../es/unex/sextante/devel/BenchmarkAlgorithm.html#BenchmarkAlgorithm()">BenchmarkAlgorithm</A></B>()</CODE>
145

    
146
<BR>
147
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
148
</TR>
149
</TABLE>
150
&nbsp;
151
<!-- ========== METHOD SUMMARY =========== -->
152

    
153
<A NAME="method_summary"><!-- --></A>
154
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
155
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
156
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
157
<B>Method Summary</B></FONT></TH>
158
</TR>
159
<TR BGCOLOR="white" CLASS="TableRowColor">
160
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161
<CODE>&nbsp;void</CODE></FONT></TD>
162
<TD><CODE><B><A HREF="../../../../es/unex/sextante/devel/BenchmarkAlgorithm.html#defineCharacteristics()">defineCharacteristics</A></B>()</CODE>
163

    
164
<BR>
165
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
166
</TR>
167
<TR BGCOLOR="white" CLASS="TableRowColor">
168
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169
<CODE>&nbsp;boolean</CODE></FONT></TD>
170
<TD><CODE><B><A HREF="../../../../es/unex/sextante/devel/BenchmarkAlgorithm.html#processAlgorithm()">processAlgorithm</A></B>()</CODE>
171

    
172
<BR>
173
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
174
</TR>
175
</TABLE>
176
&nbsp;<A NAME="methods_inherited_from_class_es.unex.sextante.core.GeoAlgorithm"><!-- --></A>
177
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
178
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
179
<TH ALIGN="left"><B>Methods inherited from class es.unex.sextante.core.GeoAlgorithm</B></TH>
180
</TR>
181
<TR BGCOLOR="white" CLASS="TableRowColor">
182
<TD><CODE>addOutput3DRasterLayer, addOutput3DRasterLayer, addOutputChart, addOutputChart, addOutputImage, addOutputNumericalValue, addOutputNumericalValue, addOutputObject, addOutputObject, addOutputRasterLayer, addOutputRasterLayer, addOutputRasterLayer, addOutputTable, addOutputTable, addOutputText, addOutputText, addOutputVectorLayer, addOutputVectorLayer, addOutputVectorLayer, addOutputVectorLayer, adjustOutputExtent, canDefineOutputExtentFromInput, execute, execute, generatesLayers, generatesLayersOrTables, getAlgorithmAsCommandLineSentences, getAnalysisExtent, getColorAlpha, getColorB, getColorG, getColorR, getCommandLineHelp, getCommandLineName, getCommandLineParametersHelp, getDescription, getGroup, getName, getNew3DRasterLayer, getNew3DRasterLayer, getNewInstance, getNewRasterLayer, getNewRasterLayer, getNewRasterLayer, getNewRasterLayer, getNewTable, getNewVectorLayer, getNewVectorLayer, getNumberOfBandsParameters, getNumberOfLineVectorLayers, getNumberOfNoDataParameters, getNumberOfOutputObjects, getNumberOfParameters, getNumberOfPointVectorLayers, getNumberOfPolygonLayers, getNumberOfRasterLayers, getNumberOfTableFieldsParameters, getNumberOfTables, getNumberOfVectorLayers, getOutputChannel, getOutputCRS, getOutputFilename, getOutputObjects, getParameters, getProcessMetadata, getTempRasterLayer, getTempRasterLayer, getTempVectorLayer, getUserCanDefineAnalysisExtent, hasCorrectParameterValues, is3D, isActive, isAutoExtent, isDeterminatedProcess, isSuitableForModelling, meets3DRasterRequirements, meetsDataRequirements, meetsRasterRequirements, meetsTableRequirements, meetsVectorRequirements, preprocessForModeller, requires3DRasterLayers, requiresIndividualRasterLayers, requiresIndividualVectorLayers, requiresLineVectorLayers, requiresMultipleRasterBands, requiresMultipleRasterLayers, requiresMultipleTables, requiresMultipleVectorLayers, requiresNonDataObjects, requiresPoints, requiresPointVectorLayers, requiresPolygonVectorLayers, requiresRasterLayers, requiresTableFields, requiresTables, requiresVectorLayers, setAnalysisExtent, setColorAlpha, setColorB, setColorG, setColorR, setDescription, setGroup, setIsDeterminatedProcess, setName, setOutputObjects, setParameters, setProgress, setProgressText, setUserCanDefineAnalysisExtent, toString</CODE></TD>
183
</TR>
184
</TABLE>
185
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
186
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
187
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
188
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
189
</TR>
190
<TR BGCOLOR="white" CLASS="TableRowColor">
191
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
192
</TR>
193
</TABLE>
194
&nbsp;
195
<P>
196

    
197
<!-- ============ FIELD DETAIL =========== -->
198

    
199
<A NAME="field_detail"><!-- --></A>
200
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
201
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
202
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
203
<B>Field Detail</B></FONT></TH>
204
</TR>
205
</TABLE>
206

    
207
<A NAME="INPUT"><!-- --></A><H3>
208
INPUT</H3>
209
<PRE>
210
public static final java.lang.String <B>INPUT</B></PRE>
211
<DL>
212
<DL>
213
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#es.unex.sextante.devel.BenchmarkAlgorithm.INPUT">Constant Field Values</A></DL>
214
</DL>
215

    
216
<!-- ========= CONSTRUCTOR DETAIL ======== -->
217

    
218
<A NAME="constructor_detail"><!-- --></A>
219
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
220
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
221
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
222
<B>Constructor Detail</B></FONT></TH>
223
</TR>
224
</TABLE>
225

    
226
<A NAME="BenchmarkAlgorithm()"><!-- --></A><H3>
227
BenchmarkAlgorithm</H3>
228
<PRE>
229
public <B>BenchmarkAlgorithm</B>()</PRE>
230
<DL>
231
</DL>
232

    
233
<!-- ============ METHOD DETAIL ========== -->
234

    
235
<A NAME="method_detail"><!-- --></A>
236
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
237
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
238
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
239
<B>Method Detail</B></FONT></TH>
240
</TR>
241
</TABLE>
242

    
243
<A NAME="defineCharacteristics()"><!-- --></A><H3>
244
defineCharacteristics</H3>
245
<PRE>
246
public void <B>defineCharacteristics</B>()</PRE>
247
<DL>
248
<DD><DL>
249
<DT><B>Specified by:</B><DD><CODE>defineCharacteristics</CODE> in class <CODE>es.unex.sextante.core.GeoAlgorithm</CODE></DL>
250
</DD>
251
<DD><DL>
252
</DL>
253
</DD>
254
</DL>
255
<HR>
256

    
257
<A NAME="processAlgorithm()"><!-- --></A><H3>
258
processAlgorithm</H3>
259
<PRE>
260
public boolean <B>processAlgorithm</B>()
261
                         throws es.unex.sextante.exceptions.GeoAlgorithmExecutionException</PRE>
262
<DL>
263
<DD><DL>
264
<DT><B>Specified by:</B><DD><CODE>processAlgorithm</CODE> in class <CODE>es.unex.sextante.core.GeoAlgorithm</CODE></DL>
265
</DD>
266
<DD><DL>
267

    
268
<DT><B>Throws:</B>
269
<DD><CODE>es.unex.sextante.exceptions.GeoAlgorithmExecutionException</CODE></DL>
270
</DD>
271
</DL>
272
<!-- ========= END OF CLASS DATA ========= -->
273
<HR>
274

    
275

    
276
<!-- ======= START OF BOTTOM NAVBAR ====== -->
277
<A NAME="navbar_bottom"><!-- --></A>
278
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
279
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
280
<TR>
281
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
282
<A NAME="navbar_bottom_firstrow"><!-- --></A>
283
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
284
  <TR ALIGN="center" VALIGN="top">
285
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
286
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
287
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
288
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BenchmarkAlgorithm.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
289
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
290
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
291
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
292
  </TR>
293
</TABLE>
294
</TD>
295
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
296
</EM>
297
</TD>
298
</TR>
299

    
300
<TR>
301
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
302
&nbsp;PREV CLASS&nbsp;
303
&nbsp;NEXT CLASS</FONT></TD>
304
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
305
  <A HREF="../../../../index.html?es/unex/sextante/devel/BenchmarkAlgorithm.html" target="_top"><B>FRAMES</B></A>  &nbsp;
306
&nbsp;<A HREF="BenchmarkAlgorithm.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
307
&nbsp;<SCRIPT type="text/javascript">
308
  <!--
309
  if(window==top) {
310
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
311
  }
312
  //-->
313
</SCRIPT>
314
<NOSCRIPT>
315
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
316
</NOSCRIPT>
317

    
318

    
319
</FONT></TD>
320
</TR>
321
<TR>
322
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
323
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
324
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
325
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
326
</TR>
327
</TABLE>
328
<A NAME="skip-navbar_bottom"></A>
329
<!-- ======== END OF BOTTOM NAVBAR ======= -->
330

    
331
<HR>
332
Copyright &#169; 2014 <a href="http://www.gvsig.com/">gvSIG Association</a>. All Rights Reserved.
333
</BODY>
334
</HTML>