VTK
vtkNIFTIImageWriter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkNIFTIImageWriter.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
36 #ifndef vtkNIFTIImageWriter_h
37 #define vtkNIFTIImageWriter_h
38 
39 #include "vtkIOImageModule.h" // For export macro
40 #include "vtkImageWriter.h"
41 
42 class vtkMatrix4x4;
44 
45 class VTKIOIMAGE_EXPORT vtkNIFTIImageWriter : public vtkImageWriter
46 {
47 public:
49 
55 
59  void PrintSelf(ostream& os, vtkIndent indent) override;
60 
62 
68  vtkSetMacro(NIFTIVersion, int);
69  vtkGetMacro(NIFTIVersion, int);
71 
73 
77  vtkSetStringMacro(Description);
78  vtkGetStringMacro(Description);
80 
82 
88  vtkGetMacro(TimeDimension, int);
89  vtkSetMacro(TimeDimension, int);
90  vtkGetMacro(TimeSpacing, double);
91  vtkSetMacro(TimeSpacing, double);
93 
95 
103  vtkSetMacro(RescaleSlope, double);
104  vtkGetMacro(RescaleSlope, double);
105  vtkSetMacro(RescaleIntercept, double);
106  vtkGetMacro(RescaleIntercept, double);
108 
110 
117  vtkGetMacro(PlanarRGB, bool);
118  vtkSetMacro(PlanarRGB, bool);
119  vtkBooleanMacro(PlanarRGB, bool);
121 
123 
128  vtkSetMacro(QFac, double);
129  vtkGetMacro(QFac, double);
131 
140  vtkMatrix4x4 *GetQFormMatrix() { return this->QFormMatrix; }
141 
150  vtkMatrix4x4 *GetSFormMatrix() { return this->SFormMatrix; }
151 
153 
163 
164 protected:
167 
171  int GenerateHeader(vtkInformation *info, bool singleFile);
172 
177  vtkInformationVector** inputVector,
178  vtkInformationVector* outputVector) override;
179 
186  static char *ReplaceExtension(
187  const char *fname, const char *ext1, const char *ext2);
188 
190 
194  double TimeSpacing;
196 
198 
202  double RescaleSlope;
204 
208  double QFac;
209 
211 
217 
221  char *Description;
222 
224 
231 
235  bool PlanarRGB;
236 
237 private:
238  vtkNIFTIImageWriter(const vtkNIFTIImageWriter&) = delete;
239  void operator=(const vtkNIFTIImageWriter&) = delete;
240 };
241 
242 #endif // vtkNIFTIImageWriter_h
vtkNIFTIImageWriter::~vtkNIFTIImageWriter
~vtkNIFTIImageWriter() override
vtkNIFTIImageWriter::GenerateHeader
int GenerateHeader(vtkInformation *info, bool singleFile)
Generate the header information for the file.
vtkImageWriter
Writes images to files.
Definition: vtkImageWriter.h:36
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkNIFTIImageWriter::QFac
double QFac
Is -1 if VTK slice order is opposite to NIFTI slice order, +1 otherwise.
Definition: vtkNIFTIImageWriter.h:208
vtkNIFTIImageWriter::GetNIFTIHeader
vtkNIFTIImageHeader * GetNIFTIHeader()
vtkNIFTIImageWriter::SFormMatrix
vtkMatrix4x4 * SFormMatrix
Definition: vtkNIFTIImageWriter.h:215
vtkNIFTIImageWriter::New
static vtkNIFTIImageWriter * New()
Static method for construction.
vtkNIFTIImageWriter::TimeSpacing
double TimeSpacing
Definition: vtkNIFTIImageWriter.h:194
vtkNIFTIImageWriter::TimeDimension
int TimeDimension
The size and spacing of the Time dimension to use in the file.
Definition: vtkNIFTIImageWriter.h:193
vtkNIFTIImageWriter::RequestData
int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
The main execution method, which writes the file.
vtkNIFTIImageWriter::SetSFormMatrix
void SetSFormMatrix(vtkMatrix4x4 *)
Set a matrix for the "sform" transformation stored in the file.
vtkNIFTIImageWriter::Description
char * Description
A description of how the file was produced.
Definition: vtkNIFTIImageWriter.h:221
vtkNIFTIImageWriter::ReplaceExtension
static char * ReplaceExtension(const char *fname, const char *ext1, const char *ext2)
Make a new filename by replacing extension "ext1" with "ext2".
vtkNIFTIImageWriter::RescaleSlope
double RescaleSlope
Definition: vtkNIFTIImageWriter.h:202
vtkNIFTIImageHeader
Store NIfTI header information.
Definition: vtkNIFTIImageHeader.h:50
vtkNIFTIImageWriter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Print information about this object.
vtkNIFTIImageWriter::GetQFormMatrix
vtkMatrix4x4 * GetQFormMatrix()
Definition: vtkNIFTIImageWriter.h:140
vtkImageWriter.h
vtkNIFTIImageWriter::QFormMatrix
vtkMatrix4x4 * QFormMatrix
The orientation matrices for the NIFTI file.
Definition: vtkNIFTIImageWriter.h:214
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkMatrix4x4
represent and manipulate 4x4 transformation matrices
Definition: vtkMatrix4x4.h:42
vtkNIFTIImageWriter::OwnHeader
vtkNIFTIImageHeader * OwnHeader
Definition: vtkNIFTIImageWriter.h:228
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkNIFTIImageWriter::RescaleIntercept
double RescaleIntercept
Information for rescaling data to quantitative units.
Definition: vtkNIFTIImageWriter.h:201
vtkNIFTIImageWriter::PlanarRGB
bool PlanarRGB
Use planar RGB instead of the default (packed).
Definition: vtkNIFTIImageWriter.h:235
vtkNIFTIImageWriter::vtkNIFTIImageWriter
vtkNIFTIImageWriter()
vtkNIFTIImageWriter::NIFTIHeader
vtkNIFTIImageHeader * NIFTIHeader
The header information.
Definition: vtkNIFTIImageWriter.h:227
vtkNIFTIImageWriter::NIFTIVersion
int NIFTIVersion
Definition: vtkNIFTIImageWriter.h:229
vtkNIFTIImageWriter
Write NIfTI-1 and NIfTI-2 medical image files.
Definition: vtkNIFTIImageWriter.h:46
vtkNIFTIImageWriter::SetQFormMatrix
void SetQFormMatrix(vtkMatrix4x4 *)
Set the "qform" orientation and offset for the image data.
vtkNIFTIImageWriter::GetSFormMatrix
vtkMatrix4x4 * GetSFormMatrix()
Definition: vtkNIFTIImageWriter.h:150
vtkNIFTIImageWriter::SetNIFTIHeader
void SetNIFTIHeader(vtkNIFTIImageHeader *hdr)
Set the NIFTI header information to use when writing the file.