MHeaderTools

java.lang.Object
- astro.fits.MHeaderTools

public class MHeaderTools
extends Object

Deals with fits headers.

Author:: wooz

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MHeaderTools.Photometry
Header keyss for use with photometry

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MHeaderTools.Photometry` Header keyss for use with photometry

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BITPIX` The mandatory FITS key denoting the end of the header section.
`static String`	`BSCALE` The FITS key denoting the scale of image data.
`static String`	`BSCALEREM` The FITS key denoting the scale of image data.
`static String`	`BZERO` The FITS key denoting the zero point of image data.
`static String`	`BZEROREM` The FITS key denoting the zero point of image data.
`static String`	`DATE` The FITS key denoting the yyyy-mm-tt of the observing date.
`static String`	`DATE_OBS` The header keyword for obs.
`static String`	`END` The mandatory FITS key denoting the end of the header section.
`static String`	`GAIN` Gain of CCD.
`static String`	`GAINREM` Gain of CCD.
`static String`	`NAXIS` The mandatory FITS key denoting the end of the header section.
`static String`	`RDNOISE` Read noise of CCD.
`static String`	`RDNOISEREM` Read noise of CCD.
`static String`	`SIMPLE` The mandatory FITS key denoting the end of the header section.
`static String`	`TIME` The FITS key denoting the HH:MM:ss of the observing date.
`static String`	`TIME_OBS` The header keyword for obs.
`static NumberFormat`	`WATNR`
`static String`	`XORIGIN` Fits key for entering x-pregap info to header.
`static String`	`XORIGINREM` Fits key for entering x-pregap info to header.
`static String`	`XTENSION` The mandatory FITS key denoting the end of the header section.
`static String`	`XTENSIONIMAGE` The recognized extensions is an image
`static String`	`YORIGIN` Fits key for entering y-pregap info to header.
`static String`	`YORIGINREM` Fits key for entering y-pregap info to header.

Constructor Summary

Constructors
Constructor and Description

MHeaderTools()

Constructors
Constructor and Description
`MHeaderTools()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addWatCards(Collection<MHeaderCard> ret, String key, String split)`
`static Object`	`getBestValue(Map<String,MHeaderCard> cards, List<String> keytries)` Convenience method that narrows down all valid keys found in the header to the first non-null
`static Date`	`getDateObs(HeaderDataUnit hdu)` We scan for the fits creation time.
`static Date`	`getDateObs(MFits f)` We scan for the fits creation time.
`static Date`	`getDateObs(MHeader hdu)` We scan for the fits creation time.
`static List<HeaderValue>`	`getHeaderValuesFromKeyList(Map<String,MHeaderCard> cards, List<String> keytries)` We have a list of possible header key words, which we try one after the other on the mapping of header cards provided.
`static Pair<Statistic,NumberFormat>`	`getHeaderValueStatistic(String key, Collection<MHeader> comb, NumberFormat... nfs)` A collection of similar headers is scanned for a distinct key.
`static MHeader`	`mergeWith(MHeader into, MHeader add)` Merges all hards with keys not found in the primary header into the primary header.
`static MHeader`	`mergeWith(MHeader into, MHeader add, boolean replace)` Merges two headers, discarding identical keys.
`static String`	`scanStringValue(MHeader head, String key)` Scans an mheader for the specified key and returns a non-null value only if a card to this key is found and the first card has a string value.

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

- Field Detail
  - SIMPLE
```
public static final String SIMPLE
```
    The mandatory FITS key denoting the end of the header section.
    
    See Also:
    
    Constant Field Values
  - XTENSION
```
public static final String XTENSION
```
    The mandatory FITS key denoting the end of the header section.
    
    See Also:
    
    Constant Field Values
  - BITPIX
```
public static final String BITPIX
```
    The mandatory FITS key denoting the end of the header section.
    
    See Also:
    
    Constant Field Values
  - NAXIS
```
public static final String NAXIS
```
    The mandatory FITS key denoting the end of the header section.
    
    See Also:
    
    Constant Field Values
  - BZERO
```
public static final String BZERO
```
    The FITS key denoting the zero point of image data.
    
    See Also:
    
    Constant Field Values
  - BSCALE
```
public static final String BSCALE
```
    The FITS key denoting the scale of image data.
    
    See Also:
    
    Constant Field Values
  - END
```
public static final String END
```
    The mandatory FITS key denoting the end of the header section.
    
    See Also:
    
    Constant Field Values
  - DATE_OBS
```
public static final String DATE_OBS
```
    The header keyword for obs. date in UT If 'T' present, also has time.
    
    See Also:
    
    Constant Field Values
  - TIME_OBS
