FitsHeader

Defined in: header/header.ts:23

A parsed FITS header: the ordered list of HeaderCards plus keyword lookup. Returned inside ParseHeaderResult by parseHeader.

Keyword lookups are case-insensitive (FITS keywords are uppercase). The standard permits a keyword to repeat; FitsHeader.get returns the first occurrence and FitsHeader.getAll returns every one in card order.

Example

const { header } = parseHeader(bytes);
if (header.getString("XTENSION") === "BINTABLE") {
  const fields = header.getNumber("TFIELDS");
}

See

FITS Standard v4.0 §4.4: Keywords

Constructors

Constructor

new FitsHeader(cards): FitsHeader;

Defined in: header/header.ts:27

Parameters

Parameter	Type
cards	readonly HeaderCard[]

Returns

FitsHeader

Properties

cards

readonly cards: readonly HeaderCard[];

Defined in: header/header.ts:24

Accessors

comments

Get Signature

get comments(): string[];

Defined in: header/header.ts:79

Accumulated COMMENT card text, in order.

Returns

string[]

---

history

Get Signature

get history(): string[];

Defined in: header/header.ts:84

Accumulated HISTORY card text, in order.

Returns

string[]

Methods

get()

get(keyword): HeaderValue;

Defined in: header/header.ts:44

First value for the keyword, or undefined.

Parameters

Parameter	Type
keyword	string

Returns

HeaderValue

---

getAll()

getAll(keyword): HeaderValue[];

Defined in: header/header.ts:49

Every value for a keyword, in card order (FITS permits duplicates).

Parameters

Parameter	Type
keyword	string

Returns

HeaderValue[]

---

getBoolean()

getBoolean(keyword): boolean | undefined;

Defined in: header/header.ts:73

Parameters

Parameter	Type
keyword	string

Returns

boolean | undefined

---

getNumber()

getNumber(keyword): number | undefined;

Defined in: header/header.ts:63

The value as a number, or undefined if it is not numeric or is a bigint too large to represent exactly. Use FitsHeader.get to retrieve large integers without loss.

Parameters

Parameter	Type
keyword	string

Returns

number | undefined

---

getString()

getString(keyword): string | undefined;

Defined in: header/header.ts:53

Parameters

Parameter	Type
keyword	string

Returns

string | undefined

---

has()

has(keyword): boolean;

Defined in: header/header.ts:39

Parameters

Parameter	Type
keyword	string

Returns

boolean