Automatic Update

Thu Aug 31 19:47:56 UTC 2023

api.html

@@ -101,10 +101,19 @@ <h3>Navigation</h3>
 
 <dl class="py method">
 <dt class="sig sig-object py" id="pytools.HedwigZarrImage.rechunk">
-<span class="sig-name descname"><span class="pre">rechunk</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chunk_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pytools.HedwigZarrImage.rechunk" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">rechunk</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chunk_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compressor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pytools.HedwigZarrImage.rechunk" title="Link to this definition">¶</a></dt>
 <dd><p>Change the chunk size of each ZARR array inplace in the pyramid.</p>
 <p>The chunk_size is applied to all spacial dimension, and other dimension (CT) are the full size.</p>
 <p>The ImageZarrImage need write access to the ZARR.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>chunk_size</strong> – The size as an integer to resize the chunk sizes.</p></li>
+<li><p><strong>compressor</strong> – The output arrays will be written with the provided compressor, if None then the compressor
+of the input arrays will be used.</p></li>
+</ul>
+</dd>
+</dl>
 </dd></dl>
 
 <dl class="py property">