heimdall2 icon indicating copy to clipboard operation
heimdall2 copied to clipboard

Add flag to cURL to force ckl generation

Open georgedias opened this issue 9 months ago • 0 comments

[This may be OBE ... Standing by]

Update the Heimdall cURL API to accept a flag that generates the scan being ingested into a ckl.

  • This is predicated on the assumption that the scan is converted into HDF format, hence, it is also saved into the database as a HDF format rather than the raw data.
  • Saving the scan as HDF format streamlines the loading into the viewing panel, as the raw scan doe not have to be converted.

Example

use something like this: -F "generateCKL=true/false" the default would be false, meaning the absent of the flag the ckl is not generated.

curl -F "data=@<Path to Evaluation File>" -F "filename=<Filename To Show in Heimdall>" -F "public=true/false" -F "evaluationTags=<tag-name>,<another-tag-name>..." -F "generateCKL=true/false" -H "Authorization: Api-Key apikeygoeshere" "http://localhost:3000/evaluations"

This is what needs to be done:

  • Need to persist tags for ingested files that are non HDF - AKA normalize the ingested scan(file)
    • When do we do this, at the cURL (aka during the pipeline process)
      • advantages is that scans loads much faster into the viewing panel
      • this will block the ingest process during pipeline execution
  • Need to update the database schema so we can save both original and hdf
  • Need the capability to extract the raw data (original file)

georgedias avatar Apr 25 '24 16:04 georgedias