Skip to content

Commit e702a42

Browse files
RylernRylern
committed
Rename image creation functions
1 parent 728fc0d commit e702a42

File tree

2 files changed

+27
-27
lines changed

2 files changed

+27
-27
lines changed

‎src/main/java/qupath/ext/imglib2/ImgBuilder.java‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
/**
4040
* A class to create {@link Img} or {@link RandomAccessibleInterval} from an {@link ImageServer}.
4141
* <p>
42-
* Use a {@link #create(ImageServer)} or {@link #create(ImageServer, NativeType)} to create an instance of this class.
42+
* Use a {@link #createBuilder(ImageServer)} or {@link #createBuilder(ImageServer, NativeType)} to create an instance of this class.
4343
* <p>
4444
* This class is thread-safe.
4545
*
@@ -94,13 +94,13 @@ private ImgBuilder(ImageServer<BufferedImage> server, T type, Function<BufferedI
9494
* Create a builder from an {@link ImageServer}. This doesn't create any accessibles yet.
9595
* <p>
9696
* The type of the output image is not checked, which might lead to problems later when accessing pixel values of the
97-
* returned accessibles of this class. It is recommended to use {@link #create(ImageServer, NativeType)} instead.
97+
* returned accessibles of this class. It is recommended to use {@link #createBuilder(ImageServer, NativeType)} instead.
9898
*
9999
* @param server the input image
100100
* @return a builder to create an instance of this class
101101
* @throws IllegalArgumentException if the provided image has less than one channel
102102
*/
103-
public static ImgBuilder<?, ?> create(ImageServer<BufferedImage> server) {
103+
public static ImgBuilder<?, ?> createBuilder(ImageServer<BufferedImage> server) {
104104
if (server.isRGB()) {
105105
return new ImgBuilder<>(server, new ARGBType(), ArgbBufferedImageAccess::new);
106106
} else {
@@ -201,7 +201,7 @@ private ImgBuilder(ImageServer<BufferedImage> server, T type, Function<BufferedI
201201
* @throws IllegalArgumentException if the provided type is not compatible with the input image (see above), or if the provided image
202202
* has less than one channel
203203
*/
204-
public static <T extends NativeType<T> & NumericType<T>> ImgBuilder<T, ?> create(ImageServer<BufferedImage> server, T type) {
204+
public static <T extends NativeType<T> & NumericType<T>> ImgBuilder<T, ?> createBuilder(ImageServer<BufferedImage> server, T type) {
205205
checkType(server, type);
206206

207207
if (server.isRGB()) {
@@ -245,7 +245,7 @@ public ImgBuilder<T, A> cellCache(CellCache cellCache) {
245245
*/
246246
public List<? extends RandomAccessibleInterval<T>> buildForAllLevels() {
247247
return IntStream.range(0, server.getMetadata().nLevels())
248-
.mapToObj(this::createForLevel)
248+
.mapToObj(this::buildForLevel)
249249
.toList();
250250
}
251251

@@ -264,7 +264,7 @@ public List<? extends RandomAccessibleInterval<T>> buildForAllLevels() {
264264
* @return an {@link Img} corresponding to the provided level of the input image
265265
* @throws IllegalArgumentException if the provided level does not match with a level of the input image
266266
*/
267-
public Img<T> createForLevel(int level) {
267+
public Img<T> buildForLevel(int level) {
268268
if (level < 0 || level >= server.getMetadata().nLevels()) {
269269
throw new IllegalArgumentException(String.format(
270270
"The provided level %d is not within 0 and %d",
@@ -316,17 +316,17 @@ public Img<T> createForLevel(int level) {
316316
* @return a {@link RandomAccessibleInterval} corresponding to the input image with the provided downsample applied
317317
* @throws IllegalArgumentException if the provided downsample is not greater than 0
318318
*/
319-
public RandomAccessibleInterval<T> createForDownsample(double downsample) {
319+
public RandomAccessibleInterval<T> buildForDownsample(double downsample) {
320320
if (downsample <= 0) {
321321
throw new IllegalArgumentException(String.format("The provided downsample %f is not greater than 0", downsample));
322322
}
323323

324324
int level = ServerTools.getPreferredResolutionLevel(server, downsample);
325325

326326
if (server.getMetadata().getChannelType() == ImageServerMetadata.ChannelType.CLASSIFICATION) {
327-
return AccessibleScaler.scaleWithNearestNeighborInterpolation(createForLevel(level), server.getDownsampleForResolution(level) / downsample);
327+
return AccessibleScaler.scaleWithNearestNeighborInterpolation(buildForLevel(level), server.getDownsampleForResolution(level) / downsample);
328328
} else {
329-
return AccessibleScaler.scaleWithLinearInterpolation(createForLevel(level), server.getDownsampleForResolution(level) / downsample);
329+
return AccessibleScaler.scaleWithLinearInterpolation(buildForLevel(level), server.getDownsampleForResolution(level) / downsample);
330330
}
331331
}
332332

‎src/test/java/qupath/ext/imglib2/TestImgBuilder.java‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ void Check_Rgb_Server() throws Exception {
4444
PixelType pixelType = PixelType.UINT8;
4545
ImageServer<BufferedImage> imageServer = new GenericImageServer(isRgb, pixelType);
4646

47-
Img<ARGBType> img = ImgBuilder.create(imageServer, new ARGBType()).createForLevel(0);
47+
Img<ARGBType> img = ImgBuilder.createBuilder(imageServer, new ARGBType()).buildForLevel(0);
4848

4949
Utils.assertArgbRandomAccessibleEquals(img, (x, y, channel, z, t) -> ARGBType.rgba(255, 0, 0, 0), 1);
5050

@@ -57,7 +57,7 @@ void Check_Uint8_Server() throws Exception {
5757
PixelType pixelType = PixelType.UINT8;
5858
ImageServer<BufferedImage> imageServer = new GenericImageServer(isRgb, pixelType);
5959

60-
Img<UnsignedByteType> img = ImgBuilder.create(imageServer, new UnsignedByteType()).createForLevel(0);
60+
Img<UnsignedByteType> img = ImgBuilder.createBuilder(imageServer, new UnsignedByteType()).buildForLevel(0);
6161

6262
Utils.assertRandomAccessibleEquals(img, (x, y, channel, z, t) -> 1, 1);
6363

@@ -70,7 +70,7 @@ void Check_Int8_Server() throws Exception {
7070
PixelType pixelType = PixelType.INT8;
7171
ImageServer<BufferedImage> imageServer = new GenericImageServer(isRgb, pixelType);
7272

73-
Img<ByteType> img = ImgBuilder.create(imageServer, new ByteType()).createForLevel(0);
73+
Img<ByteType> img = ImgBuilder.createBuilder(imageServer, new ByteType()).buildForLevel(0);
7474

7575
Utils.assertRandomAccessibleEquals(img, (x, y, channel, z, t) -> 1, 1);
7676

@@ -83,7 +83,7 @@ void Check_Uint16_Server() throws Exception {
8383
PixelType pixelType = PixelType.UINT16;
8484
ImageServer<BufferedImage> imageServer = new GenericImageServer(isRgb, pixelType);
8585

86-
Img<UnsignedShortType> img = ImgBuilder.create(imageServer, new UnsignedShortType()).createForLevel(0);
86+
Img<UnsignedShortType> img = ImgBuilder.createBuilder(imageServer, new UnsignedShortType()).buildForLevel(0);
8787

8888
Utils.assertRandomAccessibleEquals(img, (x, y, channel, z, t) -> 1, 1);
8989

@@ -96,7 +96,7 @@ void Check_Int16_Server() throws Exception {
9696
PixelType pixelType = PixelType.INT16;
9797
ImageServer<BufferedImage> imageServer = new GenericImageServer(isRgb, pixelType);
9898

99-
Img<ShortType> img = ImgBuilder.create(imageServer, new ShortType()).createForLevel(0);
99+
Img<ShortType> img = ImgBuilder.createBuilder(imageServer, new ShortType()).buildForLevel(0);
100100

101101
Utils.assertRandomAccessibleEquals(img, (x, y, channel, z, t) -> 1, 1);
102102

@@ -109,7 +109,7 @@ void Check_Uint32_Server() throws Exception {
109109
PixelType pixelType = PixelType.UINT32;
110110
ImageServer<BufferedImage> imageServer = new GenericImageServer(isRgb, pixelType);
111111

112-
Img<UnsignedIntType> img = ImgBuilder.create(imageServer, new UnsignedIntType()).createForLevel(0);
112+
Img<UnsignedIntType> img = ImgBuilder.createBuilder(imageServer, new UnsignedIntType()).buildForLevel(0);
113113

114114
Utils.assertRandomAccessibleEquals(img, (x, y, channel, z, t) -> 1, 1);
115115

@@ -122,7 +122,7 @@ void Check_Int32_Server() throws Exception {
122122
PixelType pixelType = PixelType.INT32;
123123
ImageServer<BufferedImage> imageServer = new GenericImageServer(isRgb, pixelType);
124124

125-
Img<IntType> img = ImgBuilder.create(imageServer, new IntType()).createForLevel(0);
125+
Img<IntType> img = ImgBuilder.createBuilder(imageServer, new IntType()).buildForLevel(0);
126126

127127
Utils.assertRandomAccessibleEquals(img, (x, y, channel, z, t) -> 1, 1);
128128

@@ -135,7 +135,7 @@ void Check_Float32_Server() throws Exception {
135135
PixelType pixelType = PixelType.FLOAT32;
136136
ImageServer<BufferedImage> imageServer = new GenericImageServer(isRgb, pixelType);
137137

138-
Img<FloatType> img = ImgBuilder.create(imageServer, new FloatType()).createForLevel(0);
138+
Img<FloatType> img = ImgBuilder.createBuilder(imageServer, new FloatType()).buildForLevel(0);
139139

140140
Utils.assertRandomAccessibleEquals(img, (x, y, channel, z, t) -> 1, 1);
141141

@@ -148,7 +148,7 @@ void Check_Float64_Server() throws Exception {
148148
PixelType pixelType = PixelType.FLOAT64;
149149
ImageServer<BufferedImage> imageServer = new GenericImageServer(isRgb, pixelType);
150150

151-
Img<DoubleType> img = ImgBuilder.create(imageServer, new DoubleType()).createForLevel(0);
151+
Img<DoubleType> img = ImgBuilder.createBuilder(imageServer, new DoubleType()).buildForLevel(0);
152152

153153
Utils.assertRandomAccessibleEquals(img, (x, y, channel, z, t) -> 1, 1);
154154

@@ -159,7 +159,7 @@ void Check_Float64_Server() throws Exception {
159159
void Check_X_Dimension_Size() throws Exception {
160160
ImageServer<BufferedImage> imageServer = new ComplexDoubleImageServer();
161161
int expectedSize = imageServer.getWidth();
162-
Img<?> img = ImgBuilder.create(imageServer).createForLevel(0);
162+
Img<?> img = ImgBuilder.createBuilder(imageServer).buildForLevel(0);
163163
int dimensionIndex = ImgBuilder.AXIS_X;
164164

165165
Assertions.assertEquals(expectedSize, img.dimension(dimensionIndex));
@@ -171,7 +171,7 @@ void Check_X_Dimension_Size() throws Exception {
171171
void Check_Y_Dimension_Size() throws Exception {
172172
ImageServer<BufferedImage> imageServer = new ComplexDoubleImageServer();
173173
int expectedSize = imageServer.getHeight();
174-
Img<?> img = ImgBuilder.create(imageServer).createForLevel(0);
174+
Img<?> img = ImgBuilder.createBuilder(imageServer).buildForLevel(0);
175175
int dimensionIndex = ImgBuilder.AXIS_Y;
176176

177177
Assertions.assertEquals(expectedSize, img.dimension(dimensionIndex));
@@ -183,7 +183,7 @@ void Check_Y_Dimension_Size() throws Exception {
183183
void Check_Channel_Dimension_Size() throws Exception {
184184
ImageServer<BufferedImage> imageServer = new ComplexDoubleImageServer();
185185
int expectedSize = imageServer.nChannels();
186-
Img<?> img = ImgBuilder.create(imageServer).createForLevel(0);
186+
Img<?> img = ImgBuilder.createBuilder(imageServer).buildForLevel(0);
187187
int dimensionIndex = ImgBuilder.AXIS_CHANNEL;
188188

189189
Assertions.assertEquals(expectedSize, img.dimension(dimensionIndex));
@@ -195,7 +195,7 @@ void Check_Channel_Dimension_Size() throws Exception {
195195
void Check_Z_Dimension_Size() throws Exception {
196196
ImageServer<BufferedImage> imageServer = new ComplexDoubleImageServer();
197197
int expectedSize = imageServer.getMetadata().getSizeZ();
198-
Img<?> img = ImgBuilder.create(imageServer).createForLevel(0);
198+
Img<?> img = ImgBuilder.createBuilder(imageServer).buildForLevel(0);
199199
int dimensionIndex = ImgBuilder.AXIS_Z;
200200

201201
Assertions.assertEquals(expectedSize, img.dimension(dimensionIndex));
@@ -207,7 +207,7 @@ void Check_Z_Dimension_Size() throws Exception {
207207
void Check_Time_Dimension_Size() throws Exception {
208208
ImageServer<BufferedImage> imageServer = new ComplexDoubleImageServer();
209209
int expectedSize = imageServer.getMetadata().getSizeT();
210-
Img<?> img = ImgBuilder.create(imageServer).createForLevel(0);
210+
Img<?> img = ImgBuilder.createBuilder(imageServer).buildForLevel(0);
211211
int dimensionIndex = ImgBuilder.AXIS_TIME;
212212

213213
Assertions.assertEquals(expectedSize, img.dimension(dimensionIndex));
@@ -221,7 +221,7 @@ void Check_Pixels_Of_Level_0() throws Exception {
221221
ImageServer<BufferedImage> imageServer = new ComplexDoubleImageServer();
222222
double downsample = imageServer.getDownsampleForResolution(level);
223223

224-
Img<DoubleType> img = ImgBuilder.create(imageServer, new DoubleType()).createForLevel(level);
224+
Img<DoubleType> img = ImgBuilder.createBuilder(imageServer, new DoubleType()).buildForLevel(level);
225225

226226
Utils.assertRandomAccessibleEquals(img, ComplexDoubleImageServer::getPixel, downsample);
227227

@@ -234,7 +234,7 @@ void Check_Pixels_Of_Level_1() throws Exception {
234234
ImageServer<BufferedImage> imageServer = new ComplexDoubleImageServer();
235235
double downsample = imageServer.getDownsampleForResolution(level);
236236

237-
Img<DoubleType> img = ImgBuilder.create(imageServer, new DoubleType()).createForLevel(level);
237+
Img<DoubleType> img = ImgBuilder.createBuilder(imageServer, new DoubleType()).buildForLevel(level);
238238

239239
Utils.assertRandomAccessibleEquals(img, ComplexDoubleImageServer::getPixel, downsample);
240240

@@ -247,7 +247,7 @@ void Check_Pixels_Of_Downsample_1() throws Exception {
247247
ImageServer<BufferedImage> imageServer = new ComplexDoubleImageServer();
248248
double downsample = imageServer.getDownsampleForResolution(level);
249249

250-
RandomAccessibleInterval<DoubleType> img = ImgBuilder.create(imageServer, new DoubleType()).createForDownsample(downsample);
250+
RandomAccessibleInterval<DoubleType> img = ImgBuilder.createBuilder(imageServer, new DoubleType()).buildForDownsample(downsample);
251251

252252
Utils.assertRandomAccessibleEquals(img, ComplexDoubleImageServer::getPixel, downsample);
253253

@@ -260,7 +260,7 @@ void Check_Pixels_Of_Downsample_4() throws Exception {
260260
ImageServer<BufferedImage> imageServer = new ComplexDoubleImageServer();
261261
double downsample = imageServer.getDownsampleForResolution(level);
262262

263-
RandomAccessibleInterval<DoubleType> img = ImgBuilder.create(imageServer, new DoubleType()).createForDownsample(downsample);
263+
RandomAccessibleInterval<DoubleType> img = ImgBuilder.createBuilder(imageServer, new DoubleType()).buildForDownsample(downsample);
264264

265265
Utils.assertRandomAccessibleEquals(img, ComplexDoubleImageServer::getPixel, downsample);
266266

0 commit comments

Comments
 (0)