nom.tam.image.tile.operation.ITileOperation Maven / Gradle / Ivy
package nom.tam.image.tile.operation;
/*
* #%L
* nom.tam FITS library
* %%
* Copyright (C) 1996 - 2024 nom-tam-fits
* %%
* This is free and unencumbered software released into the public domain.
*
* Anyone is free to copy, modify, publish, use, compile, sell, or
* distribute this software, either in source code form or as a compiled
* binary, for any purpose, commercial or non-commercial, and by any
* means.
*
* In jurisdictions that recognize copyright laws, the author or authors
* of this software dedicate any and all copyright interest in the
* software to the public domain. We make this dedication for the benefit
* of the public at large and to the detriment of our heirs and
* successors. We intend this dedication to be an overt act of
* relinquishment in perpetuity of all present and future rights to this
* software under copyright law.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
* #L%
*/
/**
* (for internal use) Interface for performing parallel operations on
* serialized 2D image tiles.
*
* @see nom.tam.image.ImageTiler
* @see nom.tam.image.tile.operation.buffer.TileBuffer
*/
public interface ITileOperation {
/**
* Specifies the location of the tile in the serialized buffer.
*
* @param dataOffset
* the byte offset at which the tile data begins.
* @param width
* the width of the tile in pixels.
* @param height
* the tile height in pixels.
* @return itself.
*/
ITileOperation setDimensions(int dataOffset, int width, int height);
/**
* Waits until the parallelized operation is complete
*/
void waitForResult();
}