Skip to content

Commit

Permalink
correct javadoc to build snapshot
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosuc3m committed Sep 5, 2023
1 parent 6b798a8 commit 382fb7a
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ private static byte[] compress(byte[] arr) throws IOException {
* @param data
* the data corresponding to the input to the model
* @return the output of the server
* @throws ProtocolExceptionif the connection with the server cannot be opened
* @throws ProtocolException if the connection with the server cannot be opened
* or the server is not found
* @throws MalformedURLException if the url is not correct
* @throws IOException if the connection with the server cannot be opened
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -151,8 +151,6 @@ private BioEngineOutput(byte[] rawOutput) throws IOException, Exception {
* @return an object that can be used to provide
* inputs to the BioEngine
* @throws IOException if there is any error deserializing the raw output bytes
* @throws JsonMappingException if there is any error deserializing the raw output bytes
* @throws JsonParseException if there is any error deserializing the raw output bytes
* @throws Exception if the BioEngine sends an error message after execution
*/
public static BioEngineOutput build(byte[] rawOutput) throws IOException,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ private BioEngineOutputArray(String name, HashMap<String, Object> outputMap) thr
* shape of the tensor
* @param buffer
* data of the tensor as a byte array
* @return an understandable tensor
* @throws IllegalArgumentException if the data type of the array is not supported
*/
public BioEngineOutputArray(String name, String dataType, Object shape, byte[] buffer) {
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/io/bioimage/modelrunner/engine/EngineInfo.java
Original file line number Diff line number Diff line change
Expand Up @@ -1101,12 +1101,12 @@ public boolean isBioengine() {
*
* @return the server url where the bioengine is hosted.
* @throws IllegalArgumentException if the method is called when the {@link EngineInfo}
* object has not been created for the Bioengine, with the method {@link #defineBioengine(String, String)}
* object has not been created for the Bioengine, with the method {@link #defineBioengine(String)}
*/
public String getServer() {
if (!isBioengine())
throw new IllegalArgumentException("The Bioengine server can only be retrieved if the "
+ "method EngineInfo.defineBioengine(String, String) has been used to create the object.");
+ "method EngineInfo.defineBioengine(String) has been used to create the object.");
return this.serverURL;
}

Expand Down
26 changes: 16 additions & 10 deletions src/main/java/io/bioimage/modelrunner/tiling/ImgLib2Utils.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@
import net.imglib2.loops.LoopBuilder;

/**
* Class to handle {@link ImgLib2} operations, as mirroring or tiling
* Utility class for {@link ImgLib2} objects.
* Class to handle {@link RandomAccessibleInterval} operations, as mirroring or tiling
*
* @author Carlos Garcia Lopez de Haro and Daniel Felipe Gonzalez Obando
*
Expand All @@ -48,11 +47,13 @@ private ImgLib2Utils()
* Copies values from source to target NDArrays starting at the source offset position as the origin in target NDArrays and taking the given size. This
* method assumes the target NDArray is already initialized with all the needed space.
*
* @param <T>
* possible data types the ImgLib2 object might have
* @param sourceNDArray
* Source data INDArray.
* @param targetNDArray
* Target INDArray.
* @param newSourceOffset
* @param sourceOffset
* Position in source sequence to start the copy from. Must be of length 5.
* @param paddingBottomRight
* the size of the padding at the bottom or right sides for the special case
Expand Down Expand Up @@ -93,15 +94,17 @@ public static < T extends RealType< T > & NativeType< T > > void copyRaiData(Ran
* Takes the {@code INDArray} and adds a mirror on the areas out of the patch (specified by patchStart and patchSize). Boundaries are checked with both
* the input and the patch sequences. The result is added to the {@code patchSequence}.</br>
*
* @param <T>
* ImgLib2 data types the image might have
* @param inputNDArr
* The INDArray the patch was taken from.
* @param patchNDArr
* The patch extracted from the input INDArray.
* @param newPatchStart
* The patch position in the input INDArray. First array start of the
* front padding and second array, start of the back.
* @param patchSize
* The patch size without any padding (the output patch size).
* @param padding
* the padding of the image
*/
public static < T extends RealType< T > & NativeType< T > > void addMirrorToPatchRai(RandomAccessibleInterval<T> inputNDArr, RandomAccessibleInterval<T> patchNDArr,
int[] newPatchStart, int[][] padding) {
Expand Down Expand Up @@ -130,20 +133,23 @@ public static < T extends RealType< T > & NativeType< T > > void addMirrorToPatc
* Uses the {@code patchSequence} to fill the {@code resultSequence} at the {@code resultOffset} position. The copied interval in the patch is given by the
* {@code patchOffset} and the {@code patchSize}.</br>
*
* @param <T>
* possible ImgLib2 data types the {@link RandomAccessibleInterval} might have
* @param resultNDArray
* The sequence where the data is pasted at.
* @param patchNDArray
* The sequence where the data is copied from.
* @param newResultOffset
* @param resultOffset
* The position in the result sequence where the data is pasted.
* @param patchOffset5D
* @param paddingFront
* The position in the patch sequence where the copy starts.
* @param areaOfInterestSize5D
* @param areaOfInterestSize
* The length on each axis to be copied from the patch sequence.
* This size only corresponds to the area of interest, the pixels
* corresponding to padding are left out
*/
public static < T extends RealType< T > & NativeType< T > > void fillRaiAt(RandomAccessibleInterval<T> resultNDArray, RandomAccessibleInterval<T> patchNDArray, int[] resultOffset,
public static < T extends RealType< T > & NativeType< T > > void fillRaiAt(RandomAccessibleInterval<T> resultNDArray,
RandomAccessibleInterval<T> patchNDArray, int[] resultOffset,
int[] paddingFront, int[] areaOfInterestSize)
{
long[] finalSize = resultNDArray.dimensionsAsLongArray();
Expand Down Expand Up @@ -223,7 +229,7 @@ public static int[] to5DFillWith1(int[] arr) {
}

/**
* Creates an array containing the size of the given {@link NDArray}.
* Creates an array containing the size of the given {@link RandomAccessibleInterval}.
* It is the same as teh shape
*
* @param s
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,6 @@ public String getClosestSupportedPythonVersion(String version) {
* version of the Deep Learning framework (engine) used to create
* the model
* @return the corresponding Java version
* @throws Exception
* throw exception in the case the version wanted is not
* supported
*/
public String getCorrespondingJavaVersion( String version )
{
Expand Down

0 comments on commit 382fb7a

Please sign in to comment.