nom.tam.fits.FitsFactory 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
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.
package nom.tam.fits;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.ThreadFactory;
import nom.tam.fits.header.hierarch.IHierarchKeyFormatter;
import nom.tam.fits.header.hierarch.StandardIHierarchKeyFormatter;
import nom.tam.image.compression.hdu.CompressedImageData;
import nom.tam.image.compression.hdu.CompressedImageHDU;
import nom.tam.image.compression.hdu.CompressedTableData;
import nom.tam.image.compression.hdu.CompressedTableHDU;
/*
* #%L
* nom.tam FITS library
* %%
* Copyright (C) 2004 - 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%
*/
/**
* This class contains the code which associates particular FITS types with
* header and data configurations. It comprises a set of Factory methods which
* call appropriate methods in the HDU classes. If -- God forbid -- a new FITS
* HDU type were created, then the XXHDU, XXData classes would need to be added
* and this file modified but no other changes should be needed in the FITS
* libraries.
*/
public final class FitsFactory {
private static class FitsSettings {
private boolean useAsciiTables = true;
private boolean useHierarch = false;
private boolean checkAsciiStrings = false;
private boolean allowTerminalJunk = false;
private boolean longStringsEnabled = false;
private IHierarchKeyFormatter hierarchKeyFormatter = new StandardIHierarchKeyFormatter();
private FitsSettings copy() {
FitsSettings settings = new FitsSettings();
settings.useAsciiTables = this.useAsciiTables;
settings.useHierarch = this.useHierarch;
settings.checkAsciiStrings = this.checkAsciiStrings;
settings.allowTerminalJunk = this.allowTerminalJunk;
settings.longStringsEnabled = this.longStringsEnabled;
settings.hierarchKeyFormatter = this.hierarchKeyFormatter;
return settings;
}
}
private static final FitsSettings GLOBAL_SETTINGS = new FitsSettings();
private static final ThreadLocal LOCAL_SETTINGS = new ThreadLocal();
private static ExecutorService threadPool;
public static final int FITS_BLOCK_SIZE = 2880;
private static FitsSettings current() {
FitsSettings settings = LOCAL_SETTINGS.get();
if (settings == null) {
return GLOBAL_SETTINGS;
} else {
return settings;
}
}
/**
* @return Given a Header construct an appropriate data.
* @param hdr
* header to create the data from
* @throws FitsException
* if the header did not contain enough information to detect
* the type of the data
*/
public static Data dataFactory(Header hdr) throws FitsException {
if (ImageHDU.isHeader(hdr)) {
Data d = ImageHDU.manufactureData(hdr);
hdr.afterExtend(); // Fix for positioning error noted by V. Forchi
return d;
} else if (RandomGroupsHDU.isHeader(hdr)) {
return RandomGroupsHDU.manufactureData(hdr);
} else if (current().useAsciiTables && AsciiTableHDU.isHeader(hdr)) {
return AsciiTableHDU.manufactureData(hdr);
} else if (CompressedImageHDU.isHeader(hdr)) {
return CompressedImageHDU.manufactureData(hdr);
} else if (CompressedTableHDU.isHeader(hdr)) {
return CompressedTableHDU.manufactureData(hdr);
} else if (BinaryTableHDU.isHeader(hdr)) {
return BinaryTableHDU.manufactureData(hdr);
} else if (UndefinedHDU.isHeader(hdr)) {
return UndefinedHDU.manufactureData(hdr);
} else {
throw new FitsException("Unrecognizable header in dataFactory");
}
}
/**
* @return Is terminal junk (i.e., non-FITS data following a valid HDU)
* allowed.
*/
public static boolean getAllowTerminalJunk() {
return current().allowTerminalJunk;
}
/**
* @return Get the current status for string checking.
*/
static boolean getCheckAsciiStrings() {
return current().checkAsciiStrings;
}
/**
* @return true if we are processing HIERARCH style keywords
*/
public static boolean getUseHierarch() {
return current().useHierarch;
}
/**
* @return Given Header and data objects return the appropriate type of HDU.
* @param hdr
* the header of the date
* @param d
* the data
* @param
* the class of the data
* @throws FitsException
* if the operation failed
*/
@SuppressWarnings("unchecked")
public static BasicHDU hduFactory(Header hdr, DataClass d) throws FitsException {
if (d instanceof ImageData) {
return (BasicHDU) new ImageHDU(hdr, (ImageData) d);
} else if (d instanceof CompressedImageData) {
return (BasicHDU) new CompressedImageHDU(hdr, (CompressedImageData) d);
} else if (d instanceof RandomGroupsData) {
return (BasicHDU) new RandomGroupsHDU(hdr, (RandomGroupsData) d);
} else if (current().useAsciiTables && d instanceof AsciiTable) {
return (BasicHDU) new AsciiTableHDU(hdr, (AsciiTable) d);
} else if (d instanceof CompressedTableData) {
return (BasicHDU) new CompressedTableHDU(hdr, (CompressedTableData) d);
} else if (d instanceof BinaryTable) {
return (BasicHDU) new BinaryTableHDU(hdr, (BinaryTable) d);
} else if (d instanceof UndefinedData) {
return (BasicHDU) new UndefinedHDU(hdr, (UndefinedData) d);
}
return null;
}
/**
* @return Given an object, create the appropriate FITS header to describe
* it.
* @param o
* The object to be described.
* @throws FitsException
* if the parameter could not be converted to a hdu.
*/
public static BasicHDU hduFactory(Object o) throws FitsException {
Data d;
Header h;
if (o instanceof Header) {
h = (Header) o;
d = dataFactory(h);
} else if (ImageHDU.isData(o)) {
d = ImageHDU.encapsulate(o);
h = ImageHDU.manufactureHeader(d);
} else if (RandomGroupsHDU.isData(o)) {
d = RandomGroupsHDU.encapsulate(o);
h = RandomGroupsHDU.manufactureHeader(d);
} else if (current().useAsciiTables && AsciiTableHDU.isData(o)) {
d = AsciiTableHDU.encapsulate(o);
h = AsciiTableHDU.manufactureHeader(d);
} else if (BinaryTableHDU.isData(o)) {
d = BinaryTableHDU.encapsulate(o);
h = BinaryTableHDU.manufactureHeader(d);
} else if (UndefinedHDU.isData(o)) {
d = UndefinedHDU.encapsulate(o);
h = UndefinedHDU.manufactureHeader(d);
} else {
throw new FitsException("Invalid data presented to HDUFactory");
}
return hduFactory(h, d);
}
// CHECKSTYLE:OFF
/**
* @return Given Header and data objects return the appropriate type of HDU.
* @param hdr
* the header of the date
* @param d
* the data
* @param
* the class of the data
* @throws FitsException
* if the operation failed
* @deprecated use {@link #hduFactory(Header, Data)} instead
*/
@Deprecated
public static BasicHDU HDUFactory(Header hdr, DataClass d) throws FitsException {
return hduFactory(hdr, d);
}
// CHECKSTYLE:ON
// CHECKSTYLE:OFF
/**
* @return Given an object, create the appropriate FITS header to describe
* it.
* @param o
* The object to be described.
* @throws FitsException
* if the parameter could not be converted to a hdu.
* @deprecated use {@link #hduFactory(Object)} instead
*/
@Deprecated
public static BasicHDU HDUFactory(Object o) throws FitsException {
return hduFactory(o);
}
// CHECKSTYLE:ON
private static void initializeThreadPool() {
synchronized (GLOBAL_SETTINGS) {
if (threadPool == null) {
// 1.5 thread per core
threadPool = Executors.newFixedThreadPool(Runtime.getRuntime().availableProcessors() * 2, //
new ThreadFactory() {
private int counter = 1;
@Override
public Thread newThread(Runnable r) {
return new Thread(r, "nom-tam-fits worker " + this.counter++);
}
});
}
}
}
/**
* @return true If long string support is enabled.
*/
public static boolean isLongStringsEnabled() {
return current().longStringsEnabled;
}
/**
* Do we allow junk after a valid FITS file?
*
* @param allowTerminalJunk
* value to set
*/
public static void setAllowTerminalJunk(boolean allowTerminalJunk) {
current().allowTerminalJunk = allowTerminalJunk;
}
/**
* Enable/Disable checking of strings values used in tables to ensure that
* they are within the range specified by the FITS standard. The standard
* only allows the values 0x20 - 0x7E with null bytes allowed in one limited
* context. Disabled by default.
*
* @param checkAsciiStrings
* value to set
*/
public static void setCheckAsciiStrings(boolean checkAsciiStrings) {
current().checkAsciiStrings = checkAsciiStrings;
}
/**
* Enable/Disable longstring support.
*
* @param longStringsEnabled
* value to set
*/
public static void setLongStringsEnabled(boolean longStringsEnabled) {
current().longStringsEnabled = longStringsEnabled;
}
/**
* Indicate whether ASCII tables should be used where feasible.
*
* @param useAsciiTables
* value to set
*/
public static void setUseAsciiTables(boolean useAsciiTables) {
current().useAsciiTables = useAsciiTables;
}
/**
* There is not a real standard how to write hierarch keys, default we use
* the one where every key is separated by a blank. If you want or need
* another format assing the formater here.
*
* @param formatter
* the hierarch key formatter.
*/
public static void setHierarchFormater(IHierarchKeyFormatter formatter) {
current().hierarchKeyFormatter = formatter;
}
/**
* @return the formatter to use for hierarch keys.
*/
public static IHierarchKeyFormatter getHierarchFormater() {
return current().hierarchKeyFormatter;
}
/**
* Enable/Disable hierarchical keyword processing.
*
* @param useHierarch
* value to set
*/
public static void setUseHierarch(boolean useHierarch) {
current().useHierarch = useHierarch;
}
public static ExecutorService threadPool() {
if (threadPool == null) {
initializeThreadPool();
}
return threadPool;
}
/**
* Use thread local settings for the current thread instead of the global
* ones if the parameter is set to true, else use the shared global
* settings.
*
* @param useThreadSettings
* true if the thread should not share the global settings.
*/
public static void useThreadLocalSettings(boolean useThreadSettings) {
if (useThreadSettings) {
LOCAL_SETTINGS.set(GLOBAL_SETTINGS.copy());
} else {
LOCAL_SETTINGS.remove();
}
}
private FitsFactory() {
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy