This release is a pre-release and may not be stable for production use.
An interface containing a validator and a spec translator for DKIST FITS specs SPEC122 and SPEC214:
SPEC-0122: Data received from the summit
SPEC-0214 l0: Data ingested and parsed by the Data Center
SPEC-0214: Data published by the Data Center (incomplete)
The validator references a machine readable version of the DKIST Header Specifications which are defined here in the dkist-fits-specifications package. Unless otherwise specified, the latest version of dkist-fits-specifications package is installed along with the validator. Data can be validated against past revisions of the DKIST Header Specifications if a previous version of the dkist-fits-specifications package is installed. If you are receiving validation errors, please reference the version of the DKIST Header Specifications identified in the dkist-fits-specifications package to make sure that your headers are expected to be compliant with that version.
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-validatorUsage
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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file dkist_header_validator-5.4.1rc1.tar.gz.
File metadata
- Download URL: dkist_header_validator-5.4.1rc1.tar.gz
- Upload date:
- Size: 29.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0e4199d3dc9347a879daa4084d220440120c3cb47ae8d33f45f6acaafa579d81
|
|
| MD5 |
ee712113ff7d841fc45ec635a31356a0
|
|
| BLAKE2b-256 |
aeeabbcc678defe1fd4b700cab05dafefb6352c75543c067c2a779fbca276261
|
File details
Details for the file dkist_header_validator-5.4.1rc1-py3-none-any.whl.
File metadata
- Download URL: dkist_header_validator-5.4.1rc1-py3-none-any.whl
- Upload date:
- Size: 30.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
91306224652a2b9ae866e9342f98e7a1dbf17bd5c3fd7da63d1e48a1e840676f
|
|
| MD5 |
7e25658ba6d1f086d7560a0872821f09
|
|
| BLAKE2b-256 |
978530a4e35aedb701dd3f71bf319c8c627d19c377727f71103696c1089a3fda
|
