def write_reference_metadata_headers(obs_id, subarray, writer):
"""
Attaches Core Provenence headers to an output HDF5 file.
Right now this is hard-coded for use with the ctapipe-stage1-process tool
Parameters
----------
output_path: pathlib.Path
output HDF5 file
obs_id: int
observation ID
subarray:
SubarrayDescription to get metadata from
writer: HDF5TableWriter
output
"""
activity = PROV.current_activity.provenance
reference = meta.Reference(
contact=meta.Contact(
name="",
email="",
organization="CTA Consortium",
),
product=meta.Product(
description="DL1 Data Product",
data_category="S",
data_level="DL1",
data_association="Subarray",
data_model_name="ASWG DL1",
data_model_version=DL1_DATA_MODEL_VERSION,
data_model_url="",
format="hdf5",
),
process=meta.Process(type_="Simulation", subtype="", id_=int(obs_id)),
activity=meta.Activity.from_provenance(activity),
instrument=meta.Instrument(
site="Other", # need a way to detect site...
class_="Subarray",
type_="unknown",
version="unknown",
id_=subarray.name,
),
)
# convert all values to strings, since hdf5 can't handle Times, etc.:
# TODO: add activity_stop_time?
headers = {k: str(v) for k, v in reference.to_dict().items()}
meta.write_to_hdf5(headers, writer._h5file)
def test_construct_and_write_metadata(tmp_path):
""" basic test of making a Reference object and writing it"""
prov = Provenance()
prov.start_activity("test")
prov.finish_activity()
prov_activity = prov.finished_activities[0]
reference = meta.Reference(
contact=meta.Contact(name="Somebody",
email="*****@*****.**",
organization="CTA Consortium"),
product=meta.Product(
description="An Amazing Product",
creation_time="2020-10-11 15:23:31",
data_category="Sim",
data_level=["DL1_IMAGES", "DL1_PARAMETERS"],
data_association="Subarray",
data_model_name="Unofficial DL1",
data_model_version="1.0",
data_model_url="http://google.com",
format="hdf5",
),
process=meta.Process(type_="Simulation",
subtype="Prod3b",
id_="423442"),
activity=meta.Activity.from_provenance(prov_activity.provenance),
instrument=meta.Instrument(
site="CTA-North",
class_="Array",
type_="Layout H1B",
version="1.0",
id_="threshold",
),
)
ref_dict = reference.to_dict()
assert ref_dict["CTA PRODUCT FORMAT"] == "hdf5"
import uuid # pylint: disable=import-outside-toplevel
assert str(uuid.UUID(
ref_dict["CTA PRODUCT ID"])) == ref_dict["CTA PRODUCT ID"]
# check that we can write this to the header of a typical table file in multiple
# formats:
from astropy.table import Table # pylint: disable=import-outside-toplevel
table = Table(dict(x=[1, 2, 3], y=[15.2, 15.2, 14.5]))
for path in [tmp_path / "test.fits", tmp_path / "test.ecsv"]:
if ".fits" in path.suffixes:
reference.format = "fits"
ref_dict = reference.to_dict(fits=True)
else:
reference.format = "ecsv"
ref_dict = reference.to_dict()
table.meta = ref_dict
table.write(path)
# write to pytables file
import tables # pylint: disable=import-outside-toplevel
with tables.open_file(tmp_path / "test.h5", mode="w") as h5file:
meta.write_to_hdf5(ref_dict, h5file)