updated docs

Author: njbradley

docs/constitch.composite.html

@@ -21,19 +21,18 @@
 <a href="collections.html">collections</a><br>
 <a href="concurrent.html">concurrent</a><br>
 <a href="dataclasses.html">dataclasses</a><br>
-<a href="imageio.v3.html">imageio.v3</a><br>
-</td><td width="25%" valign=top><a href="math.html">math</a><br>
-<a href="constitch.merging.html">constitch.merging</a><br>
+<a href="math.html">math</a><br>
+</td><td width="25%" valign=top><a href="constitch.merging.html">constitch.merging</a><br>
 <a href="numpy.html">numpy</a><br>
 <a href="pickle.html">pickle</a><br>
 <a href="matplotlib.pyplot.html">matplotlib.pyplot</a><br>
-</td><td width="25%" valign=top><a href="random.html">random</a><br>
-<a href="skimage.html">skimage</a><br>
+<a href="random.html">random</a><br>
+</td><td width="25%" valign=top><a href="skimage.html">skimage</a><br>
 <a href="sklearn.html">sklearn</a><br>
 <a href="constitch.solving.html">constitch.solving</a><br>
 <a href="sys.html">sys</a><br>
-</td><td width="25%" valign=top><a href="time.html">time</a><br>
-<a href="constitch.utils.html">constitch.utils</a><br>
+<a href="time.html">time</a><br>
+</td><td width="25%" valign=top><a href="constitch.utils.html">constitch.utils</a><br>
 <a href="warnings.html">warnings</a><br>
 </td></tr></table></td></tr></table><p>
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
@@ -103,6 +102,10 @@
 
 <dl><dt><a name="BBox-__str__"><strong>__str__</strong></a>(self)</dt><dd><tt>Return&nbsp;str(self).</tt></dd></dl>
 
+<dl><dt><a name="BBox-area"><strong>area</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;area&nbsp;of&nbsp;the&nbsp;box,&nbsp;basically&nbsp;self.<strong>size</strong>.prod()<br>
+However&nbsp;if&nbsp;the&nbsp;size&nbsp;of&nbsp;the&nbsp;rectangle&nbsp;is&nbsp;negative&nbsp;in&nbsp;either&nbsp;or&nbsp;both<br>
+dimentions&nbsp;the&nbsp;result&nbsp;will&nbsp;be&nbsp;negative,&nbsp;indicating&nbsp;an&nbsp;invalid&nbsp;rectangle</tt></dd></dl>
+
 <dl><dt><a name="BBox-as2d"><strong>as2d</strong></a>(self)</dt><dd><tt>Creates&nbsp;a&nbsp;copy&nbsp;of&nbsp;this&nbsp;box&nbsp;that&nbsp;only&nbsp;has&nbsp;two&nbsp;dimensions,<br>
 dropping&nbsp;extra&nbsp;values.</tt></dd></dl>
 
@@ -114,6 +117,9 @@
 
 <dl><dt><a name="BBox-copy"><strong>copy</strong></a>(self)</dt></dl>
 
+<dl><dt><a name="BBox-intersection"><strong>intersection</strong></a>(self, other)</dt><dd><tt>Returns&nbsp;the&nbsp;overlapping&nbsp;area&nbsp;between&nbsp;this&nbsp;box&nbsp;and&nbsp;the&nbsp;<a href="#BBox">BBox</a>&nbsp;other&nbsp;passed&nbsp;in<br>
+This&nbsp;may&nbsp;return&nbsp;boxes&nbsp;with&nbsp;negative&nbsp;size,&nbsp;which&nbsp;would&nbsp;indicate&nbsp;there&nbsp;is&nbsp;no&nbsp;overlap</tt></dd></dl>
+
 <dl><dt><a name="BBox-overlaps"><strong>overlaps</strong></a>(self, otherbox)</dt><dd><tt>Whether&nbsp;this&nbsp;box&nbsp;overlaps&nbsp;with&nbsp;the&nbsp;other&nbsp;box.&nbsp;This&nbsp;does&nbsp;not&nbsp;consider<br>
 sharing&nbsp;an&nbsp;edge&nbsp;as&nbsp;overlapping,&nbsp;to&nbsp;count&nbsp;as&nbsp;overlapping&nbsp;there&nbsp;must&nbsp;be&nbsp;at&nbsp;least<br>
 one&nbsp;pixel&nbsp;that&nbsp;is&nbsp;contained&nbsp;in&nbsp;both&nbsp;images</tt></dd></dl>
@@ -400,7 +406,7 @@
 Raises:<br>
 &nbsp;&nbsp;&nbsp;&nbsp;KeyError:&nbsp;The&nbsp;specified&nbsp;constraint&nbsp;does&nbsp;not&nbsp;exist</tt></dd></dl>
 
