Skip to content

Commit d5a698e

Browse files
committed
fix javadoc problems
1 parent afbd8a3 commit d5a698e

12 files changed

Lines changed: 78 additions & 10 deletions

‎src/main/java/inra/ijpb/morphology/BinaryMorphology.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111
* A collection of static method for performing morphological filters (erosion,
1212
* dilation) on binary 2D or 3D images.
1313
*
14-
* @see net.ijt.binary.ops.DistanceMapBinaryDilation;
15-
* @see net.ijt.binary.ops.DistanceMapBinaryErosion;
16-
* @see net.ijt.binary.ops.DistanceMapBinaryDilation3D;
17-
* @see net.ijt.binary.ops.DistanceMapBinaryErosion3D;
14+
* @see inra.ijpb.morphology.binary.DistanceMapBinaryDilation
15+
* @see inra.ijpb.morphology.binary.DistanceMapBinaryErosion
16+
* @see inra.ijpb.morphology.binary.DistanceMapBinaryDilation3D
17+
* @see inra.ijpb.morphology.binary.DistanceMapBinaryErosion3D
1818
*
1919
* @author dlegland
2020
*

‎src/main/java/inra/ijpb/morphology/binary/DistanceMapBinaryClosing.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ public class DistanceMapBinaryClosing extends DistanceMapBasedOperator
2121
{
2222
double radius;
2323

24+
/**
25+
* Creates a new closing operator for binary images, using a disk with the
26+
* specified radius as structuring element.
27+
*
28+
* @param radius
29+
* the radius of the disk structuring element
30+
*/
2431
public DistanceMapBinaryClosing(double radius)
2532
{
2633
this.radius = radius;

‎src/main/java/inra/ijpb/morphology/binary/DistanceMapBinaryClosing3D.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ public class DistanceMapBinaryClosing3D extends DistanceMapBasedOperator3D
2121
{
2222
double radius;
2323

24+
/**
25+
* Creates a new closing operator for 3D binary images, using a ball with
26+
* the specified radius as structuring element.
27+
*
28+
* @param radius
29+
* the radius of the ball structuring element
30+
*/
2431
public DistanceMapBinaryClosing3D(double radius)
2532
{
2633
this.radius = radius;

‎src/main/java/inra/ijpb/morphology/binary/DistanceMapBinaryDilation.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ public class DistanceMapBinaryDilation extends DistanceMapBasedOperator
2121
{
2222
double radius;
2323

24+
/**
25+
* Creates a new dilation operator for binary images, using a disk with the
26+
* specified radius as structuring element.
27+
*
28+
* @param radius
29+
* the radius of the disk structuring element
30+
*/
2431
public DistanceMapBinaryDilation(double radius)
2532
{
2633
this.radius = radius;

‎src/main/java/inra/ijpb/morphology/binary/DistanceMapBinaryDilation3D.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ public class DistanceMapBinaryDilation3D extends DistanceMapBasedOperator3D
2121
{
2222
double radius;
2323

24+
/**
25+
* Creates a new dilation operator for 3D binary images, using a ball with
26+
* the specified radius as structuring element.
27+
*
28+
* @param radius
29+
* the radius of the ball structuring element
30+
*/
2431
public DistanceMapBinaryDilation3D(double radius)
2532
{
2633
this.radius = radius;

‎src/main/java/inra/ijpb/morphology/binary/DistanceMapBinaryErosion.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ public class DistanceMapBinaryErosion extends DistanceMapBasedOperator
2121
{
2222
double radius;
2323

24+
/**
25+
* Creates a new erosion operator for binary images, using a disk with the
26+
* specified radius as structuring element.
27+
*
28+
* @param radius
29+
* the radius of the disk structuring element
30+
*/
2431
public DistanceMapBinaryErosion(double radius)
2532
{
2633
this.radius = radius;

‎src/main/java/inra/ijpb/morphology/binary/DistanceMapBinaryErosion3D.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@ public class DistanceMapBinaryErosion3D extends DistanceMapBasedOperator3D
2020
{
2121
double radius;
2222

23+
/**
24+
* Creates a new erosion operator for 3D binary images, using a ball with
25+
* the specified radius as structuring element.
26+
*
27+
* @param radius
28+
* the radius of the ball structuring element
29+
*/
2330
public DistanceMapBinaryErosion3D(double radius)
2431
{
2532
this.radius = radius;

‎src/main/java/inra/ijpb/morphology/binary/DistanceMapBinaryOpening.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ public class DistanceMapBinaryOpening extends DistanceMapBasedOperator
2121
{
2222
double radius;
2323

24+
/**
25+
* Creates a new opening operator for binary images, using a disk with the
26+
* specified radius as structuring element.
27+
*
28+
* @param radius
29+
* the radius of the disk structuring element
30+
*/
2431
public DistanceMapBinaryOpening(double radius)
2532
{
2633
this.radius = radius;

‎src/main/java/inra/ijpb/morphology/binary/DistanceMapBinaryOpening3D.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@ public class DistanceMapBinaryOpening3D extends DistanceMapBasedOperator3D
2020
{
2121
double radius;
2222

23+
/**
24+
* Creates a new opening operator for 3D binary images, using a ball with
25+
* the specified radius as structuring element.
26+
*
27+
* @param radius
28+
* the radius of the ball structuring element
29+
*/
2330
public DistanceMapBinaryOpening3D(double radius)
2431
{
2532
this.radius = radius;

‎src/main/java/inra/ijpb/morphology/binary/Relational.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ public void process(ImageStack image, double value, ImageStack target)
405405
* the 3D image to process
406406
* @param value
407407
* the value to use as threshold
408-
* @param image
408+
* @param target
409409
* the 3D image containing the results the comparison of each
410410
* element within the input image with the specified value.
411411
*/

0 commit comments

Comments
 (0)