Skip to content

Commit

Permalink
build based on afb173b
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed May 7, 2024
1 parent 98ef907 commit 6cd557a
Show file tree
Hide file tree
Showing 10 changed files with 75 additions and 77 deletions.
28 changes: 14 additions & 14 deletions previews/PR66/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -533,19 +533,19 @@ <h2 id="high-level-types">High-level types</h2>
<div class="highlight"><pre><span></span><code><span class="n">BONSampler</span>
</code></pre></div>
<p>A union of the abstract types <code>BONSeeder</code> and <code>BONRefiner</code>. Both types return a tuple with the coordinates as a vector of <code>CartesianIndex</code>, and the weight matrix as a <code>Matrix</code> of <code>AbstractFloat</code>, in that order.</p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/dabb52aef000148ebce1eb166e6ea1937110f53a/src/types.jl#L17-L23' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/afb173b45e5796ec1123ef3175f159f66dad7314/src/types.jl#L17-L23' class='documenter-source'>source</a><br></p>
<p><a id='BiodiversityObservationNetworks.BONSeeder' href='#BiodiversityObservationNetworks.BONSeeder'>#</a>
<strong><code>BiodiversityObservationNetworks.BONSeeder</code></strong> &mdash; <em>Type</em>.</p>
<div class="highlight"><pre><span></span><code><span class="k">abstract</span><span class="w"> </span><span class="k">type</span> <span class="kt">BONSeeder</span><span class="w"> </span><span class="k">end</span>
</code></pre></div>
<p>A <code>BONSeeder</code> is an algorithm for proposing sampling locations using a raster of weights, represented as a matrix, in each cell.</p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/dabb52aef000148ebce1eb166e6ea1937110f53a/src/types.jl#L1-L6' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/afb173b45e5796ec1123ef3175f159f66dad7314/src/types.jl#L1-L6' class='documenter-source'>source</a><br></p>
<p><a id='BiodiversityObservationNetworks.BONRefiner' href='#BiodiversityObservationNetworks.BONRefiner'>#</a>
<strong><code>BiodiversityObservationNetworks.BONRefiner</code></strong> &mdash; <em>Type</em>.</p>
<div class="highlight"><pre><span></span><code><span class="k">abstract</span><span class="w"> </span><span class="k">type</span> <span class="kt">BONRefiner</span><span class="w"> </span><span class="k">end</span>
</code></pre></div>
<p>A <code>BONRefiner</code> is an algorithm for proposing sampling locations by <em>refining</em> a set of candidate points to a smaller set of 'best' points.</p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/dabb52aef000148ebce1eb166e6ea1937110f53a/src/types.jl#L9-L14' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/afb173b45e5796ec1123ef3175f159f66dad7314/src/types.jl#L9-L14' class='documenter-source'>source</a><br></p>
<p><a id='Seeder-and-refiner-functions'></a></p>
<p><a id='Seeder-and-refiner-functions-1'></a></p>
<h2 id="seeder-and-refiner-functions">Seeder and refiner functions</h2>
Expand All @@ -554,7 +554,7 @@ <h2 id="seeder-and-refiner-functions">Seeder and refiner functions</h2>
<div class="highlight"><pre><span></span><code><span class="n">seed</span><span class="p">(</span><span class="n">sampler</span><span class="o">::</span><span class="kt">ST</span><span class="p">)</span>
</code></pre></div>
<p>Produces a set of candidate sampling locations in a vector <code>coords</code> of length numsites from a raster using <code>sampler</code>, where <code>sampler</code> is a <a href="./#BiodiversityObservationNetworks.BONSeeder"><code>BONSeeder</code></a>.</p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/dabb52aef000148ebce1eb166e6ea1937110f53a/src/seed.jl#L22-L27' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/afb173b45e5796ec1123ef3175f159f66dad7314/src/seed.jl#L22-L27' class='documenter-source'>source</a><br></p>
<p><a id='BiodiversityObservationNetworks.seed!' href='#BiodiversityObservationNetworks.seed!'>#</a>
<strong><code>BiodiversityObservationNetworks.seed!</code></strong> &mdash; <em>Function</em>.</p>
<div class="highlight"><pre><span></span><code><span class="n">seed!</span><span class="p">(</span><span class="n">coords</span><span class="o">::</span><span class="kt">Vector</span><span class="p">{</span><span class="kt">CartesianIndex</span><span class="p">},</span><span class="w"> </span><span class="n">sampler</span><span class="o">::</span><span class="kt">ST</span><span class="p">,</span><span class="w"> </span><span class="n">uncertainty</span><span class="o">::</span><span class="kt">Matrix</span><span class="p">{</span><span class="kt">T</span><span class="p">})</span>
Expand All @@ -563,27 +563,27 @@ <h2 id="seeder-and-refiner-functions">Seeder and refiner functions</h2>
<ul>
<li>Seeder's work on rasters, refiners work on set of coordinates.</li>
</ul>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/dabb52aef000148ebce1eb166e6ea1937110f53a/src/seed.jl#L1-L8' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/afb173b45e5796ec1123ef3175f159f66dad7314/src/seed.jl#L1-L8' class='documenter-source'>source</a><br></p>
<p><a id='BiodiversityObservationNetworks.refine' href='#BiodiversityObservationNetworks.refine'>#</a>
<strong><code>BiodiversityObservationNetworks.refine</code></strong> &mdash; <em>Function</em>.</p>
<div class="highlight"><pre><span></span><code><span class="n">refine</span><span class="p">(</span><span class="n">pool</span><span class="o">::</span><span class="kt">Vector</span><span class="p">{</span><span class="kt">CartesianIndex</span><span class="p">},</span><span class="w"> </span><span class="n">sampler</span><span class="o">::</span><span class="kt">ST</span><span class="p">)</span>
</code></pre></div>
<p>Refines a set of candidate sampling locations and returns a vector <code>coords</code> of length numsites from a vector of coordinates <code>pool</code> using <code>sampler</code>, where <code>sampler</code> is a <a href="./#BiodiversityObservationNetworks.BONRefiner"><code>BONRefiner</code></a>.</p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/dabb52aef000148ebce1eb166e6ea1937110f53a/src/refine.jl#L46-L51' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/afb173b45e5796ec1123ef3175f159f66dad7314/src/refine.jl#L46-L51' class='documenter-source'>source</a><br></p>
<div class="highlight"><pre><span></span><code>refine(sampler::BONRefiner)
</code></pre></div>
<p>Returns a curried function of <code>refine</code></p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/dabb52aef000148ebce1eb166e6ea1937110f53a/src/refine.jl#L60-L64' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/afb173b45e5796ec1123ef3175f159f66dad7314/src/refine.jl#L60-L64' class='documenter-source'>source</a><br></p>
<p><a id='BiodiversityObservationNetworks.refine!' href='#BiodiversityObservationNetworks.refine!'>#</a>
<strong><code>BiodiversityObservationNetworks.refine!</code></strong> &mdash; <em>Function</em>.</p>
<div class="highlight"><pre><span></span><code><span class="n">refine!</span><span class="p">(</span><span class="n">cooords</span><span class="o">::</span><span class="kt">Vector</span><span class="p">{</span><span class="kt">CartesianIndex</span><span class="p">},</span><span class="w"> </span><span class="n">pool</span><span class="o">::</span><span class="kt">Vector</span><span class="p">{</span><span class="kt">CartesianIndex</span><span class="p">},</span><span class="w"> </span><span class="n">sampler</span><span class="o">::</span><span class="kt">ST</span><span class="p">)</span>
</code></pre></div>
<p>Refines a set of candidate sampling locations in the preallocated vector <code>coords</code> from a vector of coordinates <code>pool</code> using <code>sampler</code>, where <code>sampler</code> is a <a href="./#BiodiversityObservationNetworks.BONRefiner"><code>BONRefiner</code></a>.</p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/dabb52aef000148ebce1eb166e6ea1937110f53a/src/refine.jl#L1-L6' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/afb173b45e5796ec1123ef3175f159f66dad7314/src/refine.jl#L1-L6' class='documenter-source'>source</a><br></p>
<div class="highlight"><pre><span></span><code>refine!(cooords::Vector{CartesianIndex}, pool::Vector{CartesianIndex}, sampler::ST)
</code></pre></div>
<p>The curried version of <code>refine!</code>, which returns a function that acts on the input coordinate pool passed to the curried function (<code>p</code> below).</p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/dabb52aef000148ebce1eb166e6ea1937110f53a/src/refine.jl#L29-L34' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/afb173b45e5796ec1123ef3175f159f66dad7314/src/refine.jl#L29-L34' class='documenter-source'>source</a><br></p>
<p><a id='Seeder-algorithms'></a></p>
<p><a id='Seeder-algorithms-1'></a></p>
<h2 id="seeder-algorithms">Seeder algorithms</h2>
Expand All @@ -592,7 +592,7 @@ <h2 id="seeder-algorithms">Seeder algorithms</h2>
<div class="highlight"><pre><span></span><code><span class="n">BalancedAcceptance</span>
</code></pre></div>
<p>A <code>BONSeeder</code> that uses Balanced-Acceptance Sampling (Van-dem-Bates et al. 2017 https://doi.org/10.1111/2041-210X.13003)</p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/dabb52aef000148ebce1eb166e6ea1937110f53a/src/balancedacceptance.jl#L1-L6' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/afb173b45e5796ec1123ef3175f159f66dad7314/src/balancedacceptance.jl#L1-L6' class='documenter-source'>source</a><br></p>
<p><a id='Refiner-algorithms'></a></p>
<p><a id='Refiner-algorithms-1'></a></p>
<h2 id="refiner-algorithms">Refiner algorithms</h2>
Expand All @@ -602,13 +602,13 @@ <h2 id="refiner-algorithms">Refiner algorithms</h2>
</code></pre></div>
<p>...</p>
<p><strong>numsites</strong>, an Integer (def. 50), specifying the number of points to use.</p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/dabb52aef000148ebce1eb166e6ea1937110f53a/src/adaptivespatial.jl#L1-L7' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/afb173b45e5796ec1123ef3175f159f66dad7314/src/adaptivespatial.jl#L1-L7' class='documenter-source'>source</a><br></p>
<p><a id='BiodiversityObservationNetworks.Uniqueness' href='#BiodiversityObservationNetworks.Uniqueness'>#</a>
<strong><code>BiodiversityObservationNetworks.Uniqueness</code></strong> &mdash; <em>Type</em>.</p>
<div class="highlight"><pre><span></span><code><span class="n">Uniqueness</span>
</code></pre></div>
<p>A <code>BONRefiner</code></p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/dabb52aef000148ebce1eb166e6ea1937110f53a/src/uniqueness.jl#L1-L5' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/afb173b45e5796ec1123ef3175f159f66dad7314/src/uniqueness.jl#L1-L5' class='documenter-source'>source</a><br></p>
<p><a id='Helper-functions'></a></p>
<p><a id='Helper-functions-1'></a></p>
<h2 id="helper-functions">Helper functions</h2>
Expand All @@ -622,13 +622,13 @@ <h2 id="helper-functions">Helper functions</h2>
</code></pre></div>
<p>This function turns a matrix <code>A</code> (storing measurement values) into pixel-wise entropy values, stored in a matrix <code>U</code> (that is previously allocated).</p>
<p>Pixel-wise entropy is determined by measuring the empirical probability of randomly picking a value in the matrix that is either lower or higher than the pixel value. The entropy of both these probabilities are calculated using the -p×log(2,p) formula. The entropy of the pixel is the <em>sum</em> of the two entropies, so that it is close to 1 for values close to the median, and close to 0 for values close to the extreme of the distribution.</p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/dabb52aef000148ebce1eb166e6ea1937110f53a/src/entropize.jl#L1-L13' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/afb173b45e5796ec1123ef3175f159f66dad7314/src/entropize.jl#L1-L13' class='documenter-source'>source</a><br></p>
<p><a id='BiodiversityObservationNetworks.entropize' href='#BiodiversityObservationNetworks.entropize'>#</a>
<strong><code>BiodiversityObservationNetworks.entropize</code></strong> &mdash; <em>Function</em>.</p>
<div class="highlight"><pre><span></span><code><span class="n">entropize</span><span class="p">(</span><span class="n">A</span><span class="o">::</span><span class="kt">Matrix</span><span class="p">{</span><span class="kt">Number</span><span class="p">})</span>
</code></pre></div>
<p>Allocation version of <code>entropize!</code>.</p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/dabb52aef000148ebce1eb166e6ea1937110f53a/src/entropize.jl#L30-L34' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/PoisotLab/BiodiversityObservationNetworks.jl/blob/afb173b45e5796ec1123ef3175f159f66dad7314/src/entropize.jl#L30-L34' class='documenter-source'>source</a><br></p>



Expand Down
Loading

0 comments on commit 6cd557a

Please sign in to comment.