VTK  9.2.5
vtkMINCImageReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkMINCImageReader.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 =========================================================================*/
15 /*=========================================================================
16 
17 Copyright (c) 2006 Atamai, Inc.
18 
19 Use, modification and redistribution of the software, in source or
20 binary forms, are permitted provided that the following terms and
21 conditions are met:
22 
23 1) Redistribution of the source code, in verbatim or modified
24  form, must retain the above copyright notice, this license,
25  the following disclaimer, and any notices that refer to this
26  license and/or the following disclaimer.
27 
28 2) Redistribution in binary form must include the above copyright
29  notice, a copy of this license and the following disclaimer
30  in the documentation or with other materials provided with the
31  distribution.
32 
33 3) Modified copies of the source code must be clearly marked as such,
34  and must not be misrepresented as verbatim copies of the source code.
35 
36 THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS"
37 WITHOUT EXPRESSED OR IMPLIED WARRANTY INCLUDING, BUT NOT LIMITED TO,
38 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39 PURPOSE. IN NO EVENT SHALL ANY COPYRIGHT HOLDER OR OTHER PARTY WHO MAY
40 MODIFY AND/OR REDISTRIBUTE THE SOFTWARE UNDER THE TERMS OF THIS LICENSE
41 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES
42 (INCLUDING, BUT NOT LIMITED TO, LOSS OF DATA OR DATA BECOMING INACCURATE
43 OR LOSS OF PROFIT OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF
44 THE USE OR INABILITY TO USE THE SOFTWARE, EVEN IF ADVISED OF THE
45 POSSIBILITY OF SUCH DAMAGES.
46 
47 =========================================================================*/
74 #ifndef vtkMINCImageReader_h
75 #define vtkMINCImageReader_h
76 
77 #include "vtkIOMINCModule.h" // For export macro
78 #include "vtkImageReader2.h"
79 
80 class vtkStringArray;
81 class vtkIdTypeArray;
82 class vtkDoubleArray;
83 class vtkMatrix4x4;
84 
85 // A special class that holds the attributes
87 
88 class VTKIOMINC_EXPORT vtkMINCImageReader : public vtkImageReader2
89 {
90 public:
92 
94  void PrintSelf(ostream& os, vtkIndent indent) override;
95 
99  void SetFileName(VTK_FILEPATH const char* name) override;
100 
104  const char* GetFileExtensions() override { return ".mnc"; }
105 
109  const char* GetDescriptiveName() override { return "MINC"; }
110 
114  int CanReadFile(VTK_FILEPATH const char* name) override;
115 
122 
124 
129  virtual double GetRescaleSlope();
130  virtual double GetRescaleIntercept();
132 
134 
139  vtkSetMacro(RescaleRealValues, vtkTypeBool);
140  vtkBooleanMacro(RescaleRealValues, vtkTypeBool);
141  vtkGetMacro(RescaleRealValues, vtkTypeBool);
143 
145 
151  virtual double* GetDataRange() VTK_SIZEHINT(2);
152  virtual void GetDataRange(double range[2])
153  {
154  double* r = this->GetDataRange();
155  range[0] = r[0];
156  range[1] = r[1];
157  }
159 
163  virtual int GetNumberOfTimeSteps();
164 
166 
169  vtkSetMacro(TimeStep, int);
170  vtkGetMacro(TimeStep, int);
172 
178 
179 protected:
182 
185 
186  double ValidRange[2];
187  double ImageRange[2];
188  double DataRange[2];
189 
191  int TimeStep;
193  double RescaleSlope;
197 
199 
200  virtual int OpenNetCDFFile(const char* filename, int& ncid);
201  virtual int CloseNetCDFFile(int ncid);
202  virtual int IndexFromDimensionName(const char* dimName);
203  virtual int ReadMINCFileAttributes();
205  static int ConvertMINCTypeToVTKType(int minctype, int mincsigned);
206 
207  void ExecuteInformation() override;
209 
210 private:
211  vtkMINCImageReader(const vtkMINCImageReader&) = delete;
212  void operator=(const vtkMINCImageReader&) = delete;
213 };
214 
215 #endif
general representation of visualization data
dynamic, self-adjusting array of double
dynamic, self-adjusting array of vtkIdType
Superclass of binary file readers.
a simple class to control print indentation
Definition: vtkIndent.h:119
Store vtkAlgorithm input/output information.
A container for a MINC image header.
A reader for MINC files.
virtual double GetRescaleIntercept()
Get the slope and intercept for rescaling the scalar values to real data values.
virtual int CloseNetCDFFile(int ncid)
virtual double * GetDataRange()
Get the scalar range of the output from the information in the file header.
void SetFileName(VTK_FILEPATH const char *name) override
Set the file name.
void ExecuteDataWithInformation(vtkDataObject *out, vtkInformation *outInfo) override
This is a convenience method that is implemented in many subclasses instead of RequestData.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual int IndexFromDimensionName(const char *dimName)
virtual double GetRescaleSlope()
Get the slope and intercept for rescaling the scalar values to real data values.
~vtkMINCImageReader() override
virtual vtkMINCImageAttributes * GetImageAttributes()
Get the image attributes, which contain patient information and other useful metadata.
static int ConvertMINCTypeToVTKType(int minctype, int mincsigned)
const char * GetDescriptiveName() override
Get the name of this file format.
const char * GetFileExtensions() override
Get the extension for this file format.
static vtkMINCImageReader * New()
virtual int OpenNetCDFFile(const char *filename, int &ncid)
vtkMINCImageAttributes * ImageAttributes
void ExecuteInformation() override
virtual int ReadMINCFileAttributes()
virtual vtkMatrix4x4 * GetDirectionCosines()
Get a matrix that describes the orientation of the data.
vtkTypeBool RescaleRealValues
virtual int GetNumberOfTimeSteps()
Get the number of time steps in the file.
virtual void FindRangeAndRescaleValues()
int CanReadFile(VTK_FILEPATH const char *name) override
Test whether the specified file can be read.
vtkMatrix4x4 * DirectionCosines
represent and manipulate 4x4 transformation matrices
Definition: vtkMatrix4x4.h:151
a vtkAbstractArray subclass for strings
@ range
Definition: vtkX3D.h:244
@ name
Definition: vtkX3D.h:225
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_FILEPATH
#define VTK_SIZEHINT(...)