Class FitsOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

java.io.BufferedOutputStream

nom.tam.util.ArrayOutputStream

nom.tam.util.FitsOutputStream

All Implemented Interfaces:

Closeable, DataOutput, Flushable, AutoCloseable, ArrayDataOutput, FitsIO, FitsOutput, OutputWriter

Direct Known Subclasses:

BufferedDataOutputStream

public class FitsOutputStream
extends ArrayOutputStream
implements FitsOutput

For writing FITS files through an OutputStream.

Testing and timing for this class is performed in the nom.tam.util.test.BufferedFileTester class.

Version 2.0 -- October 30, 2021: Completely overhauled, with new name and hierarchy. Performance is 2-4 times better than before. (Attila Kovacs)

See Also:

• FitsInputStream
• FitsFile

Field Summary

Fields inherited from interface FitsIO

BITS_OF_1_BYTE, BITS_OF_2_BYTES, BITS_OF_3_BYTES, BITS_OF_4_BYTES, BITS_OF_5_BYTES, BITS_OF_6_BYTES, BITS_OF_7_BYTES, BYTE_1_OF_LONG_MASK, BYTE_2_OF_LONG_MASK, BYTE_3_OF_LONG_MASK, BYTE_4_OF_LONG_MASK, BYTE_MASK, BYTES_IN_BOOLEAN, BYTES_IN_BYTE, BYTES_IN_CHAR, BYTES_IN_DOUBLE, BYTES_IN_FLOAT, BYTES_IN_INTEGER, BYTES_IN_LONG, BYTES_IN_SHORT, DEFAULT_BUFFER_SIZE, HIGH_INTEGER_MASK, INTEGER_MASK, SHORT_MASK, SHORT_OF_LONG_MASK

Modifier and Type	Field	Description
static final int	BITS_OF_1_BYTE	number of bits in one byte.
static final int	BITS_OF_2_BYTES	number of bits in two byte.
static final int	BITS_OF_3_BYTES	number of bits in three byte.
static final int	BITS_OF_4_BYTES	number of bits in four byte.
static final int	BITS_OF_5_BYTES	number of bits in five byte.
static final int	BITS_OF_6_BYTES	number of bits in six byte.
static final int	BITS_OF_7_BYTES	number of bits in seven byte.
static final long	BYTE_1_OF_LONG_MASK	bit mask to get the lowest byte of a long.
static final long	BYTE_2_OF_LONG_MASK	bit mask to get the second lowest byte of a long.
static final long	BYTE_3_OF_LONG_MASK	bit mask to get the third lowest byte of a long.
static final long	BYTE_4_OF_LONG_MASK	bit mask to get the fourth lowest byte of a long.
static final int	BYTE_MASK	bit mask to get the lowest byte from an integer.
static final int	BYTES_IN_BOOLEAN	number of bytes occupied by a boolean.
static final int	BYTES_IN_BYTE	number of bytes occupied by a byte.
static final int	BYTES_IN_CHAR	number of bytes occupied by a char.
static final int	BYTES_IN_DOUBLE	number of bytes occupied by a double.
static final int	BYTES_IN_FLOAT	number of bytes occupied by a float.
static final int	BYTES_IN_INTEGER	number of bytes occupied by a integer.
static final int	BYTES_IN_LONG	number of bytes occupied by a long.
static final int	BYTES_IN_SHORT	number of bytes occupied by a short.
static final int	DEFAULT_BUFFER_SIZE	default buffer size to use unless specified otherwise.
static final long	HIGH_INTEGER_MASK	bit mask to get the highest integer from an long.
static final long	INTEGER_MASK	bit mask to get the lowest integer from an long.
static final int	SHORT_MASK	bit mask to get the lowest short of a integer.
static final long	SHORT_OF_LONG_MASK	bit mask to get the lowest short of a long.

Constructor Summary

Constructors

Constructor	Description
FitsOutputStream(OutputStream o)	Use the BufferedOutputStream constructor
FitsOutputStream(OutputStream o, int bufLength)	Use the BufferedOutputStream constructor

Method Summary

