fix: passing metadata to getTextLines callback in annotation tools

[salimkanoun]

Context

In nuclear medicine, some quantifications may have different normalization such as SUV lean body mass or glycaemia corrected SUV.

To implement specific quantification we previously add callback definition to override statistics computation or result rendering (stat calculator and getTextLines parameters)

Our current problem is that we want to change the rendered value SUV => SUL, to do this we need to get PatientWeight, PatientSize and PatientSex in the Metadata store.

The probleme we are facing is that the getTextLines callaback is not giving enough context about the measurement especially to retrieve the volumeId/displaySet/SeriesInstanceUID that are needed to link the measurement rendering from the Metadata Store.

So in this PR i add the metadata in the getTextLines of Circle and Rectangle start stop, it should solve our problem but now the issues is that getTextLines has different definition from a tool to another, for instance :

In 2D annotation we have : defaultGetTextLines(data, targetId)
in UltrasoundDirectional we have : defaultGetTextLines(data, targetId, configuration)
And now for 3D annotation we will have : defaultGetTextLines(data, _metadata)

I'm a bit afraid seeing different callback definition from a tool to another, that can be complicated to document and maintain in long term, i wonder if we shouldn't send the whole annotation object as one single param so the getTextLines call back can pickup watever needed, but this will become a breaking change

Changes & Results

Add more context to getTextLines params

Testing

Checklist

PR

• [] My Pull Request title is descriptive, accurate and follows the
  semantic-release format and guidelines.

Code

• [] My code has been well-documented (function documentation, inline comments,
  etc.)

• [] I have run the yarn build:update-api to update the API documentation, and have
  committed the changes to this PR. (Read more here https://www.cornerstonejs.org/docs/contribute/update-api)

Public Documentation Updates

• [] The documentation page has been updated as necessary for any public API
  additions or removals.

Tested Environment

• [] "OS:
• [] "Node version:
• [] "Browser:

[stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[netlify]

✅ Deploy Preview for cornerstone-3d-docs ready!

Name	Link
🔨 Latest commit	421100a
🔍 Latest deploy log	https://app.netlify.com/sites/cornerstone-3d-docs/deploys/6760a84774daf20008f2b861
😎 Deploy Preview	https://deploy-preview-1710--cornerstone-3d-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[sedghi]

can we have it as defaultGetTextLines(data, {} ), i'm pretty sure in future something else need to get injected too

[salimkanoun]

here it is, yes this object is more extensible in the future,

What to do with 2D annotation which have :
defaultGetTextLines(data, targetId)
And ultrasounds direction tools has
defaultGetTextLines(data, targetId, configuration):

Do we change something for 2D roi ? (but can be a breaking change)