nom.tam.fits.header.IFitsHeader 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.fits.header;

/*
 * #%L
 * INDI for Java Utilities for the fits image format
 * %%
 * Copyright (C) 2012 - 2015 indiforjava
 * %%
 * 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%
 */

public interface IFitsHeader {

    enum HDU {
        ANY,
        ASCII_TABLE,
        BINTABLE,
        EXTENSION,
        GROUPS,
        IMAGE,
        PRIMARY,
        PRIMARY_EXTENSION,
        TABLE
    }

    enum SOURCE {
        /**
         *          *  @see checksum doc
         * 
         */
        CHECKSUM("http://heasarc.gsfc.nasa.gov/docs/heasarc/ofwg/docs/general/checksum/checksum.html"),

        /**
         *          * @see http://cxc.harvard.edu/contrib/arots/fits/content.txt
         * 
         */
        CXC("http://cxc.harvard.edu/contrib/arots/fits/content.txt"),
        /**
         *          *  @see http://arcdev.hq.eso.org/dicb/dicd/dic-1-1.4.html
         * 
         */
        ESO("http://arcdev.hq.eso.org/dicb/dicd/dic-1-1.4.html"),
        /**
         *          *  @see http://heasarc.gsfc.nasa.gov/docs/heasarc/ofwg/docs/ofwg_recomm/r13.html
         * 
         */
        HEASARC("http://heasarc.gsfc.nasa.gov/docs/heasarc/ofwg/docs/ofwg_recomm/r13.html"),
        /**
         * integral.
         */
        INTEGRAL(null),
        /**
         * defined mandatory by the fits standard.
         */
        MANDATORY("http://heasarc.gsfc.nasa.gov/docs/fcg/standard_dict.html"),
        /**
         *          * @see http://www.cyanogen.com/help/maximdl/FITS_File_Header_Definitions.htm
         * 
         */
        MaxImDL("http://www.cyanogen.com/help/maximdl/FITS_File_Header_Definitions.htm"),
        /**
         *          *  @see http://iraf.noao.edu/iraf/web/projects/ccdmosaic/imagedef/fitsdic.html
         * 
         */
        NOAO("http://iraf.noao.edu/iraf/web/projects/ccdmosaic/imagedef/fitsdic.html"),
        /**
         * defined reserved by the fits standard.
         */
        RESERVED("http://heasarc.gsfc.nasa.gov/docs/fcg/standard_dict.html"),
        /**
         * rosat no link available.
         */
        ROSAT(null),
        /**
         *          * @see http://archive.sbig.com/pdffiles/SBFITSEXT_1r0.pdf
         * 
         */
        SBIG("http://archive.sbig.com/pdffiles/SBFITSEXT_1r0.pdf"),
        /**
         *          *  @see http://tucana.noao.edu/ADASS/adass_proc/adass_95/zaraten/zaraten.html
         * 
         */
        STScI("http://tucana.noao.edu/ADASS/adass_proc/adass_95/zaraten/zaraten.html"),
        /**
         *          *  @see http://www.ucolick.org
         * 
         */
        UCOLICK("http://www.ucolick.org"),
        /**
         * developed over time, source long forgotten.
         */
        UNKNOWN(null);

        private final String url;

        SOURCE(String url) {
            this.url = url;
        }

        public String url() {
            return this.url;
        }
    }

    enum VALUE {
        INTEGER,
        LOGICAL,
        NONE,
        REAL,
        STRING,
        ANY
    }

    String comment();

    HDU hdu();

    String key();

    IFitsHeader n(int... number);

    SOURCE status();

    VALUE valueType();
}