-
Notifications
You must be signed in to change notification settings - Fork 128
Exposing more Instrument methods to python #39044
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
Conversation
9bdc4e9
to
9d74eb3
Compare
"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") |
There was a problem hiding this comment.
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
)
mantid/Framework/Geometry/src/Instrument.cpp
Lines 845 to 850 in 789921c
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!
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new test convinces me
9d74eb3
to
053088a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My previous comment stands.
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
Functional Tests
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.