A B C D E F G H I K L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractArrayDataIO - Class in uk.ac.starlink.fits
-
Abstract implementation of an implementation of a
nom.tam.util
-compatible FITS I/O handler. - AbstractArrayDataIO() - Constructor for class uk.ac.starlink.fits.AbstractArrayDataIO
- AbstractFitsTableWriter - Class in uk.ac.starlink.fits
-
Abstract table writer superclass designed for writing FITS tables.
- AbstractFitsTableWriter(String) - Constructor for class uk.ac.starlink.fits.AbstractFitsTableWriter
-
Constructor.
- AbstractWideFits - Class in uk.ac.starlink.fits
-
Implementations of the WideFits interface.
- AbstractWideFits(int, int, String) - Constructor for class uk.ac.starlink.fits.AbstractWideFits
-
Constructor.
- acquireBlock(int) - Method in class uk.ac.starlink.fits.BlockMappedInput
-
Obtains a buffer corresponding to a named block of the stream.
- addContainerColumnHeader(Header, long, long) - Method in class uk.ac.starlink.fits.AbstractWideFits
- addContainerColumnHeader(Header, long, long) - Method in interface uk.ac.starlink.fits.WideFits
-
Adds the per-HDU header cards that describe the single container column (with index icolContainer) used to implement this convention in a BINTABLE HDU.
- addExtensionHeader(Header, int) - Method in class uk.ac.starlink.fits.AbstractWideFits
- addExtensionHeader(Header, int) - Method in interface uk.ac.starlink.fits.WideFits
-
Adds the per-HDU header cards that announce the operation of this convention in a BINTABLE HDU.
- addMetadata(Header) - Method in class uk.ac.starlink.fits.AbstractFitsTableWriter
-
Adds some standard metadata header cards to a FITS table header.
- addStringValue(Header, String, String, String) - Static method in class uk.ac.starlink.fits.FitsConstants
-
Attempts to add a string-valued card to the header.
- addTrimmedValue(Header, String, String, String) - Static method in class uk.ac.starlink.fits.FitsConstants
-
Adds a string-valued card to the header.
- attemptReadTable(ArrayDataInput, boolean, DataSource, WideFits, long[]) - Static method in class uk.ac.starlink.fits.FitsTableBuilder
-
Reads the next header, and returns a StarTable based on it if it represents a table.
B
- BasicInput - Interface in uk.ac.starlink.fits
-
Interface defining the basic data input operations required for the FITS reading classes.
- BasicInputThreadLocal - Class in uk.ac.starlink.fits
-
ThreadLocal based on an InputFactory.
- BasicInputThreadLocal(InputFactory, boolean) - Constructor for class uk.ac.starlink.fits.BasicInputThreadLocal
-
Constructor.
- BintableColumnHeader - Class in uk.ac.starlink.fits
-
Understands how per-column metadata is stored in the headers of a FITS BINTABLE extension.
- BintableColumnHeader() - Constructor for class uk.ac.starlink.fits.BintableColumnHeader
-
Constructor.
- BintableStarTable - Class in uk.ac.starlink.fits
-
An implementation of the StarTable interface which uses a FITS BINTABLE extension.
- BintableStarTable(Header, boolean, WideFits) - Constructor for class uk.ac.starlink.fits.BintableStarTable
-
Constructor.
- BlockMappedInput - Class in uk.ac.starlink.fits
-
Random-access BasicInput implementation that maps a given region of a file as a number of byte buffers.
- BlockMappedInput(FileChannel, long, long, String, int) - Constructor for class uk.ac.starlink.fits.BlockMappedInput
-
Constructor.
- BORING_KEYS - Variable in class uk.ac.starlink.fits.HeaderCards
-
Keywords which are never used as table parameters.
- BufferedRandomInput - Class in uk.ac.starlink.fits
-
BasicInput implementation based on a RandomAccessFile.
- BufferedRandomInput(RandomAccessFile, long) - Constructor for class uk.ac.starlink.fits.BufferedRandomInput
-
Constructs a BufferedRandomInput with a default sized buffer.
- BufferedRandomInput(RandomAccessFile, long, int) - Constructor for class uk.ac.starlink.fits.BufferedRandomInput
-
Constructs a BufferedRandomInput with a buffer of specified size.
C
- canImport(DataFlavor) - Method in class uk.ac.starlink.fits.ColFitsTableBuilder
- canImport(DataFlavor) - Method in class uk.ac.starlink.fits.FitsTableBuilder
-
Returns true for a flavor with the MIME type "application/fits".
- checkColumnCount(WideFits, int) - Static method in class uk.ac.starlink.fits.FitsConstants
-
Checks that a table with the given number of columns can be written.
- close() - Method in interface uk.ac.starlink.fits.BasicInput
-
Releases resources belonging to this object.
- close() - Method in class uk.ac.starlink.fits.BasicInputThreadLocal
- close() - Method in class uk.ac.starlink.fits.BufferedRandomInput
- close() - Method in class uk.ac.starlink.fits.ColFitsStarTable
- close() - Method in class uk.ac.starlink.fits.MappedFile
- close() - Method in class uk.ac.starlink.fits.MultiMappedFile
- close() - Method in class uk.ac.starlink.fits.SimpleMappedInput
- ColFitsStarTable - Class in uk.ac.starlink.fits
-
StarTable based on a single-row FITS BINTABLE which contains the data for an entire column in each cell of the table.
- ColFitsStarTable(DataSource, Header, long, boolean, WideFits) - Constructor for class uk.ac.starlink.fits.ColFitsStarTable
-
Constructor.
- ColFitsTableBuilder - Class in uk.ac.starlink.fits
-
Implementation of the
TableBuilder
interface which reads tables stored in column-oriented FITS binary table format. - ColFitsTableBuilder() - Constructor for class uk.ac.starlink.fits.ColFitsTableBuilder
-
Default constructor.
- ColFitsTableBuilder(WideFits) - Constructor for class uk.ac.starlink.fits.ColFitsTableBuilder
-
Constructor.
- ColFitsTableSerializer - Class in uk.ac.starlink.fits
-
Object which can serialize a StarTable to a data stream as a one-row FITS file in which each element contains an entire column of the table.
- ColFitsTableSerializer(StarTable, WideFits) - Constructor for class uk.ac.starlink.fits.ColFitsTableSerializer
-
Constructor.
- ColFitsTableWriter - Class in uk.ac.starlink.fits
-
Handles writing of a
StarTable
in a column-oriented FITS binary table format. - ColFitsTableWriter() - Constructor for class uk.ac.starlink.fits.ColFitsTableWriter
-
Default constructor.
- ColFitsTableWriter(String, WideFits) - Constructor for class uk.ac.starlink.fits.ColFitsTableWriter
-
Custom constructor.
- configureHierarch() - Static method in class uk.ac.starlink.fits.FitsConstants
-
Ensures that use of the HIERARCH convention when dealing with FITS headers is set to the state expected for STIL operation.
- containsKey(String) - Method in class uk.ac.starlink.fits.HeaderCards
-
Indicates whether the header collection contains a card with the given keyword.
- containsKey(HeaderCards, String) - Method in class uk.ac.starlink.fits.BintableColumnHeader
-
Indicates whether a given header card is present for this object's column.
- createAlphaWideFits(int) - Static method in class uk.ac.starlink.fits.AbstractWideFits
-
Returns a WideFits instance that uses normal TFORMaaa headers where aaa is a 3-digit base-26 integer (each digit is [A-Z]).
- createExtendedHeader(int, int) - Method in interface uk.ac.starlink.fits.WideFits
-
Creates a BintableColumnHeader instance suitable for use with the extended column convention defined by this class.
- createFactory(DataSource, long, long) - Static method in class uk.ac.starlink.fits.InputFactory
-
Constructs an instance of this class to read a given data source.
- createFileFactory(File, long, long) - Static method in class uk.ac.starlink.fits.InputFactory
-
Constructs an instance of this class to read a given uncompressed file.
- createHeaderCard(String) - Static method in class uk.ac.starlink.fits.FitsConstants
-
Create a HeaderCard from a FITS card image.
- createHierarchWideFits(int) - Static method in class uk.ac.starlink.fits.AbstractWideFits
-
Returns a WideFits instance that uses headers of the form HIERARCH XT TFORMnnnnn, using the ESO HIERARCH convention.
- createInput(boolean) - Method in class uk.ac.starlink.fits.InputFactory
-
Returns a BasicInput instance to read this object's byte stream.
- createInput(FileChannel, long, long, String, boolean) - Static method in class uk.ac.starlink.fits.BlockMappedInput
-
Constructs an instance that does or does not support caching.
- createInput(FileChannel, long, long, String, int, long) - Static method in class uk.ac.starlink.fits.BlockMappedInput
-
Constructs an instance with explicit configuration.
- createSequentialFactory(DataSource, long, long) - Static method in class uk.ac.starlink.fits.InputFactory
-
Constructs an instance of this class to read a given data source viewed as a stream, not a file.
- createSequentialInput(DataInput) - Static method in class uk.ac.starlink.fits.InputFactory
-
Returns a non-random-access BasicInput based on a supplied input stream.
- createSerializer(StarTable) - Method in class uk.ac.starlink.fits.AbstractFitsTableWriter
-
Provides a suitable serializer for a given table.
- createSerializer(StarTable) - Method in class uk.ac.starlink.fits.ColFitsTableWriter
- createSerializer(StarTable) - Method in class uk.ac.starlink.fits.FitsTableWriter
- createSerializer(StarTable) - Method in class uk.ac.starlink.fits.HduFitsTableWriter
- createSerializer(StarTable) - Method in class uk.ac.starlink.fits.HealpixFitsTableWriter
-
Returns a StandardFitsTableSerializer only if the table looks like a HEALpix map.
- createSerializer(StarTable) - Method in class uk.ac.starlink.fits.VariableFitsTableWriter
- createStandardHeader(int) - Static method in class uk.ac.starlink.fits.BintableColumnHeader
-
Returns an instance of this class for use with standard FITS BINTABLE headers.
- createTable(Header, InputFactory, WideFits) - Static method in class uk.ac.starlink.fits.BintableStarTable
-
Returns an instance of this class given a data access instance.
- createUnsortedHeader() - Static method in class uk.ac.starlink.fits.FitsConstants
-
Creates a Header instance which does not perform any unsolicited reordering of the header cards.
D
- DEFAULT - Static variable in interface uk.ac.starlink.fits.WideFits
-
Default WideFits instance; currently TFORMaaa using column 999.
- DEFAULT_BLOCKSIZE - Static variable in class uk.ac.starlink.fits.BlockMappedInput
-
Default maximum size in bytes for mapped blocks.
- DEFAULT_EXPIRYMILLIS - Static variable in class uk.ac.starlink.fits.BlockMappedInput
-
Default time in milliseconds after which buffers will be discarded.
- defaultFitsExtensions() - Static method in class uk.ac.starlink.fits.FitsConstants
-
Gets the default permitted list of extensions which identify a FITS resource in the path part of a URL.
- DFLT_BUFSIZE - Static variable in class uk.ac.starlink.fits.BufferedRandomInput
E
- END_CARD - Static variable in class uk.ac.starlink.fits.FitsConstants
-
Image of end-of-header card.
F
- findNamedTable(ArrayDataInput, DataSource, String, WideFits, long[]) - Static method in class uk.ac.starlink.fits.FitsTableBuilder
-
Looks through the HDUs in a given FITS stream and if it finds one which has a given name, attempts to make a table out of it.
- FITS_BLOCK - Static variable in class uk.ac.starlink.fits.FitsConstants
-
Standard size of a FITS block in bytes.
- FitsArrayBuilder - Class in uk.ac.starlink.fits
-
Turns URLs which reference FITS array resources into NDArray objects.
- FitsConstants - Class in uk.ac.starlink.fits
-
Utility class providing some constants and static methods related to FITS file format and starlink classes.
- FitsConstants() - Constructor for class uk.ac.starlink.fits.FitsConstants
- FitsNdxHandler - Class in uk.ac.starlink.fits
-
Turns URLs which reference FITS files or HDUs into Ndx objects.
- FitsStarTable - Class in uk.ac.starlink.fits
-
An implementation of the StarTable interface which uses FITS TABLE or BINTABLE extensions.
- FitsStarTable(TableHDU) - Constructor for class uk.ac.starlink.fits.FitsStarTable
-
Constructs a FitsStarTable object from a FITS TableHDU object.
- FitsTableBuilder - Class in uk.ac.starlink.fits
-
Implementation of the TableBuilder interface which gets StarTables from FITS files.
- FitsTableBuilder() - Constructor for class uk.ac.starlink.fits.FitsTableBuilder
-
Default constructor.
- FitsTableBuilder(WideFits) - Constructor for class uk.ac.starlink.fits.FitsTableBuilder
-
Constructor.
- FitsTableSerializer - Interface in uk.ac.starlink.fits
-
Defines an object which can serialize a table to a FITS HDU.
- FitsTableWriter - Class in uk.ac.starlink.fits
-
Handles writing of a StarTable in FITS binary format.
- FitsTableWriter() - Constructor for class uk.ac.starlink.fits.FitsTableWriter
-
Default constructor.
- FitsTableWriter(String, boolean, WideFits) - Constructor for class uk.ac.starlink.fits.FitsTableWriter
-
Custom constructor.
- flush() - Method in class uk.ac.starlink.fits.MappedFile
- flush() - Method in class uk.ac.starlink.fits.MultiMappedFile
G
- get() - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
-
Reads one byte from the current position.
- get() - Method in class uk.ac.starlink.fits.MappedFile
- get() - Method in class uk.ac.starlink.fits.MultiMappedFile
- get(byte[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
-
Reads bytes into a buffer from the current position.
- get(byte[], int, int) - Method in class uk.ac.starlink.fits.MappedFile
- get(byte[], int, int) - Method in class uk.ac.starlink.fits.MultiMappedFile
- getBadValue(int) - Method in class uk.ac.starlink.fits.ColFitsTableSerializer
- getBadValue(int) - Method in interface uk.ac.starlink.fits.FitsTableSerializer
-
Returns the bad value (text of the TNULLnn card), if any, used for a given column.
- getBadValue(int) - Method in class uk.ac.starlink.fits.StandardFitsTableSerializer
- getBlockCount() - Method in class uk.ac.starlink.fits.BlockMappedInput
-
Returns the number of mapped blocks used.
- getCell(long, int) - Method in class uk.ac.starlink.fits.ColFitsStarTable
- getCell(long, int) - Method in class uk.ac.starlink.fits.FitsStarTable
- getColumnAuxDataInfos() - Method in class uk.ac.starlink.fits.BintableStarTable
- getColumnAuxDataInfos() - Method in class uk.ac.starlink.fits.FitsStarTable
- getColumnCount() - Method in class uk.ac.starlink.fits.BintableStarTable
- getColumnCount() - Method in class uk.ac.starlink.fits.ColFitsStarTable
- getColumnCount() - Method in class uk.ac.starlink.fits.FitsStarTable
- getColumnInfo(int) - Method in class uk.ac.starlink.fits.BintableStarTable
- getColumnInfo(int) - Method in class uk.ac.starlink.fits.ColFitsStarTable
- getColumnInfo(int) - Method in class uk.ac.starlink.fits.FitsStarTable
- getColumnOffsets() - Method in class uk.ac.starlink.fits.BintableStarTable
-
Returns the array of byte offsets from the start of the row at which each column starts.
- getContainerColumnIndex() - Method in class uk.ac.starlink.fits.AbstractWideFits
- getContainerColumnIndex() - Method in interface uk.ac.starlink.fits.WideFits
-
Returns the index of the column used (if any) by this specification for extended column data.
- getCurrentDate() - Static method in class uk.ac.starlink.fits.AbstractFitsTableWriter
-
Returns an ISO-8601 data string representing the time at which this method is called.
- getDataSize(Header) - Static method in class uk.ac.starlink.fits.FitsConstants
-
Utility function to find the number of bytes in the data segment of an HDU.
- getDimensions(int) - Method in class uk.ac.starlink.fits.ColFitsTableSerializer
- getDimensions(int) - Method in interface uk.ac.starlink.fits.FitsTableSerializer
-
Returns the dimensions of the items which will be output for a given column.
- getDimensions(int) - Method in class uk.ac.starlink.fits.StandardFitsTableSerializer
- getDoubleValue(String) - Method in class uk.ac.starlink.fits.HeaderCards
-
Returns the double value for a card with a given key.
- getDoubleValue(HeaderCards, String) - Method in class uk.ac.starlink.fits.BintableColumnHeader
-
Returns the double precision value of a header card for this object's column.
- getExtColumnMax() - Method in class uk.ac.starlink.fits.AbstractWideFits
- getExtColumnMax() - Method in interface uk.ac.starlink.fits.WideFits
-
Maximum extended number of columns that can be represented by this convention.
- getExtendedColumnCount(HeaderCards, int) - Method in class uk.ac.starlink.fits.AbstractWideFits
- getExtendedColumnCount(HeaderCards, int) - Method in interface uk.ac.starlink.fits.WideFits
-
Returns the total number of columns, including extended ones, described by a FITS header according to this convention.
- getFilePointer() - Method in class uk.ac.starlink.fits.MappedFile
- getFilePointer() - Method in class uk.ac.starlink.fits.MultiMappedFile
- getFormatChar(int) - Method in class uk.ac.starlink.fits.ColFitsTableSerializer
- getFormatChar(int) - Method in interface uk.ac.starlink.fits.FitsTableSerializer
-
Returns the FITS TFORM letter which describes the type of data output for a given column.
- getFormatChar(int) - Method in class uk.ac.starlink.fits.StandardFitsTableSerializer
- getFormatName() - Method in class uk.ac.starlink.fits.AbstractFitsTableWriter
- getFormatName() - Method in class uk.ac.starlink.fits.ColFitsTableBuilder
- getFormatName() - Method in class uk.ac.starlink.fits.FitsTableBuilder
-
Returns "FITS".
- getHeader() - Method in class uk.ac.starlink.fits.ColFitsTableSerializer
- getHeader() - Method in interface uk.ac.starlink.fits.FitsTableSerializer
-
Returns a header suitable for the HDU which will contain the table.
- getHeader() - Method in class uk.ac.starlink.fits.StandardFitsTableSerializer
- getHeader() - Method in class uk.ac.starlink.fits.VariableFitsTableSerializer
- getHealpixHeaders(HealpixTableInfo) - Method in class uk.ac.starlink.fits.StandardFitsTableSerializer
-
Returns FITS headers specific for a table containing a HEALPix map.
- getInputStreamStart(DataSource) - Static method in class uk.ac.starlink.fits.FitsConstants
-
Returns an input stream which can be used with the various FITS classes based on a given DataSource object, positioned at the start of the stream.
- getInstance() - Static method in class uk.ac.starlink.fits.FitsArrayBuilder
-
Returns a FitsArrayBuilder.
- getInstance() - Static method in class uk.ac.starlink.fits.FitsNdxHandler
-
Returns a FitsNdxHandler.
- getInstance() - Static method in class uk.ac.starlink.fits.Unmapper
-
Returns an instance of this class.
- getIntValue(String) - Method in class uk.ac.starlink.fits.HeaderCards
-
Returns the integer value for a card with a given key.
- getKeyName(String) - Method in class uk.ac.starlink.fits.BintableColumnHeader
-
Gives the name of the actual FITS header card for the column managed by this object and a standard FITS BINTABLE base header name.
- getLongValue(String) - Method in class uk.ac.starlink.fits.HeaderCards
-
Returns the long value for a card with a given key.
- getLongValue(HeaderCards, String) - Method in class uk.ac.starlink.fits.BintableColumnHeader
-
Returns the long integer value of a header card for this object's column.
- getMimeType() - Method in class uk.ac.starlink.fits.AbstractFitsTableWriter
-
Returns "application/fits".
- getOffset() - Method in interface uk.ac.starlink.fits.BasicInput
-
Returns the curent position in this stream (optional operation).
- getOffset() - Method in class uk.ac.starlink.fits.BlockMappedInput
- getOffset() - Method in class uk.ac.starlink.fits.BufferedRandomInput
- getOffset() - Method in class uk.ac.starlink.fits.SimpleMappedInput
- getRow(long) - Method in class uk.ac.starlink.fits.ColFitsStarTable
- getRow(long) - Method in class uk.ac.starlink.fits.FitsStarTable
- getRowCount() - Method in class uk.ac.starlink.fits.BintableStarTable
- getRowCount() - Method in class uk.ac.starlink.fits.ColFitsStarTable
- getRowCount() - Method in class uk.ac.starlink.fits.ColFitsTableSerializer
- getRowCount() - Method in class uk.ac.starlink.fits.FitsStarTable
- getRowCount() - Method in interface uk.ac.starlink.fits.FitsTableSerializer
-
Returns the number of rows which will be output.
- getRowCount() - Method in class uk.ac.starlink.fits.StandardFitsTableSerializer
- getRowLength() - Method in class uk.ac.starlink.fits.BintableStarTable
-
Returns the number of bytes occupied in the data stream by a single row of the table.
- getRowSequence() - Method in class uk.ac.starlink.fits.ColFitsStarTable
- getStringValue(String) - Method in class uk.ac.starlink.fits.HeaderCards
-
Returns the string value for a card with a given key.
- getStringValue(HeaderCards, String) - Method in class uk.ac.starlink.fits.BintableColumnHeader
-
Returns the string value of a header card for this object's column.
- getUnusedParams() - Method in class uk.ac.starlink.fits.HeaderCards
-
Returns an array of DescribedValue objects suitable for use as items of per-table metadata derived from this FITS header.
H
- HduFitsTableWriter - Class in uk.ac.starlink.fits
-
TableWriter which writes a single extension BINTABLE HDU containing the table.
- HduFitsTableWriter() - Constructor for class uk.ac.starlink.fits.HduFitsTableWriter
-
Default constructor.
- HduFitsTableWriter(String, boolean, WideFits) - Constructor for class uk.ac.starlink.fits.HduFitsTableWriter
-
Custom constructor.
- HeaderCards - Class in uk.ac.starlink.fits
-
Controlled access to a collection of FITS header cards.
- HeaderCards(Header) - Constructor for class uk.ac.starlink.fits.HeaderCards
-
Constructor.
- headerIterable(Header) - Static method in class uk.ac.starlink.fits.FitsConstants
-
Returns an iterable over HeaderCards for a given Header.
- HealpixFitsTableWriter - Class in uk.ac.starlink.fits
-
TableWriter implementation that writes FITS files using the HEALPix-FITS convention.
- HealpixFitsTableWriter() - Constructor for class uk.ac.starlink.fits.HealpixFitsTableWriter
-
Constructor.
I
- initialValue() - Method in class uk.ac.starlink.fits.BasicInputThreadLocal
- InputFactory - Class in uk.ac.starlink.fits
-
Represents a sequence of bytes, and can create BasicInput objects to read it.
- InputFactory() - Constructor for class uk.ac.starlink.fits.InputFactory
- isMagic(byte[]) - Static method in class uk.ac.starlink.fits.FitsConstants
-
Indicates whether the supplied buffer is the start of a FITS file.
- isRandom() - Method in interface uk.ac.starlink.fits.BasicInput
-
Indicates whether this object supports random access.
- isRandom() - Method in class uk.ac.starlink.fits.BlockMappedInput
- isRandom() - Method in class uk.ac.starlink.fits.BufferedRandomInput
- isRandom() - Method in class uk.ac.starlink.fits.ColFitsStarTable
- isRandom() - Method in class uk.ac.starlink.fits.InputFactory
-
Indicates whether the BasicInput objects created by this factory will support random access.
- isRandom() - Method in class uk.ac.starlink.fits.SimpleMappedInput
K
- KEY_ICOL_CONTAINER - Static variable in class uk.ac.starlink.fits.AbstractWideFits
-
Index of container column hosting extended column data.
- KEY_NCOL_EXT - Static variable in class uk.ac.starlink.fits.AbstractWideFits
-
Header key for extended column count - includes standard ones.
L
- length() - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
-
Returns the size of this buffer.
- length() - Method in class uk.ac.starlink.fits.MappedFile
- length() - Method in class uk.ac.starlink.fits.MultiMappedFile
- logWideRead(Logger, int, int) - Static method in class uk.ac.starlink.fits.AbstractWideFits
-
Utility method to write a log message indicating that this convention is being used to read a FITS file.
- logWideWrite(Logger, int, int) - Static method in class uk.ac.starlink.fits.AbstractWideFits
-
Utility method to write a log message indicating that this convention is being used to write a FITS file.
- LONGOFF_INFO - Static variable in class uk.ac.starlink.fits.BintableStarTable
-
Column aux metadata key for stringified longs offset.
- looksLikeFile(String) - Method in class uk.ac.starlink.fits.ColFitsTableWriter
- looksLikeFile(String) - Method in class uk.ac.starlink.fits.FitsTableWriter
-
Returns true if location ends with something like ".fit" or ".fits" or ".fts".
- looksLikeFile(String) - Method in class uk.ac.starlink.fits.HduFitsTableWriter
-
Returns false.
- looksLikeFile(String) - Method in class uk.ac.starlink.fits.HealpixFitsTableWriter
-
Returns false.
- looksLikeFile(String) - Method in class uk.ac.starlink.fits.VariableFitsTableWriter
-
Always returns false.
M
- makeBlankNdx(URL, Ndx) - Method in class uk.ac.starlink.fits.FitsNdxHandler
- makeHdxDocument(URL) - Method in class uk.ac.starlink.fits.FitsNdxHandler
- makeHdxSource(URL) - Method in class uk.ac.starlink.fits.FitsNdxHandler
- makeNDArray(URL, AccessMode) - Method in class uk.ac.starlink.fits.FitsArrayBuilder
- makeNDArray(ArrayDataInput, AccessMode) - Method in class uk.ac.starlink.fits.FitsArrayBuilder
-
Makes a readable NDArray from a data input stream.
- makeNdx(URL, AccessMode) - Method in class uk.ac.starlink.fits.FitsNdxHandler
- makeNewNDArray(OutputStream, NDShape, Type, BadHandler, boolean, HeaderCard[]) - Method in class uk.ac.starlink.fits.FitsArrayBuilder
-
Makes a new HDU written into a given stream containing an NDArray with the type and shape as specified.
- makeNewNDArray(URL, NDShape, Type, BadHandler) - Method in class uk.ac.starlink.fits.FitsArrayBuilder
-
Makes a new HDU at a given URL containing an NDArray with the shape and type as specified.
- makeStarTable(DataSource, boolean, StoragePolicy) - Method in class uk.ac.starlink.fits.ColFitsTableBuilder
- makeStarTable(DataSource, boolean, StoragePolicy) - Method in class uk.ac.starlink.fits.FitsTableBuilder
-
Creates a StarTable from a DataSource which refers to a FITS file or stream.
- makeStarTables(DataSource, StoragePolicy) - Method in class uk.ac.starlink.fits.FitsTableBuilder
- MappedFile - Class in uk.ac.starlink.fits
-
Provides mapped access to a data buffer using a single mapped byte buffer, compatible with nom.tam.util classes.
- MappedFile(String) - Constructor for class uk.ac.starlink.fits.MappedFile
-
Constructs a MappedFile object by mapping the whole of an existing file using read-only mode.
- MappedFile(String, String) - Constructor for class uk.ac.starlink.fits.MappedFile
-
Constructs a MappedFile object by mapping the whole of an existing file with a given mode.
- MappedFile(String, String, long, int) - Constructor for class uk.ac.starlink.fits.MappedFile
-
Constructs a MappedFile object by mapping part of an existing file with a given mode.
- MappedFile(ByteBuffer) - Constructor for class uk.ac.starlink.fits.MappedFile
-
Constructs a MappedFile object from a byte buffer.
- MappedFile.FileTooLongException - Exception in uk.ac.starlink.fits
-
Exception indicating that a file is too long to map.
- mark(int) - Method in class uk.ac.starlink.fits.MappedFile
- mark(int) - Method in class uk.ac.starlink.fits.MultiMappedFile
- markSupported() - Method in class uk.ac.starlink.fits.MappedFile
- markSupported() - Method in class uk.ac.starlink.fits.MultiMappedFile
- MAX_NCOLSTD - Static variable in class uk.ac.starlink.fits.FitsConstants
-
Maximum number of columns in standard FITS BINTABLE extension.
- MAX_NCOLSTD - Static variable in interface uk.ac.starlink.fits.WideFits
-
Maximum number of standard columns, imposed by FITS standard (999).
- MultiMappedFile - Class in uk.ac.starlink.fits
-
ArrayDataIO implementation which works by mapping but is capable of splitting a file up into multiple mapped sections.
- MultiMappedFile(File, FileChannel.MapMode, int) - Constructor for class uk.ac.starlink.fits.MultiMappedFile
-
Constructs a MultiMappedFile from a file.
- MultiMappedFile(FileChannel, FileChannel.MapMode, int) - Constructor for class uk.ac.starlink.fits.MultiMappedFile
-
Constructs a MultiMappedFile from a channel.
N
- NDARRAY_ORIGIN - Static variable in class uk.ac.starlink.fits.FitsConstants
-
FITS header card for indicating NDArray origin values.
- NDARRAY_PREFIX - Static variable in class uk.ac.starlink.fits.FitsConstants
-
Prefix for NDArray-related FITS header cards.
- NDX_PREFIX - Static variable in class uk.ac.starlink.fits.FitsConstants
-
Prefix for NDX-related FITS header cards.
- NDX_XML - Static variable in class uk.ac.starlink.fits.FitsConstants
-
FITS header card for location (relative URL) of XML representation.
O
- outputNdx(URL, Ndx) - Method in class uk.ac.starlink.fits.FitsNdxHandler
- outputNdx(ArrayDataOutput, URL, Ndx) - Method in class uk.ac.starlink.fits.FitsNdxHandler
-
Writes an NDX to a given output stream.
P
- put(byte) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
-
Writes a single byte at the current position.
- put(byte) - Method in class uk.ac.starlink.fits.MappedFile
- put(byte) - Method in class uk.ac.starlink.fits.MultiMappedFile
- put(byte[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
-
Writes bytes from a buffer to the current position.
- put(byte[], int, int) - Method in class uk.ac.starlink.fits.MappedFile
- put(byte[], int, int) - Method in class uk.ac.starlink.fits.MultiMappedFile
R
- read(boolean[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- read(boolean[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- read(byte[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- read(byte[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- read(char[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- read(char[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- read(double[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- read(double[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- read(float[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- read(float[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- read(int[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- read(int[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- read(long[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- read(long[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- read(short[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- read(short[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- readArray(Object) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- readBoolean() - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- readByte() - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- readByte() - Method in interface uk.ac.starlink.fits.BasicInput
-
Reads a byte from the stream.
- readByte() - Method in class uk.ac.starlink.fits.BlockMappedInput
- readByte() - Method in class uk.ac.starlink.fits.BufferedRandomInput
- readByte() - Method in class uk.ac.starlink.fits.SimpleMappedInput
- readBytes(byte[]) - Method in interface uk.ac.starlink.fits.BasicInput
-
Reads bytes into an array from the stream.
- readBytes(byte[]) - Method in class uk.ac.starlink.fits.BlockMappedInput
- readBytes(byte[]) - Method in class uk.ac.starlink.fits.BufferedRandomInput
- readBytes(byte[]) - Method in class uk.ac.starlink.fits.SimpleMappedInput
- readCell(BasicInput, int) - Method in class uk.ac.starlink.fits.BintableStarTable
-
Reads a cell from a given column from the current position in a stream.
- readChar() - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- readDouble() - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- readDouble() - Method in interface uk.ac.starlink.fits.BasicInput
-
Reads an 8-byte floating point value from the stream.
- readDouble() - Method in class uk.ac.starlink.fits.BlockMappedInput
- readDouble() - Method in class uk.ac.starlink.fits.BufferedRandomInput
- readDouble() - Method in class uk.ac.starlink.fits.SimpleMappedInput
- readFloat() - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- readFloat() - Method in interface uk.ac.starlink.fits.BasicInput
-
Reads a 4-byte floating point value from the stream.
- readFloat() - Method in class uk.ac.starlink.fits.BlockMappedInput
- readFloat() - Method in class uk.ac.starlink.fits.BufferedRandomInput
- readFloat() - Method in class uk.ac.starlink.fits.SimpleMappedInput
- readFully(byte[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- readFully(byte[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
-
Reads a specified number of bytes into an array.
- readHeader(Header, ArrayDataInput) - Static method in class uk.ac.starlink.fits.FitsConstants
-
Populates a header from an input stream, reporting its length in bytes.
- readInt() - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- readInt() - Method in interface uk.ac.starlink.fits.BasicInput
-
Reads a 4-byte integer from the stream.
- readInt() - Method in class uk.ac.starlink.fits.BlockMappedInput
- readInt() - Method in class uk.ac.starlink.fits.BufferedRandomInput
- readInt() - Method in class uk.ac.starlink.fits.SimpleMappedInput
- readLArray(Object) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- readLine() - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
-
Deprecated.see
DataInputStream.readLine()
- readLong() - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- readLong() - Method in interface uk.ac.starlink.fits.BasicInput
-
Reads an 8-byte integer from the stream.
- readLong() - Method in class uk.ac.starlink.fits.BlockMappedInput
- readLong() - Method in class uk.ac.starlink.fits.BufferedRandomInput
- readLong() - Method in class uk.ac.starlink.fits.SimpleMappedInput
- readRow(BasicInput) - Method in class uk.ac.starlink.fits.BintableStarTable
-
Reads a whole row of the table from the current position in a stream, returning a new Object[] array.
- readShort() - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- readShort() - Method in interface uk.ac.starlink.fits.BasicInput
-
Reads a 2-byte integer from the stream.
- readShort() - Method in class uk.ac.starlink.fits.BlockMappedInput
- readShort() - Method in class uk.ac.starlink.fits.BufferedRandomInput
- readShort() - Method in class uk.ac.starlink.fits.SimpleMappedInput
- readUnsignedByte() - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- readUnsignedShort() - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- readUTF() - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- remaining() - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
-
Returns the number of bytes remaining between the current position and the end of the file.
- remaining() - Method in class uk.ac.starlink.fits.MappedFile
- remaining() - Method in class uk.ac.starlink.fits.MultiMappedFile
- REQUIRE_HIERARCH - Static variable in class uk.ac.starlink.fits.FitsConstants
-
Whether HIERARCH convention is used; true by default.
- reset() - Method in class uk.ac.starlink.fits.MappedFile
- reset() - Method in class uk.ac.starlink.fits.MultiMappedFile
S
- seek(long) - Method in interface uk.ac.starlink.fits.BasicInput
-
Moves the current position of this stream to a given byte offset (optional operation).
- seek(long) - Method in class uk.ac.starlink.fits.BlockMappedInput
- seek(long) - Method in class uk.ac.starlink.fits.BufferedRandomInput
- seek(long) - Method in class uk.ac.starlink.fits.MappedFile
- seek(long) - Method in class uk.ac.starlink.fits.MultiMappedFile
- seek(long) - Method in class uk.ac.starlink.fits.SimpleMappedInput
- set64BitMode(boolean) - Method in class uk.ac.starlink.fits.VariableFitsTableSerializer
-
Sets whether this serializer should use the 'P' descriptor (32-bit addressing into the heap) or the 'Q' descriptor (64-bit addressing into the heap) for variable-length array columns.
- setFormatName(String) - Method in class uk.ac.starlink.fits.AbstractFitsTableWriter
-
Sets the declared format name.
- setStoragePolicy(StoragePolicy) - Method in class uk.ac.starlink.fits.VariableFitsTableWriter
-
Sets the storage policy which will be used for temporary storage during writing.
- SimpleMappedInput - Class in uk.ac.starlink.fits
-
Random-access BasicInput implementation that maps a given region of a file as a monolithic byte buffer.
- SimpleMappedInput(FileChannel, long, int, String) - Constructor for class uk.ac.starlink.fits.SimpleMappedInput
-
Constructor.
- skip(long) - Method in interface uk.ac.starlink.fits.BasicInput
-
Skips a given number of bytes forwards through the stream.
- skip(long) - Method in class uk.ac.starlink.fits.BlockMappedInput
- skip(long) - Method in class uk.ac.starlink.fits.BufferedRandomInput
- skip(long) - Method in class uk.ac.starlink.fits.MappedFile
- skip(long) - Method in class uk.ac.starlink.fits.MultiMappedFile
- skip(long) - Method in class uk.ac.starlink.fits.SimpleMappedInput
- skipAllBytes(int) - Method in class uk.ac.starlink.fits.MappedFile
- skipAllBytes(int) - Method in class uk.ac.starlink.fits.MultiMappedFile
- skipAllBytes(long) - Method in class uk.ac.starlink.fits.MappedFile
- skipAllBytes(long) - Method in class uk.ac.starlink.fits.MultiMappedFile
- skipBytes(int) - Method in class uk.ac.starlink.fits.MappedFile
- skipBytes(int) - Method in class uk.ac.starlink.fits.MultiMappedFile
- skipHDUs(ArrayDataInput, int) - Static method in class uk.ac.starlink.fits.FitsConstants
-
Skips forward over a given number of HDUs in the supplied stream.
- StandardFitsTableSerializer - Class in uk.ac.starlink.fits
-
Class which knows how to do the various bits of serializing a StarTable to FITS BINTABLE format.
- StandardFitsTableSerializer(StarTable, boolean, WideFits) - Constructor for class uk.ac.starlink.fits.StandardFitsTableSerializer
-
Constructs a serializer to write a given StarTable, with explicit instruction about how to write byte-type columns data.
- streamStarTable(InputStream, TableSink, String) - Method in class uk.ac.starlink.fits.ColFitsTableBuilder
- streamStarTable(InputStream, TableSink, String) - Method in class uk.ac.starlink.fits.FitsTableBuilder
-
Reads a FITS table from an input stream and writes it to a sink.
- streamStarTable(Header, BasicInput, WideFits, TableSink) - Static method in class uk.ac.starlink.fits.BintableStarTable
-
Reads a BINTABLE extension from a stream and writes the result to a table sink.
T
- TBCOL_INFO - Static variable in class uk.ac.starlink.fits.BintableStarTable
-
Column aux metadata key for TBCOLn cards.
- TDISP_INFO - Static variable in class uk.ac.starlink.fits.BintableStarTable
-
Column aux metadata key for TDISPn cards.
- TFORM_INFO - Static variable in class uk.ac.starlink.fits.BintableStarTable
-
Column aux metadata key for TFORMn cards.
- TNULL_INFO - Static variable in class uk.ac.starlink.fits.BintableStarTable
-
Column aux metadata key for TNULLn cards.
- toString() - Method in class uk.ac.starlink.fits.AbstractWideFits
- TSCAL_INFO - Static variable in class uk.ac.starlink.fits.BintableStarTable
-
Column aux metadata key for TSCALn cards.
- TZERO_INFO - Static variable in class uk.ac.starlink.fits.BintableStarTable
-
Column aux metadata key for TZEROn cards.
U
- uk.ac.starlink.fits - package uk.ac.starlink.fits
-
Classes for general FITS handling, including NDX, NDArray and StarTable implementations.
- unmap(MappedByteBuffer) - Method in class uk.ac.starlink.fits.Unmapper
-
Attempts to release the resources (mapped memory) used by a given MappedByteBuffer.
- UNMAP_PROPERTY - Static variable in class uk.ac.starlink.fits.Unmapper
-
Name of system property to control buffer unmapping ("startable.unmap").
- Unmapper - Class in uk.ac.starlink.fits
-
Attempts to free resources from a MappedByteBuffer.
- Unmapper() - Constructor for class uk.ac.starlink.fits.Unmapper
- useKey(String) - Method in class uk.ac.starlink.fits.HeaderCards
-
Marks a given keyword as used.
V
- VariableFitsTableSerializer - Class in uk.ac.starlink.fits
-
FitsTableSerializer which can write variable array-valued columns using the 'P' or 'Q' TFORM formatting characters.
- VariableFitsTableSerializer(StarTable, StoragePolicy, boolean, WideFits) - Constructor for class uk.ac.starlink.fits.VariableFitsTableSerializer
-
Constructor.
- VariableFitsTableWriter - Class in uk.ac.starlink.fits
-
TableWriter which writes FITS BINTABLEs with variable-length arrays where appropriate.
- VariableFitsTableWriter() - Constructor for class uk.ac.starlink.fits.VariableFitsTableWriter
-
Constructs a writer with default characteristics.
- VariableFitsTableWriter(Boolean, boolean, WideFits) - Constructor for class uk.ac.starlink.fits.VariableFitsTableWriter
-
Constructs a writer with custom characteristics.
W
- WCS_ENCODING - Static variable in class uk.ac.starlink.fits.FitsConstants
-
Default encoding used for writing WCS into FITS headers.
- WideFits - Interface in uk.ac.starlink.fits
-
Defines a convention for storing extended column data in a FITS BINTABLE extension.
- write(boolean[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(boolean[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(byte[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(byte[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(char[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(char[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(double[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(double[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(float[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(float[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(int[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(int[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(long[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(long[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(short[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(short[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(String[]) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- write(String[], int, int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- writeArray(Object) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- writeBoolean(boolean) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- writeByte(int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- writeBytes(String) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- writeChar(int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- writeChars(String) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- writeData(DataOutput) - Method in class uk.ac.starlink.fits.ColFitsTableSerializer
-
Write the FITS data unit populated by this serializer.
- writeData(DataOutput) - Method in interface uk.ac.starlink.fits.FitsTableSerializer
-
Writes the HDU data for the table to an output stream.
- writeData(DataOutput) - Method in class uk.ac.starlink.fits.StandardFitsTableSerializer
- writeData(DataOutput) - Method in class uk.ac.starlink.fits.VariableFitsTableSerializer
- writeDouble(double) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- writeEmptyPrimary(DataOutput) - Static method in class uk.ac.starlink.fits.FitsConstants
-
Writes a null header representing an empty primary HDU to a stream.
- writeFloat(float) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- writeHeader(DataOutput, Header) - Static method in class uk.ac.starlink.fits.FitsConstants
-
Writes a header object to a DataOutput.
- writeInt(int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- writeLong(long) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- writePrimaryHDU(DataOutput) - Method in class uk.ac.starlink.fits.AbstractFitsTableWriter
-
Writes the primary HDU.
- writePrimaryHDU(DataOutput) - Method in class uk.ac.starlink.fits.HduFitsTableWriter
-
Does nothing.
- writeShort(int) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
- writeStarTable(StarTable, OutputStream) - Method in class uk.ac.starlink.fits.AbstractFitsTableWriter
-
Writes a single table.
- writeStarTables(TableSequence, OutputStream) - Method in class uk.ac.starlink.fits.AbstractFitsTableWriter
-
Writes tables.
- writeStarTables(TableSequence, String, StarTableOutput) - Method in class uk.ac.starlink.fits.AbstractFitsTableWriter
- writeTableHDU(StarTable, FitsTableSerializer, DataOutput) - Method in class uk.ac.starlink.fits.AbstractFitsTableWriter
-
Writes a data HDU.
- writeUTF(String) - Method in class uk.ac.starlink.fits.AbstractArrayDataIO
All Classes All Packages