nom.tam.util.FitsIO 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.util;

/*
 * #%L
 * nom.tam FITS library
 * %%
 * Copyright (C) 1996 - 2015 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.io.Closeable;
import java.io.IOException;

/**
 * super closable interface for all fits reader/writers. It defines the
 * necessary constants common for all reader and writers.
 * 
 * @author ritchie
 */
public interface FitsIO extends Closeable {

    /**
     * default buffer size to use if none is specified.
     */
    int DEFAULT_BUFFER_SIZE = 32768;

    /**
     * number of bits in one byte.
     */
    int BITS_OF_1_BYTE = 8;

    /**
     * number of bits in two byte.
     */
    int BITS_OF_2_BYTES = 16;

    /**
     * number of bits in three byte.
     */
    int BITS_OF_3_BYTES = 24;

    /**
     * number of bits in four byte.
     */
    int BITS_OF_4_BYTES = 32;

    /**
     * number of bits in five byte.
     */
    int BITS_OF_5_BYTES = 40;

    /**
     * number of bits in six byte.
     */
    int BITS_OF_6_BYTES = 48;

    /**
     * number of bits in seven byte.
     */
    int BITS_OF_7_BYTES = 56;

    /**
     * number of bytes occupied by a boolean.
     */
    int BYTES_IN_BOOLEAN = 1;

    /**
     * number of bytes occupied by a byte.
     */
    int BYTES_IN_BYTE = 1;

    /**
     * number of bytes occupied by a char.
     */
    int BYTES_IN_CHAR = 2;

    /**
     * number of bytes occupied by a short.
     */
    int BYTES_IN_SHORT = 2;

    /**
     * number of bytes occupied by a integer.
     */
    int BYTES_IN_INTEGER = 4;

    /**
     * number of bytes occupied by a long.
     */
    int BYTES_IN_LONG = 8;

    /**
     * number of bytes occupied by a float.
     */
    int BYTES_IN_FLOAT = 4;

    /**
     * number of bytes occupied by a double.
     */
    int BYTES_IN_DOUBLE = 8;

    /**
     * bit mask to get the lowest byte from an integer. Or to get an unsigned
     * integer from a byte.
     */
    int BYTE_MASK = 0xFF;

    /**
     * bit mask to get the lowest short of a integer.
     */
    int SHORT_MASK = 0xffff;

    /**
     * bit mask to get the lowest short of a long.
     */
    long SHORT_OF_LONG_MASK = 0xffffL;

    /**
     * bit mask to get the lowest byte of a long.
     */
    long BYTE_1_OF_LONG_MASK = 0xffL;

    /**
     * bit mask to get the second lowest byte of a long.
     */
    long BYTE_2_OF_LONG_MASK = 0xff00L;

    /**
     * bit mask to get the third lowest byte of a long.
     */
    long BYTE_3_OF_LONG_MASK = 0xff0000L;

    /**
     * bit mask to get the fourth lowest byte of a long.
     */
    long BYTE_4_OF_LONG_MASK = 0xff000000L;

    /**
     * bit mask to get the lowest integer from an long.
     */
    long INTEGER_MASK = 0x00000000ffffffffL;

    /**
     * bit mask to get the highest integer from an long.
     */
    long HIGH_INTEGER_MASK = 0xFFFFFFFF00000000L;

    @Override
    void close() throws IOException;
}