For university holography and interferometry labs
The exact path from one frame on your disk to one line in your methods section, with the real file names at each step.
Step 1 — The frame and its settings
You need the hologram (PNG, TIFF or NPY) and four numbers: wavelength in
micrometres, camera pixel pitch in micrometres, the hologram type (inline,
off-axis or auto), and a focus search range in millimetres. Getting
started shows where each comes from and the common unit mistakes.
Step 2 — Submit
Use the browser form at https://api.apertureapi.com/, the two-call command line, or Python. The
no-account path allows 5 reconstructions per hour; an account gives more. The
complete, runnable version of this step is run.py in the Reproducibility
bundle.
Step 3 — The result and its IDs
The ZIP you get back carries two identifiers:
| ID | Where | What it commits to |
|---|---|---|
provenance_id (APV-…) |
provenance.json |
the input, the settings and the software version — no timestamp |
evidence_report_id (AEV-…) |
pdhm_metadata.json, evidence.json |
the full evidence content, including the quality bands and the exact build |
Step 4 — The evidence record
Open evidence.html in a browser. It states what was measured, which
quantities are not-yet-established, the input and settings commitments, and
the quality bands. Forward it to a collaborator or attach it to a data
management plan as it is.
Step 5 — The methods citation
Paste the methods line from pdhm_metadata.json (field citation, which
names the provenance ID and the evidence report ID), or the filled-in
paragraph in methods_supplement.md. A reader holding your frame and settings
can rerun it and confirm the provenance ID. Keep the result package itself:
output arrays from two runs are not yet identical on the in-line path.
Methods supplement explains both.
Next step
Run the sample end to end with the Reproducibility bundle, then send your own frame to system@apertureapi.com. For a 90-day engagement on your rig with your own reference measurement, see Design partnership.