Features

• Uses voluptuous schemas to validate a given input header against dkist specifications

• 3 keyword validations: type validation, required-ness validation, and value validation

• Failure exceptions include a dictionary of validation failure causes

• SPEC-0122 to SPEC-0214 l0 translation

Installation

pip install dkist-header-validator

Usage

Currently, this package can be used to validate SPEC122 data or SPEC214 data. Please import the corresponding methods (spec122_validator and Spec122ValidationException, or spec214_validator and Spec214ValidationException, or spec214_l0_validator and Spec214ValidationException).

Input data can be one of:

• fits.Header object

• fits.PrimaryHDU or fits.ImageHDU or fits.CompImageHDU object

• HDUList object

• File path to an HDUList object

To validate an object in memory:

>>> from dkist_header_validator import spec122_validator, Spec122ValidationException
>>> from astropy.io import fits
>>> hdul = fits.open('dkist_rosa0181200000_observation.fits')
>>> validated_hdul = spec122_validator.validate(hdul)
>>> # or
>>> validated_hdu = spec122_validator.validate(hdul[1])
>>> # or
>>> validated_header = spec122_validator.validate(hdul[1].header)

Or, validate an object on disk directly:

>>> from dkist_header_validator import spec122_validator, Spec122ValidationException
>>> filepath = spec122_validator.validate('dkist_rosa0181200000_observation.fits')

Note that the return is just the input. If no errors or exceptions are raised, the header is valid. The validate method also accepts the boolean flag extra, which determines if extra keywords are allowed in the validation schema. Default value is extra=True.

The CLI can also be used to validate files:

$ dkist-header-validator validate122 "path/to/file.fits"
$ dkist-header-validator validate214 "path/to/file.fits"

In addition, this package can be used to translate headers from SPEC122 to SPEC214 l0:

>>> from dkist_header_validator import translate_spec122_to_spec214_l0
>>> translated_hdul = translate_spec122_to_spec214_l0('dkist_rosa0181200000_observation.fits')

The return in this case is the an HDUList with a translated header and the original data.

This project is Copyright (c) AURA/NSO.