Skip to content

Commit d9075a9

Browse files
ctruedengselzer
ctrueden
authored and
gselzer
committed
Fix scijava-ops-image javadoc errors
1 parent ab987f7 commit d9075a9

File tree

130 files changed

+431
-435
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

130 files changed

+431
-435
lines changed

‎scijava-ops-image/src/main/java/org/scijava/ops/image/adapt/LiftComputersToRAI.java‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@
4949
* {@link RandomAccessibleInterval}s of those types. An output
5050
* {@link RandomAccessibleInterval} is created based off of the dimensions of
5151
* the first input image and using the output type of the passed
52-
* {@link Function}. The {@Function}{@code <I, O>} is then applied iteratively
53-
* over each pixel of the input image(s). NOTE: It is assumed that the input
52+
* {@link Function}. The {@code Function<I, O>} is then applied iteratively over
53+
* each pixel of the input image(s). NOTE: It is assumed that the input
5454
* {@code RAI}s are the same size. If they are not, the lifted {@link Function}
5555
* will only iteratively process the images until one image runs out of pixels
5656
* to iterate over.
@@ -65,7 +65,7 @@ private LiftComputersToRAI() {
6565
}
6666

6767
/**
68-
* @param originalOp the original Op
68+
* @param computer the original Op
6969
* @return the adapted Op
7070
* @implNote op names='engine.adapt', priority='100.'
7171
*/
@@ -79,7 +79,7 @@ Computers.Arity1<RAII1, RAIO> lift11(Computers.Arity1<I1, O> computer)
7979
}
8080

8181
/**
82-
* @param originalOp the original Op
82+
* @param computer the original Op
8383
* @return the adapted Op
8484
* @implNote op names='engine.adapt', priority='100.'
8585
*/
@@ -94,7 +94,7 @@ Computers.Arity2<RAII1, I2, RAIO> lift21(
9494
}
9595

9696
/**
97-
* @param originalOp the original Op
97+
* @param computer the original Op
9898
* @return the adapted Op
9999
* @implNote op names='engine.adapt', priority='100.'
100100
*/
@@ -109,7 +109,7 @@ Computers.Arity2<RAII1, RAII2, RAIO> lift22(
109109
}
110110

111111
/**
112-
* @param originalOp the original Op
112+
* @param computer the original Op
113113
* @return the adapted Op
114114
* @implNote op names='engine.adapt', priority='100.'
115115
*/
@@ -124,7 +124,7 @@ Computers.Arity3<RAII1, I2, I3, RAIO> lift31(
124124
}
125125

126126
/**
127-
* @param originalOp the original Op
127+
* @param computer the original Op
128128
* @return the adapted Op
129129
* @implNote op names='engine.adapt', priority='100.'
130130
*/
@@ -139,7 +139,7 @@ Computers.Arity3<RAII1, RAII2, I3, RAIO> lift32(
139139
}
140140

141141
/**
142-
* @param originalOp the original Op
142+
* @param computer the original Op
143143
* @return the adapted Op
144144
* @implNote op names='engine.adapt', priority='100.'
145145
*/
@@ -155,7 +155,7 @@ Computers.Arity3<RAII1, RAII2, RAII3, RAIO> lift33(
155155
}
156156

157157
/**
158-
* @param originalOp the original Op
158+
* @param computer the original Op
159159
* @return the adapted Op
160160
* @implNote op names='engine.adapt', priority='100.'
161161
*/
@@ -170,7 +170,7 @@ Computers.Arity4<RAII1, I2, I3, I4, RAIO> lift41(
170170
}
171171

172172
/**
173-
* @param originalOp the original Op
173+
* @param computer the original Op
174174
* @return the adapted Op
175175
* @implNote op names='engine.adapt', priority='100.'
176176
*/
@@ -185,7 +185,7 @@ Computers.Arity4<RAII1, RAII2, I3, I4, RAIO> lift42(
185185
}
186186

187187
/**
188-
* @param originalOp the original Op
188+
* @param computer the original Op
189189
* @return the adapted Op
190190
* @implNote op names='engine.adapt', priority='100.'
191191
*/
@@ -202,7 +202,7 @@ Computers.Arity4<RAII1, RAII2, RAII3, I4, RAIO> lift43(
202202
}
203203

204204
/**
205-
* @param originalOp the original Op
205+
* @param computer the original Op
206206
* @return the adapted Op
207207
* @implNote op names='engine.adapt', priority='100.'
208208
*/
@@ -219,7 +219,7 @@ Computers.Arity4<RAII1, RAII2, RAII3, RAII4, RAIO> lift44(
219219
}
220220

221221
/**
222-
* @param originalOp the original Op
222+
* @param computer the original Op
223223
* @return the adapted Op
224224
* @implNote op names='engine.adapt', priority='100.'
225225
*/
@@ -235,7 +235,7 @@ Computers.Arity5<RAII1, I2, I3, I4, I5, RAIO> lift51(
235235
}
236236

237237
/**
238-
* @param originalOp the original Op
238+
* @param computer the original Op
239239
* @return the adapted Op
240240
* @implNote op names='engine.adapt', priority='100.'
241241
*/
@@ -251,7 +251,7 @@ Computers.Arity5<RAII1, RAII2, I3, I4, I5, RAIO> lift52(
251251
}
252252

