From d4c8a3418ab2ad321275f801546200f2e1356723 Mon Sep 17 00:00:00 2001
From: Amandine Tournay <amandine.tournay@pasteur.fr>
Date: Mon, 21 Sep 2020 14:19:09 +0200
Subject: [PATCH] Fixed Javadoc errors
---
pom.xml | 2 +-
.../sequenceblocks/infos/EzVarColormap.java | 1 +
.../tprovoost/sequenceblocks/infos/GetMetaData.java | 13 +++++++------
.../sequenceblocks/infos/GetResolution.java | 13 +++++++------
.../sequenceblocks/infos/ReadMetadata.java | 13 +++++++------
.../sequenceblocks/infos/SetResolution.java | 13 +++++++------
.../tprovoost/sequenceblocks/infos/VarColormap.java | 2 ++
7 files changed, 32 insertions(+), 25 deletions(-)
diff --git a/pom.xml b/pom.xml
index 7c8b1fb..67f9386 100644
--- a/pom.xml
+++ b/pom.xml
@@ -11,7 +11,7 @@
</parent>
<artifactId>icy-sequence-blocks</artifactId>
- <version>2.0.15</version>
+ <version>2.0.16</version>
<name>SequenceBlocks</name>
diff --git a/src/main/java/plugins/tprovoost/sequenceblocks/infos/EzVarColormap.java b/src/main/java/plugins/tprovoost/sequenceblocks/infos/EzVarColormap.java
index d3fd86c..a810bec 100644
--- a/src/main/java/plugins/tprovoost/sequenceblocks/infos/EzVarColormap.java
+++ b/src/main/java/plugins/tprovoost/sequenceblocks/infos/EzVarColormap.java
@@ -11,6 +11,7 @@ public class EzVarColormap extends EzVar<IcyColorMap>
*
* @param varName
* the parameter name
+ * @param defaultValue IcyColorMap
*/
public EzVarColormap(String varName, IcyColorMap defaultValue)
{
diff --git a/src/main/java/plugins/tprovoost/sequenceblocks/infos/GetMetaData.java b/src/main/java/plugins/tprovoost/sequenceblocks/infos/GetMetaData.java
index 0145c1f..db267be 100644
--- a/src/main/java/plugins/tprovoost/sequenceblocks/infos/GetMetaData.java
+++ b/src/main/java/plugins/tprovoost/sequenceblocks/infos/GetMetaData.java
@@ -2,6 +2,7 @@ package plugins.tprovoost.sequenceblocks.infos;
import java.awt.Rectangle;
+import icy.math.UnitUtil;
import icy.plugin.abstract_.Plugin;
import icy.plugin.interface_.PluginBundled;
import icy.sequence.Sequence;
@@ -28,13 +29,13 @@ public class GetMetaData extends Plugin implements SequenceBlock, PluginBundled
final protected Var<OMEXMLMetadata> metaData = new Var<OMEXMLMetadata>("Metadata", OMEXMLMetadata.class);
final protected VarString name = new VarString("Name", "");
final protected VarInteger seriesIndex = new VarInteger("Series index", 0);
- final protected VarDouble pxSizeX = new VarDouble("Pixel Size X (µm)", 1d);
- final protected VarDouble pxSizeY = new VarDouble("Pixel Size Y (µm)", 1d);
- final protected VarDouble pxSizeZ = new VarDouble("Pixel Size Z (µm)", 1d);
+ final protected VarDouble pxSizeX = new VarDouble("Pixel Size X (" + UnitUtil.MICRO_STRING + "m)", 1d);
+ final protected VarDouble pxSizeY = new VarDouble("Pixel Size Y (" + UnitUtil.MICRO_STRING + "m)", 1d);
+ final protected VarDouble pxSizeZ = new VarDouble("Pixel Size Z (" + UnitUtil.MICRO_STRING + "m)", 1d);
final protected VarDouble timeIntT = new VarDouble("Time interval T (s)", 100d);
- final protected VarDouble positionX = new VarDouble("Position X (µm)", 0d);
- final protected VarDouble positionY = new VarDouble("Position Y (µm)", 0d);
- final protected VarDouble positionZ = new VarDouble("Position Z (µm)", 0d);
+ final protected VarDouble positionX = new VarDouble("Position X (" + UnitUtil.MICRO_STRING + "m)", 0d);
+ final protected VarDouble positionY = new VarDouble("Position Y (" + UnitUtil.MICRO_STRING + "m)", 0d);
+ final protected VarDouble positionZ = new VarDouble("Position Z (" + UnitUtil.MICRO_STRING + "m)", 0d);
final protected VarInteger originResolution = new VarInteger("Resolution", 0);
final protected Var<Rectangle> originRegion = new Var<Rectangle>("Region", new Rectangle());
final protected VarInteger originZMin = new VarInteger("Z min", -1);
diff --git a/src/main/java/plugins/tprovoost/sequenceblocks/infos/GetResolution.java b/src/main/java/plugins/tprovoost/sequenceblocks/infos/GetResolution.java
index aa738a9..053d573 100644
--- a/src/main/java/plugins/tprovoost/sequenceblocks/infos/GetResolution.java
+++ b/src/main/java/plugins/tprovoost/sequenceblocks/infos/GetResolution.java
@@ -1,5 +1,6 @@
package plugins.tprovoost.sequenceblocks.infos;
+import icy.math.UnitUtil;
import icy.plugin.abstract_.Plugin;
import icy.plugin.interface_.PluginBundled;
import icy.sequence.Sequence;
@@ -20,9 +21,9 @@ import plugins.tprovoost.sequenceblocks.SequenceBlocks;
public class GetResolution extends Plugin implements SequenceBlock, PluginBundled
{
final protected VarSequence varSequence = new VarSequence("Sequence", null);
- final protected VarDouble pxSizeX = new VarDouble("Pixel Size X (µm)", 1d);
- final protected VarDouble pxSizeY = new VarDouble("Pixel Size Y (µm)", 1d);
- final protected VarDouble pxSizeZ = new VarDouble("Pixel Size Z (µm)", 1d);
+ final protected VarDouble pxSizeX = new VarDouble("Pixel Size X (" + UnitUtil.MICRO_STRING + "m)", 1d);
+ final protected VarDouble pxSizeY = new VarDouble("Pixel Size Y (" + UnitUtil.MICRO_STRING + "m)", 1d);
+ final protected VarDouble pxSizeZ = new VarDouble("Pixel Size Z (" + UnitUtil.MICRO_STRING + "m)", 1d);
final protected VarDouble timeIntT = new VarDouble("Time interval T (s)", 0.1d);
@Override
@@ -51,9 +52,9 @@ public class GetResolution extends Plugin implements SequenceBlock, PluginBundle
@Override
public void declareOutput(VarList outputMap)
{
- outputMap.add("Pixel Size X (µm)", pxSizeX);
- outputMap.add("Pixel Size Y (µm)", pxSizeY);
- outputMap.add("Pixel Size Z (µm)", pxSizeZ);
+ outputMap.add("Pixel Size X (" + UnitUtil.MICRO_STRING + "m)", pxSizeX);
+ outputMap.add("Pixel Size Y (" + UnitUtil.MICRO_STRING + "m)", pxSizeY);
+ outputMap.add("Pixel Size Z (" + UnitUtil.MICRO_STRING + "m)", pxSizeZ);
outputMap.add("Time interval T (s)", timeIntT);
}
diff --git a/src/main/java/plugins/tprovoost/sequenceblocks/infos/ReadMetadata.java b/src/main/java/plugins/tprovoost/sequenceblocks/infos/ReadMetadata.java
index e492453..1abdef6 100644
--- a/src/main/java/plugins/tprovoost/sequenceblocks/infos/ReadMetadata.java
+++ b/src/main/java/plugins/tprovoost/sequenceblocks/infos/ReadMetadata.java
@@ -1,5 +1,6 @@
package plugins.tprovoost.sequenceblocks.infos;
+import icy.math.UnitUtil;
import icy.plugin.abstract_.Plugin;
import icy.plugin.interface_.PluginBundled;
import icy.plugin.interface_.PluginLibrary;
@@ -33,13 +34,13 @@ public class ReadMetadata extends Plugin implements SequenceBlock, PluginLibrary
final protected VarInteger sizeC = new VarInteger("Size C", 1);
final protected VarInteger sizeZ = new VarInteger("Size Z", 1);
final protected VarInteger sizeT = new VarInteger("Size T", 1);
- final protected VarDouble pxSizeX = new VarDouble("Pixel Size X (µm)", 1d);
- final protected VarDouble pxSizeY = new VarDouble("Pixel Size Y (µm)", 1d);
- final protected VarDouble pxSizeZ = new VarDouble("Pixel Size Z (µm)", 1d);
+ final protected VarDouble pxSizeX = new VarDouble("Pixel Size X (" + UnitUtil.MICRO_STRING + "m)", 1d);
+ final protected VarDouble pxSizeY = new VarDouble("Pixel Size Y (" + UnitUtil.MICRO_STRING + "m)", 1d);
+ final protected VarDouble pxSizeZ = new VarDouble("Pixel Size Z (" + UnitUtil.MICRO_STRING + "m)", 1d);
final protected VarDouble timeIntT = new VarDouble("Time interval T (s)", 100d);
- final protected VarDouble positionX = new VarDouble("Position X (µm)", 0d);
- final protected VarDouble positionY = new VarDouble("Position Y (µm)", 0d);
- final protected VarDouble positionZ = new VarDouble("Position Z (µm)", 0d);
+ final protected VarDouble positionX = new VarDouble("Position X (" + UnitUtil.MICRO_STRING + "m)", 0d);
+ final protected VarDouble positionY = new VarDouble("Position Y (" + UnitUtil.MICRO_STRING + "m)", 0d);
+ final protected VarDouble positionZ = new VarDouble("Position Z (" + UnitUtil.MICRO_STRING + "m)", 0d);
@Override
public void run()
diff --git a/src/main/java/plugins/tprovoost/sequenceblocks/infos/SetResolution.java b/src/main/java/plugins/tprovoost/sequenceblocks/infos/SetResolution.java
index e821818..2fb2bbc 100644
--- a/src/main/java/plugins/tprovoost/sequenceblocks/infos/SetResolution.java
+++ b/src/main/java/plugins/tprovoost/sequenceblocks/infos/SetResolution.java
@@ -1,5 +1,6 @@
package plugins.tprovoost.sequenceblocks.infos;
+import icy.math.UnitUtil;
import icy.plugin.abstract_.Plugin;
import icy.plugin.interface_.PluginBundled;
import icy.sequence.Sequence;
@@ -16,9 +17,9 @@ import plugins.tprovoost.sequenceblocks.SequenceBlocks;
public class SetResolution extends Plugin implements SequenceBlock, PluginBundled
{
final protected VarSequence varSequence = new VarSequence("Sequence", null);
- final protected VarDouble pxSizeX = new VarDouble("Pixel Size X (µm)", 1d);
- final protected VarDouble pxSizeY = new VarDouble("Pixel Size Y (µm)", 1d);
- final protected VarDouble pxSizeZ = new VarDouble("Pixel Size Z (µm)", 1d);
+ final protected VarDouble pxSizeX = new VarDouble("Pixel Size X (" + UnitUtil.MICRO_STRING + "m)", 1d);
+ final protected VarDouble pxSizeY = new VarDouble("Pixel Size Y (" + UnitUtil.MICRO_STRING + "m)", 1d);
+ final protected VarDouble pxSizeZ = new VarDouble("Pixel Size Z (" + UnitUtil.MICRO_STRING + "m)", 1d);
final protected VarDouble timeIntT = new VarDouble("Time interval T (s)", 100d);
@Override
@@ -50,9 +51,9 @@ public class SetResolution extends Plugin implements SequenceBlock, PluginBundle
public void declareInput(VarList inputMap)
{
inputMap.add("sequence", varSequence);
- inputMap.add("PxSize X (µm)", pxSizeX);
- inputMap.add("PxSize Y (µm)", pxSizeY);
- inputMap.add("PxSize Z (µm)", pxSizeZ);
+ inputMap.add("PxSize X (" + UnitUtil.MICRO_STRING + "m)", pxSizeX);
+ inputMap.add("PxSize Y (" + UnitUtil.MICRO_STRING + "m)", pxSizeY);
+ inputMap.add("PxSize Z (" + UnitUtil.MICRO_STRING + "m)", pxSizeZ);
inputMap.add("Time interval T (s)", timeIntT);
}
diff --git a/src/main/java/plugins/tprovoost/sequenceblocks/infos/VarColormap.java b/src/main/java/plugins/tprovoost/sequenceblocks/infos/VarColormap.java
index 017f8b9..bd81d7b 100644
--- a/src/main/java/plugins/tprovoost/sequenceblocks/infos/VarColormap.java
+++ b/src/main/java/plugins/tprovoost/sequenceblocks/infos/VarColormap.java
@@ -38,6 +38,8 @@ public class VarColormap extends Var<IcyColorMap>
/**
* Create a new VarColormap with given name and default value
+ * @param name String
+ * @param defaultValue IcyColorMap
*/
public VarColormap(String name, IcyColorMap defaultValue)
{
--
GitLab