Commit 85635c59 authored by Jean-Yves TINEVEZ's avatar Jean-Yves TINEVEZ
Browse files

Fix javadoc errors.

parent b0005ce0
...@@ -52,7 +52,7 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3 ...@@ -52,7 +52,7 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3
} }
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
protected ActiveContour(Var<Double> sampling, SlidingWindow convergenceWindow) protected ActiveContour(Var<Double> sampling, final SlidingWindow convergenceWindow)
{ {
super(0, 0, 0, 0); super(0, 0, 0, 0);
...@@ -77,7 +77,7 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3 ...@@ -77,7 +77,7 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3
return name; return name;
} }
public void setName(String name) public void setName(final String name)
{ {
this.name = name; this.name = name;
} }
...@@ -91,7 +91,6 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3 ...@@ -91,7 +91,6 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3
* *
* @param p * @param p
* the point to add * the point to add
* @return the index indicating where the point has been inserted in the internal list
*/ */
protected abstract void addPoint(Point3d p); protected abstract void addPoint(Point3d p);
...@@ -183,8 +182,6 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3 ...@@ -183,8 +182,6 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3
* *
* @param imageData * @param imageData
* the data on which the average intensity should be computed * the data on which the average intensity should be computed
* @param channel
* the channel on which the average intensity should be computed
* @param mask * @param mask
* the boolean mask where all contours (including the current one) have already been * the boolean mask where all contours (including the current one) have already been
* rasterised * rasterised
...@@ -193,51 +190,52 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3 ...@@ -193,51 +190,52 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3
public abstract double computeBackgroundIntensity(Sequence imageData, BooleanMask3D mask); public abstract double computeBackgroundIntensity(Sequence imageData, BooleanMask3D mask);
/** /**
* Tests whether the given point is inside the contour, and if so returns the penetration depth * Tests whether the given point is inside the contour, and if so returns
* of this point. <br> * the penetration depth of this point. <br>
* *
* @param p * @param p
* a point to test * a point to test
* @return * @return
* <ul> * <ul>
* <li/>if <code>p</code> is outside: <code>0</code> * <li>if <code>p</code> is outside: <code>0</code>
* <li/>if <code>p</code> is inside: the distance from <code>p</code> to the contour * <li>if <code>p</code> is inside: the distance from <code>p</code>
* edge * to the contour edge
* </ul> * </ul>
*/ */
public abstract double getDistanceToEdge(Point3d p); public abstract double getDistanceToEdge(Point3d p);
/** /**
* @param order * @param order
* the dimension (a.k.a. norm) to compute:<br/> * the dimension (a.k.a. norm) to compute:
* <ul> * <ul>
* <li>0: number of points,</li> * <li>0: number of points,</li>
* <li>1: perimeter (2D) or surface area (3D),</li> * <li>1: perimeter (2D) or surface area (3D),</li>
* <li>2: surface (2D) or volume (3D)</li> * <li>2: surface (2D) or volume (3D)</li>
* </ul> * </ul>
* @return the dimension for the specified order * @return the dimension for the specified order
*/ */
public abstract double getDimension(int order); public abstract double getDimension(int order);
abstract void move(ROI boundField, double timeStep); abstract void move(ROI boundField, double timeStep);
/** /**
* Re-samples the Contour according to an 'average distance between points' criterion. This * Re-samples the Contour according to an 'average distance between points'
* method ensures that the distance between two consecutive points is strictly comprised between * criterion. This method ensures that the distance between two consecutive
* a minimum value and a maximum value. In order to avoid oscillatory behavior, 'max' and 'min' * points is strictly comprised between a minimum value and a maximum value.
* should verify the following relations: min < 1, max > 1, 2*min <= max. * In order to avoid oscillatory behavior, 'max' and 'min' should verify the
* * following relations: min &lt; 1, max &gt; 1, 2*min &lt;= max.
* @param minFactor *
* the minimum distance between two points. * @param minFactor
* @param maxFactor * the minimum distance between two points.
* the maximum distance between two points. * @param maxFactor
*/ * the maximum distance between two points.
*/
public abstract void reSample(double minFactor, double maxFactor) throws TopologyException; public abstract void reSample(double minFactor, double maxFactor) throws TopologyException;
/** /**
* @return a ROI representing the contour * @return a ROI representing the contour
* @deprecated use {@link #toROI(ROIType)} instead * @deprecated use {@link #toROI(ROIType, Sequence)} instead
*/ */
@Deprecated @Deprecated
public abstract ROI toROI(); public abstract ROI toROI();
...@@ -262,19 +260,20 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3 ...@@ -262,19 +260,20 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3
public abstract void toSequence(Sequence output, double value); public abstract void toSequence(Sequence output, double value);
/** /**
* Updates the contour's meta-data (i.e. data that can be computed directly from the actual * Updates the contour's meta-data (i.e. data that can be computed directly
* contour data, but stored locally for fast repetitive access). This includes:<br/> * from the actual contour data, but stored locally for fast repetitive
* <ul> * access). This includes:
* <li>bounding box</li> * <ul>
* <li>bounding sphere</li> * <li>bounding box</li>
* <li>contour normals</li> * <li>bounding sphere</li>
* <li>center of mass</li> * <li>contour normals</li>
* </ul> * <li>center of mass</li>
*/ * </ul>
*/
protected void updateMetaData() protected void updateMetaData()
{ {
// center of mass // center of mass
Point3d center = new Point3d(); final Point3d center = new Point3d();
// bounding sphere // bounding sphere
double radius = 0; double radius = 0;
...@@ -289,7 +288,7 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3 ...@@ -289,7 +288,7 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3
// center calculation // center calculation
double nbPts = 0; double nbPts = 0;
for (Point3d p : this) for (final Point3d p : this)
{ {
nbPts++; nbPts++;
...@@ -322,9 +321,9 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3 ...@@ -322,9 +321,9 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3
boundingSphere.setCenter(center); boundingSphere.setCenter(center);
// radius calculation // radius calculation
for (Point3d p : this) for (final Point3d p : this)
{ {
double d = p.distanceSquared(center); final double d = p.distanceSquared(center);
if (d > radius) if (d > radius)
radius = d; radius = d;
...@@ -358,12 +357,12 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3 ...@@ -358,12 +357,12 @@ public abstract class ActiveContour extends Detection implements Iterable<Point3
return lastConvergedFrame; return lastConvergedFrame;
} }
public void setLastConvergedFrame(int frame) public void setLastConvergedFrame(final int frame)
{ {
lastConvergedFrame = frame; lastConvergedFrame = frame;
} }
public void setDivisionSensitivity(Var<Double> divisionSensitivity) public void setDivisionSensitivity(final Var<Double> divisionSensitivity)
{ {
this.divisionSensitivity = divisionSensitivity; this.divisionSensitivity = divisionSensitivity;
} }
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment