Documentation

FitsHeader
in package

Table of Contents

Properties

$keywords  : array<string|int, Keyword>
$blanks  : array<string|int, string>
$headerBlock  : string

Methods

__construct()  : mixed
getKeywordRecord()  : Keyword|null
Retrieve a Keyword record based on key name
getKeywordValue()  : string
Note: the keyword key string is case-sensitive
isValid()  : bool
Check if header contains a multiple of 36 records (aka 'card images')
toString()  : string
Return the FITS header as a string (byte stream)
readKeywords()  : array<string|int, Keyword>
Initialize the keyword records array

Properties

$blanks

private array<string|int, string> $blanks

Methods

__construct()

public __construct(string $headerBlock) : mixed
Parameters
$headerBlock : string

getKeywordRecord()

Retrieve a Keyword record based on key name

public getKeywordRecord(string $key) : Keyword|null
Parameters
$key : string
Return values
Keyword|null

getKeywordValue()

Note: the keyword key string is case-sensitive

public getKeywordValue(string $key) : string
Parameters
$key : string
Return values
string

isValid()

Check if header contains a multiple of 36 records (aka 'card images')

public isValid() : bool
Return values
bool

toString()

Return the FITS header as a string (byte stream)

public toString() : string
Return values
string

readKeywords()

Initialize the keyword records array

private readKeywords() : array<string|int, Keyword>

From the spec: each keyword record, including any comments, is at most 80 bytes long

Tags
todo

Comments and keyword values could span more than one 80-bytes block...

Return values
array<string|int, Keyword>

        
On this page

Search results