fact.io.hdureader

Class Header

java.lang.Object

fact.io.hdureader.Header

public class Header
extends Object

This class represents a header in the HDU of fits file. The values in the header can be accessed via convenience 'get' methods for the main data types. HISTORY and COMMENT strings are also saved.

Created by mackaiver on 18/11/16.

Field Summary

Fields

Modifier and Type	Field and Description
String	comment
String	history

Method Summary

Modifier and Type	Method and Description
Map<String,Serializable>	asMapOfSerializables() This converts this Header into a map of key value pairs of type .
Optional<ZonedDateTime>	date() According to the FITS standard a header can contain a DATE keyword.
Optional<String>	get(String key) Get the value for the keyword in the header as string if it exists.
Optional<Boolean>	getBoolean(String key) Get the value for the keyword in the header as float if it exists and the value is parseable as float.
Optional<Double>	getDouble(String key) Get the value for the keyword in the header as Double if it exists and the value is parseable as double.
Optional<Float>	getFloat(String key) Get the value for the keyword in the header as float if it exists and the value is parseable as float.
Optional<Integer>	getInt(String key) Get the value for the keyword in the header as integer if it exists and the value is parseable as int.
Optional<Long>	getLong(String key) Get the value for the keyword in the header as long if it exists and the value is parseable as long.

Methods inherited from class java.lang.Object

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

Field Detail

comment

public final String comment

history

public final String history

Method Detail

asMapOfSerializables

public Map<String,Serializable> asMapOfSerializables()

This converts this Header into a map of key value pairs of type .

Returns:

a HashMap containing the key value pairs.

date

public Optional<ZonedDateTime> date()

According to the FITS standard a header can contain a DATE keyword. This method returns a LocalDateTime if a date can be found in the header.

Returns:

date stored in the HDU header

getInt

public Optional<Integer> getInt(String key)

Get the value for the keyword in the header as integer if it exists and the value is parseable as int.

Returns:

integer value for the key

getLong

public Optional<Long> getLong(String key)

Get the value for the keyword in the header as long if it exists and the value is parseable as long.

Returns:

long value for the key

getFloat

public Optional<Float> getFloat(String key)

Get the value for the keyword in the header as float if it exists and the value is parseable as float.

Returns:

float value for the key

getBoolean

public Optional<Boolean> getBoolean(String key)

Get the value for the keyword in the header as float if it exists and the value is parseable as float.

Returns:

float value for the key

getDouble

public Optional<Double> getDouble(String key)

Get the value for the keyword in the header as Double if it exists and the value is parseable as double.

Returns:

Double value for the key

get

public Optional<String> get(String key)

Get the value for the keyword in the header as string if it exists.

Returns:

Double value for the key