|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.table.StreamStarTableWriter
uk.ac.starlink.fits.AbstractFitsTableWriter
uk.ac.starlink.votable.VOTableFitsTableWriter
uk.ac.starlink.votable.FitsPlusTableWriter
public class FitsPlusTableWriter
TableWriter which writes table data into the first extension of a FITS file,
Unlike FitsTableWriter
however, the
primary extension is not left contentless, instead it gets the
text of a DATA-less VOTable written into it. This VOTable describes
the metadata of the table, as if the DATA element contained a FITS
element referencing the first extension HDU of the file.
Tables stored in this format have all the rich metadata associated
with VOTables, and benefit from the compactness of FITS tables,
without the considerable disdvantage of being split into two files.
The header cards in the primary HDU look like this:
SIMPLE = T / Standard FITS format BITPIX = 8 / Character data NAXIS = 1 / Text string NAXIS1 = nnnn / Number of characters VOTMETA = T / Table metadata in VOTABLE format EXTEND = T / There are standard extensionsthe VOTMETA card in particular marking that this HDU contains VOTable metadata.
Constructor Summary | |
---|---|
FitsPlusTableWriter()
Default constructor. |
|
FitsPlusTableWriter(String name,
WideFits wide)
Custom constructor. |
Method Summary | |
---|---|
protected FitsTableSerializer |
createSerializer(StarTable table)
Provides a suitable serializer for a given table. |
protected void |
customisePrimaryHeader(nom.tam.fits.Header hdr)
Hook for adding custom entries to the FITS header which is written to the primary HDU. |
static StarTableWriter[] |
getStarTableWriters()
Returns a list of FITS-plus table writers with variant values of attributes. |
protected boolean |
isMagic(int icard,
String key,
String value)
Tests a header card to see if it looks like part of the magic number for the format written by this handler. |
boolean |
looksLikeFile(String location)
Returns true if location ends with something like ".fit" or ".fits". |
Methods inherited from class uk.ac.starlink.votable.VOTableFitsTableWriter |
---|
isMagic, setVotableVersion, writeStarTables |
Methods inherited from class uk.ac.starlink.fits.AbstractFitsTableWriter |
---|
addMetadata, getCurrentDate, getFormatName, getMimeType, setFormatName, writePrimaryHDU, writeStarTable, 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 |
---|
public FitsPlusTableWriter()
public FitsPlusTableWriter(String name, WideFits wide)
name
- writer namewide
- convention for representing over-wide tables;
null to avoid this conventionMethod Detail |
---|
public boolean looksLikeFile(String location)
location
- filename
protected void customisePrimaryHeader(nom.tam.fits.Header hdr) throws nom.tam.fits.HeaderCardException
VOTableFitsTableWriter
customisePrimaryHeader
in class VOTableFitsTableWriter
nom.tam.fits.HeaderCardException
protected boolean isMagic(int icard, String key, String value)
VOTableFitsTableWriter
VOTableFitsTableWriter
implementation tests that
the first four cards read:
SIMPLE = T BITPIX = 8 NAXIS = 1 NAXIS1 = ???Subclasses may override this to add tests for later cards (as written in
VOTableFitsTableWriter.customisePrimaryHeader(nom.tam.fits.Header)
).
isMagic
in class VOTableFitsTableWriter
icard
- 0-based card indexkey
- card namevalue
- card value
protected FitsTableSerializer createSerializer(StarTable table) throws IOException
AbstractFitsTableWriter
createSerializer
in class AbstractFitsTableWriter
table
- table to serialize
IOException
- if the table can't be writtenpublic static StarTableWriter[] getStarTableWriters()
|
Copyright © 2004 CLRC: Central Laboratory of the Research Councils. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |