Add experiment type #702
Merged
Add experiment type #702
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #702 +/- ##
=======================================
Coverage 41.81% 41.81%
=======================================
Files 187 187
Lines 16806 16810 +4
Branches 3210 3211 +1
=======================================
+ Hits 7027 7029 +2
- Misses 9133 9140 +7
+ Partials 646 641 -5 |
src/dxtbx/model/__init__.py
Outdated
|
|
||
| def all_sequences(self): | ||
| """Check if all the experiments are from sequences""" | ||
| return all(exp.is_sequence() for exp in self) | ||
| warnings.warn("all_sequences() is deprecated. Use all_rotations() instead") |
There was a problem hiding this comment.
A still sequence is meaningful e.g. grid scan
| @@ -74,6 +74,11 @@ namespace dxtbx { namespace model { namespace boost_python { | |||
| }; | |||
|
|
|||
| void export_experiment() { | |||
| enum_<ExperimentType>("ExperimentType") | |||
| .value("still", still) | |||
There was a problem hiding this comment.
What about a sequence of stills?
There was a problem hiding this comment.
I appreciate that the behaviour of the current system is not well defined?
src/dxtbx/model/experiment.h
Outdated
| @@ -28,6 +28,8 @@ | |||
|
|
|||
| namespace dxtbx { namespace model { | |||
|
|
|||
| enum ExperimentType { rotation = 1, still = 2, tof = 3 }; | |||
There was a problem hiding this comment.
Enumerations are usually ENUMERATED?
|
Discussion from core:
|
toastisme
force-pushed
the
add_experiment_type
branch
from
bab5155
to
d355b28
Compare
…equence, and experiment_list.all_sequences. ExperimentType is now all caps. is_still and is_sequence call get_type to ensure they remain consistent.
toastisme
added a commit
to toastisme/dxtbx
that referenced
this pull request
Jul 18, 2024
* Added ExperimentType to Experiment, accessed via get_type().
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds
Experiment.get_type(), which returns anExperimentTypeenum. The idea is to replaceExperiment.is_still()/Experiment.is_sequence()with something more flexible.There is an argument that this goes a bit against the dials as a toolkit ethos, where you should be able to mix pipelines of algorithms. However, the workflow for stills and rotational experiments are distinct enough that a quick way of identifying them is useful (
is_still()), and time of flight experiments are similar in being quite separate.Experiments do not have a static enum applied to their type. Instead it's calculated on the fly to ensure it's always consistent and defined in only one place.