1 package nom.tam.image.tile.operation;
2
3 /*
4 * #%L
5 * nom.tam FITS library
6 * %%
7 * Copyright (C) 1996 - 2024 nom-tam-fits
8 * %%
9 * This is free and unencumbered software released into the public domain.
10 *
11 * Anyone is free to copy, modify, publish, use, compile, sell, or
12 * distribute this software, either in source code form or as a compiled
13 * binary, for any purpose, commercial or non-commercial, and by any
14 * means.
15 *
16 * In jurisdictions that recognize copyright laws, the author or authors
17 * of this software dedicate any and all copyright interest in the
18 * software to the public domain. We make this dedication for the benefit
19 * of the public at large and to the detriment of our heirs and
20 * successors. We intend this dedication to be an overt act of
21 * relinquishment in perpetuity of all present and future rights to this
22 * software under copyright law.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
27 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
28 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
29 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
30 * OTHER DEALINGS IN THE SOFTWARE.
31 * #L%
32 */
33
34 /**
35 * (<i>for internal use</i>) Interface for performing parallel operations on
36 * serialized 2D image tiles.
37 *
38 * @see nom.tam.image.ImageTiler
39 * @see nom.tam.image.tile.operation.buffer.TileBuffer
40 */
41 public interface ITileOperation {
42
43 /**
44 * Specifies the location of the tile in the serialized buffer.
45 *
46 * @param dataOffset
47 * the byte offset at which the tile data begins.
48 * @param width
49 * the width of the tile in pixels.
50 * @param height
51 * the tile height in pixels.
52 * @return itself.
53 */
54 ITileOperation setDimensions(int dataOffset, int width, int height);
55
56 /**
57 * Waits until the parallelized operation is complete
58 */
59 void waitForResult();
60 }