```
public static final String TIME_OBS
```
    The header keyword for obs. time in UT.
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final String DATE
```
    The FITS key denoting the yyyy-mm-tt of the observing date.
    
    See Also:
    
    Constant Field Values
  - TIME
```
public static final String TIME
```
    The FITS key denoting the HH:MM:ss of the observing date.
    
    See Also:
    
    Constant Field Values
  - XTENSIONIMAGE
```
public static final String XTENSIONIMAGE
```
    The recognized extensions is an image
    
    See Also:
    
    Constant Field Values
  - XORIGIN
```
public static final String XORIGIN
```
    Fits key for entering x-pregap info to header.
    
    See Also:
    
    Constant Field Values
  - YORIGIN
```
public static final String YORIGIN
```
    Fits key for entering y-pregap info to header.
    
    See Also:
    
    Constant Field Values
  - XORIGINREM
```
public static final String XORIGINREM
```
    Fits key for entering x-pregap info to header.
    
    See Also:
    
    Constant Field Values
  - YORIGINREM
```
public static final String YORIGINREM
```
    Fits key for entering y-pregap info to header.
    
    See Also:
    
    Constant Field Values
  - BZEROREM
```
public static final String BZEROREM
```
    The FITS key denoting the zero point of image data.
    
    See Also:
    
    Constant Field Values
  - BSCALEREM
```
public static final String BSCALEREM
```
    The FITS key denoting the scale of image data.
    
    See Also:
    
    Constant Field Values
  - GAIN
```
public static final String GAIN
```
    Gain of CCD.
    
    See Also:
    
    Constant Field Values
  - GAINREM
```
public static final String GAINREM
```
    Gain of CCD.
    
    See Also:
    
    Constant Field Values
  - RDNOISE
```
public static final String RDNOISE
```
    Read noise of CCD.
    
    See Also:
    
    Constant Field Values
  - RDNOISEREM
```
public static final String RDNOISEREM
```
    Read noise of CCD.
    
    See Also:
    
    Constant Field Values
  - WATNR
```
public static final NumberFormat WATNR
```
- Constructor Detail
  - MHeaderTools
```
public MHeaderTools()
```
- Method Detail
  - mergeWith
```
public static MHeader mergeWith(MHeader into,
                                MHeader add)
```
    Merges all hards with keys not found in the primary header into the primary header.
    
    Parameters:
    
    into -
    
    add -
    
    Returns:
  - mergeWith
```
public static MHeader mergeWith(MHeader into,
                                MHeader add,
                                boolean replace)
```
    Merges two headers, discarding identical keys. If replace is set, the card from the second header replaces the card in the first, otherwise the card in the first header is kept.
    
    Returns:
    
    The first header
  - getDateObs
```
public static Date getDateObs(MFits f)
                       throws ParseException
```
    We scan for the fits creation time. This is done by examining the header for the keyword TIME-OBS and DATE-OBS. If only date exists, it is assumed to carry a ISO-date string, otherwise we try to parse the date from pasting DATE-OBS 'T' and TIME-OBS together. If successful, a date is returned.
    
    Throws:
    
    ParseException
  - getDateObs
```
public static Date getDateObs(HeaderDataUnit hdu)
                       throws ParseException
```
    We scan for the fits creation time. This is done by examining the header for the keyword TIME-OBS and DATE-OBS. If only date exists, it is assumed to carry a ISO-date string, otherwise we try to parse the date from pasting DATE-OBS 'T' and TIME-OBS together. If successful, a date is returned.
    
    Throws:
    
    ParseException
  - getDateObs
```
public static Date getDateObs(MHeader hdu)
                       throws ParseException
```
    We scan for the fits creation time. This is done by examining the header for the keyword TIME-OBS and DATE-OBS. If only date exists, it is assumed to carry a ISO-date string, otherwise we try to parse the date from pasting DATE-OBS 'T' and TIME-OBS together. If successful, a date is returned.
    
    Throws:
    
    ParseException
  - scanStringValue
```
public static String scanStringValue(MHeader head,
                                     String key)
```
    Scans an mheader for the specified key and returns a non-null value only if a card to this key is found and the first card has a string value.
    
    Parameters:
    
    head -
    
    key -
    
    Returns:
  - getHeaderValuesFromKeyList
```
public static List<HeaderValue> getHeaderValuesFromKeyList(Map<String,MHeaderCard> cards,
                                                           List<String> keytries)
```
    We have a list of possible header key words, which we try one after the other on the mapping of header cards provided. Any key linked to a non-null value generates an entry in the returned list.
  - getBestValue
```
public static Object getBestValue(Map<String,MHeaderCard> cards,
                                  List<String> keytries)
```
    Convenience method that narrows down all valid keys found in the header to the first non-null
  - addWatCards
```
public static void addWatCards(Collection<MHeaderCard> ret,
                               String key,
                               String split)
```
  - getHeaderValueStatistic
```
public static Pair<Statistic,NumberFormat> getHeaderValueStatistic(String key,
                                                                   Collection<MHeader> comb,
                                                                   NumberFormat... nfs)
                                                            throws ParseException
```
    A collection of similar headers is scanned for a distinct key. In all headers this key is found, its value is used to build up a statistic. If the header value is numeric, it is converted to a double. If it is a string (a date), the supplied number formatters are tried sequentially to convert the string to a number, which is then used for the statistic. The finally successful formatter is returned along with the statistic.
    
    Parameters:
    
    key -
    
    comb -
    
    nfs -
    
    Returns:
    
    Throws:
    
    ParseException

Class MHeaderTools

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SIMPLE

XTENSION

BITPIX

NAXIS

BZERO

BSCALE

END

DATE_OBS

TIME_OBS

DATE

TIME

XTENSIONIMAGE

XORIGIN

YORIGIN

XORIGINREM

YORIGINREM

BZEROREM

BSCALEREM

GAIN

GAINREM

RDNOISE

RDNOISEREM

WATNR

Constructor Detail

MHeaderTools

Method Detail

mergeWith

mergeWith

getDateObs

getDateObs

getDateObs

scanStringValue

getHeaderValuesFromKeyList

getBestValue

addWatCards

getHeaderValueStatistic