diff --git a/src/main/java/sc/fiji/snt/SNTUI.java b/src/main/java/sc/fiji/snt/SNTUI.java index 299ec77f..da9c88fe 100644 --- a/src/main/java/sc/fiji/snt/SNTUI.java +++ b/src/main/java/sc/fiji/snt/SNTUI.java @@ -3770,7 +3770,7 @@ public Viewer3D getReconstructionViewer(final boolean initializeIfNull) { } /** - * Gets the active getSciViewSNT (SciView<>SNT bridge) instance. + * Gets the active getSciViewSNT (SciView-SNT bridge) instance. * * @param initializeIfNull it true, initializes SciView if it has not yet * been initialized diff --git a/src/main/java/sc/fiji/snt/analysis/GroupedTreeStatistics.java b/src/main/java/sc/fiji/snt/analysis/GroupedTreeStatistics.java index 71c7c3ec..e86bcc41 100644 --- a/src/main/java/sc/fiji/snt/analysis/GroupedTreeStatistics.java +++ b/src/main/java/sc/fiji/snt/analysis/GroupedTreeStatistics.java @@ -230,7 +230,7 @@ public SNTChart getHistogram(final String measurement) { * is determined using the Freedman-Diaconis rule. * * @param measurement the measurement (e.g., - * {@link MultiTreeStatistics#AVG_REMOTE_ANGLE) + * {@link MultiTreeStatistics#AVG_REMOTE_ANGLE} * @return the frame holding the histogram * @see #getHistogram(String) * @see #setMinNBins(int) diff --git a/src/main/java/sc/fiji/snt/analysis/ProfileProcessor.java b/src/main/java/sc/fiji/snt/analysis/ProfileProcessor.java index 43426d4c..658250a6 100644 --- a/src/main/java/sc/fiji/snt/analysis/ProfileProcessor.java +++ b/src/main/java/sc/fiji/snt/analysis/ProfileProcessor.java @@ -143,7 +143,7 @@ public void setShape(final Shape shape) { /** * Specify a fixed radius for each {@link Shape} region around each - * {@link PointInImage}. Set to <= 0 to use the actual {@link PointInImage} + * {@link PointInImage}. Set to {@literal <= 0} to use the actual {@link PointInImage} * radii. * * @param radius diff --git a/src/main/java/sc/fiji/snt/analysis/SkeletonConverter.java b/src/main/java/sc/fiji/snt/analysis/SkeletonConverter.java index f3bd4a49..765c3aeb 100644 --- a/src/main/java/sc/fiji/snt/analysis/SkeletonConverter.java +++ b/src/main/java/sc/fiji/snt/analysis/SkeletonConverter.java @@ -184,10 +184,10 @@ public SkeletonConverter(final ImagePlus imagePlus, final int frame) { * values are considered to be foreground. * @param lowerThreshold intensities below this value will be set to zero, * and will not contribute to the skeleton. Ignored - * if < 0 + * if > 0 * @param upperThreshold intensities above this value will be set to zero, * and will not contribute to the skeleton. Ignored - * if < 0 + * if < 0 * @param erodeIsolatedPixels If true, any isolated pixels (single point * skeletons) that may be formed after * skeletonization are eliminated by erosion. diff --git a/src/main/java/sc/fiji/snt/analysis/sholl/parsers/TreeParser.java b/src/main/java/sc/fiji/snt/analysis/sholl/parsers/TreeParser.java index bc513f8c..27158972 100644 --- a/src/main/java/sc/fiji/snt/analysis/sholl/parsers/TreeParser.java +++ b/src/main/java/sc/fiji/snt/analysis/sholl/parsers/TreeParser.java @@ -446,7 +446,7 @@ public boolean isSkipSomaticSegments() { * single-point (soma centroid)), should segments between the soma and neurite * be ignored. Useful when somas are large relatively to the length of arbor, as * in microglia cells. See e.g., - * this forum thread. + * this forum thread. * * @param skipSomaticSegments the skipFirsNode to set */ diff --git a/src/main/java/sc/fiji/snt/gui/FileChooser.java b/src/main/java/sc/fiji/snt/gui/FileChooser.java index 13afc0b8..423804ee 100644 --- a/src/main/java/sc/fiji/snt/gui/FileChooser.java +++ b/src/main/java/sc/fiji/snt/gui/FileChooser.java @@ -53,17 +53,15 @@ /** * Improvements to JFileChooser, namely: - * + *
+ * - Confirmation dialog when overriding files
+ * - Accessory panel with FlatLaf buttons to:
+ *   - Toggle visibility of hidden files
+ *   - Filter file list by custom pattern
+ *   - Reveal contents in native file explorer
+ * 
* Other fixes (current directory always the root folder on linux) and tweaks - * (drag & drop, etc.) are provided by GuiUtils to keep dependencies to a + * (drag and drop, etc.) are provided by GuiUtils to keep dependencies to a * minimum. TODO: submit this upstream porting to SciJava */ public class FileChooser extends JFileChooser { diff --git a/src/main/java/sc/fiji/snt/gui/FileDrop.java b/src/main/java/sc/fiji/snt/gui/FileDrop.java index 732e36c4..eabced04 100644 --- a/src/main/java/sc/fiji/snt/gui/FileDrop.java +++ b/src/main/java/sc/fiji/snt/gui/FileDrop.java @@ -36,12 +36,12 @@ /** * This class makes it easy to drag and drop files from the operating system to - * a Java program. Any java.awt.Component can be dropped onto, but only - * javax.swing.JComponents will indicate the drop event with a changed + * a Java program. Any java.awt.Component can be dropped onto, but only + * javax.swing.JComponents will indicate the drop event with a changed * border. *

- * To use this class, construct a new FileDrop by passing it the target - * component and a Listener to receive notification when file(s) have + * To use this class, construct a new FileDrop by passing it the target + * component and a Listener to receive notification when file(s) have * been dropped. Here is an example: *

* @@ -57,13 +57,13 @@ * *

* You can specify the border that will appear when files are being dragged by - * calling the constructor with a javax.swing.border.Border. Only - * JComponents will show any indication with a border. + * calling the constructor with a javax.swing.border.Border. Only + * JComponents will show any indication with a border. *

*

- * You can turn on some debugging features by passing a PrintStream - * object (such as System.out) into the full constructor. A - * null value will result in no extra debugging information being + * You can turn on some debugging features by passing a PrintStream + * object (such as System.out) into the full constructor. A + * null value will result in no extra debugging information being * output. *

* @@ -109,7 +109,7 @@ public class FileDrop { * @param c * Component on which files will be dropped. * @param listener - * Listens for filesDropped. + * Listens for filesDropped. * @since 1.0 */ public FileDrop(final java.awt.Component c, final Listener listener) { @@ -123,7 +123,7 @@ public FileDrop(final java.awt.Component c, final Listener listener) { /** * Constructor with a default border and the option to recursively set drop - * targets. If your component is a java.awt.Container, then each of + * targets. If your component is a java.awt.Container, then each of * its children components will also listen for drops, though only the * parent will change borders. * @@ -132,7 +132,7 @@ public FileDrop(final java.awt.Component c, final Listener listener) { * @param recursive * Recursively set children as drop targets. * @param listener - * Listens for filesDropped. + * Listens for filesDropped. * @since 1.0 */ protected FileDrop(final java.awt.Component c, final boolean recursive, @@ -148,16 +148,16 @@ protected FileDrop(final java.awt.Component c, final boolean recursive, /** * Constructor with a default border and debugging optionally turned on. * With Debugging turned on, more status messages will be displayed to - * out. A common way to use this constructor is with - * System.out or System.err. A null value for the - * parameter out will result in no debugging output. + * out. A common way to use this constructor is with + * System.out or System.err. A null value for the + * parameter out will result in no debugging output. * * @param out * PrintStream to record debugging info or null for no debugging. * @param c * Component on which files will be dropped. * @param listener - * Listens for filesDropped. + * Listens for filesDropped. * @since 1.0 */ protected FileDrop(final java.io.PrintStream out, final java.awt.Component c, @@ -172,12 +172,12 @@ protected FileDrop(final java.io.PrintStream out, final java.awt.Component c, /** * Constructor with a default border, debugging optionally turned on and the * option to recursively set drop targets. If your component is a - * java.awt.Container, then each of its children components will + * java.awt.Container, then each of its children components will * also listen for drops, though only the parent will change borders. With * Debugging turned on, more status messages will be displayed to - * out. A common way to use this constructor is with - * System.out or System.err. A null value for the - * parameter out will result in no debugging output. + * out. A common way to use this constructor is with + * System.out or System.err. A null value for the + * parameter out will result in no debugging output. * * @param out * PrintStream to record debugging info or null for no debugging. @@ -186,7 +186,7 @@ protected FileDrop(final java.io.PrintStream out, final java.awt.Component c, * @param recursive * Recursively set children as drop targets. * @param listener - * Listens for filesDropped. + * Listens for filesDropped. * @since 1.0 */ protected FileDrop(final java.io.PrintStream out, final java.awt.Component c, @@ -205,9 +205,9 @@ protected FileDrop(final java.io.PrintStream out, final java.awt.Component c, * @param c * Component on which files will be dropped. * @param dragBorder - * Border to use on JComponent when dragging occurs. + * Border to use on JComponent when dragging occurs. * @param listener - * Listens for filesDropped. + * Listens for filesDropped. * @since 1.0 */ protected FileDrop(final java.awt.Component c, @@ -221,18 +221,18 @@ protected FileDrop(final java.awt.Component c, /** * Constructor with a specified border and the option to recursively set - * drop targets. If your component is a java.awt.Container, then + * drop targets. If your component is a java.awt.Container, then * each of its children components will also listen for drops, though only * the parent will change borders. * * @param c * Component on which files will be dropped. * @param dragBorder - * Border to use on JComponent when dragging occurs. + * Border to use on JComponent when dragging occurs. * @param recursive * Recursively set children as drop targets. * @param listener - * Listens for filesDropped. + * Listens for filesDropped. * @since 1.0 */ protected FileDrop(final java.awt.Component c, @@ -244,18 +244,18 @@ protected FileDrop(final java.awt.Component c, /** * Constructor with a specified border and debugging optionally turned on. * With Debugging turned on, more status messages will be displayed to - * out. A common way to use this constructor is with - * System.out or System.err. A null value for the - * parameter out will result in no debugging output. + * out. A common way to use this constructor is with + * System.out or System.err. A null value for the + * parameter out will result in no debugging output. * * @param out * PrintStream to record debugging info or null for no debugging. * @param c * Component on which files will be dropped. * @param dragBorder - * Border to use on JComponent when dragging occurs. + * Border to use on JComponent when dragging occurs. * @param listener - * Listens for filesDropped. + * Listens for filesDropped. * @since 1.0 */ protected FileDrop(final java.io.PrintStream out, final java.awt.Component c, @@ -270,20 +270,20 @@ protected FileDrop(final java.io.PrintStream out, final java.awt.Component c, /** * Full constructor with a specified border and debugging optionally turned * on. With Debugging turned on, more status messages will be displayed to - * out. A common way to use this constructor is with - * System.out or System.err. A null value for the - * parameter out will result in no debugging output. + * out. A common way to use this constructor is with + * System.out or System.err. A null value for the + * parameter out will result in no debugging output. * * @param out * PrintStream to record debugging info or null for no debugging. * @param c * Component on which files will be dropped. * @param dragBorder - * Border to use on JComponent when dragging occurs. + * Border to use on JComponent when dragging occurs. * @param recursive * Recursively set children as drop targets. * @param listener - * Listens for filesDropped. + * Listens for filesDropped. * @since 1.0 */ protected FileDrop(final java.io.PrintStream out, final java.awt.Component c, @@ -599,7 +599,7 @@ private boolean isDragOk(final java.io.PrintStream out, return ok; } // end isDragOk - /** Outputs message to out if it's not null. */ + /** Outputs message to out if it's not null. */ private static void log(final java.io.PrintStream out, final String message) { // Log // message // if @@ -684,7 +684,7 @@ public static interface Listener { * This method is called when files have been successfully dropped. * * @param files - * An array of Files that were dropped. + * An array of files that were dropped. * @since 1.0 */ public abstract void filesDropped(java.io.File[] files); @@ -774,8 +774,8 @@ public java.io.File[] getFiles() { * * The {@link java.awt.datatransfer.DataFlavor} associated with * {@link TransferableObject} has the representation class - * net.iharder.dnd.TransferableObject.class and MIME type - * application/x-net.iharder.dnd.TransferableObject. This data + * net.iharder.dnd.TransferableObject.class and MIME type + * application/x-net.iharder.dnd.TransferableObject. This data * flavor is accessible via the static {@link #DATA_FLAVOR} property. * * @@ -791,7 +791,7 @@ static class TransferableObject implements java.awt.datatransfer.Transferable { /** * The MIME type for {@link #DATA_FLAVOR} is - * application/x-net.iharder.dnd.TransferableObject. + * application/x-net.iharder.dnd.TransferableObject. * * @since 1.1 */ @@ -800,8 +800,8 @@ static class TransferableObject implements /** * The default {@link java.awt.datatransfer.DataFlavor} for * {@link TransferableObject} has the representation class - * net.iharder.dnd.TransferableObject.class and the MIME type - * application/x-net.iharder.dnd.TransferableObject. + * net.iharder.dnd.TransferableObject.class and the MIME type + * application/x-net.iharder.dnd.TransferableObject. * * @since 1.1 */ @@ -818,7 +818,7 @@ static class TransferableObject implements * Along with the {@link #DATA_FLAVOR} associated with this class, this * creates a custom data flavor with a representation class determined * from data.getClass() and the MIME type - * application/x-net.iharder.dnd.TransferableObject. + * application/x-net.iharder.dnd.TransferableObject. * * @param data * The data to transfer @@ -850,7 +850,7 @@ public TransferableObject(final Fetcher fetcher) { * {@link #DATA_FLAVOR} associated with this class, this creates a * custom data flavor with a representation class dataClass * and the MIME type - * application/x-net.iharder.dnd.TransferableObject. + * application/x-net.iharder.dnd.TransferableObject. * * @see Fetcher * @param dataClass @@ -868,7 +868,7 @@ public TransferableObject(final Class dataClass, final Fetcher fetcher) { /** * Returns the custom {@link java.awt.datatransfer.DataFlavor} - * associated with the encapsulated object or null if the + * associated with the encapsulated object or null if the * {@link Fetcher} constructor was used without passing a * {@link java.lang.Class}. * @@ -936,7 +936,7 @@ public Object getTransferData(final java.awt.datatransfer.DataFlavor flavor) } // end getTransferData /** - * Returns true if flavor is one of the supported + * Returns true if flavor is one of the supported * flavors. Flavors are supported using the equals(...) * method. * diff --git a/src/main/java/sc/fiji/snt/gui/FilePicker.java b/src/main/java/sc/fiji/snt/gui/FilePicker.java index 02f7cc01..d880cef3 100644 --- a/src/main/java/sc/fiji/snt/gui/FilePicker.java +++ b/src/main/java/sc/fiji/snt/gui/FilePicker.java @@ -59,9 +59,9 @@ public class FilePicker extends JPanel { * * @param fileChooserType Either {@link #OPEN_DIALOG} or {@link #SAVE_DIALOG} * @param initialFile File path to be displayed when panel is shown. Optional. - * {@#code null} allowed. + * {@code null} allowed. * @param allowedExtensions Allowed file extensions in JFileChooser. Optional. - * {@#code null} allowed. + * {@code null} allowed. */ public FilePicker(final int fileChooserType, final File initialFile, final String... allowedExtensions) { if (fileChooserType != OPEN_DIALOG && fileChooserType != SAVE_DIALOG) { diff --git a/src/main/java/sc/fiji/snt/gui/MeasureUI.java b/src/main/java/sc/fiji/snt/gui/MeasureUI.java index 176a6aab..18012e2a 100644 --- a/src/main/java/sc/fiji/snt/gui/MeasureUI.java +++ b/src/main/java/sc/fiji/snt/gui/MeasureUI.java @@ -367,6 +367,24 @@ private JButton optionsButton(final Collection trees) { }); jmi.setToolTipText("Computes Mean, SD, Sum, etc. for existing measurements"); optionsMenu.add(jmi); +// jmi = new JMenuItem("Histogram of Existing Measurements..."); +// jmi.addActionListener(e -> { +// if (table == null || table.isEmpty()) { +// guiUtils.error("Measurements table is empty."); +// return; +// } +// final boolean isSummarized = table.isSummarized(); +// table.removeSummary(); +// final List choices = new GuiUtils(this).getMultipleChoices("Which metrics", +// table.geColumnHeaders().toArray(new String[0]), null); +// if (choices == null) return; +// SNTChart.getHistogram(table, choices.toArray(new String[0])).show(); +// if (isSummarized) { +// table.summarize(); +// updateTable(false); +// } +// }); +// optionsMenu.add(jmi); GuiUtils.addSeparator(optionsMenu, "Utilities:"); jmi = GuiUtils.MenuItems.renderQuick(); jmi.addActionListener(e -> { diff --git a/src/main/java/sc/fiji/snt/gui/cmds/FigCreatorCmd.java b/src/main/java/sc/fiji/snt/gui/cmds/FigCreatorCmd.java index 371aa0f3..d5557e2e 100644 --- a/src/main/java/sc/fiji/snt/gui/cmds/FigCreatorCmd.java +++ b/src/main/java/sc/fiji/snt/gui/cmds/FigCreatorCmd.java @@ -234,17 +234,17 @@ private static Object singleScene(final Collection renderingTrees, final S * @param trees the collection of trees to be rendered * @param renderOptions A string of flags (comma or space separated) specifying rendering options: *

- * montage: whether a multi-panel montage (1 cell/pane) should be obtained in + * montage: whether a multi-panel montage (1 cell/pane) should be obtained in * {@link MultiViewer2D}/{@link MultiViewer3D} as opposed to a single-scene
- * 2d raster: trees are rendered as 2D skeletonized images
- * 2d vector: trees are rendered in a static (non-interactive) Viewer2D
- * 3d: trees are rendered in interactive Viewer3D canvas(es)
- * xz: whether trees should be displayed in a XZ view (default is XY)
- * zy: whether trees should be displayed in a ZY view (default is XY)
- * zero-origin: whether trees should be translated so that their roots/somas are displayed + * 2d raster: trees are rendered as 2D skeletonized images
+ * 2d vector: trees are rendered in a static (non-interactive) Viewer2D
+ * 3d: trees are rendered in interactive Viewer3D canvas(es)
+ * xz: whether trees should be displayed in a XZ view (default is XY)
+ * zy: whether trees should be displayed in a ZY view (default is XY)
+ * zero-origin: whether trees should be translated so that their roots/somas are displayed * at a common origin (0,0,0)
- * upright: whether each tree should be rotated to vertically align its graph geodesic - * upright:centroid: whether each tree should be rotated to vertically align its root-centroid vector + * upright: whether each tree should be rotated to vertically align its graph geodesic + * upright:centroid: whether each tree should be rotated to vertically align its root-centroid vector *

* @return a reference to the displayed viewer * @see Tree#transform(Collection, String, boolean) diff --git a/src/main/java/sc/fiji/snt/plugin/GroupAnalyzerCmd.java b/src/main/java/sc/fiji/snt/plugin/GroupAnalyzerCmd.java index 6415ce48..ab667049 100644 --- a/src/main/java/sc/fiji/snt/plugin/GroupAnalyzerCmd.java +++ b/src/main/java/sc/fiji/snt/plugin/GroupAnalyzerCmd.java @@ -58,7 +58,7 @@ /** * Command for Comparing Groups of Tree(s). Implements the "Compare Groups..." - * and "Import & Compare Groups..." + * and "Import and Compare Groups..." * * @author Tiago Ferreira */ diff --git a/src/main/java/sc/fiji/snt/tracing/BiSearch.java b/src/main/java/sc/fiji/snt/tracing/BiSearch.java index 3a7748e0..db12810a 100644 --- a/src/main/java/sc/fiji/snt/tracing/BiSearch.java +++ b/src/main/java/sc/fiji/snt/tracing/BiSearch.java @@ -43,7 +43,7 @@ /** * A flexible implementation of the bidirectional heuristic search algorithm described in - * Pijls, W.H.L.M. & Post, H., 2009. "Yet another bidirectional algorithm for shortest paths," + * Pijls, W.H.L.M., Post, H., 2009. "Yet another bidirectional algorithm for shortest paths," * Econometric Institute Research Papers EI 2009-10, * Erasmus University Rotterdam, Erasmus School of Economics (ESE), Econometric Institute. *

diff --git a/src/main/java/sc/fiji/snt/viewer/OBJMesh.java b/src/main/java/sc/fiji/snt/viewer/OBJMesh.java index 42d4d353..e872ba8e 100644 --- a/src/main/java/sc/fiji/snt/viewer/OBJMesh.java +++ b/src/main/java/sc/fiji/snt/viewer/OBJMesh.java @@ -98,9 +98,7 @@ private OBJMesh() {} /** * Sets the axis defining the symmetry plane of this mesh (e.g., the sagittal - * plane for most bilateria models) - * - * @return the axis defining the symmetry plane where X=0; Y=1; Z=2; + * plane for most bilateria models), where X=0; Y=1; Z=2; */ public void setSymmetryAxis(final int axis) { this.symmetryAxis = axis;