-
-
Notifications
You must be signed in to change notification settings - Fork 668
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
ENH: Add DICOMOrientation class from remote module #4791
Closed
blowekamp
wants to merge
10
commits into
InsightSoftwareConsortium:master
from
blowekamp:add_DICOMOrientImageFilter
Closed
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
899219a
ENH: Add DICOMOrientation class from remote module
blowekamp f65805d
ENH: Add DICOMOrientImageFilter
blowekamp b2a8968
ENH: Conversion from SpatialOrientation to DICOMOrientation
blowekamp cb079f7
ENH: Migrate MetaIO to DICOMOrientation
blowekamp 2b83ab5
ENH: Improve compatibility with legacy coordinate enums
blowekamp f56ccbb
ENH: Prefer usage of FROMToTO CoordinateEnum
blowekamp a13d287
ENH: Use DICOMOrientation with FROMToTO CoordinateEnums
blowekamp 4d8bf5c
ENH: Update NiftiImageIO to use DICOMOrientation
blowekamp 4ae42c8
ENH: Use Variable Templates for coordinate enum values.
blowekamp d7425ef
BUG: Remove default initialization in struct
blowekamp File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,362 @@ | ||
| /*========================================================================= | ||
| * | ||
| * Copyright NumFOCUS | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0.txt | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| *=========================================================================*/ | ||
| #ifndef itkDICOMOrientation_h | ||
| #define itkDICOMOrientation_h | ||
|
|
||
| #include "ITKCommonExport.h" | ||
| #include "itkImageBase.h" | ||
| #ifndef ITK_FUTURE_LEGACY_REMOVE | ||
| # include "itkSpatialOrientation.h" | ||
| #endif | ||
| #include <map> | ||
| #include <string> | ||
|
|
||
| namespace itk | ||
| { | ||
|
|
||
| /** \class DICOMOrientation | ||
| * \brief A supporting class for DICOMOrientImageFilter. | ||
| * | ||
| * Defines enums to for patient orientation in a compatible way with DICOM. | ||
| * | ||
| * Instances hold the patient orientation enum and allow conversion to and from enums, string and direction cosine | ||
| * matrices. Conversions from a direction cosine matrix is approximated with the orientation of the closes axes. | ||
| * | ||
| * \ingroup ITKCommon | ||
| */ | ||
| class ITKCommon_EXPORT DICOMOrientation | ||
| { | ||
| public: | ||
| static constexpr unsigned int Dimension = 3; | ||
| using DirectionType = typename ImageBase<Dimension>::DirectionType; | ||
| static constexpr unsigned int ImageDimension = Dimension; | ||
|
|
||
| #ifndef ITK_FUTURE_LEGACY_REMOVE | ||
| using LegacyOrientationType = SpatialOrientationEnums::ValidCoordinateOrientations; | ||
| #endif | ||
|
|
||
| enum class CoordinateEnum : uint8_t | ||
| { | ||
| UNKNOWN = 0, | ||
| Left = 2, ///< 0b0010 | ||
| RightToLeft = 2, | ||
| Right = 3, | ||
| LeftToRight = 3, | ||
| Anterior = 4, ///< front - 0b0100 | ||
| PosteriorToAnterior = 4, | ||
| Posterior = 5, ///< back | ||
| AnteriorToPosterior = 5, | ||
| Superior = 8, ///< above - 0b1000 | ||
| InferiorToSuperior = 8, | ||
| Inferior = 9, ///< bottom | ||
| SuperiorToInferior = 9, | ||
| }; | ||
|
|
||
| private: | ||
| enum class CoordinateMajornessTermsEnum : uint8_t | ||
| { | ||
| PrimaryMinor = 0, | ||
| SecondaryMinor = 8, | ||
| TertiaryMinor = 16 | ||
| }; | ||
|
|
||
| template <CoordinateEnum VPrimary, CoordinateEnum VSecondary, CoordinateEnum VTertiary> | ||
| static constexpr uint32_t m_ToOrientation = | ||
| (static_cast<uint32_t>(VPrimary) << static_cast<uint8_t>(CoordinateMajornessTermsEnum::PrimaryMinor)) + | ||
| (static_cast<uint32_t>(VSecondary) << static_cast<uint8_t>(CoordinateMajornessTermsEnum::SecondaryMinor)) + | ||
| (static_cast<uint32_t>(VTertiary) << static_cast<uint8_t>(CoordinateMajornessTermsEnum::TertiaryMinor)); | ||
|
|
||
| CoordinateEnum | ||
| GetCoordinateTerm(CoordinateMajornessTermsEnum cmt) const; | ||
|
|
||
| public: | ||
| #define ITK_ORIENTATION_ENUM(P, S, T) m_ToOrientation<P, S, T> | ||
|
|
||
|
|
||
| enum class OrientationEnum : uint32_t | ||
|
|
||
| { | ||
| INVALID = 0, | ||
| RIP = ITK_ORIENTATION_ENUM(CoordinateEnum::LeftToRight, | ||
| CoordinateEnum::SuperiorToInferior, | ||
| CoordinateEnum::AnteriorToPosterior), | ||
| LIP = ITK_ORIENTATION_ENUM(CoordinateEnum::RightToLeft, | ||
| CoordinateEnum::SuperiorToInferior, | ||
| CoordinateEnum::AnteriorToPosterior), | ||
| RSP = ITK_ORIENTATION_ENUM(CoordinateEnum::LeftToRight, | ||
| CoordinateEnum::InferiorToSuperior, | ||
| CoordinateEnum::AnteriorToPosterior), | ||
| LSP = ITK_ORIENTATION_ENUM(CoordinateEnum::RightToLeft, | ||
| CoordinateEnum::InferiorToSuperior, | ||
| CoordinateEnum::AnteriorToPosterior), | ||
| RIA = ITK_ORIENTATION_ENUM(CoordinateEnum::LeftToRight, | ||
| CoordinateEnum::SuperiorToInferior, | ||
| CoordinateEnum::PosteriorToAnterior), | ||
| LIA = ITK_ORIENTATION_ENUM(CoordinateEnum::RightToLeft, | ||
| CoordinateEnum::SuperiorToInferior, | ||
| CoordinateEnum::PosteriorToAnterior), | ||
| RSA = ITK_ORIENTATION_ENUM(CoordinateEnum::LeftToRight, | ||
| CoordinateEnum::InferiorToSuperior, | ||
| CoordinateEnum::PosteriorToAnterior), | ||
| LSA = ITK_ORIENTATION_ENUM(CoordinateEnum::RightToLeft, | ||
| CoordinateEnum::InferiorToSuperior, | ||
| CoordinateEnum::PosteriorToAnterior), | ||
|
|
||
| IRP = ITK_ORIENTATION_ENUM(CoordinateEnum::SuperiorToInferior, | ||
| CoordinateEnum::LeftToRight, | ||
| CoordinateEnum::AnteriorToPosterior), | ||
| ILP = ITK_ORIENTATION_ENUM(CoordinateEnum::SuperiorToInferior, | ||
| CoordinateEnum::RightToLeft, | ||
| CoordinateEnum::AnteriorToPosterior), | ||
| SRP = ITK_ORIENTATION_ENUM(CoordinateEnum::InferiorToSuperior, | ||
| CoordinateEnum::LeftToRight, | ||
| CoordinateEnum::AnteriorToPosterior), | ||
| SLP = ITK_ORIENTATION_ENUM(CoordinateEnum::InferiorToSuperior, | ||
| CoordinateEnum::RightToLeft, | ||
| CoordinateEnum::AnteriorToPosterior), | ||
| IRA = ITK_ORIENTATION_ENUM(CoordinateEnum::SuperiorToInferior, | ||
| CoordinateEnum::LeftToRight, | ||
| CoordinateEnum::PosteriorToAnterior), | ||
| ILA = ITK_ORIENTATION_ENUM(CoordinateEnum::SuperiorToInferior, | ||
| CoordinateEnum::RightToLeft, | ||
| CoordinateEnum::PosteriorToAnterior), | ||
| SRA = ITK_ORIENTATION_ENUM(CoordinateEnum::InferiorToSuperior, | ||
| CoordinateEnum::LeftToRight, | ||
| CoordinateEnum::PosteriorToAnterior), | ||
| SLA = ITK_ORIENTATION_ENUM(CoordinateEnum::InferiorToSuperior, | ||
| CoordinateEnum::RightToLeft, | ||
| CoordinateEnum::PosteriorToAnterior), | ||
|
|
||
| RPI = ITK_ORIENTATION_ENUM(CoordinateEnum::LeftToRight, | ||
| CoordinateEnum::AnteriorToPosterior, | ||
| CoordinateEnum::SuperiorToInferior), | ||
| LPI = ITK_ORIENTATION_ENUM(CoordinateEnum::RightToLeft, | ||
| CoordinateEnum::AnteriorToPosterior, | ||
| CoordinateEnum::SuperiorToInferior), | ||
| RAI = ITK_ORIENTATION_ENUM(CoordinateEnum::LeftToRight, | ||
| CoordinateEnum::PosteriorToAnterior, | ||
| CoordinateEnum::SuperiorToInferior), | ||
| LAI = ITK_ORIENTATION_ENUM(CoordinateEnum::RightToLeft, | ||
| CoordinateEnum::PosteriorToAnterior, | ||
| CoordinateEnum::SuperiorToInferior), | ||
| RPS = ITK_ORIENTATION_ENUM(CoordinateEnum::LeftToRight, | ||
| CoordinateEnum::AnteriorToPosterior, | ||
| CoordinateEnum::InferiorToSuperior), | ||
| LPS = ITK_ORIENTATION_ENUM(CoordinateEnum::RightToLeft, | ||
| CoordinateEnum::AnteriorToPosterior, | ||
| CoordinateEnum::InferiorToSuperior), | ||
| RAS = ITK_ORIENTATION_ENUM(CoordinateEnum::LeftToRight, | ||
| CoordinateEnum::PosteriorToAnterior, | ||
| CoordinateEnum::InferiorToSuperior), | ||
| LAS = ITK_ORIENTATION_ENUM(CoordinateEnum::RightToLeft, | ||
| CoordinateEnum::PosteriorToAnterior, | ||
| CoordinateEnum::InferiorToSuperior), | ||
|
|
||
| PRI = ITK_ORIENTATION_ENUM(CoordinateEnum::AnteriorToPosterior, | ||
| CoordinateEnum::LeftToRight, | ||
| CoordinateEnum::SuperiorToInferior), | ||
| PLI = ITK_ORIENTATION_ENUM(CoordinateEnum::AnteriorToPosterior, | ||
| CoordinateEnum::RightToLeft, | ||
| CoordinateEnum::SuperiorToInferior), | ||
| ARI = ITK_ORIENTATION_ENUM(CoordinateEnum::PosteriorToAnterior, | ||
| CoordinateEnum::LeftToRight, | ||
| CoordinateEnum::SuperiorToInferior), | ||
| ALI = ITK_ORIENTATION_ENUM(CoordinateEnum::PosteriorToAnterior, | ||
| CoordinateEnum::RightToLeft, | ||
| CoordinateEnum::SuperiorToInferior), | ||
| PRS = ITK_ORIENTATION_ENUM(CoordinateEnum::AnteriorToPosterior, | ||
| CoordinateEnum::LeftToRight, | ||
| CoordinateEnum::InferiorToSuperior), | ||
| PLS = ITK_ORIENTATION_ENUM(CoordinateEnum::AnteriorToPosterior, | ||
| CoordinateEnum::RightToLeft, | ||
| CoordinateEnum::InferiorToSuperior), | ||
| ARS = ITK_ORIENTATION_ENUM(CoordinateEnum::PosteriorToAnterior, | ||
| CoordinateEnum::LeftToRight, | ||
| CoordinateEnum::InferiorToSuperior), | ||
| ALS = ITK_ORIENTATION_ENUM(CoordinateEnum::PosteriorToAnterior, | ||
| CoordinateEnum::RightToLeft, | ||
| CoordinateEnum::InferiorToSuperior), | ||
|
|
||
| IPR = ITK_ORIENTATION_ENUM(CoordinateEnum::SuperiorToInferior, | ||
| CoordinateEnum::AnteriorToPosterior, | ||
| CoordinateEnum::LeftToRight), | ||
| SPR = ITK_ORIENTATION_ENUM(CoordinateEnum::InferiorToSuperior, | ||
| CoordinateEnum::AnteriorToPosterior, | ||
| CoordinateEnum::LeftToRight), | ||
| IAR = ITK_ORIENTATION_ENUM(CoordinateEnum::SuperiorToInferior, | ||
| CoordinateEnum::PosteriorToAnterior, | ||
| CoordinateEnum::LeftToRight), | ||
| SAR = ITK_ORIENTATION_ENUM(CoordinateEnum::InferiorToSuperior, | ||
| CoordinateEnum::PosteriorToAnterior, | ||
| CoordinateEnum::LeftToRight), | ||
| IPL = ITK_ORIENTATION_ENUM(CoordinateEnum::SuperiorToInferior, | ||
| CoordinateEnum::AnteriorToPosterior, | ||
| CoordinateEnum::RightToLeft), | ||
| SPL = ITK_ORIENTATION_ENUM(CoordinateEnum::InferiorToSuperior, | ||
| CoordinateEnum::AnteriorToPosterior, | ||
| CoordinateEnum::RightToLeft), | ||
| IAL = ITK_ORIENTATION_ENUM(CoordinateEnum::SuperiorToInferior, | ||
| CoordinateEnum::PosteriorToAnterior, | ||
| CoordinateEnum::RightToLeft), | ||
| SAL = ITK_ORIENTATION_ENUM(CoordinateEnum::InferiorToSuperior, | ||
| CoordinateEnum::PosteriorToAnterior, | ||
| CoordinateEnum::RightToLeft), | ||
|
|
||
| PIR = ITK_ORIENTATION_ENUM(CoordinateEnum::AnteriorToPosterior, | ||
| CoordinateEnum::SuperiorToInferior, | ||
| CoordinateEnum::LeftToRight), | ||
| PSR = ITK_ORIENTATION_ENUM(CoordinateEnum::AnteriorToPosterior, | ||
| CoordinateEnum::InferiorToSuperior, | ||
| CoordinateEnum::LeftToRight), | ||
| AIR = ITK_ORIENTATION_ENUM(CoordinateEnum::PosteriorToAnterior, | ||
| CoordinateEnum::SuperiorToInferior, | ||
| CoordinateEnum::LeftToRight), | ||
| ASR = ITK_ORIENTATION_ENUM(CoordinateEnum::PosteriorToAnterior, | ||
| CoordinateEnum::InferiorToSuperior, | ||
| CoordinateEnum::LeftToRight), | ||
| PIL = ITK_ORIENTATION_ENUM(CoordinateEnum::AnteriorToPosterior, | ||
| CoordinateEnum::SuperiorToInferior, | ||
| CoordinateEnum::RightToLeft), | ||
| PSL = ITK_ORIENTATION_ENUM(CoordinateEnum::AnteriorToPosterior, | ||
| CoordinateEnum::InferiorToSuperior, | ||
| CoordinateEnum::RightToLeft), | ||
| AIL = ITK_ORIENTATION_ENUM(CoordinateEnum::PosteriorToAnterior, | ||
| CoordinateEnum::SuperiorToInferior, | ||
| CoordinateEnum::RightToLeft), | ||
| ASL = ITK_ORIENTATION_ENUM(CoordinateEnum::PosteriorToAnterior, | ||
| CoordinateEnum::InferiorToSuperior, | ||
| CoordinateEnum::RightToLeft) | ||
| }; | ||
|
|
||
| #undef ITK_ORIENTATION_ENUM | ||
|
|
||
|
|
||
| /** \brief Initialize with CoordinateEnum's from separate axes. | ||
| * | ||
| * If multiple CoordinateEnums are from the same axes then the Orientation value is INVALID. | ||
| */ | ||
| DICOMOrientation(CoordinateEnum primary, CoordinateEnum secondary, CoordinateEnum tertiary); | ||
|
|
||
| DICOMOrientation(OrientationEnum orientation) | ||
| : m_Value(orientation) | ||
| {} | ||
|
|
||
|
|
||
| #ifndef ITK_FUTURE_LEGACY_REMOVE | ||
| /** \brief Conversion from Legacy SpatialOrientation | ||
| * | ||
| * @param legacyOrientation | ||
| */ | ||
| DICOMOrientation(LegacyOrientationType legacyOrientation); | ||
| #endif | ||
|
|
||
| explicit DICOMOrientation(const DirectionType & d) | ||
| : m_Value(DirectionCosinesToOrientation(d)) | ||
| {} | ||
|
|
||
| explicit DICOMOrientation(std::string str); | ||
|
|
||
| operator OrientationEnum() const { return m_Value; } | ||
|
|
||
| const std::string & | ||
| GetAsString() const; | ||
|
|
||
| DirectionType | ||
| GetAsDirection() const | ||
| { | ||
| return OrientationToDirectionCosines(m_Value); | ||
| } | ||
|
|
||
| OrientationEnum | ||
| GetAsOrientation() const | ||
| { | ||
| return m_Value; | ||
| } | ||
|
|
||
| CoordinateEnum | ||
| GetPrimaryTerm() const | ||
| { | ||
| return GetCoordinateTerm(CoordinateMajornessTermsEnum::PrimaryMinor); | ||
| } | ||
|
|
||
| CoordinateEnum | ||
| GetSecondaryTerm() const | ||
| { | ||
| return GetCoordinateTerm(CoordinateMajornessTermsEnum::SecondaryMinor); | ||
| } | ||
|
|
||
| CoordinateEnum | ||
| GetTertiaryTerm() const | ||
| { | ||
| return GetCoordinateTerm(CoordinateMajornessTermsEnum::TertiaryMinor); | ||
| } | ||
|
|
||
|
|
||
| static bool | ||
| SameOrientationAxes(CoordinateEnum a, CoordinateEnum b) | ||
| { | ||
| const unsigned int AxisField = 0xE; // b1110, mask lowest bit | ||
| return (static_cast<uint8_t>(a) & AxisField) == (static_cast<uint8_t>(b) & AxisField); | ||
| } | ||
|
|
||
| /** \brief Return the closest orientation for a direction cosine matrix. */ | ||
| static OrientationEnum | ||
| DirectionCosinesToOrientation(const DirectionType & dir); | ||
|
|
||
| /** \brief Return the direction cosine matrix for a orientation. */ | ||
| static DirectionType OrientationToDirectionCosines(OrientationEnum); | ||
|
|
||
|
|
||
| friend ITKCommon_EXPORT std::ostream & | ||
| operator<<(std::ostream & out, OrientationEnum value); | ||
|
|
||
|
|
||
| private: | ||
| // Private methods to create the maps, these will only be called once. | ||
| static std::map<OrientationEnum, std::string> | ||
| CreateCodeToString(); | ||
| static std::map<std::string, OrientationEnum> | ||
| CreateStringToCode(); | ||
|
|
||
| /** \brief Return the global instance of the map from orientation enum to strings. | ||
| * | ||
| * The implementation uses a function static local variable so the global is created only if needed, only once. | ||
| */ | ||
| static const std::map<OrientationEnum, std::string> & | ||
| GetCodeToString(); | ||
|
|
||
| /** \brief Return the global instance of the map from string to orientation enum. | ||
| */ | ||
| static const std::map<std::string, OrientationEnum> & | ||
| GetStringToCode(); | ||
|
|
||
| OrientationEnum m_Value; | ||
| }; | ||
|
|
||
|
|
||
| ITKCommon_EXPORT std::ostream & | ||
| operator<<(std::ostream & out, typename DICOMOrientation::OrientationEnum value); | ||
|
|
||
| ITKCommon_EXPORT std::ostream & | ||
| operator<<(std::ostream & out, const DICOMOrientation & orientation); | ||
|
|
||
|
|
||
| } // end namespace itk | ||
|
|
||
|
|
||
| #endif |
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
Oops, something went wrong.
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.
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.
This is word does not belong to the dictionary, because it should be rejected. It would be better to avoid using this word in the source code or disable spellchecking at the single place where this word is intentionally used.
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.
This sounds like a misspelling of posterior.