Modifier and Type	Method	Description
boolean	isAtStart()	Checks whether we are currently at the start of this output file or stream.
void	write(boolean[] b, int start, int length)	Write a segment of an array of boolean's.
void	write(byte[] b, int start, int length)	Writes up to the specified number of bytes from a buffer to the stream.
void	write(char[] c, int start, int length)	Write a segment of an array of char's.
void	write(double[] d, int start, int length)	Write a segment of an array of double's.
void	write(float[] f, int start, int length)	Write a segment of an array of float's.
void	write(int b)	Writes a byte.
void	write(int[] i, int start, int length)	Write a segment of an array of int's.
void	write(long[] l, int start, int length)	Write a segment of an array of longs.
void	write(short[] s, int start, int length)	Write a segment of an array of shorts.
void	write(Boolean[] buf, int offset, int size)	Write a segment of an array of booleans, possibly including legal null values.
void	write(String[] s, int start, int len)	Write a segment of an array of Strings.
void	writeBoolean(boolean b)
void	writeByte(int b)
void	writeBytes(String s)
void	writeChar(int c)
void	writeChars(String s)
void	writeDouble(double d)
void	writeFloat(float f)
void	writeInt(int i)
void	writeLong(long l)
final void	writePrimitiveArray(Object o)	Deprecated. use ArrayOutputStream.writeArray(Object) instead
void	writeShort(int s)
void	writeUTF(String s)

Methods inherited from class ArrayOutputStream

writeArray

Modifier and Type	Method	Description
void	writeArray(Object o)	See ArrayDataOutput.writeArray(Object) for a contract of this method.

Methods inherited from class BufferedOutputStream

flush

Methods inherited from class FilterOutputStream

close, write

Methods inherited from class OutputStream

nullOutputStream

Methods inherited from class Object

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

Methods inherited from interface ArrayDataOutput

flush, write, write, write, write, write, write, write, write, write, writeArray

Modifier and Type	Method	Description
void	flush()	Flush the output buffer
default void	write(boolean[] buf)	Write an array of boolean's.
default void	write(char[] buf)	Write an array of char's.
default void	write(double[] buf)	Write an array of double's.
default void	write(float[] buf)	Write an array of float's.
default void	write(int[] buf)	Write an array of int's.
default void	write(long[] buf)	Write an array of longs.
default void	write(short[] buf)	Write an array of shorts.
default void	write(Boolean[] buf)	Write an array of booleans, including legal null values.
default void	write(String[] buf)	Write an array of Strings.
void	writeArray(Object o)	Writes the contents of a Java array to the output translating the data to the required binary representation.

Methods inherited from interface DataOutput

write

Methods inherited from interface FitsIO

close

Modifier and Type	Method	Description
void	close()

Constructor Details

FitsOutputStream

public FitsOutputStream(OutputStream o)

Use the BufferedOutputStream constructor

Parameters:

o - An open output stream.

FitsOutputStream

public FitsOutputStream(OutputStream o,
 int bufLength)

Use the BufferedOutputStream constructor

Parameters:

o - An open output stream.

bufLength - The buffer size.

Method Details

write

public void write(int b)
           throws IOException

Description copied from interface: OutputWriter

Writes a byte. See the general contract of DataOutputStream.write(int).

Specified by:

write in interface DataOutput

Specified by:

write in interface OutputWriter

Overrides:

write in class BufferedOutputStream

Parameters:

b - the (unsigned) byte value to write.

Throws:

IOException - if there was an underlying IO error

See Also:

• DataOutputStream.write(int)

write

public void write(byte[] b,
 int start,
 int length)
           throws IOException

Description copied from interface: OutputWriter

Writes up to the specified number of bytes from a buffer to the stream. See the general contract of DataOutputStream.write(byte[], int, int).

Specified by:

write in interface DataOutput

Specified by:

write in interface OutputWriter

Overrides:

write in class BufferedOutputStream

Parameters:

b - the buffer

start - the starting buffer index

length - the number of bytes to write.

Throws:

IOException - if there was an underlying IO error

See Also:

• DataOutputStream.write(byte[], int, int)

write

public void write(boolean[] b,
 int start,
 int length)
           throws IOException

Description copied from interface: ArrayDataOutput

Write a segment of an array of boolean's.

Specified by:

write in interface ArrayDataOutput

Parameters:

b - array of boolean's.

start - start index in the array

length - number of array elements to write

Throws:

IOException - if one of the underlying write operations failed

write

public void write(Boolean[] buf,
 int offset,
 int size)
           throws IOException

Description copied from interface: ArrayDataOutput

Write a segment of an array of booleans, possibly including legal null values. The method has a default implementation, which calls DataOutput.writeBoolean(boolean) element by element. Classes that implement this interface might want to replace that with a more efficient block read implementation/

Specified by:

write in interface ArrayDataOutput

Parameters:

buf - array of booleans.

offset - start index in the array

size - number of array elements to write

Throws:

IOException - if one of the underlying write operations failed

write

public void write(char[] c,
 int start,
 int length)
           throws IOException

