File: itkPhilipsRECImageIO.h

package info (click to toggle)
insighttoolkit5 5.4.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 704,588 kB
  • sloc: cpp: 784,579; ansic: 628,724; xml: 44,704; fortran: 34,250; python: 22,934; sh: 4,078; pascal: 2,636; lisp: 2,158; makefile: 461; yacc: 328; asm: 205; perl: 203; lex: 146; tcl: 132; javascript: 98; csh: 81
file content (166 lines) | stat: -rw-r--r-- 5,641 bytes parent folder | download | duplicates (2)
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
/*=========================================================================
 *
 *  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.
 *
 *=========================================================================*/
/**
 * \file   itkPhilipsRECImageIO.h
 *         The code for this file reader was written based on
 *         examination of Philips REC/PAR image files acquired at the
 *         Center for NMR Research at the Penn State Milton S. Hershey
 *         Medical Center.
 *
 *
 * \author Don C. Bigler
 *         The Pennsylvania State University 2005
 *
 * This implementation was contributed as a paper to the Insight Journal
 * https://www.insight-journal.org/browse/publication/237
 *
 */

#ifndef itkPhilipsRECImageIO_h
#define itkPhilipsRECImageIO_h
#include "ITKIOPhilipsRECExport.h"


#include "itkImageIOBase.h"
#include "itkVectorContainer.h"
#include "vnl/vnl_vector_fixed.h"

namespace itk
{
/** \class PhilipsRECImageIO
 * \author Don C. Bigler
 * \brief Reads Philips REC/PAR image files.
 *
 *  This class supports reading only and not writing.
 * \ingroup IOFilters
 * \ingroup ITKIOPhilipsREC
 */

class ITKIOPhilipsREC_EXPORT PhilipsRECImageIO : public ImageIOBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(PhilipsRECImageIO);

  /** Standard class type aliases. */
  using Self = PhilipsRECImageIO;
  using Superclass = ImageIOBase;
  using Pointer = SmartPointer<Self>;

  /** Method for creation through the object factory. */
  itkNewMacro(Self);

  /** \see LightObject::GetNameOfClass() */
  itkOverrideGetNameOfClassMacro(PhilipsRECImageIO);

  /** Special types used for Philips PAR meta data. */
  using EchoTimesContainerType = VectorContainer<unsigned int, double>;
  using TriggerTimesContainerType = VectorContainer<unsigned int, double>;
  using RepetitionTimesContainerType = VectorContainer<unsigned int, double>;
  using ScanResolutionType = vnl_vector_fixed<int, 2>;
  using FOVType = vnl_vector_fixed<float, 3>;
  using AngulationMidSliceType = vnl_vector_fixed<double, 3>;
  using OffCentreMidSliceType = vnl_vector_fixed<double, 3>;
  using PhaseEncodingVelocityType = vnl_vector_fixed<float, 3>;
  /** Image types:
   * 0 = Magnitude,
   * 1 = Real,
   * 2 = Imaginary,
   * 3 = Phase,
   * 4 = Special/Processed. */
  using ImageTypesType = vnl_vector_fixed<int, 8>;
  using ScanningSequencesType = vnl_vector_fixed<int, 8>;
  using IndexValueType = Superclass::IndexValueType;
  using SliceIndexType = std::vector<IndexValueType>;
  using ImageTypeRescaleValuesType = vnl_vector_fixed<double, 3>;

  using ImageTypeRescaleValuesContainerType = VectorContainer<unsigned int, ImageTypeRescaleValuesType>;
  using ImageTypeRescaleValuesContainerTypePtr = ImageTypeRescaleValuesContainerType::Pointer;
  using ScanningSequenceImageTypeRescaleValuesContainerType =
    VectorContainer<unsigned int, ImageTypeRescaleValuesContainerTypePtr>;
  using GradientBvalueType = double;
  using GradientBvalueContainerType = VectorContainer<unsigned int, GradientBvalueType>;
  using GradientDirectionType = vnl_vector_fixed<double, 3>;
  using GradientDirectionContainerType = VectorContainer<unsigned int, GradientDirectionType>;
  using LabelTypesASLContainerType = VectorContainer<unsigned int, int>;

  /*-------- This part of the interfaces deals with reading data. ----- */

  /** Determine if the file can be read with this ImageIO implementation.
   * \author Don C. Bigler
   * \param FileNameToRead The name of the file to test for reading.
   * \return Returns true if this ImageIO can read the file specified.
   */
  bool
  CanReadFile(const char * FileNameToRead) override;

  /** Set the spacing and dimension information for the set filename. */
  void
  ReadImageInformation() override;

  /** Reads the data from disk into the memory buffer provided. */
  void
  Read(void * buffer) override;

  /*-------- This part of the interfaces deals with writing data. ----- */

  /** Determine if the file can be written with this ImageIO implementation.
   * FileNameToWrite The name of the file to test for writing.
   * \author Don C. Bigler
   * \post This function will always return false (Not implemented).
   * \return Returns true if this ImageIO can write the file specified.
   */
  bool
  CanWriteFile(const char * itkNotUsed(FileNameToWrite)) override
  {
    return false;
  }

  /** Set the spacing and dimension information for the set filename. */
  void
  WriteImageInformation() override
  {
    return;
  }

  /** Writes the data to disk from the memory buffer provided. Make sure
   * that the IORegions has been set properly. */
  void
  Write(const void * itkNotUsed(buffer)) override
  {
    return;
  }

protected:
  PhilipsRECImageIO();
  ~PhilipsRECImageIO() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

private:
  void
  SwapBytesIfNecessary(void * buffer, SizeValueType numberOfPixels);

  IndexValueType
  GetSliceIndex(IndexValueType index) const;

  SliceIndexType * m_SliceIndex{};
  IOByteOrderEnum  m_MachineByteOrder{};
};
} // end namespace itk

#endif // itkPhilipsRECImageIO_h