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:

Field Summary

Fields inherited from interface nom.tam.util.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
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 nom.tam.util.ArrayOutputStream
writeArray

Methods inherited from class java.io.BufferedOutputStream
flush

Methods inherited from class java.io.FilterOutputStream
close, write

Methods inherited from class java.io.OutputStream
nullOutputStream

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nom.tam.util.ArrayDataOutput
flush, write, write, write, write, write, write, write, write, write, writeArray

Methods inherited from interface java.io.DataOutput
write

Methods inherited from interface nom.tam.util.FitsIO
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()

Class FitsOutputStream

Field Summary

Fields inherited from interface nom.tam.util.FitsIO

Constructor Summary

Method Summary

Methods inherited from class nom.tam.util.ArrayOutputStream

Methods inherited from class java.io.BufferedOutputStream

Methods inherited from class java.io.FilterOutputStream

Methods inherited from class java.io.OutputStream

Methods inherited from class java.lang.Object

Methods inherited from interface nom.tam.util.ArrayDataOutput

Methods inherited from interface java.io.DataOutput

Methods inherited from interface nom.tam.util.FitsIO

Constructor Details

FitsOutputStream

FitsOutputStream

Method Details

write

write

write

write

write

write

write

write

write

write

writeBytes

writeChars

writeUTF

write

writeByte

writeBoolean

writeChar

writeShort

writeInt

writeLong

writeFloat

writeDouble

writePrimitiveArray

isAtStart