-<dl><dt><a name="CompositeConstraintSet-solve"><strong>solve</strong></a>(self, solver='mse', **kwargs)</dt><dd><tt>Solve&nbsp;the&nbsp;constraints&nbsp;to&nbsp;get&nbsp;a&nbsp;global&nbsp;position&nbsp;for&nbsp;each&nbsp;image<br>
+<dl><dt><a name="CompositeConstraintSet-solve"><strong>solve</strong></a>(self, solver='mae', **kwargs)</dt><dd><tt>Solve&nbsp;the&nbsp;constraints&nbsp;to&nbsp;get&nbsp;a&nbsp;global&nbsp;position&nbsp;for&nbsp;each&nbsp;image<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;&nbsp;&nbsp;solver&nbsp;(constitch.Solver&nbsp;or&nbsp;str):&nbsp;default&nbsp;constitch.LinearSolver()<br>
@@ -714,7 +720,7 @@
 
 <dl><dt><a name="CompositeImage-pair_func"><strong>pair_func</strong></a>(self)</dt></dl>
 
-<dl><dt><a name="CompositeImage-plot_scores"><strong>plot_scores</strong></a>(self, path, constraints=None, score_func=None, axis_size=12)</dt></dl>
+<dl><dt><a name="CompositeImage-plot_scores"><strong>plot_scores</strong></a>(self, path, constraints=None, score_func=None, axis_size=12, constraint_multiplier=1)</dt></dl>
 
 <dl><dt><a name="CompositeImage-print_mem_usage"><strong>print_mem_usage</strong></a>(self)</dt></dl>
 
@@ -1162,7 +1168,7 @@
 Raises:<br>
 &nbsp;&nbsp;&nbsp;&nbsp;KeyError:&nbsp;The&nbsp;specified&nbsp;constraint&nbsp;does&nbsp;not&nbsp;exist</tt></dd></dl>
 
-<dl><dt><a name="SubCompositeConstraintSet-solve"><strong>solve</strong></a>(self, solver='mse', **kwargs)</dt><dd><tt>Solve&nbsp;the&nbsp;constraints&nbsp;to&nbsp;get&nbsp;a&nbsp;global&nbsp;position&nbsp;for&nbsp;each&nbsp;image<br>
+<dl><dt><a name="SubCompositeConstraintSet-solve"><strong>solve</strong></a>(self, solver='mae', **kwargs)</dt><dd><tt>Solve&nbsp;the&nbsp;constraints&nbsp;to&nbsp;get&nbsp;a&nbsp;global&nbsp;position&nbsp;for&nbsp;each&nbsp;image<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;&nbsp;&nbsp;solver&nbsp;(constitch.Solver&nbsp;or&nbsp;str):&nbsp;default&nbsp;constitch.LinearSolver()<br>
@@ -1360,7 +1366,7 @@
 
 <dl><dt><a name="SubCompositeImage-html_summary"><strong>html_summary</strong></a>(self, path, score_func=None)</dt></dl>
 
-<dl><dt><a name="SubCompositeImage-plot_scores"><strong>plot_scores</strong></a>(self, path, constraints=None, score_func=None, axis_size=12)</dt></dl>
+<dl><dt><a name="SubCompositeImage-plot_scores"><strong>plot_scores</strong></a>(self, path, constraints=None, score_func=None, axis_size=12, constraint_multiplier=1)</dt></dl>
 
 <dl><dt><a name="SubCompositeImage-print_mem_usage"><strong>print_mem_usage</strong></a>(self)</dt></dl>
 

docs/constitch.constraints.html

@@ -474,7 +474,7 @@
 Raises:<br>
 &nbsp;&nbsp;&nbsp;&nbsp;KeyError:&nbsp;The&nbsp;specified&nbsp;constraint&nbsp;does&nbsp;not&nbsp;exist</tt></dd></dl>
 
-<dl><dt><a name="ConstraintSet-solve"><strong>solve</strong></a>(self, solver='mse', **kwargs)</dt><dd><tt>Solve&nbsp;the&nbsp;constraints&nbsp;to&nbsp;get&nbsp;a&nbsp;global&nbsp;position&nbsp;for&nbsp;each&nbsp;image<br>
+<dl><dt><a name="ConstraintSet-solve"><strong>solve</strong></a>(self, solver='mae', **kwargs)</dt><dd><tt>Solve&nbsp;the&nbsp;constraints&nbsp;to&nbsp;get&nbsp;a&nbsp;global&nbsp;position&nbsp;for&nbsp;each&nbsp;image<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;&nbsp;&nbsp;solver&nbsp;(constitch.Solver&nbsp;or&nbsp;str):&nbsp;default&nbsp;constitch.LinearSolver()<br>