uk.ac.starlink.fits
Class FitsTableWriter

java.lang.Object
  extended by uk.ac.starlink.table.StreamStarTableWriter
      extended by uk.ac.starlink.fits.AbstractFitsTableWriter
          extended by uk.ac.starlink.fits.FitsTableWriter
All Implemented Interfaces:
MultiStarTableWriter, StarTableWriter

public class FitsTableWriter
extends AbstractFitsTableWriter

Handles writing of a StarTable in FITS binary format. Not all columns can be written to a FITS table, only those ones whose contentClass is in the following list:

In all other cases a warning message will be logged and the column will be ignored for writing purposes.

Output is currently to fixed-width columns only. For StarTable columns of variable size, a first pass is made through the table data to determine the largest size they assume, and the size in the output table is set to the largest of these. Excess space is padded with some sort of blank value (NaN for floating point values, spaces for strings, zero-like values otherwise).


Constructor Summary
FitsTableWriter()
          Default constructor.
FitsTableWriter(String name, boolean allowSignedByte, WideFits wide)
          Custom constructor.
 
Method Summary
protected  FitsTableSerializer createSerializer(StarTable table)
          Provides a suitable serializer for a given table.
 boolean looksLikeFile(String location)
          Returns true if location ends with something like ".fit" or ".fits" or ".fts".
 
Methods inherited from class uk.ac.starlink.fits.AbstractFitsTableWriter
addMetadata, getCurrentDate, getFormatName, getMimeType, setFormatName, writePrimaryHDU, writeStarTable, writeStarTables, writeStarTables, writeTableHDU
 
Methods inherited from class uk.ac.starlink.table.StreamStarTableWriter
writeStarTable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface uk.ac.starlink.table.StarTableWriter
writeStarTable
 

Constructor Detail

FitsTableWriter

public FitsTableWriter()
Default constructor.


FitsTableWriter

public FitsTableWriter(String name,
                       boolean allowSignedByte,
                       WideFits wide)
Custom constructor.

Parameters:
name - writer name
allowSignedByte - if true, bytes written as FITS signed bytes (TZERO=-128), if false bytes written as signed shorts
wide - convention for representing over-wide tables; null to avoid this convention
Method Detail

looksLikeFile

public boolean looksLikeFile(String location)
Returns true if location ends with something like ".fit" or ".fits" or ".fts".

Parameters:
location - filename
Returns:
true if it sounds like a fits file

createSerializer

protected FitsTableSerializer createSerializer(StarTable table)
                                        throws IOException
Description copied from class: AbstractFitsTableWriter
Provides a suitable serializer for a given table. Note this should throw an IOException if it can be determined that the submitted table cannot be written by this writer, for instance if it has too many columns.

Specified by:
createSerializer in class AbstractFitsTableWriter
Parameters:
table - table to serialize
Returns:
FITS serializer
Throws:
IOException - if the table can't be written

Copyright © 2004 CLRC: Central Laboratory of the Research Councils. All rights reserved.