fact.io

Class FITSWriter

java.lang.Object

fact.io.Writer

fact.io.FITSWriter

All Implemented Interfaces:

stream.Processor, stream.StatefulProcessor

public class FITSWriter
extends Writer
implements stream.StatefulProcessor

Created by maxnoe on 10.08.16.

Write data to a FITS file sequentially.

This processor is able to serialize scalars and 1d-arrays of fixed length containing primitive types. Other data structures will be ignored (complex objects) or lead to errors (variable length arrays).

The fits file is initialised and the header is filled using the given keys from first data item. All following items must have the same structure.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allowNullKeys
boolean	caseSensitive
String	extname
stream.Keys	headerKeys
stream.Keys	keys
URL	url

Constructor Summary

Constructors

Constructor and Description
FITSWriter()

Method Summary

Modifier and Type	Method and Description
void	addFACTToolsMetaData(nom.tam.fits.Header header)
void	finish()
static String	formatDateTime(ZonedDateTime zonedDateTime) Java DateTimeFormatter.ISO_INSTANT creates variable length strings, because only the significant digits are returned.
void	init(stream.ProcessContext processContext)
stream.Data	process(stream.Data item)
void	resetState()

Methods inherited from class fact.io.Writer

getDefaultKeys, isSimulated, testKeys

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

keys

@Parameter(description="Keys to save to the outputfile, if not given, the default keys for observations and simulations are stored, taken from the default/settings.properties file")
public stream.Keys keys

headerKeys

@Parameter(description="Keys to write to the FITS Header. Only the first data item will be used. Using streams.Keys")
public stream.Keys headerKeys

url

@Parameter(required=true,
           description="Url for the output file")
public URL url

extname

@Parameter(defaultValue="Events",
           description="EXTNAME for the binary table extension")
public String extname

allowNullKeys

@Parameter(required=false,
           description="Set if you want to allow non existing keys.")
public boolean allowNullKeys

caseSensitive

@Parameter(required=false,
           description="If the matching of the keys should be done case sensitive")
public boolean caseSensitive

Constructor Detail

FITSWriter

public FITSWriter()

Method Detail

process

public stream.Data process(stream.Data item)

Specified by:

process in interface stream.Processor

addFACTToolsMetaData

public void addFACTToolsMetaData(nom.tam.fits.Header header)
                          throws nom.tam.fits.FitsException

Throws:

nom.tam.fits.FitsException

init

public void init(stream.ProcessContext processContext)
          throws Exception

Specified by:

init in interface stream.StatefulProcessor

Throws:

Exception

resetState

public void resetState()
                throws Exception

Specified by:

resetState in interface stream.StatefulProcessor

Throws:

Exception

finish

public void finish()
            throws Exception

Specified by:

finish in interface stream.StatefulProcessor

Throws:

Exception

formatDateTime

public static String formatDateTime(ZonedDateTime zonedDateTime)

Java DateTimeFormatter.ISO_INSTANT creates variable length strings, because only the significant digits are returned. Thus, we pad the string and return only the microseconds part.

Parameters:

zonedDateTime -

Returns: