File: itkIOTestHelper.h

package info (click to toggle)
insighttoolkit5 5.4.3-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 704,384 kB
  • sloc: cpp: 783,592; ansic: 628,724; xml: 44,704; fortran: 34,250; python: 22,874; sh: 4,078; pascal: 2,636; lisp: 2,158; makefile: 464; yacc: 328; asm: 205; perl: 203; lex: 146; tcl: 132; javascript: 98; csh: 81
file content (224 lines) | stat: -rw-r--r-- 6,823 bytes parent folder | download
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
/*=========================================================================
 *
 *  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 itkIOTestHelper_h
#define itkIOTestHelper_h
#include "ITKIOImageBaseExport.h"
#include <string>

#include "itksys/SystemTools.hxx"
#include "itkImageFileWriter.h"
#include "itkImageFileReader.h"
#include "vnl/vnl_random.h"
namespace itk
{
class IOTestHelper
{
public:
  template <typename TImage>
  static typename TImage::Pointer
  ReadImage(const std::string &           fileName,
            const bool                    zeroOrigin = false,
            typename ImageIOBase::Pointer imageio = nullptr)
  {
    using ReaderType = itk::ImageFileReader<TImage>;

    auto reader = ReaderType::New();
    {
      if (imageio)
      {
        reader->SetImageIO(imageio);
      }
      reader->SetFileName(fileName.c_str());
      try
      {
        reader->Update();
      }
      catch (const itk::ExceptionObject & err)
      {
        std::cout << "Caught an exception: " << std::endl;
        std::cout << err << ' ' << __FILE__ << ' ' << __LINE__ << std::endl;
        throw;
      }
      catch (...)
      {
        std::cout << "Error while reading in image for patient " << fileName << std::endl;
        throw;
      }
    }
    typename TImage::Pointer image = reader->GetOutput();
    if (zeroOrigin)
    {
      double origin[TImage::ImageDimension];
      for (unsigned int i = 0; i < TImage::ImageDimension; ++i)
      {
        origin[i] = 0;
      }
      image->SetOrigin(origin);
    }
    return image;
  }

  template <typename ImageType, typename ImageIOType>
  static void
  WriteImage(typename ImageType::Pointer   image,
             const std::string &           filename,
             typename ImageIOType::Pointer imageio = nullptr)
  {
    const bool create_local_io_object{ imageio.IsNull() };
    using WriterType = itk::ImageFileWriter<ImageType>;
    { // Test valid filename writing
      if (create_local_io_object)
      {
        imageio = ImageIOType::New();
      }
      auto writer = WriterType::New();
      writer->SetImageIO(imageio);
      writer->SetFileName(filename);
      writer->SetInput(image);
      try
      {
        writer->Update();
      }
      catch (const itk::ExceptionObject & err)
      {
        std::cerr << "Exception Object caught: " << std::endl << err << std::endl;
        throw;
      }
    }

    {                             // Test if writing to an invalid location causes exception to be thrown:
      imageio = imageio->Clone(); // A new io object is needed because the HDF5 io object is single use.  A new IO
                                  // object is needed to re-initialize the internal state.

      const std::string bad_root_path{ "/a_blatantly_obvious/bad_file_path/that/should/never/exist/on/the/computer/" };
      const std::string bad_filename{ bad_root_path + filename };
      bool              exception_correctly_caught = false;

      auto writer = WriterType::New();
      writer->SetImageIO(imageio);
      writer->SetFileName(bad_filename);
      writer->SetInput(image);
      try
      {
        writer->Update();
      }
      catch (const itk::ExceptionObject & /* err */)
      {
        // This is the correct behavior
        std::cout << "Correctly caught exception for attempting to write to an invalid file." << std::endl;
        exception_correctly_caught = true;
      }
      catch (...)
      {
        itkGenericExceptionMacro("IO library exception not converted to an itk::ExceptionObject.");
      }
      if (!exception_correctly_caught)
      {
        itkGenericExceptionMacro("Invalid file writing path did not throw an exception: " << bad_filename << " with "
                                                                                          << imageio->GetNameOfClass());
      }
    }
  }

  //
  // generate random pixels of various types
  static void
  RandomPix(vnl_random & randgen, itk::RGBPixel<unsigned char> & pix)
  {
    for (unsigned int i = 0; i < 3; ++i)
    {
      pix[i] = randgen.lrand32(itk::NumericTraits<unsigned char>::max());
    }
  }

  template <typename TPixel>
  static void
  RandomPix(vnl_random & randgen, TPixel & pix)
  {
    pix = randgen.lrand32(itk::NumericTraits<TPixel>::max());
  }

  static void
  RandomPix(vnl_random & randgen, long long & pix)
  {
    pix = randgen.lrand32(itk::NumericTraits<int>::max());
    pix = (pix << 32) | randgen.lrand32();
  }

  static void
  RandomPix(vnl_random & randgen, unsigned long long & pix)
  {
    pix = randgen.lrand32();
    pix = (pix << 32) | randgen.lrand32();
  }

  static void
  RandomPix(vnl_random & randgen, double & pix)
  {
    pix = randgen.drand64(itk::NumericTraits<double>::max());
  }

  static void
  RandomPix(vnl_random & randgen, float & pix)
  {
    pix = randgen.drand64(itk::NumericTraits<float>::max());
  }

  static int
  Remove(const char * fname)
  {
    return static_cast<bool>(itksys::SystemTools::RemoveFile(fname));
  }

  template <typename ImageType>
  static void
  SetIdentityDirection(typename ImageType::Pointer & im)
  {
    typename ImageType::DirectionType dir;
    dir.SetIdentity();
    im->SetDirection(dir);
  }

  template <typename ImageType>
  static typename ImageType::Pointer
  AllocateImageFromRegionAndSpacing(const typename ImageType::RegionType &  region,
                                    const typename ImageType::SpacingType & spacing)
  {
    auto rval = ImageType::New();
    SetIdentityDirection<ImageType>(rval);
    rval->SetSpacing(spacing);
    rval->SetRegions(region);
    rval->Allocate();
    return rval;
  }
  template <typename ImageType>
  static typename ImageType::Pointer
  AllocateImageFromRegionAndSpacing(const typename ImageType::RegionType &  region,
                                    const typename ImageType::SpacingType & spacing,
                                    int                                     vecLength)
  {
    auto rval = ImageType::New();
    rval->SetSpacing(spacing);
    rval->SetRegions(region);
    rval->SetVectorLength(vecLength);
    rval->Allocate();
    return rval;
  }
};
} // namespace itk
#endif // itkIOTestHelper_h