253253
/**
254-
* @param originalOp the original Op
254+
* @param computer the original Op
255255
* @return the adapted Op
256256
* @implNote op names='engine.adapt', priority='100.'
257257
*/
@@ -268,7 +268,7 @@ Computers.Arity5<RAII1, RAII2, RAII3, I4, I5, RAIO> lift53(
268268
}
269269

270270
/**
271-
* @param originalOp the original Op
271+
* @param computer the original Op
272272
* @return the adapted Op
273273
* @implNote op names='engine.adapt', priority='100.'
274274
*/
@@ -285,7 +285,7 @@ Computers.Arity5<RAII1, RAII2, RAII3, RAII4, I5, RAIO> lift54(
285285
}
286286

287287
/**
288-
* @param originalOp the original Op
288+
* @param computer the original Op
289289
* @return the adapted Op
290290
* @implNote op names='engine.adapt', priority='100.'
291291
*/

‎scijava-ops-image/src/main/java/org/scijava/ops/image/adapt/LiftFunctionsToRAI.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@
5252
* {@link RandomAccessibleInterval}s of those types. An output
5353
* {@link RandomAccessibleInterval} is created based off of the dimensions of
5454
* the first input image and using the output type of the passed
55-
* {@link Function}. The {@Function}{@code <I, O>} is then applied iteratively
56-
* over each pixel of the input image(s). NOTE: It is assumed that the input
55+
* {@link Function}. The {@code Function<I, O>} is then applied iteratively over
56+
* each pixel of the input image(s). NOTE: It is assumed that the input
5757
* {@code RAI}s are the same size. If they are not, the lifted {@link Function}
5858
* will only iteratively process the images until one image runs out of pixels
5959
* to iterate over.

‎scijava-ops-image/src/main/java/org/scijava/ops/image/coloc/kendallTau/KendallTauBRank.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@
4545
* According to <a href=
4646
* "http://en.wikipedia.org/wiki/Kendall_tau_rank_correlation_coefficient">this
4747
* article</a>, Tau-b (appropriate if multiple pairs share the same first, or
48-
* second, value), the rank correlation of a set of pairs <tt>(x_1, y_1), ...,
49-
* (x_n, y_n)</tt>:
48+
* second, value), the rank correlation of a set of pairs
49+
* {@code (x_1, y_1), ..., (x_n, y_n)}:
5050
* </p>
5151
*
5252
* <pre>

‎scijava-ops-image/src/main/java/org/scijava/ops/image/create/DefaultCreateKernel2ndDerivBiGauss.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@
6565
* with Application to Vasculature Images. IEEE TMI, vol. 22, no. 1, 2013.
6666
*
6767
* @author Vladimír Ulman
68-
* @param <T>
6968
*/
7069
public final class DefaultCreateKernel2ndDerivBiGauss {
7170

‎scijava-ops-image/src/main/java/org/scijava/ops/image/create/DefaultCreateKernelBiGauss.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@
6363
* with Application to Vasculature Images. IEEE TMI, vol. 22, no. 1, 2013.
6464
*
6565
* @author Vladimír Ulman
66-
* @param <T>
6766
*/
6867
public final class DefaultCreateKernelBiGauss {
6968

‎scijava-ops-image/src/main/java/org/scijava/ops/image/create/DefaultCreateKernelGabor.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
* length.
5858
*
5959
* @author Vladimír Ulman
60-
* @param <T>
6160
*/
6261
public final class DefaultCreateKernelGabor {
6362

‎scijava-ops-image/src/main/java/org/scijava/ops/image/create/DefaultCreateKernelGauss.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@
5050
* @author Stephan Sellien (University of Konstanz)
5151
* @author Brian Northan
5252
* @author Gabe Selzer
53-
* @param <T>
5453
*/
5554
public final class DefaultCreateKernelGauss {
5655

‎scijava-ops-image/src/main/java/org/scijava/ops/image/create/DefaultCreateKernelSobel.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@
4343
* Creates a separated sobel kernel.
4444
*
4545
* @author Eike Heinz, University of Konstanz
46-
* @param <T> type of input
4746
*/
4847

4948
public final class DefaultCreateKernelSobel {

‎scijava-ops-image/src/main/java/org/scijava/ops/image/deconvolve/NonCirculantFirstGuess.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,17 +80,17 @@ public class NonCirculantFirstGuess<I extends RealType<I>, O extends RealType<O>
8080
* @return the output
8181
*/
8282
@Override
83-
public RandomAccessibleInterval<O> apply(RandomAccessibleInterval<I> in,
83+
public RandomAccessibleInterval<O> apply(RandomAccessibleInterval<I> input,
8484
final O outType, final Dimensions k)
8585
{
8686

87-
final Img<O> firstGuess = create.apply(in, outType);
87+
final Img<O> firstGuess = create.apply(input, outType);
8888

8989
// set first guess to be a constant = to the average value
9090

9191
// so first compute the sum...
9292
final DoubleType s = new DoubleType();
93-
sum.compute(Views.iterable(in), s);
93+
sum.compute(Views.iterable(input), s);
9494

9595
// then the number of pixels
9696
long numPixels = 1;

‎scijava-ops-image/src/main/java/org/scijava/ops/image/deconvolve/RichardsonLucyUpdate.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ public class RichardsonLucyUpdate<T extends RealType<T>> implements
5555
/**
5656
* performs update step of the Richardson Lucy Algorithm
5757
*
58-
* @param input
59-
* @param output
58+
* @param correction
59+
* @param estimate
6060
*/
6161
@Override
6262
public void compute(RandomAccessibleInterval<T> correction,

0 commit comments

Comments
 (0)