diff --git a/pom.xml b/pom.xml index 7ecea948517064ae638151ee34e5d7a738bfb9d0..a104bf4fb9e387037a5a297e8f045c17e14b71c4 100644 --- a/pom.xml +++ b/pom.xml @@ -11,7 +11,7 @@ </parent> <artifactId>icy-connected-components</artifactId> - <version>4.8.6</version> + <version>4.8.7</version> <packaging>jar</packaging> diff --git a/src/main/java/plugins/adufour/connectedcomponents/ConnectedComponent.java b/src/main/java/plugins/adufour/connectedcomponents/ConnectedComponent.java index fdc1ab7bad74b6c17a81604524f261fd232161ff..6fad271bf9b35069b854d39ca9f2e79e10759531 100644 --- a/src/main/java/plugins/adufour/connectedcomponents/ConnectedComponent.java +++ b/src/main/java/plugins/adufour/connectedcomponents/ConnectedComponent.java @@ -61,7 +61,7 @@ public class ConnectedComponent extends Detection implements Iterable<Point3i> /** * Creates a new connected component with given initial capacity * - * @param initialCapacity + * @param initialCapacity int */ public ConnectedComponent(int initialCapacity) { @@ -167,7 +167,7 @@ public class ConnectedComponent extends Detection implements Iterable<Point3i> * Computes the average intensity of the component on each channel of the given sequence, at the * time point where this component was found * - * @param sequence + * @param sequence Sequence * @return an array containing the average intensity of the component in each band */ public double[] computeMeanIntensity(Sequence sequence) @@ -179,7 +179,8 @@ public class ConnectedComponent extends Detection implements Iterable<Point3i> * Computes the average intensity of the component on each channel of the given sequence and the * specified time point * - * @param sequence + * @param sequence Sequence + * @param t int * @return an array containing the average intensity of the component in each band */ public double[] computeMeanIntensity(Sequence sequence, int t) @@ -206,7 +207,7 @@ public class ConnectedComponent extends Detection implements Iterable<Point3i> * Computes the minimum intensity of the component on each channel of the given sequence, at the * time point where this component was found * - * @param sequence + * @param sequence Sequence * @return an array containing the average intensity of the component in each band */ public double[] computeMinIntensity(Sequence sequence) @@ -218,7 +219,8 @@ public class ConnectedComponent extends Detection implements Iterable<Point3i> * Computes the minimum intensity of the component on each channel of the given sequence and the * specified time point * - * @param sequence + * @param sequence Sequence + * @param t int * @return an array containing the average intensity of the component in each band */ public double[] computeMinIntensity(Sequence sequence, int t) @@ -247,7 +249,7 @@ public class ConnectedComponent extends Detection implements Iterable<Point3i> * Computes the maximum intensity of the component on each channel of the given sequence, at the * time point where this component was found * - * @param sequence + * @param sequence Sequence * @return an array containing the average intensity of the component in each band */ public double[] computeMaxIntensity(Sequence sequence) @@ -258,8 +260,9 @@ public class ConnectedComponent extends Detection implements Iterable<Point3i> /** * Computes the maximum intensity pixel of the component on each channel of the given sequence * and the specified time point - * - * @param sequence + * + * @param sequence Sequence + * @param t int * @return an array containing the average intensity of the component in each band */ public double[] computeMaxIntensity(Sequence sequence, int t) @@ -289,7 +292,7 @@ public class ConnectedComponent extends Detection implements Iterable<Point3i> * * @param component * the component to compute the distance to - * @return + * @return double */ public double distanceTo(ConnectedComponent component) { @@ -313,7 +316,7 @@ public class ConnectedComponent extends Detection implements Iterable<Point3i> * Returns an iterator over the internal points array. Useful to browse all points without * duplicating the array * - * @return + * @return Point3i Iterator */ public Iterable<Point3i> getIterablePoints() { @@ -323,10 +326,10 @@ public class ConnectedComponent extends Detection implements Iterable<Point3i> /** * Computes the major axis of the object, which is the vector between the two most distant * points of this component. Note that the result vector orientation is meaningless if the - * component is spherical.<br/> + * component is spherical.<br> * NOTE: this is an potentially expensive operation: O(N log N) * - * @return + * @return 3D Vector */ public Vector3d getMajorAxis() { @@ -401,7 +404,7 @@ public class ConnectedComponent extends Detection implements Iterable<Point3i> /** * Computes the mass center of this component * - * @return + * @return 3D Point */ public Point3d getMassCenter() { @@ -416,8 +419,8 @@ public class ConnectedComponent extends Detection implements Iterable<Point3i> /** * Returns the maximum distance between any point of this component and the specified point * - * @param point - * @return + * @param point 3D Point + * @return double */ public double getMaxDistanceTo(Point3d point) { @@ -569,7 +572,7 @@ public class ConnectedComponent extends Detection implements Iterable<Point3i> } /** - * @param component + * @param component ConnectedComponent * @return true if this component intersects (e.g. has at least one voxel overlapping with) the * specified component */ @@ -598,8 +601,8 @@ public class ConnectedComponent extends Detection implements Iterable<Point3i> /** * Creates a new component with the intersection between the current and specified components * - * @param component - * @return + * @param component ConnectedComponent + * @return ConnectedComponent */ public ConnectedComponent intersection(ConnectedComponent component) { @@ -628,8 +631,10 @@ public class ConnectedComponent extends Detection implements Iterable<Point3i> /** * Paints this component onto the given sequence with the specified value * - * @param s - * @param value + * @param s Sequence + * @param t int + * @param c int + * @param value double */ public void paintOnSequence(Sequence s, int t, int c, double value) { @@ -672,7 +677,7 @@ public class ConnectedComponent extends Detection implements Iterable<Point3i> * Creates a new byte sequence filled with this component. The sequence has a unique time point, * and the image size is equal to the bounding box of this component. * - * @return + * @return Sequence */ public Sequence toSequence() { diff --git a/src/main/java/plugins/adufour/connectedcomponents/ConnectedComponentDescriptor.java b/src/main/java/plugins/adufour/connectedcomponents/ConnectedComponentDescriptor.java index 67fded23ed65b6d8a09b9d15d4776b9a97ffb838..dd037cbb5efe3ed313f1973a3979d7d4c68de1ef 100644 --- a/src/main/java/plugins/adufour/connectedcomponents/ConnectedComponentDescriptor.java +++ b/src/main/java/plugins/adufour/connectedcomponents/ConnectedComponentDescriptor.java @@ -84,7 +84,7 @@ public class ConnectedComponentDescriptor extends Plugin implements PluginBundle } /** - * @param cc + * @param cc ConnectedComponent * @return a triplet representing the radiuses of the best fitting ellipse (the third value is 0 * for 2D objects) */ @@ -175,7 +175,7 @@ public class ConnectedComponentDescriptor extends Plugin implements PluginBundle * the input component * @param bsCenter * the computed center of the bounding sphere - * @param maxBounds + * @param bsRadius * the computed radius of the bounding sphere */ public void computeBoundingSphere(ConnectedComponent cc, Point3d bsCenter, VarDouble bsRadius) @@ -185,6 +185,7 @@ public class ConnectedComponentDescriptor extends Plugin implements PluginBundle } /** + * @param cc ConnectedComponent * @param contourPoints * (set to <code>null</code> if not wanted) an output list of extracted contour * points @@ -300,7 +301,7 @@ public class ConnectedComponentDescriptor extends Plugin implements PluginBundle /** * Compute the sphericity (circularity in 2D) of the given component, measured as a weighted - * ratio between the component's dimensions.<br/> + * ratio between the component's dimensions.<br> * NOTE: the circularity index is adjusted to work with digitized contours, and partially * corrects for digitization artifacts (see the * {@link #computePerimeter(ConnectedComponent, ArrayList, Sequence)} method) @@ -379,7 +380,7 @@ public class ConnectedComponentDescriptor extends Plugin implements PluginBundle } /** - * @param cc + * @param cc ConnectedComponent * @return The hull ratio, measured as the ratio between the object volume and its convex hull * (envelope) */ @@ -391,7 +392,7 @@ public class ConnectedComponentDescriptor extends Plugin implements PluginBundle } /** - * @param cc + * @param cc ConnectedComponent * @return An array containing [contour, area] of the smallest convex envelope surrounding the * object. The 2 values are returned together because their computation is simultaneous * (in the 3D case only) diff --git a/src/main/java/plugins/adufour/connectedcomponents/ConnectedComponents.java b/src/main/java/plugins/adufour/connectedcomponents/ConnectedComponents.java index 8f4fe76764a43c5956c919d8b51d2ee8b9ac0e9e..1360ebefe9b056ebe31eefffa5fe16c2495a2d7f 100644 --- a/src/main/java/plugins/adufour/connectedcomponents/ConnectedComponents.java +++ b/src/main/java/plugins/adufour/connectedcomponents/ConnectedComponents.java @@ -1347,8 +1347,8 @@ public class ConnectedComponents extends EzPlug implements Block * * @param output * a sequence of type INT - * @param components - * @param comparator + * @param components Map of List of ConnectedComponent + * @param comparator Comparator of ConnectedComponents */ public static void createLabeledSequence(Sequence output, Map<Integer, List<ConnectedComponent>> components, Comparator<ConnectedComponent> comparator)