From 4c634578437edf1d66003c80706ef566a1c9748b Mon Sep 17 00:00:00 2001 From: ctrebeau <ctrebeau@pasteur.fr> Date: Fri, 6 May 2022 14:00:28 +0200 Subject: [PATCH] Comments update --- .../ida/zellige/gui/SelectionController.java | 2 ++ .../classification/OtsuClassification.java | 18 +++++++++--------- .../utils/jzy3D/HeightMapArrayWriter.java | 6 ------ .../utils/jzy3D/SelectedPixelsArrayWriter.java | 7 +------ 4 files changed, 12 insertions(+), 21 deletions(-) diff --git a/src/main/java/fr/pasteur/ida/zellige/gui/SelectionController.java b/src/main/java/fr/pasteur/ida/zellige/gui/SelectionController.java index 6bf4ef58..9c83aca5 100644 --- a/src/main/java/fr/pasteur/ida/zellige/gui/SelectionController.java +++ b/src/main/java/fr/pasteur/ida/zellige/gui/SelectionController.java @@ -246,6 +246,8 @@ public class SelectionController implements Initializable /** * Displays the slice of the classified stack according to the value of the Z Slider. + * + * @param value the z value */ public void refreshDisplay( int value ) { diff --git a/src/main/java/fr/pasteur/ida/zellige/steps/selection/classification/OtsuClassification.java b/src/main/java/fr/pasteur/ida/zellige/steps/selection/classification/OtsuClassification.java index 654db06b..ce5ee18a 100644 --- a/src/main/java/fr/pasteur/ida/zellige/steps/selection/classification/OtsuClassification.java +++ b/src/main/java/fr/pasteur/ida/zellige/steps/selection/classification/OtsuClassification.java @@ -106,10 +106,10 @@ public class OtsuClassification< T extends RealType< T > & NativeType< T > > } /** - * @param input - * @param factory - * @param <T> - * @return + * @param input the input image as a {@link RandomAccessibleInterval} + * @param factory the {@link ImgFactory} of the input image + * @param <T> the type on the input + * @return an {@link Img} */ public static < T extends RealType< T > & NativeType< T > > Img< T > computeOtsuImage( final RandomAccessibleInterval< T > input, ImgFactory< T > factory ) { @@ -120,11 +120,11 @@ public class OtsuClassification< T extends RealType< T > & NativeType< T > > /** - * @param input - * @param grid - * @param userThreshold - * @param <T> - * @return + * @param input the input image as a {@link RandomAccessibleInterval} + * @param grid the local thresholds image as a {@link RandomAccessibleInterval} + * @param userThreshold the user threshold + * @param <T> the type on the input + * @return the classified image as an {@link Img} */ public static < T extends RealType< T > & NativeType< T > > Img< BitType > applyLocalThreshold( IterableInterval< T > input, IterableInterval< T > grid, int userThreshold ) diff --git a/src/main/java/fr/pasteur/ida/zellige/utils/jzy3D/HeightMapArrayWriter.java b/src/main/java/fr/pasteur/ida/zellige/utils/jzy3D/HeightMapArrayWriter.java index 856a9c59..ceabd5a8 100644 --- a/src/main/java/fr/pasteur/ida/zellige/utils/jzy3D/HeightMapArrayWriter.java +++ b/src/main/java/fr/pasteur/ida/zellige/utils/jzy3D/HeightMapArrayWriter.java @@ -28,7 +28,6 @@ */ package fr.pasteur.ida.zellige.utils.jzy3D; -import fr.pasteur.ida.zellige.element.Surface; import fr.pasteur.ida.zellige.utils.test.CSVWriter; import io.scif.img.IO; import io.scif.img.SCIFIOImgPlus; @@ -58,11 +57,6 @@ public class HeightMapArrayWriter< T extends RealType< T > & NativeType< T > > e init(); } - /** - * Displays the local maximums found using jzy3D package. - * - * @param surface the {@link Surface} to display - */ public static < T extends RealType< T > & NativeType< T > > void writeHeightMap( Img< T > surface, String originalInput, int surfaceNumber ) { try diff --git a/src/main/java/fr/pasteur/ida/zellige/utils/jzy3D/SelectedPixelsArrayWriter.java b/src/main/java/fr/pasteur/ida/zellige/utils/jzy3D/SelectedPixelsArrayWriter.java index 307232b8..0f7d7fe1 100644 --- a/src/main/java/fr/pasteur/ida/zellige/utils/jzy3D/SelectedPixelsArrayWriter.java +++ b/src/main/java/fr/pasteur/ida/zellige/utils/jzy3D/SelectedPixelsArrayWriter.java @@ -29,7 +29,6 @@ package fr.pasteur.ida.zellige.utils.jzy3D; import fr.pasteur.ida.zellige.element.Pixels; -import fr.pasteur.ida.zellige.element.Surface; import fr.pasteur.ida.zellige.utils.test.CSVWriter; import org.jzy3d.analysis.AbstractAnalysis; @@ -49,11 +48,7 @@ public class SelectedPixelsArrayWriter extends AbstractAnalysis init(); } - /** - * Displays the local maximums found using jzy3D package. - * - * @param selectedPixels the {@link Surface} to display - */ + public static void writeSelectedPixels( Pixels[][] selectedPixels, String originalInput ) { try -- GitLab