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

Change prefix from PETAcquisitionData to STIRAcquisitionData. #1146

Merged
merged 4 commits into from
Nov 17, 2022

Conversation

evgueni-ovtchinnikov
Copy link
Contributor

@evgueni-ovtchinnikov evgueni-ovtchinnikov commented Nov 15, 2022

Changes in this pull request

STIR now handles SPECT in addition to PET, so we should use prefix STIR for STIR data containers.

This was already in place for images - this pull request does the same for acquisition data.

For the sake of backward compatibility, the old nomenclature is preserved for the time being via typedef.

Testing performed

Related issues

Fixes #1126.

Checklist before requesting a review

  • I have performed a self-review of my code
  • I have added docstrings/doxygen in line with the guidance in the developer guide
  • I have implemented unit tests that cover any new or modified functionality
  • The code builds and runs on my machine
  • CHANGES.md has been updated with any functionality change

Contribution Notes

Please read and adhere to the contribution guidelines.

Please tick the following:

  • The content of this Pull Request (the Contribution) is intentionally submitted for inclusion in SIRF (the Work) under the terms and conditions of the Apache-2.0 License.

@evgueni-ovtchinnikov evgueni-ovtchinnikov self-assigned this Nov 15, 2022
@evgueni-ovtchinnikov evgueni-ovtchinnikov changed the title Change prefix from PETAcquisitionData to STIRPETAcquisitionData. Change prefix from PETAcquisitionData to STIRAcquisitionData. Nov 15, 2022
@evgueni-ovtchinnikov evgueni-ovtchinnikov added this to the v3.4 milestone Nov 15, 2022
@KrisThielemans
Copy link
Member

thanks! We will need to put this in version 4.0, as it breaks backwards compatibility.

@johannesmayer presumably this will affect #1007 ?

@evgueni-ovtchinnikov
Copy link
Contributor Author

We will need to put this in version 4.0, as it breaks backwards compatibility.

Actually, this PR can be merged right away as we have

	///
	///  Backward compatibility - to be removed in SIRF 4
	///
	typedef STIRAcquisitionData PETAcquisitionData;
	typedef STIRAcquisitionDataInFile PETAcquisitionDataInFile;
	typedef STIRAcquisitionDataInMemory PETAcquisitionDataInMemory;

(stir_data_containers.h, lines 772-777).

@KrisThielemans
Copy link
Member

ah. perfect. Great idea!

can you put those typedefs between #ifdef SIRF_VERSION < 040000 or whatever it has to be? Also add a line to CHANGES.md. Feel free to merge then. thanks!

@evgueni-ovtchinnikov evgueni-ovtchinnikov merged commit e043a5a into master Nov 17, 2022
@KrisThielemans
Copy link
Member

I notice the problem you had with version.h. I guess this means that we don't have access to the generated file
Correct? I think this means we need to add a line after

configure_file("cmake/version.h.in" "${CMAKE_CURRENT_BINARY_DIR}/cmake/include/sirf/common/version.h")

include_directories(${CMAKE_CURRENT_BINARY_DIR}/cmake/include
If you think that's correct, please create an issue for it

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.

Change prefix from PET to STIR for DataContainer
2 participants