Skip to content

221 Document gridscan coordinate systems#715

Merged
rtuck99 merged 5 commits intomainfrom
221_document_gridscan_coordinate_systems
Dec 18, 2024
Merged

221 Document gridscan coordinate systems#715
rtuck99 merged 5 commits intomainfrom
221_document_gridscan_coordinate_systems

Conversation

@rtuck99
Copy link
Contributor

@rtuck99 rtuck99 commented Dec 12, 2024

This addresses #221 and improves documentation about the reporting of the Zocalo Results

See also DiamondLightSource/dodal#958

It also fixes an issue where the bounding box returned in the XRayCentreResult is off by 0.5 of a grid-box, however I don't think this impacts anything as this attribute isn't used yet.

@codecov
Copy link

codecov bot commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.89%. Comparing base (91d755e) to head (631e3d7).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #715   +/-   ##
=======================================
  Coverage   86.89%   86.89%           
=======================================
  Files         102      102           
  Lines        6908     6908           
=======================================
  Hits         6003     6003           
  Misses        905      905           
Components Coverage Δ
i24 SSX 72.69% <ø> (ø)
hyperion 96.88% <ø> (ø)
other 94.24% <ø> (ø)

Copy link
Contributor

@olliesilvester olliesilvester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I think this part of the code is always going to be confusing, but it's much more understandable after your changes

Comment on lines 294 to 297
centre_of_mass_mm=xray_centre,
bounding_box_mm=(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed the entire logic here is quite hard to explain via comments, but I think this helps to explain the 0.5

Suggested change
centre_of_mass_mm=xray_centre,
bounding_box_mm=(
# Bounding box coordinates give position of the centre of the box, subtract half a box size to get the start of the box
bounding_box_mm=(

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops, didn't mean to delete line 294 in this suggestion

@rtuck99 rtuck99 force-pushed the 221_document_gridscan_coordinate_systems branch from 8672fc6 to 631e3d7 Compare December 18, 2024 15:17
@rtuck99 rtuck99 merged commit c80d4d0 into main Dec 18, 2024
@rtuck99 rtuck99 deleted the 221_document_gridscan_coordinate_systems branch December 18, 2024 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants