You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@commons.apache.org by lu...@apache.org on 2015/08/14 21:12:44 UTC
svn commit: r961863 [5/34] - in
/websites/production/commons/content/proper/commons-math: ./ apidocs/
apidocs/org/apache/commons/math3/analysis/class-use/
apidocs/org/apache/commons/math3/analysis/interpolation/
apidocs/org/apache/commons/math3/analysi...
Added: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/analysis/interpolation/InterpolatingMicrosphere.html
==============================================================================
--- websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/analysis/interpolation/InterpolatingMicrosphere.html (added)
+++ websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/analysis/interpolation/InterpolatingMicrosphere.html Fri Aug 14 19:12:42 2015
@@ -0,0 +1,458 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
+<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
+<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
+<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
+<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
+<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
+<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
+<span class="sourceLineNo">008</span> *<a name="line.8"></a>
+<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
+<span class="sourceLineNo">010</span> *<a name="line.10"></a>
+<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
+<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
+<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
+<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
+<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
+<span class="sourceLineNo">016</span> */<a name="line.16"></a>
+<span class="sourceLineNo">017</span>package org.apache.commons.math3.analysis.interpolation;<a name="line.17"></a>
+<span class="sourceLineNo">018</span><a name="line.18"></a>
+<span class="sourceLineNo">019</span>import java.util.List;<a name="line.19"></a>
+<span class="sourceLineNo">020</span>import java.util.ArrayList;<a name="line.20"></a>
+<span class="sourceLineNo">021</span>import org.apache.commons.math3.random.UnitSphereRandomVectorGenerator;<a name="line.21"></a>
+<span class="sourceLineNo">022</span>import org.apache.commons.math3.exception.DimensionMismatchException;<a name="line.22"></a>
+<span class="sourceLineNo">023</span>import org.apache.commons.math3.exception.NotPositiveException;<a name="line.23"></a>
+<span class="sourceLineNo">024</span>import org.apache.commons.math3.exception.NotStrictlyPositiveException;<a name="line.24"></a>
+<span class="sourceLineNo">025</span>import org.apache.commons.math3.exception.MaxCountExceededException;<a name="line.25"></a>
+<span class="sourceLineNo">026</span>import org.apache.commons.math3.exception.OutOfRangeException;<a name="line.26"></a>
+<span class="sourceLineNo">027</span>import org.apache.commons.math3.util.FastMath;<a name="line.27"></a>
+<span class="sourceLineNo">028</span>import org.apache.commons.math3.util.MathArrays;<a name="line.28"></a>
+<span class="sourceLineNo">029</span><a name="line.29"></a>
+<span class="sourceLineNo">030</span>/**<a name="line.30"></a>
+<span class="sourceLineNo">031</span> * Utility class for the {@link MicrosphereProjectionInterpolator} algorithm.<a name="line.31"></a>
+<span class="sourceLineNo">032</span> *<a name="line.32"></a>
+<span class="sourceLineNo">033</span> * @since 3.6<a name="line.33"></a>
+<span class="sourceLineNo">034</span> */<a name="line.34"></a>
+<span class="sourceLineNo">035</span>public class InterpolatingMicrosphere {<a name="line.35"></a>
+<span class="sourceLineNo">036</span> /** Microsphere. */<a name="line.36"></a>
+<span class="sourceLineNo">037</span> private final List<Facet> microsphere;<a name="line.37"></a>
+<span class="sourceLineNo">038</span> /** Microsphere data. */<a name="line.38"></a>
+<span class="sourceLineNo">039</span> private final List<FacetData> microsphereData;<a name="line.39"></a>
+<span class="sourceLineNo">040</span> /** Space dimension. */<a name="line.40"></a>
+<span class="sourceLineNo">041</span> private final int dimension;<a name="line.41"></a>
+<span class="sourceLineNo">042</span> /** Number of surface elements. */<a name="line.42"></a>
+<span class="sourceLineNo">043</span> private final int size;<a name="line.43"></a>
+<span class="sourceLineNo">044</span> /** Maximum fraction of the facets that can be dark. */<a name="line.44"></a>
+<span class="sourceLineNo">045</span> private final double maxDarkFraction;<a name="line.45"></a>
+<span class="sourceLineNo">046</span> /** Lowest non-zero illumination. */<a name="line.46"></a>
+<span class="sourceLineNo">047</span> private final double darkThreshold;<a name="line.47"></a>
+<span class="sourceLineNo">048</span> /** Background value. */<a name="line.48"></a>
+<span class="sourceLineNo">049</span> private final double background;<a name="line.49"></a>
+<span class="sourceLineNo">050</span><a name="line.50"></a>
+<span class="sourceLineNo">051</span> /**<a name="line.51"></a>
+<span class="sourceLineNo">052</span> * Create an unitialiazed sphere.<a name="line.52"></a>
+<span class="sourceLineNo">053</span> * Sub-classes are responsible for calling the {@code add(double[]) add}<a name="line.53"></a>
+<span class="sourceLineNo">054</span> * method in order to initialize all the sphere's facets.<a name="line.54"></a>
+<span class="sourceLineNo">055</span> *<a name="line.55"></a>
+<span class="sourceLineNo">056</span> * @param dimension Dimension of the data space.<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * @param size Number of surface elements of the sphere.<a name="line.57"></a>
+<span class="sourceLineNo">058</span> * @param maxDarkFraction Maximum fraction of the facets that can be dark.<a name="line.58"></a>
+<span class="sourceLineNo">059</span> * If the fraction of "non-illuminated" facets is larger, no estimation<a name="line.59"></a>
+<span class="sourceLineNo">060</span> * of the value will be performed, and the {@code background} value will<a name="line.60"></a>
+<span class="sourceLineNo">061</span> * be returned instead.<a name="line.61"></a>
+<span class="sourceLineNo">062</span> * @param darkThreshold Value of the illumination below which a facet is<a name="line.62"></a>
+<span class="sourceLineNo">063</span> * considered dark.<a name="line.63"></a>
+<span class="sourceLineNo">064</span> * @param background Value returned when the {@code maxDarkFraction}<a name="line.64"></a>
+<span class="sourceLineNo">065</span> * threshold is exceeded.<a name="line.65"></a>
+<span class="sourceLineNo">066</span> * @throws NotStrictlyPositiveException if {@code dimension <= 0}<a name="line.66"></a>
+<span class="sourceLineNo">067</span> * or {@code size <= 0}.<a name="line.67"></a>
+<span class="sourceLineNo">068</span> * @throws NotPositiveException if {@code darkThreshold < 0}.<a name="line.68"></a>
+<span class="sourceLineNo">069</span> * @throws OutOfRangeException if {@code maxDarkFraction} does not<a name="line.69"></a>
+<span class="sourceLineNo">070</span> * belong to the interval {@code [0, 1]}.<a name="line.70"></a>
+<span class="sourceLineNo">071</span> */<a name="line.71"></a>
+<span class="sourceLineNo">072</span> protected InterpolatingMicrosphere(int dimension,<a name="line.72"></a>
+<span class="sourceLineNo">073</span> int size,<a name="line.73"></a>
+<span class="sourceLineNo">074</span> double maxDarkFraction,<a name="line.74"></a>
+<span class="sourceLineNo">075</span> double darkThreshold,<a name="line.75"></a>
+<span class="sourceLineNo">076</span> double background) {<a name="line.76"></a>
+<span class="sourceLineNo">077</span> if (dimension <= 0) {<a name="line.77"></a>
+<span class="sourceLineNo">078</span> throw new NotStrictlyPositiveException(dimension);<a name="line.78"></a>
+<span class="sourceLineNo">079</span> }<a name="line.79"></a>
+<span class="sourceLineNo">080</span> if (size <= 0) {<a name="line.80"></a>
+<span class="sourceLineNo">081</span> throw new NotStrictlyPositiveException(size);<a name="line.81"></a>
+<span class="sourceLineNo">082</span> }<a name="line.82"></a>
+<span class="sourceLineNo">083</span> if (maxDarkFraction < 0 ||<a name="line.83"></a>
+<span class="sourceLineNo">084</span> maxDarkFraction > 1) {<a name="line.84"></a>
+<span class="sourceLineNo">085</span> throw new OutOfRangeException(maxDarkFraction, 0, 1);<a name="line.85"></a>
+<span class="sourceLineNo">086</span> }<a name="line.86"></a>
+<span class="sourceLineNo">087</span> if (darkThreshold < 0) {<a name="line.87"></a>
+<span class="sourceLineNo">088</span> throw new NotPositiveException(darkThreshold);<a name="line.88"></a>
+<span class="sourceLineNo">089</span> }<a name="line.89"></a>
+<span class="sourceLineNo">090</span><a name="line.90"></a>
+<span class="sourceLineNo">091</span> this.dimension = dimension;<a name="line.91"></a>
+<span class="sourceLineNo">092</span> this.size = size;<a name="line.92"></a>
+<span class="sourceLineNo">093</span> this.maxDarkFraction = maxDarkFraction;<a name="line.93"></a>
+<span class="sourceLineNo">094</span> this.darkThreshold = darkThreshold;<a name="line.94"></a>
+<span class="sourceLineNo">095</span> this.background = background;<a name="line.95"></a>
+<span class="sourceLineNo">096</span> microsphere = new ArrayList<Facet>(size);<a name="line.96"></a>
+<span class="sourceLineNo">097</span> microsphereData = new ArrayList<FacetData>(size);<a name="line.97"></a>
+<span class="sourceLineNo">098</span> }<a name="line.98"></a>
+<span class="sourceLineNo">099</span><a name="line.99"></a>
+<span class="sourceLineNo">100</span> /**<a name="line.100"></a>
+<span class="sourceLineNo">101</span> * Create a sphere from randomly sampled vectors.<a name="line.101"></a>
+<span class="sourceLineNo">102</span> *<a name="line.102"></a>
+<span class="sourceLineNo">103</span> * @param dimension Dimension of the data space.<a name="line.103"></a>
+<span class="sourceLineNo">104</span> * @param size Number of surface elements of the sphere.<a name="line.104"></a>
+<span class="sourceLineNo">105</span> * @param rand Unit vector generator for creating the microsphere.<a name="line.105"></a>
+<span class="sourceLineNo">106</span> * @param maxDarkFraction Maximum fraction of the facets that can be dark.<a name="line.106"></a>
+<span class="sourceLineNo">107</span> * If the fraction of "non-illuminated" facets is larger, no estimation<a name="line.107"></a>
+<span class="sourceLineNo">108</span> * of the value will be performed, and the {@code background} value will<a name="line.108"></a>
+<span class="sourceLineNo">109</span> * be returned instead.<a name="line.109"></a>
+<span class="sourceLineNo">110</span> * @param darkThreshold Value of the illumination below which a facet<a name="line.110"></a>
+<span class="sourceLineNo">111</span> * is considered dark.<a name="line.111"></a>
+<span class="sourceLineNo">112</span> * @param background Value returned when the {@code maxDarkFraction}<a name="line.112"></a>
+<span class="sourceLineNo">113</span> * threshold is exceeded.<a name="line.113"></a>
+<span class="sourceLineNo">114</span> * @throws DimensionMismatchException if the size of the generated<a name="line.114"></a>
+<span class="sourceLineNo">115</span> * vectors does not match the dimension set in the constructor.<a name="line.115"></a>
+<span class="sourceLineNo">116</span> * @throws NotStrictlyPositiveException if {@code dimension <= 0}<a name="line.116"></a>
+<span class="sourceLineNo">117</span> * or {@code size <= 0}.<a name="line.117"></a>
+<span class="sourceLineNo">118</span> * @throws NotPositiveException if {@code darkThreshold < 0}.<a name="line.118"></a>
+<span class="sourceLineNo">119</span> * @throws OutOfRangeException if {@code maxDarkFraction} does not<a name="line.119"></a>
+<span class="sourceLineNo">120</span> * belong to the interval {@code [0, 1]}.<a name="line.120"></a>
+<span class="sourceLineNo">121</span> */<a name="line.121"></a>
+<span class="sourceLineNo">122</span> public InterpolatingMicrosphere(int dimension,<a name="line.122"></a>
+<span class="sourceLineNo">123</span> int size,<a name="line.123"></a>
+<span class="sourceLineNo">124</span> double maxDarkFraction,<a name="line.124"></a>
+<span class="sourceLineNo">125</span> double darkThreshold,<a name="line.125"></a>
+<span class="sourceLineNo">126</span> double background,<a name="line.126"></a>
+<span class="sourceLineNo">127</span> UnitSphereRandomVectorGenerator rand) {<a name="line.127"></a>
+<span class="sourceLineNo">128</span> this(dimension, size, maxDarkFraction, darkThreshold, background);<a name="line.128"></a>
+<span class="sourceLineNo">129</span><a name="line.129"></a>
+<span class="sourceLineNo">130</span> // Generate the microsphere normals, assuming that a number of<a name="line.130"></a>
+<span class="sourceLineNo">131</span> // randomly generated normals will represent a sphere.<a name="line.131"></a>
+<span class="sourceLineNo">132</span> for (int i = 0; i < size; i++) {<a name="line.132"></a>
+<span class="sourceLineNo">133</span> add(rand.nextVector(), false);<a name="line.133"></a>
+<span class="sourceLineNo">134</span> }<a name="line.134"></a>
+<span class="sourceLineNo">135</span> }<a name="line.135"></a>
+<span class="sourceLineNo">136</span><a name="line.136"></a>
+<span class="sourceLineNo">137</span> /**<a name="line.137"></a>
+<span class="sourceLineNo">138</span> * Copy constructor.<a name="line.138"></a>
+<span class="sourceLineNo">139</span> *<a name="line.139"></a>
+<span class="sourceLineNo">140</span> * @param other Instance to copy.<a name="line.140"></a>
+<span class="sourceLineNo">141</span> */<a name="line.141"></a>
+<span class="sourceLineNo">142</span> protected InterpolatingMicrosphere(InterpolatingMicrosphere other) {<a name="line.142"></a>
+<span class="sourceLineNo">143</span> dimension = other.dimension;<a name="line.143"></a>
+<span class="sourceLineNo">144</span> size = other.size;<a name="line.144"></a>
+<span class="sourceLineNo">145</span> maxDarkFraction = other.maxDarkFraction;<a name="line.145"></a>
+<span class="sourceLineNo">146</span> darkThreshold = other.darkThreshold;<a name="line.146"></a>
+<span class="sourceLineNo">147</span> background = other.background;<a name="line.147"></a>
+<span class="sourceLineNo">148</span><a name="line.148"></a>
+<span class="sourceLineNo">149</span> // Field can be shared.<a name="line.149"></a>
+<span class="sourceLineNo">150</span> microsphere = other.microsphere;<a name="line.150"></a>
+<span class="sourceLineNo">151</span><a name="line.151"></a>
+<span class="sourceLineNo">152</span> // Field must be copied.<a name="line.152"></a>
+<span class="sourceLineNo">153</span> microsphereData = new ArrayList<FacetData>(size);<a name="line.153"></a>
+<span class="sourceLineNo">154</span> for (FacetData fd : other.microsphereData) {<a name="line.154"></a>
+<span class="sourceLineNo">155</span> microsphereData.add(new FacetData(fd.illumination(), fd.sample()));<a name="line.155"></a>
+<span class="sourceLineNo">156</span> }<a name="line.156"></a>
+<span class="sourceLineNo">157</span> }<a name="line.157"></a>
+<span class="sourceLineNo">158</span><a name="line.158"></a>
+<span class="sourceLineNo">159</span> /**<a name="line.159"></a>
+<span class="sourceLineNo">160</span> * Perform a copy.<a name="line.160"></a>
+<span class="sourceLineNo">161</span> *<a name="line.161"></a>
+<span class="sourceLineNo">162</span> * @return a copy of this instance.<a name="line.162"></a>
+<span class="sourceLineNo">163</span> */<a name="line.163"></a>
+<span class="sourceLineNo">164</span> public InterpolatingMicrosphere copy() {<a name="line.164"></a>
+<span class="sourceLineNo">165</span> return new InterpolatingMicrosphere(this);<a name="line.165"></a>
+<span class="sourceLineNo">166</span> }<a name="line.166"></a>
+<span class="sourceLineNo">167</span><a name="line.167"></a>
+<span class="sourceLineNo">168</span> /**<a name="line.168"></a>
+<span class="sourceLineNo">169</span> * Get the space dimensionality.<a name="line.169"></a>
+<span class="sourceLineNo">170</span> *<a name="line.170"></a>
+<span class="sourceLineNo">171</span> * @return the number of space dimensions.<a name="line.171"></a>
+<span class="sourceLineNo">172</span> */<a name="line.172"></a>
+<span class="sourceLineNo">173</span> public int getDimension() {<a name="line.173"></a>
+<span class="sourceLineNo">174</span> return dimension;<a name="line.174"></a>
+<span class="sourceLineNo">175</span> }<a name="line.175"></a>
+<span class="sourceLineNo">176</span><a name="line.176"></a>
+<span class="sourceLineNo">177</span> /**<a name="line.177"></a>
+<span class="sourceLineNo">178</span> * Get the size of the sphere.<a name="line.178"></a>
+<span class="sourceLineNo">179</span> *<a name="line.179"></a>
+<span class="sourceLineNo">180</span> * @return the number of surface elements of the microspshere.<a name="line.180"></a>
+<span class="sourceLineNo">181</span> */<a name="line.181"></a>
+<span class="sourceLineNo">182</span> public int getSize() {<a name="line.182"></a>
+<span class="sourceLineNo">183</span> return size;<a name="line.183"></a>
+<span class="sourceLineNo">184</span> }<a name="line.184"></a>
+<span class="sourceLineNo">185</span><a name="line.185"></a>
+<span class="sourceLineNo">186</span> /**<a name="line.186"></a>
+<span class="sourceLineNo">187</span> * Estimate the value at the requested location.<a name="line.187"></a>
+<span class="sourceLineNo">188</span> * This microsphere is placed at the given {@code point}, contribution<a name="line.188"></a>
+<span class="sourceLineNo">189</span> * of the given {@code samplePoints} to each sphere facet is computed<a name="line.189"></a>
+<span class="sourceLineNo">190</span> * (illumination) and the interpolation is performed (integration of<a name="line.190"></a>
+<span class="sourceLineNo">191</span> * the illumination).<a name="line.191"></a>
+<span class="sourceLineNo">192</span> *<a name="line.192"></a>
+<span class="sourceLineNo">193</span> * @param point Interpolation point.<a name="line.193"></a>
+<span class="sourceLineNo">194</span> * @param samplePoints Sampling data points.<a name="line.194"></a>
+<span class="sourceLineNo">195</span> * @param sampleValues Sampling data values at the corresponding<a name="line.195"></a>
+<span class="sourceLineNo">196</span> * {@code samplePoints}.<a name="line.196"></a>
+<span class="sourceLineNo">197</span> * @param exponent Exponent used in the power law that computes<a name="line.197"></a>
+<span class="sourceLineNo">198</span> * the weights (distance dimming factor) of the sample data.<a name="line.198"></a>
+<span class="sourceLineNo">199</span> * @param noInterpolationTolerance When the distance between the<a name="line.199"></a>
+<span class="sourceLineNo">200</span> * {@code point} and one of the {@code samplePoints} is less than<a name="line.200"></a>
+<span class="sourceLineNo">201</span> * this value, no interpolation will be performed, and the value<a name="line.201"></a>
+<span class="sourceLineNo">202</span> * of the sample will just be returned.<a name="line.202"></a>
+<span class="sourceLineNo">203</span> * @return the estimated value at the given {@code point}.<a name="line.203"></a>
+<span class="sourceLineNo">204</span> * @throws NotPositiveException if {@code exponent < 0}.<a name="line.204"></a>
+<span class="sourceLineNo">205</span> */<a name="line.205"></a>
+<span class="sourceLineNo">206</span> public double value(double[] point,<a name="line.206"></a>
+<span class="sourceLineNo">207</span> double[][] samplePoints,<a name="line.207"></a>
+<span class="sourceLineNo">208</span> double[] sampleValues,<a name="line.208"></a>
+<span class="sourceLineNo">209</span> double exponent,<a name="line.209"></a>
+<span class="sourceLineNo">210</span> double noInterpolationTolerance) {<a name="line.210"></a>
+<span class="sourceLineNo">211</span> if (exponent < 0) {<a name="line.211"></a>
+<span class="sourceLineNo">212</span> throw new NotPositiveException(exponent);<a name="line.212"></a>
+<span class="sourceLineNo">213</span> }<a name="line.213"></a>
+<span class="sourceLineNo">214</span><a name="line.214"></a>
+<span class="sourceLineNo">215</span> clear();<a name="line.215"></a>
+<span class="sourceLineNo">216</span><a name="line.216"></a>
+<span class="sourceLineNo">217</span> // Contribution of each sample point to the illumination of the<a name="line.217"></a>
+<span class="sourceLineNo">218</span> // microsphere's facets.<a name="line.218"></a>
+<span class="sourceLineNo">219</span> final int numSamples = samplePoints.length;<a name="line.219"></a>
+<span class="sourceLineNo">220</span> for (int i = 0; i < numSamples; i++) {<a name="line.220"></a>
+<span class="sourceLineNo">221</span> // Vector between interpolation point and current sample point.<a name="line.221"></a>
+<span class="sourceLineNo">222</span> final double[] diff = MathArrays.ebeSubtract(samplePoints[i], point);<a name="line.222"></a>
+<span class="sourceLineNo">223</span> final double diffNorm = MathArrays.safeNorm(diff);<a name="line.223"></a>
+<span class="sourceLineNo">224</span><a name="line.224"></a>
+<span class="sourceLineNo">225</span> if (FastMath.abs(diffNorm) < noInterpolationTolerance) {<a name="line.225"></a>
+<span class="sourceLineNo">226</span> // No need to interpolate, as the interpolation point is<a name="line.226"></a>
+<span class="sourceLineNo">227</span> // actually (very close to) one of the sampled points.<a name="line.227"></a>
+<span class="sourceLineNo">228</span> return sampleValues[i];<a name="line.228"></a>
+<span class="sourceLineNo">229</span> }<a name="line.229"></a>
+<span class="sourceLineNo">230</span><a name="line.230"></a>
+<span class="sourceLineNo">231</span> final double weight = FastMath.pow(diffNorm, -exponent);<a name="line.231"></a>
+<span class="sourceLineNo">232</span> illuminate(diff, sampleValues[i], weight);<a name="line.232"></a>
+<span class="sourceLineNo">233</span> }<a name="line.233"></a>
+<span class="sourceLineNo">234</span><a name="line.234"></a>
+<span class="sourceLineNo">235</span> return interpolate();<a name="line.235"></a>
+<span class="sourceLineNo">236</span> }<a name="line.236"></a>
+<span class="sourceLineNo">237</span><a name="line.237"></a>
+<span class="sourceLineNo">238</span> /**<a name="line.238"></a>
+<span class="sourceLineNo">239</span> * Replace {@code i}-th facet of the microsphere.<a name="line.239"></a>
+<span class="sourceLineNo">240</span> * Method for initializing the microsphere facets.<a name="line.240"></a>
+<span class="sourceLineNo">241</span> *<a name="line.241"></a>
+<span class="sourceLineNo">242</span> * @param normal Facet's normal vector.<a name="line.242"></a>
+<span class="sourceLineNo">243</span> * @param copy Whether to copy the given array.<a name="line.243"></a>
+<span class="sourceLineNo">244</span> * @throws DimensionMismatchException if the length of {@code n}<a name="line.244"></a>
+<span class="sourceLineNo">245</span> * does not match the space dimension.<a name="line.245"></a>
+<span class="sourceLineNo">246</span> * @throws MaxCountExceededException if the method has been called<a name="line.246"></a>
+<span class="sourceLineNo">247</span> * more times than the size of the sphere.<a name="line.247"></a>
+<span class="sourceLineNo">248</span> */<a name="line.248"></a>
+<span class="sourceLineNo">249</span> protected void add(double[] normal,<a name="line.249"></a>
+<span class="sourceLineNo">250</span> boolean copy) {<a name="line.250"></a>
+<span class="sourceLineNo">251</span> if (microsphere.size() >= size) {<a name="line.251"></a>
+<span class="sourceLineNo">252</span> throw new MaxCountExceededException(size);<a name="line.252"></a>
+<span class="sourceLineNo">253</span> }<a name="line.253"></a>
+<span class="sourceLineNo">254</span> if (normal.length > dimension) {<a name="line.254"></a>
+<span class="sourceLineNo">255</span> throw new DimensionMismatchException(normal.length, dimension);<a name="line.255"></a>
+<span class="sourceLineNo">256</span> }<a name="line.256"></a>
+<span class="sourceLineNo">257</span><a name="line.257"></a>
+<span class="sourceLineNo">258</span> microsphere.add(new Facet(copy ? normal.clone() : normal));<a name="line.258"></a>
+<span class="sourceLineNo">259</span> microsphereData.add(new FacetData(0d, 0d));<a name="line.259"></a>
+<span class="sourceLineNo">260</span> }<a name="line.260"></a>
+<span class="sourceLineNo">261</span><a name="line.261"></a>
+<span class="sourceLineNo">262</span> /**<a name="line.262"></a>
+<span class="sourceLineNo">263</span> * Interpolation.<a name="line.263"></a>
+<span class="sourceLineNo">264</span> *<a name="line.264"></a>
+<span class="sourceLineNo">265</span> * @return the value estimated from the current illumination of the<a name="line.265"></a>
+<span class="sourceLineNo">266</span> * microsphere.<a name="line.266"></a>
+<span class="sourceLineNo">267</span> */<a name="line.267"></a>
+<span class="sourceLineNo">268</span> private double interpolate() {<a name="line.268"></a>
+<span class="sourceLineNo">269</span> // Number of non-illuminated facets.<a name="line.269"></a>
+<span class="sourceLineNo">270</span> int darkCount = 0;<a name="line.270"></a>
+<span class="sourceLineNo">271</span><a name="line.271"></a>
+<span class="sourceLineNo">272</span> double value = 0;<a name="line.272"></a>
+<span class="sourceLineNo">273</span> double totalWeight = 0;<a name="line.273"></a>
+<span class="sourceLineNo">274</span> for (FacetData fd : microsphereData) {<a name="line.274"></a>
+<span class="sourceLineNo">275</span> final double iV = fd.illumination();<a name="line.275"></a>
+<span class="sourceLineNo">276</span> if (iV != 0d) {<a name="line.276"></a>
+<span class="sourceLineNo">277</span> value += iV * fd.sample();<a name="line.277"></a>
+<span class="sourceLineNo">278</span> totalWeight += iV;<a name="line.278"></a>
+<span class="sourceLineNo">279</span> } else {<a name="line.279"></a>
+<span class="sourceLineNo">280</span> ++darkCount;<a name="line.280"></a>
+<span class="sourceLineNo">281</span> }<a name="line.281"></a>
+<span class="sourceLineNo">282</span> }<a name="line.282"></a>
+<span class="sourceLineNo">283</span><a name="line.283"></a>
+<span class="sourceLineNo">284</span> final double darkFraction = darkCount / (double) size;<a name="line.284"></a>
+<span class="sourceLineNo">285</span><a name="line.285"></a>
+<span class="sourceLineNo">286</span> return darkFraction <= maxDarkFraction ?<a name="line.286"></a>
+<span class="sourceLineNo">287</span> value / totalWeight :<a name="line.287"></a>
+<span class="sourceLineNo">288</span> background;<a name="line.288"></a>
+<span class="sourceLineNo">289</span> }<a name="line.289"></a>
+<span class="sourceLineNo">290</span><a name="line.290"></a>
+<span class="sourceLineNo">291</span> /**<a name="line.291"></a>
+<span class="sourceLineNo">292</span> * Illumination.<a name="line.292"></a>
+<span class="sourceLineNo">293</span> *<a name="line.293"></a>
+<span class="sourceLineNo">294</span> * @param sampleDirection Vector whose origin is at the interpolation<a name="line.294"></a>
+<span class="sourceLineNo">295</span> * point and tail is at the sample location.<a name="line.295"></a>
+<span class="sourceLineNo">296</span> * @param sampleValue Data value of the sample.<a name="line.296"></a>
+<span class="sourceLineNo">297</span> * @param weight Weight.<a name="line.297"></a>
+<span class="sourceLineNo">298</span> */<a name="line.298"></a>
+<span class="sourceLineNo">299</span> private void illuminate(double[] sampleDirection,<a name="line.299"></a>
+<span class="sourceLineNo">300</span> double sampleValue,<a name="line.300"></a>
+<span class="sourceLineNo">301</span> double weight) {<a name="line.301"></a>
+<span class="sourceLineNo">302</span> for (int i = 0; i < size; i++) {<a name="line.302"></a>
+<span class="sourceLineNo">303</span> final double[] n = microsphere.get(i).getNormal();<a name="line.303"></a>
+<span class="sourceLineNo">304</span> final double cos = MathArrays.cosAngle(n, sampleDirection);<a name="line.304"></a>
+<span class="sourceLineNo">305</span><a name="line.305"></a>
+<span class="sourceLineNo">306</span> if (cos > 0) {<a name="line.306"></a>
+<span class="sourceLineNo">307</span> final double illumination = cos * weight;<a name="line.307"></a>
+<span class="sourceLineNo">308</span><a name="line.308"></a>
+<span class="sourceLineNo">309</span> if (illumination > darkThreshold &&<a name="line.309"></a>
+<span class="sourceLineNo">310</span> illumination > microsphereData.get(i).illumination()) {<a name="line.310"></a>
+<span class="sourceLineNo">311</span> microsphereData.set(i, new FacetData(illumination, sampleValue));<a name="line.311"></a>
+<span class="sourceLineNo">312</span> }<a name="line.312"></a>
+<span class="sourceLineNo">313</span> }<a name="line.313"></a>
+<span class="sourceLineNo">314</span> }<a name="line.314"></a>
+<span class="sourceLineNo">315</span> }<a name="line.315"></a>
+<span class="sourceLineNo">316</span><a name="line.316"></a>
+<span class="sourceLineNo">317</span> /**<a name="line.317"></a>
+<span class="sourceLineNo">318</span> * Reset the all the {@link Facet facets} data to zero.<a name="line.318"></a>
+<span class="sourceLineNo">319</span> */<a name="line.319"></a>
+<span class="sourceLineNo">320</span> private void clear() {<a name="line.320"></a>
+<span class="sourceLineNo">321</span> for (int i = 0; i < size; i++) {<a name="line.321"></a>
+<span class="sourceLineNo">322</span> microsphereData.set(i, new FacetData(0d, 0d));<a name="line.322"></a>
+<span class="sourceLineNo">323</span> }<a name="line.323"></a>
+<span class="sourceLineNo">324</span> }<a name="line.324"></a>
+<span class="sourceLineNo">325</span><a name="line.325"></a>
+<span class="sourceLineNo">326</span> /**<a name="line.326"></a>
+<span class="sourceLineNo">327</span> * Microsphere "facet" (surface element).<a name="line.327"></a>
+<span class="sourceLineNo">328</span> */<a name="line.328"></a>
+<span class="sourceLineNo">329</span> private static class Facet {<a name="line.329"></a>
+<span class="sourceLineNo">330</span> /** Normal vector characterizing a surface element. */<a name="line.330"></a>
+<span class="sourceLineNo">331</span> private final double[] normal;<a name="line.331"></a>
+<span class="sourceLineNo">332</span><a name="line.332"></a>
+<span class="sourceLineNo">333</span> /**<a name="line.333"></a>
+<span class="sourceLineNo">334</span> * @param n Normal vector characterizing a surface element<a name="line.334"></a>
+<span class="sourceLineNo">335</span> * of the microsphere. No copy is made.<a name="line.335"></a>
+<span class="sourceLineNo">336</span> */<a name="line.336"></a>
+<span class="sourceLineNo">337</span> public Facet(double[] n) {<a name="line.337"></a>
+<span class="sourceLineNo">338</span> normal = n;<a name="line.338"></a>
+<span class="sourceLineNo">339</span> }<a name="line.339"></a>
+<span class="sourceLineNo">340</span><a name="line.340"></a>
+<span class="sourceLineNo">341</span> /**<a name="line.341"></a>
+<span class="sourceLineNo">342</span> * Return a reference to the vector normal to this facet.<a name="line.342"></a>
+<span class="sourceLineNo">343</span> *<a name="line.343"></a>
+<span class="sourceLineNo">344</span> * @return the normal vector.<a name="line.344"></a>
+<span class="sourceLineNo">345</span> */<a name="line.345"></a>
+<span class="sourceLineNo">346</span> public double[] getNormal() {<a name="line.346"></a>
+<span class="sourceLineNo">347</span> return normal;<a name="line.347"></a>
+<span class="sourceLineNo">348</span> }<a name="line.348"></a>
+<span class="sourceLineNo">349</span> }<a name="line.349"></a>
+<span class="sourceLineNo">350</span><a name="line.350"></a>
+<span class="sourceLineNo">351</span> /**<a name="line.351"></a>
+<span class="sourceLineNo">352</span> * Data associated with each {@link Facet}.<a name="line.352"></a>
+<span class="sourceLineNo">353</span> */<a name="line.353"></a>
+<span class="sourceLineNo">354</span> private static class FacetData {<a name="line.354"></a>
+<span class="sourceLineNo">355</span> /** Illumination received from the sample. */<a name="line.355"></a>
+<span class="sourceLineNo">356</span> private final double illumination;<a name="line.356"></a>
+<span class="sourceLineNo">357</span> /** Data value of the sample. */<a name="line.357"></a>
+<span class="sourceLineNo">358</span> private final double sample;<a name="line.358"></a>
+<span class="sourceLineNo">359</span><a name="line.359"></a>
+<span class="sourceLineNo">360</span> /**<a name="line.360"></a>
+<span class="sourceLineNo">361</span> * @param illumination Illumination.<a name="line.361"></a>
+<span class="sourceLineNo">362</span> * @param sample Data value.<a name="line.362"></a>
+<span class="sourceLineNo">363</span> */<a name="line.363"></a>
+<span class="sourceLineNo">364</span> public FacetData(double illumination,<a name="line.364"></a>
+<span class="sourceLineNo">365</span> double sample) {<a name="line.365"></a>
+<span class="sourceLineNo">366</span> this.illumination = illumination;<a name="line.366"></a>
+<span class="sourceLineNo">367</span> this.sample = sample;<a name="line.367"></a>
+<span class="sourceLineNo">368</span> }<a name="line.368"></a>
+<span class="sourceLineNo">369</span><a name="line.369"></a>
+<span class="sourceLineNo">370</span> /**<a name="line.370"></a>
+<span class="sourceLineNo">371</span> * Get the illumination.<a name="line.371"></a>
+<span class="sourceLineNo">372</span> * @return the illumination.<a name="line.372"></a>
+<span class="sourceLineNo">373</span> */<a name="line.373"></a>
+<span class="sourceLineNo">374</span> public double illumination() {<a name="line.374"></a>
+<span class="sourceLineNo">375</span> return illumination;<a name="line.375"></a>
+<span class="sourceLineNo">376</span> }<a name="line.376"></a>
+<span class="sourceLineNo">377</span><a name="line.377"></a>
+<span class="sourceLineNo">378</span> /**<a name="line.378"></a>
+<span class="sourceLineNo">379</span> * Get the data value.<a name="line.379"></a>
+<span class="sourceLineNo">380</span> * @return the data value.<a name="line.380"></a>
+<span class="sourceLineNo">381</span> */<a name="line.381"></a>
+<span class="sourceLineNo">382</span> public double sample() {<a name="line.382"></a>
+<span class="sourceLineNo">383</span> return sample;<a name="line.383"></a>
+<span class="sourceLineNo">384</span> }<a name="line.384"></a>
+<span class="sourceLineNo">385</span> }<a name="line.385"></a>
+<span class="sourceLineNo">386</span>}<a name="line.386"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
Propchange: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/analysis/interpolation/InterpolatingMicrosphere.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/analysis/interpolation/InterpolatingMicrosphere.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/analysis/interpolation/InterpolatingMicrosphere2D.html
==============================================================================
--- websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/analysis/interpolation/InterpolatingMicrosphere2D.html (added)
+++ websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/analysis/interpolation/InterpolatingMicrosphere2D.html Fri Aug 14 19:12:42 2015
@@ -0,0 +1,159 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
+<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
+<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
+<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
+<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
+<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
+<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
+<span class="sourceLineNo">008</span> *<a name="line.8"></a>
+<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
+<span class="sourceLineNo">010</span> *<a name="line.10"></a>
+<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
+<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
+<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
+<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
+<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
+<span class="sourceLineNo">016</span> */<a name="line.16"></a>
+<span class="sourceLineNo">017</span>package org.apache.commons.math3.analysis.interpolation;<a name="line.17"></a>
+<span class="sourceLineNo">018</span><a name="line.18"></a>
+<span class="sourceLineNo">019</span>import org.apache.commons.math3.util.FastMath;<a name="line.19"></a>
+<span class="sourceLineNo">020</span>import org.apache.commons.math3.util.MathUtils;<a name="line.20"></a>
+<span class="sourceLineNo">021</span><a name="line.21"></a>
+<span class="sourceLineNo">022</span>/**<a name="line.22"></a>
+<span class="sourceLineNo">023</span> * Utility class for the {@link MicrosphereProjectionInterpolator} algorithm.<a name="line.23"></a>
+<span class="sourceLineNo">024</span> * For 2D interpolation, this class constructs the microsphere as a series of<a name="line.24"></a>
+<span class="sourceLineNo">025</span> * evenly spaced facets (rather than generating random normals as in the<a name="line.25"></a>
+<span class="sourceLineNo">026</span> * base implementation).<a name="line.26"></a>
+<span class="sourceLineNo">027</span> *<a name="line.27"></a>
+<span class="sourceLineNo">028</span> * @since 3.6<a name="line.28"></a>
+<span class="sourceLineNo">029</span> */<a name="line.29"></a>
+<span class="sourceLineNo">030</span>public class InterpolatingMicrosphere2D extends InterpolatingMicrosphere {<a name="line.30"></a>
+<span class="sourceLineNo">031</span> /** Space dimension. */<a name="line.31"></a>
+<span class="sourceLineNo">032</span> private static final int DIMENSION = 2;<a name="line.32"></a>
+<span class="sourceLineNo">033</span><a name="line.33"></a>
+<span class="sourceLineNo">034</span> /**<a name="line.34"></a>
+<span class="sourceLineNo">035</span> * Create a sphere from vectors regularly sampled around a circle.<a name="line.35"></a>
+<span class="sourceLineNo">036</span> *<a name="line.36"></a>
+<span class="sourceLineNo">037</span> * @param size Number of surface elements of the sphere.<a name="line.37"></a>
+<span class="sourceLineNo">038</span> * @param maxDarkFraction Maximum fraction of the facets that can be dark.<a name="line.38"></a>
+<span class="sourceLineNo">039</span> * If the fraction of "non-illuminated" facets is larger, no estimation<a name="line.39"></a>
+<span class="sourceLineNo">040</span> * of the value will be performed, and the {@code background} value will<a name="line.40"></a>
+<span class="sourceLineNo">041</span> * be returned instead.<a name="line.41"></a>
+<span class="sourceLineNo">042</span> * @param darkThreshold Value of the illumination below which a facet is<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * considered dark.<a name="line.43"></a>
+<span class="sourceLineNo">044</span> * @param background Value returned when the {@code maxDarkFraction}<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * threshold is exceeded.<a name="line.45"></a>
+<span class="sourceLineNo">046</span> * @throws org.apache.commons.math3.exception.NotStrictlyPositiveException<a name="line.46"></a>
+<span class="sourceLineNo">047</span> * if {@code size <= 0}.<a name="line.47"></a>
+<span class="sourceLineNo">048</span> * @throws org.apache.commons.math3.exception.NotPositiveException if<a name="line.48"></a>
+<span class="sourceLineNo">049</span> * {@code darkThreshold < 0}.<a name="line.49"></a>
+<span class="sourceLineNo">050</span> * @throws org.apache.commons.math3.exception.OutOfRangeException if<a name="line.50"></a>
+<span class="sourceLineNo">051</span> * {@code maxDarkFraction} does not belong to the interval {@code [0, 1]}.<a name="line.51"></a>
+<span class="sourceLineNo">052</span> */<a name="line.52"></a>
+<span class="sourceLineNo">053</span> public InterpolatingMicrosphere2D(int size,<a name="line.53"></a>
+<span class="sourceLineNo">054</span> double maxDarkFraction,<a name="line.54"></a>
+<span class="sourceLineNo">055</span> double darkThreshold,<a name="line.55"></a>
+<span class="sourceLineNo">056</span> double background) {<a name="line.56"></a>
+<span class="sourceLineNo">057</span> super(DIMENSION, size, maxDarkFraction, darkThreshold, background);<a name="line.57"></a>
+<span class="sourceLineNo">058</span><a name="line.58"></a>
+<span class="sourceLineNo">059</span> // Generate the microsphere normals.<a name="line.59"></a>
+<span class="sourceLineNo">060</span> for (int i = 0; i < size; i++) {<a name="line.60"></a>
+<span class="sourceLineNo">061</span> final double angle = i * MathUtils.TWO_PI / size;<a name="line.61"></a>
+<span class="sourceLineNo">062</span><a name="line.62"></a>
+<span class="sourceLineNo">063</span> add(new double[] { FastMath.cos(angle),<a name="line.63"></a>
+<span class="sourceLineNo">064</span> FastMath.sin(angle) },<a name="line.64"></a>
+<span class="sourceLineNo">065</span> false);<a name="line.65"></a>
+<span class="sourceLineNo">066</span> }<a name="line.66"></a>
+<span class="sourceLineNo">067</span> }<a name="line.67"></a>
+<span class="sourceLineNo">068</span><a name="line.68"></a>
+<span class="sourceLineNo">069</span> /**<a name="line.69"></a>
+<span class="sourceLineNo">070</span> * Copy constructor.<a name="line.70"></a>
+<span class="sourceLineNo">071</span> *<a name="line.71"></a>
+<span class="sourceLineNo">072</span> * @param other Instance to copy.<a name="line.72"></a>
+<span class="sourceLineNo">073</span> */<a name="line.73"></a>
+<span class="sourceLineNo">074</span> protected InterpolatingMicrosphere2D(InterpolatingMicrosphere2D other) {<a name="line.74"></a>
+<span class="sourceLineNo">075</span> super(other);<a name="line.75"></a>
+<span class="sourceLineNo">076</span> }<a name="line.76"></a>
+<span class="sourceLineNo">077</span><a name="line.77"></a>
+<span class="sourceLineNo">078</span> /**<a name="line.78"></a>
+<span class="sourceLineNo">079</span> * Perform a copy.<a name="line.79"></a>
+<span class="sourceLineNo">080</span> *<a name="line.80"></a>
+<span class="sourceLineNo">081</span> * @return a copy of this instance.<a name="line.81"></a>
+<span class="sourceLineNo">082</span> */<a name="line.82"></a>
+<span class="sourceLineNo">083</span> @Override<a name="line.83"></a>
+<span class="sourceLineNo">084</span> public InterpolatingMicrosphere2D copy() {<a name="line.84"></a>
+<span class="sourceLineNo">085</span> return new InterpolatingMicrosphere2D(this);<a name="line.85"></a>
+<span class="sourceLineNo">086</span> }<a name="line.86"></a>
+<span class="sourceLineNo">087</span>}<a name="line.87"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
Propchange: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/analysis/interpolation/InterpolatingMicrosphere2D.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/analysis/interpolation/InterpolatingMicrosphere2D.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision