1 package nom.tam.image.tile.operation.buffer;
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 import java.nio.Buffer;
35
36 import nom.tam.util.type.ElementType;
37
38 /**
39 * (<i>for internal use</i>) A linear buffer that contains data for a single 2D image tile, in row-major format. You can
40 * use {@link TileBufferFactory} to create appropriate implementations depending on tile and image sizes.
41 *
42 * @see TileBufferFactory
43 * @see nom.tam.image.tile.operation.TileArea
44 */
45 @SuppressWarnings("javadoc")
46 public abstract class TileBuffer {
47
48 private Buffer imageBuffer;
49
50 private final int height;
51
52 private final int offset;
53
54 private final ElementType<Buffer> baseType;
55
56 private final int width;
57
58 protected TileBuffer(ElementType<Buffer> baseType, int dataOffset, int width, int height) {
59 this.baseType = baseType;
60 offset = dataOffset;
61 this.width = width;
62 this.height = height;
63 }
64
65 /**
66 * nothing to do in the normal case, overwrite this method if post processing is necessary.
67 */
68 public void finish() {
69 }
70
71 public ElementType<Buffer> getBaseType() {
72 return baseType;
73 }
74
75 public abstract Buffer getBuffer();
76
77 public int getHeight() {
78 return height;
79 }
80
81 /**
82 * @return the number of pixels in the tile this view represents.
83 */
84 public int getPixelSize() {
85 return width * height;
86 }
87
88 public int getWidth() {
89 return width;
90 }
91
92 public TileBuffer setData(Buffer value) {
93 value.position(offset);
94 imageBuffer = baseType.sliceBuffer(value);
95 return this;
96 }
97
98 protected Buffer getImageBuffer() {
99 return imageBuffer;
100 }
101
102 }