1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
/*=========================================================================
Program: DICOM for VTK
Copyright (c) 2012-2024 David Gobbi
All rights reserved.
See Copyright.txt or http://dgobbi.github.io/bsd3.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
#ifndef vtkDICOMFileSorter_h
#define vtkDICOMFileSorter_h
#include "vtkObject.h"
#include "vtkDICOMModule.h" // For export macro
#include "vtkDICOMConfig.h" // For configuration details
// Declare VTK classes within VTK's optional namespace
#if defined(VTK_ABI_NAMESPACE_BEGIN)
VTK_ABI_NAMESPACE_BEGIN
#endif
class vtkStringArray;
class vtkIntArray;
#if defined(VTK_ABI_NAMESPACE_BEGIN)
VTK_ABI_NAMESPACE_END
#endif
class vtkDICOMMetaData;
//! Sort DICOM files and group them by study and series.
/*!
* If a list of input files is provided via SetInputFileNames(), then
* the files will be grouped by study and series, and each series will
* be sorted by InstanceNumber. If a single input file is provided via
* SetInputFileName(), then other files in the same series will be found,
* and the series will be sorted by InstanceNumber.
*/
class VTKDICOM_EXPORT vtkDICOMFileSorter : public vtkObject
{
public:
vtkTypeMacro(vtkDICOMFileSorter,vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) VTK_DICOM_OVERRIDE;
static vtkDICOMFileSorter *New();
//@{
//! Set one file from the desired series.
/*!
* When Update() is called, all files that belong to the
* same series as the specified file will be identified
* and can be retrieved by calling GetOutputFileNames().
*/
void SetInputFileName(const char *name);
const char *GetInputFileName() { return this->InputFileName; }
//@}
//@{
//! Set a list of file names to group and sort.
/*!
* This method is mutually exclusive with SetInputFileName().
* If you call this method, then InputFileName will be set to NULL
* and vice versa.
*/
void SetInputFileNames(vtkStringArray *input);
vtkStringArray *GetInputFileNames() { return this->InputFileNames; }
//@}
//@{
//! Update the information about the files.
/*!
* This method must be called before any of the Get methods.
*/
virtual void Update();
//@}
//@{
//! Get the total number of series that were found.
int GetNumberOfSeries();
//! Get the number of studies that were found.
int GetNumberOfStudies();
//! Get the first series for a particular study.
int GetFirstSeriesForStudy(int study);
//! Get the last series (inclusive) for a particular study.
int GetLastSeriesForStudy(int study);
//@}
//@{
//! Get the full list of sorted filenames.
vtkStringArray *GetOutputFileNames() { return this->OutputFileNames; }
//! Get the file names for a specific series.
vtkStringArray *GetFileNamesForSeries(int i);
//@}
//@{
//! Get the error code.
unsigned long GetErrorCode() { return this->ErrorCode; }
//! Get the filename associated with the error code.
const char *GetInternalFileName() { return this->InternalFileName; }
//@}
//@{
//! If this is On, files with no pixel data will be skipped.
/*!
* This is On by default. Some files, such as dicom directory files,
* have metadata but have no images. Usually we want to skip these.
*/
vtkSetMacro(RequirePixelData, int);
vtkBooleanMacro(RequirePixelData, int);
int GetRequirePixelData() { return this->RequirePixelData; }
//@}
protected:
vtkDICOMFileSorter();
~vtkDICOMFileSorter() VTK_DICOM_OVERRIDE;
const char *InputFileName;
vtkStringArray *InputFileNames;
vtkStringArray *OutputFileNames;
int RequirePixelData;
vtkTimeStamp UpdateTime;
unsigned long ErrorCode;
char *InternalFileName;
//! Fill the output filename array.
virtual void Execute();
//! Sort the input string array
virtual void SortFiles(vtkStringArray *input);
//! Add a sorted series to output.
/*!
* This method is called from SortFiles to provide the files
* that make up one series. The study that the files belong
* to must also be provided, as a number that starts at zero
* and monotonically increases.
*/
void AddSeriesFileNames(int study, vtkStringArray *files);
//! Description:
// Convert parser errors into sorter errors.
void RelayError(vtkObject *o, unsigned long e, void *data);
//! Description:
// Set the name of the file currently being operated on.
void SetInternalFileName(const char *fname);
//! Set the error code.
void SetErrorCode(unsigned long e) { this->ErrorCode = e; }
private:
#ifdef VTK_DICOM_DELETE
vtkDICOMFileSorter(const vtkDICOMFileSorter&) VTK_DICOM_DELETE;
void operator=(const vtkDICOMFileSorter&) VTK_DICOM_DELETE;
#else
vtkDICOMFileSorter(const vtkDICOMFileSorter&) = delete;
void operator=(const vtkDICOMFileSorter&) = delete;
#endif
class StringArrayVector;
struct FileInfo;
class FileInfoVectorList;
StringArrayVector *Series;
vtkIntArray *Studies;
//! Compare FileInfo entries by instance number
static bool CompareInstance(const FileInfo &fi1, const FileInfo &fi2);
};
#endif
|