Description copied from interface: ArrayDataOutput

Write a segment of an array of char's.

Specified by:

write in interface ArrayDataOutput

Parameters:

c - array of char's.

start - start index in the array

length - number of array elements to write

Throws:

IOException - if one of the underlying write operations failed

write

public void write(short[] s,
 int start,
 int length)
           throws IOException

Description copied from interface: ArrayDataOutput

Write a segment of an array of shorts.

Specified by:

write in interface ArrayDataOutput

Parameters:

s - the value to write

start - start index in the array

length - number of array elements to write

Throws:

IOException - if one of the underlying write operations failed

write

public void write(int[] i,
 int start,
 int length)
           throws IOException

Description copied from interface: ArrayDataOutput

Write a segment of an array of int's.

Specified by:

write in interface ArrayDataOutput

Parameters:

i - array of int's

start - start index in the array

length - number of array elements to write

Throws:

IOException - if one of the underlying write operations failed

write

public void write(long[] l,
 int start,
 int length)
           throws IOException

Description copied from interface: ArrayDataOutput

Write a segment of an array of longs.

Specified by:

write in interface ArrayDataOutput

Parameters:

l - array of longs

start - start index in the array

length - number of array elements to write

Throws:

IOException - if one of the underlying write operations failed

write

public void write(float[] f,
 int start,
 int length)
           throws IOException

Description copied from interface: ArrayDataOutput

Write a segment of an array of float's.

Specified by:

write in interface ArrayDataOutput

Parameters:

f - array of float's.

start - start index in the array

length - number of array elements to write

Throws:

IOException - if one of the underlying write operations failed

write

public void write(double[] d,
 int start,
 int length)
           throws IOException

Description copied from interface: ArrayDataOutput

Write a segment of an array of double's.

Specified by:

write in interface ArrayDataOutput

Parameters:

d - array of double's.

start - start index in the array

length - number of array elements to write

Throws:

IOException - if one of the underlying write operations failed

writeBytes

public void writeBytes(String s)
                throws IOException

Specified by:

writeBytes in interface DataOutput

Throws:

IOException

writeChars

public void writeChars(String s)
                throws IOException

Specified by:

writeChars in interface DataOutput

Throws:

IOException

writeUTF

public void writeUTF(String s)
              throws IOException

Specified by:

writeUTF in interface DataOutput

Throws:

IOException

write

public void write(String[] s,
 int start,
 int len)
           throws IOException

Description copied from interface: ArrayDataOutput

Write a segment of an array of Strings. Equivalent to calling writeBytes for the selected elements.

Specified by:

write in interface ArrayDataOutput

Parameters:

s - the array to write

start - start index in the array

len - number of array elements to write

Throws:

IOException - if one of the underlying write operations failed

writeByte

public void writeByte(int b)
               throws IOException

Specified by:

writeByte in interface DataOutput

Throws:

IOException

writeBoolean

public void writeBoolean(boolean b)
                  throws IOException

Specified by:

writeBoolean in interface DataOutput

Throws:

IOException

writeChar

public void writeChar(int c)
               throws IOException

Specified by:

writeChar in interface DataOutput

Throws:

IOException

writeShort

public void writeShort(int s)
                throws IOException

Specified by:

writeShort in interface DataOutput

Throws:

IOException

writeInt

public void writeInt(int i)
              throws IOException

Specified by:

writeInt in interface DataOutput

Throws:

IOException

writeLong

public void writeLong(long l)
               throws IOException

Specified by:

writeLong in interface DataOutput

Throws:

IOException

writeFloat

public void writeFloat(float f)
                throws IOException

Specified by:

writeFloat in interface DataOutput

Throws:

IOException

writeDouble

public void writeDouble(double d)
                 throws IOException

Specified by:

writeDouble in interface DataOutput

Throws:

IOException

writePrimitiveArray

@Deprecated
public final void writePrimitiveArray(Object o)
                               throws IOException

Deprecated.

use ArrayOutputStream.writeArray(Object) instead

Deprecated use ArrayOutputStream.writeArray(Object).

Parameters:

o - The object to be written.

Throws:

IOException - if one of the underlying write operations failed

isAtStart

public boolean isAtStart()

Description copied from interface: FitsOutput

Checks whether we are currently at the start of this output file or stream.

Specified by:

isAtStart in interface FitsOutput

Returns:

true if we are currently at the start of stream (where a primary HDU is to be written), or false if we are further along, where HDUs should be written as extensions.

See Also:

• RandomAccess.position()
• OutputEncoder.getCount()