Skip to content

Commit 7109acd

Browse files
committed
add javadoc to deploy the plugin
1 parent c18fcfe commit 7109acd

10 files changed

+35
-2
lines changed

src/main/java/ai/nets/samj/communication/model/EfficientSAM.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
import ai.nets.samj.models.AbstractSamJ;
3333
import ai.nets.samj.models.EfficientSamJ;
3434
import ai.nets.samj.install.EfficientSamEnvManager;
35+
import ai.nets.samj.install.Sam2EnvManager;
3536
import ai.nets.samj.ui.SAMJLogger;
3637

3738
/**
@@ -69,6 +70,9 @@ public EfficientSAM() {
6970

7071
/**
7172
* Create an instance of the model that loads the model and encodes an image
73+
* @param manager
74+
* the model manager that contains the info about where the model
75+
* environment and model weights are installed
7276
*/
7377
public EfficientSAM(EfficientSamEnvManager manager) {
7478
this.isHeavy = true;

src/main/java/ai/nets/samj/communication/model/EfficientViTSAML0.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,9 @@ public EfficientViTSAML0() {
7272

7373
/**
7474
* Create an instance of the model that loads the model and encodes an image
75+
* @param manager
76+
* the model manager that contains the info about where the model
77+
* environment and model weights are installed
7578
*/
7679
public EfficientViTSAML0(EfficientViTSamEnvManager manager) {
7780
this.isHeavy = false;

src/main/java/ai/nets/samj/communication/model/EfficientViTSAML1.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@ public class EfficientViTSAML1 extends SAMModel {
5454

5555
/**
5656
* Create an instance of the model that loads the model and encodes an image
57+
* @param manager
58+
* the model manager that contains the info about where the model
59+
* environment and model weights are installed
5760
*/
5861
public EfficientViTSAML1() {
5962
this.isHeavy = false;

src/main/java/ai/nets/samj/communication/model/EfficientViTSAML2.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@ public class EfficientViTSAML2 extends SAMModel {
5454

5555
/**
5656
* Create an instance of the model that loads the model and encodes an image
57+
* @param manager
58+
* the model manager that contains the info about where the model
59+
* environment and model weights are installed
5760
*/
5861
public EfficientViTSAML2() {
5962
this.isHeavy = false;

src/main/java/ai/nets/samj/communication/model/EfficientViTSAMXL0.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@ public class EfficientViTSAMXL0 extends SAMModel {
5353

5454
/**
5555
* Create an instance of the model that loads the model and encodes an image
56+
* @param manager
57+
* the model manager that contains the info about where the model
58+
* environment and model weights are installed
5659
*/
5760
public EfficientViTSAMXL0() {
5861
this.isHeavy = false;

src/main/java/ai/nets/samj/communication/model/EfficientViTSAMXL1.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ public class EfficientViTSAMXL1 extends SAMModel {
5555

5656
/**
5757
* Create an instance of the model that loads the model and encodes an image
58+
* @param manager
59+
* the model manager that contains the info about where the model
60+
* environment and model weights are installed
5861
*/
5962
public EfficientViTSAMXL1() {
6063
this.isHeavy = false;

src/main/java/ai/nets/samj/communication/model/SAM2Large.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ public class SAM2Large extends SAMModel {
5555

5656
/**
5757
* Create an instance of the model that loads the model and encodes an image
58+
* @param manager
59+
* the model manager that contains the info about where the model
60+
* environment and model weights are installed
5861
*/
5962
public SAM2Large() {
6063
this.isHeavy = true;

src/main/java/ai/nets/samj/communication/model/SAM2Small.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@ public class SAM2Small extends SAMModel {
5454

5555
/**
5656
* Create an instance of the model that loads the model and encodes an image
57+
* @param manager
58+
* the model manager that contains the info about where the model
59+
* environment and model weights are installed
5760
*/
5861
public SAM2Small() {
5962
this.isHeavy = true;

src/main/java/ai/nets/samj/communication/model/SAM2Tiny.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,9 @@ public SAM2Tiny() {
7272

7373
/**
7474
* Create an instance of the model that loads the model and encodes an image
75+
* @param manager
76+
* the model manager {@link Sam2EnvManager} that contains the info about where the model
77+
* environment and model weights are installed
7578
*/
7679
public SAM2Tiny(Sam2EnvManager manager) {
7780
this.isHeavy = false;

src/main/java/ai/nets/samj/models/AbstractSamJ.java

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ public void setUsinIJRoiManager(boolean isUsingIJRoiManager) {
243243
* @param designationOfTheScript
244244
* the name (or some string to design) of the text that is going to be printed
245245
*/
246-
public <T extends RealType<T> & NativeType<T>> void printScript(final String script, final String designationOfTheScript) {
246+
public void printScript(final String script, final String designationOfTheScript) {
247247
if (!isDebugging) return;
248248
debugPrinter.printText("START: =========== "+designationOfTheScript+" ===========");
249249
debugPrinter.printText(LocalDateTime.now().toString());
@@ -883,7 +883,7 @@ List<Mask> processMask(RandomAccessibleInterval<T> img)
883883
*
884884
* @param <T>
885885
* ImgLib2 datatype of the mask
886-
* @param img
886+
* @param rai
887887
* mask used as the prompt
888888
* @param returnAll
889889
* whether to return all the polygons created by EfficientSAM of only the biggest
@@ -912,6 +912,11 @@ private ArrayList<int[]> getPointsNotInRect(List<int[]> pointsList, List<int[]>
912912
return not;
913913
}
914914

915+
/**
916+
*
917+
* @return a rectangle with the are that is currently encoded. This is the area where annotations can be
918+
* created in real time
919+
*/
915920
public Rectangle getCurrentlyEncodedArea() {
916921
Rectangle alreadyEncoded;
917922
alreadyEncoded = new Rectangle((int) encodeCoords[0], (int) encodeCoords[1],

0 commit comments

Comments
 (0)