diff options
Diffstat (limited to 'commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/fitting/GaussianFitter.html')
-rw-r--r-- | commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/fitting/GaussianFitter.html | 361 |
1 files changed, 361 insertions, 0 deletions
diff --git a/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/fitting/GaussianFitter.html b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/fitting/GaussianFitter.html new file mode 100644 index 0000000..5991e13 --- /dev/null +++ b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/fitting/GaussianFitter.html @@ -0,0 +1,361 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GaussianFitter (Apache Commons Math 3.6.1 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="GaussianFitter (Apache Commons Math 3.6.1 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/GaussianFitter.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/commons/math3/fitting/GaussianCurveFitter.ParameterGuesser.html" title="class in org.apache.commons.math3.fitting"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/commons/math3/fitting/GaussianFitter.ParameterGuesser.html" title="class in org.apache.commons.math3.fitting"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/commons/math3/fitting/GaussianFitter.html" target="_top">Frames</a></li> +<li><a href="GaussianFitter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.commons.math3.fitting</div> +<h2 title="Class GaussianFitter" class="title">Class GaussianFitter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/commons/math3/fitting/CurveFitter.html" title="class in org.apache.commons.math3.fitting">org.apache.commons.math3.fitting.CurveFitter</a><<a href="../../../../../org/apache/commons/math3/analysis/function/Gaussian.Parametric.html" title="class in org.apache.commons.math3.analysis.function">Gaussian.Parametric</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.math3.fitting.GaussianFitter</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>As of 3.3. Please use <a href="../../../../../org/apache/commons/math3/fitting/GaussianCurveFitter.html" title="class in org.apache.commons.math3.fitting"><code>GaussianCurveFitter</code></a> and + <a href="../../../../../org/apache/commons/math3/fitting/WeightedObservedPoints.html" title="class in org.apache.commons.math3.fitting"><code>WeightedObservedPoints</code></a> instead.</i></div> +</div> +<br> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +public class <span class="strong">GaussianFitter</span> +extends <a href="../../../../../org/apache/commons/math3/fitting/CurveFitter.html" title="class in org.apache.commons.math3.fitting">CurveFitter</a><<a href="../../../../../org/apache/commons/math3/analysis/function/Gaussian.Parametric.html" title="class in org.apache.commons.math3.analysis.function">Gaussian.Parametric</a>></pre> +<div class="block">Fits points to a <a href="../../../../../org/apache/commons/math3/analysis/function/Gaussian.Parametric.html" title="class in org.apache.commons.math3.analysis.function"><code>Gaussian</code></a> function. + <p> + Usage example: + <pre> + GaussianFitter fitter = new GaussianFitter( + new LevenbergMarquardtOptimizer()); + fitter.addObservedPoint(4.0254623, 531026.0); + fitter.addObservedPoint(4.03128248, 984167.0); + fitter.addObservedPoint(4.03839603, 1887233.0); + fitter.addObservedPoint(4.04421621, 2687152.0); + fitter.addObservedPoint(4.05132976, 3461228.0); + fitter.addObservedPoint(4.05326982, 3580526.0); + fitter.addObservedPoint(4.05779662, 3439750.0); + fitter.addObservedPoint(4.0636168, 2877648.0); + fitter.addObservedPoint(4.06943698, 2175960.0); + fitter.addObservedPoint(4.07525716, 1447024.0); + fitter.addObservedPoint(4.08237071, 717104.0); + fitter.addObservedPoint(4.08366408, 620014.0); + double[] parameters = fitter.fit(); + </pre></div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.2</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/fitting/GaussianFitter.ParameterGuesser.html" title="class in org.apache.commons.math3.fitting">GaussianFitter.ParameterGuesser</a></strong></code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Guesses the parameters <code>norm</code>, <code>mean</code>, and <code>sigma</code> + of a <a href="../../../../../org/apache/commons/math3/analysis/function/Gaussian.Parametric.html" title="class in org.apache.commons.math3.analysis.function"><code>Gaussian.Parametric</code></a> + based on the specified observed points.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/math3/fitting/GaussianFitter.html#GaussianFitter(org.apache.commons.math3.optim.nonlinear.vector.MultivariateVectorOptimizer)">GaussianFitter</a></strong>(<a href="../../../../../org/apache/commons/math3/optim/nonlinear/vector/MultivariateVectorOptimizer.html" title="class in org.apache.commons.math3.optim.nonlinear.vector">MultivariateVectorOptimizer</a> optimizer)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Constructs an instance using the specified optimizer.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/fitting/GaussianFitter.html#fit()">fit</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Fits a Gaussian function to the observed points.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/fitting/GaussianFitter.html#fit(double[])">fit</a></strong>(double[] initialGuess)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Fits a Gaussian function to the observed points.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.math3.fitting.CurveFitter"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.commons.math3.fitting.<a href="../../../../../org/apache/commons/math3/fitting/CurveFitter.html" title="class in org.apache.commons.math3.fitting">CurveFitter</a></h3> +<code><a href="../../../../../org/apache/commons/math3/fitting/CurveFitter.html#addObservedPoint(double,%20double)">addObservedPoint</a>, <a href="../../../../../org/apache/commons/math3/fitting/CurveFitter.html#addObservedPoint(double,%20double,%20double)">addObservedPoint</a>, <a href="../../../../../org/apache/commons/math3/fitting/CurveFitter.html#addObservedPoint(org.apache.commons.math3.fitting.WeightedObservedPoint)">addObservedPoint</a>, <a href="../../../../../org/apache/commons/math3/fitting/CurveFitter.html#clearObservations()">clearObservations</a>, <a href="../../../../../org/apache/commons/math3/fitting/CurveFitter.html#fit(int,%20T,%20double[])">fit</a>, <a href="../../../../../org/apache/commons/math3/fitting/CurveFitter.html#fit(T,%20double[])">fit</a>, <a href="../../../../../org/apache/commons/math3/fitting/CurveFitter.html#getObservations()">getObservations</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="GaussianFitter(org.apache.commons.math3.optim.nonlinear.vector.MultivariateVectorOptimizer)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>GaussianFitter</h4> +<pre>public GaussianFitter(<a href="../../../../../org/apache/commons/math3/optim/nonlinear/vector/MultivariateVectorOptimizer.html" title="class in org.apache.commons.math3.optim.nonlinear.vector">MultivariateVectorOptimizer</a> optimizer)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Constructs an instance using the specified optimizer.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>optimizer</code> - Optimizer to use for the fitting.</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="fit(double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fit</h4> +<pre>public double[] fit(double[] initialGuess)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Fits a Gaussian function to the observed points.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialGuess</code> - First guess values in the following order: + <ul> + <li>Norm</li> + <li>Mean</li> + <li>Sigma</li> + </ul></dd> +<dt><span class="strong">Returns:</span></dt><dd>the parameters of the Gaussian function that best fits the + observed points (in the same order as above).</dd><dt><span class="strong">Since:</span></dt> + <dd>3.0</dd></dl> +</li> +</ul> +<a name="fit()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>fit</h4> +<pre>public double[] fit()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Fits a Gaussian function to the observed points.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the parameters of the Gaussian function that best fits the + observed points (in the same order as above).</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/GaussianFitter.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/commons/math3/fitting/GaussianCurveFitter.ParameterGuesser.html" title="class in org.apache.commons.math3.fitting"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/commons/math3/fitting/GaussianFitter.ParameterGuesser.html" title="class in org.apache.commons.math3.fitting"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/commons/math3/fitting/GaussianFitter.html" target="_top">Frames</a></li> +<li><a href="GaussianFitter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2003–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> |