Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Exposing more Instrument methods to python #39044

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

peterfpeterson
Copy link
Member

@peterfpeterson peterfpeterson commented Mar 11, 2025

People wanted to know what filenamethe IDF came from in python. This exposes that information.

There is no associated issue.

To test:

The additional unit test shows a great example.


Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Do the release notes conform to the release notes guide?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

@peterfpeterson peterfpeterson changed the title Exposing more methods to python Exposing more Instrument methods to python Mar 12, 2025
@peterfpeterson peterfpeterson added this to the Release 6.13 milestone Mar 12, 2025
@peterfpeterson peterfpeterson marked this pull request as ready for review March 12, 2025 01:39
"Return the name of the file that the original IDF was from")

.def("setFilename", &Instrument::setFilename, (arg("self"), arg("filename")),
"Return the name of the file that the original IDF was from")
Copy link
Contributor

@RichardWaiteSTFC RichardWaiteSTFC Mar 12, 2025

Choose a reason for hiding this comment

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

Looks like this doc string for setter is duplicate of getter.

Just out of interest, it looks like setting a different filename doesn't actually re-load the IDF (like calling LoadInstrument) - it looks like it just updates m_filename)

void Instrument::setFilename(const std::string &filename) {
if (m_map)
m_instr->m_filename = filename;
else
m_filename = filename;
}

so could exposing this to python could lead to problems? Depends on what you want to use this for I guess!

Copy link
Member Author

Choose a reason for hiding this comment

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

The SNAP team is overwriting the instrument file after doing a subsampling to make the instrument effectively have giant pixels.

Copy link
Contributor

Choose a reason for hiding this comment

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

So is this grouping neighbouring pixels or similar? Not sure what the benefit of having a separate IDF is (when you group detectors, e.g. when focussing it just keeps track of the detector IDs contributing to each spectrum), but obviously I'm not familiar with SNAP stuff! My one query would be does it make sense to be able to set the filename when it could be out of date with the IDF loaded (assuming LoadInstrument set this m_filename)?

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