Return type of DicomSeriesReader::AnalyzeFileForITKImageSeriesReaderSpacingAssumption. More...
#include <mitkDicomSeriesReader.h>
Public Member Functions | |
| SliceGroupingAnalysisResult () | |
| StringContainer | GetBlockFilenames () |
| Get the grouped filenames (all with same origin-to-origin distance, no gaps). More... | |
| StringContainer | GetUnsortedFilenames () |
| Get the remaining files which could not be grouped. More... | |
| bool | ContainsGantryTilt () |
| Whether the grouped result contains a gantry tilt. More... | |
| void | AddFileToSortedBlock (const std::string &filename) |
| Add a file to the sorted (grouped) block. More... | |
| void | AddFileToUnsortedBlock (const std::string &filename) |
| Add a file to the unsorted (remaining) block. More... | |
| void | AddFilesToUnsortedBlock (const StringContainer &filenames) |
| Add multiple files to the unsorted (remaining) block. More... | |
| void | FlagGantryTilt () |
| Flag this result as containing a gantry tilt. More... | |
| void | UndoPrematureGrouping () |
| Undo a premature grouping decision. More... | |
Protected Attributes | |
| StringContainer | m_GroupedFiles |
| Files that form a valid image block. More... | |
| StringContainer | m_UnsortedFiles |
| Files that could not be grouped. More... | |
| bool | m_GantryTilt |
| Whether gantry tilt was detected. More... | |
Detailed Description
Return type of DicomSeriesReader::AnalyzeFileForITKImageSeriesReaderSpacingAssumption.
Contains the grouping result of AnalyzeFileForITKImageSeriesReaderSpacingAssumption(), which takes as input a number of images that are all equally oriented and spatially sorted along their normal direction.
The result consists of two blocks: the first contains files that can be loaded into one image block because they have equal origin-to-origin distance without gaps. The second contains remaining files that need further analysis.
Definition at line 641 of file mitkDicomSeriesReader.h.
Constructor & Destructor Documentation
◆ SliceGroupingAnalysisResult()
| mitk::DicomSeriesReader::SliceGroupingAnalysisResult::SliceGroupingAnalysisResult | ( | ) |
Member Function Documentation
◆ AddFilesToUnsortedBlock()
| void mitk::DicomSeriesReader::SliceGroupingAnalysisResult::AddFilesToUnsortedBlock | ( | const StringContainer & | filenames | ) |
Add multiple files to the unsorted (remaining) block.
- Note
- Meant for internal use by AnalyzeFileForITKImageSeriesReaderSpacingAssumption only.
- Parameters
-
filenames Paths to the files to add.
◆ AddFileToSortedBlock()
| void mitk::DicomSeriesReader::SliceGroupingAnalysisResult::AddFileToSortedBlock | ( | const std::string & | filename | ) |
Add a file to the sorted (grouped) block.
- Note
- Meant for internal use by AnalyzeFileForITKImageSeriesReaderSpacingAssumption only.
- Parameters
-
filename Path to the file to add.
◆ AddFileToUnsortedBlock()
| void mitk::DicomSeriesReader::SliceGroupingAnalysisResult::AddFileToUnsortedBlock | ( | const std::string & | filename | ) |
Add a file to the unsorted (remaining) block.
- Note
- Meant for internal use by AnalyzeFileForITKImageSeriesReaderSpacingAssumption only.
- Parameters
-
filename Path to the file to add.
◆ ContainsGantryTilt()
| bool mitk::DicomSeriesReader::SliceGroupingAnalysisResult::ContainsGantryTilt | ( | ) |
Whether the grouped result contains a gantry tilt.
- Returns
- True if gantry tilt was detected in the grouped block.
◆ FlagGantryTilt()
| void mitk::DicomSeriesReader::SliceGroupingAnalysisResult::FlagGantryTilt | ( | ) |
Flag this result as containing a gantry tilt.
- Note
- Meant for internal use by AnalyzeFileForITKImageSeriesReaderSpacingAssumption only.
◆ GetBlockFilenames()
| StringContainer mitk::DicomSeriesReader::SliceGroupingAnalysisResult::GetBlockFilenames | ( | ) |
Get the grouped filenames (all with same origin-to-origin distance, no gaps).
- Returns
- The list of filenames that form a valid image block.
◆ GetUnsortedFilenames()
| StringContainer mitk::DicomSeriesReader::SliceGroupingAnalysisResult::GetUnsortedFilenames | ( | ) |
Get the remaining files which could not be grouped.
- Returns
- The list of filenames not fitting into the primary block.
◆ UndoPrematureGrouping()
| void mitk::DicomSeriesReader::SliceGroupingAnalysisResult::UndoPrematureGrouping | ( | ) |
Undo a premature grouping decision.
Moves all files from the sorted block back into the unsorted block. Only meaningful for use by AnalyzeFileForITKImageSeriesReaderSpacingAssumption.
Member Data Documentation
◆ m_GantryTilt
|
protected |
Whether gantry tilt was detected.
Definition at line 704 of file mitkDicomSeriesReader.h.
◆ m_GroupedFiles
|
protected |
Files that form a valid image block.
Definition at line 701 of file mitkDicomSeriesReader.h.
◆ m_UnsortedFiles
|
protected |
Files that could not be grouped.
Definition at line 702 of file mitkDicomSeriesReader.h.
The documentation for this class was generated from the following file:
