VTK  9.0.20210121
vtkImageExport.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImageExport.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 =========================================================================*/
32 #ifndef vtkImageExport_h
33 #define vtkImageExport_h
34 
35 #include "vtkIOImageModule.h" // For export macro
36 #include "vtkImageAlgorithm.h"
37 
38 class VTKIOIMAGE_EXPORT vtkImageExport : public vtkImageAlgorithm
39 {
40 public:
41  static vtkImageExport* New();
43  void PrintSelf(ostream& os, vtkIndent indent) override;
44 
48  vtkIdType GetDataMemorySize();
49 
51 
55  void GetDataDimensions(int* ptr);
57  {
58  this->GetDataDimensions(this->DataDimensions);
59  return this->DataDimensions;
60  }
62 
68  int GetDataNumberOfScalarComponents();
69 
74  int GetDataScalarType();
76  {
77  return vtkImageScalarTypeNameMacro(this->GetDataScalarType());
78  }
79 
81 
84  int* GetDataExtent() VTK_SIZEHINT(6);
85  void GetDataExtent(int* ptr);
86  double* GetDataSpacing() VTK_SIZEHINT(3);
87  void GetDataSpacing(double* ptr);
88  double* GetDataOrigin() VTK_SIZEHINT(3);
89  void GetDataOrigin(double* ptr);
90  double* GetDataDirection() VTK_SIZEHINT(9);
91  void GetDataDirection(double* ptr);
93 
97  vtkImageData* GetInput();
98 
100 
108  vtkBooleanMacro(ImageLowerLeft, vtkTypeBool);
109  vtkGetMacro(ImageLowerLeft, vtkTypeBool);
110  vtkSetMacro(ImageLowerLeft, vtkTypeBool);
112 
114 
119  void SetExportVoidPointer(void*);
120  void* GetExportVoidPointer() { return this->ExportVoidPointer; }
122 
124 
129  void Export() { this->Export(this->ExportVoidPointer); }
130  virtual void Export(void*);
132 
140  void* GetPointerToData();
141 
145  void* GetCallbackUserData();
146 
148 
152  typedef void (*UpdateInformationCallbackType)(void*);
153  typedef int (*PipelineModifiedCallbackType)(void*);
154  typedef int* (*WholeExtentCallbackType)(void*);
155  typedef double* (*SpacingCallbackType)(void*);
156  typedef double* (*OriginCallbackType)(void*);
157  typedef double* (*DirectionCallbackType)(void*);
158  typedef const char* (*ScalarTypeCallbackType)(void*);
159  typedef int (*NumberOfComponentsCallbackType)(void*);
160  typedef void (*PropagateUpdateExtentCallbackType)(void*, int*);
161  typedef void (*UpdateDataCallbackType)(void*);
162  typedef int* (*DataExtentCallbackType)(void*);
163  typedef void* (*BufferPointerCallbackType)(void*);
165 
167 
170  UpdateInformationCallbackType GetUpdateInformationCallback() const;
171  PipelineModifiedCallbackType GetPipelineModifiedCallback() const;
172  WholeExtentCallbackType GetWholeExtentCallback() const;
173  SpacingCallbackType GetSpacingCallback() const;
174  OriginCallbackType GetOriginCallback() const;
175  DirectionCallbackType GetDirectionCallback() const;
176  ScalarTypeCallbackType GetScalarTypeCallback() const;
177  NumberOfComponentsCallbackType GetNumberOfComponentsCallback() const;
178  PropagateUpdateExtentCallbackType GetPropagateUpdateExtentCallback() const;
179  UpdateDataCallbackType GetUpdateDataCallback() const;
180  DataExtentCallbackType GetDataExtentCallback() const;
181  BufferPointerCallbackType GetBufferPointerCallback() const;
183 
184 protected:
185  vtkImageExport();
186  ~vtkImageExport() override;
187 
188  // This is called by the superclass.
189  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
190  vtkInformationVector* outputVector) override;
191 
192  virtual void UpdateInformationCallback();
193  virtual int PipelineModifiedCallback();
194  virtual void UpdateDataCallback();
195  virtual int* WholeExtentCallback();
196  virtual double* SpacingCallback();
197  virtual double* OriginCallback();
198  virtual double* DirectionCallback();
199  virtual const char* ScalarTypeCallback();
200  virtual int NumberOfComponentsCallback();
201  virtual void PropagateUpdateExtentCallback(int*);
202  virtual int* DataExtentCallback();
203  virtual void* BufferPointerCallback();
204 
206  int DataDimensions[3];
208 
210 
211 private:
212  vtkImageExport(const vtkImageExport&) = delete;
213  void operator=(const vtkImageExport&) = delete;
214 
215  static void UpdateInformationCallbackFunction(void*);
216  static int PipelineModifiedCallbackFunction(void*);
217  static int* WholeExtentCallbackFunction(void*);
218  static double* SpacingCallbackFunction(void*);
219  static double* OriginCallbackFunction(void*);
220  static double* DirectionCallbackFunction(void*);
221  static const char* ScalarTypeCallbackFunction(void*);
222  static int NumberOfComponentsCallbackFunction(void*);
223  static void PropagateUpdateExtentCallbackFunction(void*, int*);
224  static void UpdateDataCallbackFunction(void*);
225  static int* DataExtentCallbackFunction(void*);
226  static void* BufferPointerCallbackFunction(void*);
227 
230 };
231 
232 #endif
vtkImageAlgorithm::RequestData
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called in response to a REQUEST_DATA request from the executive.
vtkImageExport::GetDataDimensions
int * GetDataDimensions()
Definition: vtkImageExport.h:56
vtkImageExport::ExportVoidPointer
void * ExportVoidPointer
Definition: vtkImageExport.h:207
vtkIdType
int vtkIdType
Definition: vtkType.h:330
vtkImageExport::GetDataScalarTypeAsString
const char * GetDataScalarTypeAsString()
Definition: vtkImageExport.h:75
vtkAlgorithm
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:63
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:35
vtkImageAlgorithm.h
vtkImageAlgorithm
Generic algorithm superclass for image algs.
Definition: vtkImageAlgorithm.h:37
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:45
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:47
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:73
vtkImageAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkAlgorithm::New
static vtkAlgorithm * New()
vtkAlgorithm::GetInputInformation
vtkInformation * GetInputInformation()
Equivalent to GetInputInformation(0, 0)
Definition: vtkAlgorithm.h:536
vtkAlgorithm::GetInputAlgorithm
vtkAlgorithm * GetInputAlgorithm()
Equivalent to GetInputAlgorithm(0, 0).
Definition: vtkAlgorithm.h:510
vtkImageExport::LastPipelineMTime
vtkMTimeType LastPipelineMTime
Definition: vtkImageExport.h:209
vtkImageExport::ImageLowerLeft
vtkTypeBool ImageLowerLeft
Definition: vtkImageExport.h:205
vtkImageExport::Export
void Export()
The main interface: update the pipeline and export the image to the memory pointed to by SetExportVoi...
Definition: vtkImageExport.h:129
vtkImageExport
Export VTK images to third-party systems.
Definition: vtkImageExport.h:38
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:285