nom.tam.image.tile.operation.AbstractTileOperation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nom-tam-fits Show documentation
Java library for reading and writing FITS files. FITS, the Flexible Image Transport System, is the format commonly used in the archiving and transport of astronomical data.
There is a newer version: 1.20.2
Show newest version
package nom.tam.image.tile.operation;

/*
 * #%L
 * nom.tam FITS library
 * %%
 * Copyright (C) 1996 - 2016 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%
 */

import java.nio.Buffer;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Future;

import nom.tam.image.tile.operation.buffer.TileBuffer;
import nom.tam.image.tile.operation.buffer.TileBufferFactory;
import nom.tam.util.type.PrimitiveType;

public abstract class AbstractTileOperation implements Runnable, ITileOperation {

    private final ITiledImageOperation tiledImageOperation;

    private Future future;

    private TileBuffer tileBuffer;

    private final int tileIndex;

    private final TileArea area;

    public AbstractTileOperation(ITiledImageOperation operation, int tileIndex, TileArea area) {
        this.tiledImageOperation = operation;
        this.tileIndex = tileIndex;
        this.area = area;
    }

    public void execute(ExecutorService threadPool) {
        this.future = threadPool.submit(this);
    }

    public TileArea getArea() {
        return this.area;
    }

    /**
     * @return the number of pixels in this tile.
     */
    public int getPixelSize() {
        return this.tileBuffer.getPixelSize();
    }

    public int getTileIndex() {
        return this.tileIndex;
    }

    /**
     * set the buffer that describes the whole image and let the tile create a
     * slice of it from the position where the tile starts in the whole image.
     * Attention this method is not thread-safe because it changes the position
     * of the buffer parameter.
     *
     * @param buffer
     *            the buffer that describes the whole image.
     */
    public void setWholeImageBuffer(Buffer buffer) {
        this.tileBuffer.setData(buffer);
    }

    /**
     * Wait for the result of the tile processing.
     */
    @Override
    public void waitForResult() {
        try {
            this.future.get();
        } catch (Exception e) {
            throw new IllegalStateException("could not process tile", e);
        }
    }

    protected PrimitiveType getBaseType() {
        return this.tiledImageOperation.getBaseType();
    }

    protected ITileOperation getPreviousTileOperation() {
        return this.tiledImageOperation.getTileOperation(getTileIndex() - 1);
    }

    protected TileBuffer getTileBuffer() {
        return this.tileBuffer;
    }

    protected ITiledImageOperation getTiledImageOperation() {
        return this.tiledImageOperation;
    }

    @Override
    public ITileOperation setDimensions(int dataOffset, int width, int height) {
        setTileBuffer(TileBufferFactory.createTileBuffer(getBaseType(), //
                dataOffset, //
                this.tiledImageOperation.getImageWidth(), //
                width, height));
        this.area.size(width, height);
        return this;
    }

    protected void setTileBuffer(TileBuffer tileBuffer) {
        this.tileBuffer = tileBuffer;
    }
}