VTK
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
vtkImageExport Class Reference

Export VTK images to third-party systems. More...

#include <vtkImageExport.h>

Inheritance diagram for vtkImageExport:
[legend]
Collaboration diagram for vtkImageExport:
[legend]

Public Types

typedef vtkImageAlgorithm Superclass
 
typedef void(* UpdateInformationCallbackType) (void *)
 These are function pointer types for the pipeline connection callbacks. More...
 
typedef int(* PipelineModifiedCallbackType) (void *)
 
typedef int *(* WholeExtentCallbackType) (void *)
 
typedef double *(* SpacingCallbackType) (void *)
 
typedef double *(* OriginCallbackType) (void *)
 
typedef double *(* DirectionCallbackType) (void *)
 
typedef int(* NumberOfComponentsCallbackType) (void *)
 
typedef void(* PropagateUpdateExtentCallbackType) (void *, int *)
 
typedef void(* UpdateDataCallbackType) (void *)
 
typedef int *(* DataExtentCallbackType) (void *)
 
typedef void *(* BufferPointerCallbackType) (void *)
 
- Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkImageExportNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkIdType GetDataMemorySize ()
 Get the number of bytes required for the output C array. More...
 
void GetDataDimensions (int *ptr)
 Get the (x,y,z) index dimensions of the data. More...
 
int * GetDataDimensions ()
 
int GetDataNumberOfScalarComponents ()
 Get the number of scalar components of the data. More...
 
int GetDataScalarType ()
 Get the scalar type of the data. More...
 
const char * GetDataScalarTypeAsString ()
 
int * GetDataExtent ()
 Get miscellaneous additional information about the data. More...
 
void GetDataExtent (int *ptr)
 
double * GetDataSpacing ()
 
void GetDataSpacing (double *ptr)
 
double * GetDataOrigin ()
 
void GetDataOrigin (double *ptr)
 
double * GetDataDirection ()
 
void GetDataDirection (double *ptr)
 
vtkImageDataGetInput ()
 Get the input object from the image pipeline. More...
 
virtual void ImageLowerLeftOn ()
 Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner. More...
 
virtual void ImageLowerLeftOff ()
 
virtual vtkTypeBool GetImageLowerLeft ()
 
virtual void SetImageLowerLeft (vtkTypeBool)
 
void SetExportVoidPointer (void *)
 Set the void pointer of the C array to export the data to. More...
 
void * GetExportVoidPointer ()
 
void Export ()
 The main interface: update the pipeline and export the image to the memory pointed to by SetExportVoidPointer(). More...
 
virtual void Export (void *)
 
void * GetPointerToData ()
 An alternative to Export(): Use with caution. More...
 
void * GetCallbackUserData ()
 Get the user data that should be passed to the callback functions. More...
 
UpdateInformationCallbackType GetUpdateInformationCallback () const
 Get pointers to the pipeline interface callbacks. More...
 
PipelineModifiedCallbackType GetPipelineModifiedCallback () const
 
WholeExtentCallbackType GetWholeExtentCallback () const
 
SpacingCallbackType GetSpacingCallback () const
 
OriginCallbackType GetOriginCallback () const
 
DirectionCallbackType GetDirectionCallback () const
 
ScalarTypeCallbackType GetScalarTypeCallback () const
 
NumberOfComponentsCallbackType GetNumberOfComponentsCallback () const
 
PropagateUpdateExtentCallbackType GetPropagateUpdateExtentCallback () const
 
UpdateDataCallbackType GetUpdateDataCallback () const
 
DataExtentCallbackType GetDataExtentCallback () const
 
BufferPointerCallbackType GetBufferPointerCallback () const
 
- Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithmNewInstance () const
 
vtkImageDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkImageDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Process a request from the executive. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
vtkDataObjectGetInput (int port)
 Get a data object for one of the input port connections. More...
 
vtkDataObjectGetInput ()
 
vtkImageDataGetImageDataInput (int port)
 
virtual void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
virtual void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkImageExportNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageExportSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageAlgorithm
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Public Attributes

const typedef char *(* ScalarTypeCallbackType )(void *)
 
- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImageExport ()
 
 ~vtkImageExport () override
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 This is called in response to a REQUEST_DATA request from the executive. More...
 
virtual void UpdateInformationCallback ()
 
virtual int PipelineModifiedCallback ()
 
virtual void UpdateDataCallback ()
 
virtual int * WholeExtentCallback ()
 
virtual double * SpacingCallback ()
 
virtual double * OriginCallback ()
 
virtual double * DirectionCallback ()
 
virtual const char * ScalarTypeCallback ()
 
virtual int NumberOfComponentsCallback ()
 
virtual void PropagateUpdateExtentCallback (int *)
 
virtual int * DataExtentCallback ()
 
virtual void * BufferPointerCallback ()
 
- Protected Member Functions inherited from vtkImageAlgorithm
 vtkImageAlgorithm ()
 
 ~vtkImageAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 Subclasses can reimplement this method to collect information from their inputs and set information for their outputs. More...
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Subclasses can reimplement this method to translate the update extent requests from each output port into update extent requests for the input connections. More...
 
virtual void CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 Convenience method to copy the scalar type and number of components from the input data to the output data. More...
 
virtual void ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
 This is a convenience method that is implemented in many subclasses instead of RequestData. More...
 
virtual void ExecuteData (vtkDataObject *output)
 This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers. More...
 
virtual void Execute ()
 
virtual void AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
 Allocate the output data. More...
 
virtual vtkImageDataAllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
 
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
 Copy the other point and cell data. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 These method should be reimplemented by subclasses that have more than a single input or single output. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkTypeBool ImageLowerLeft
 
int DataDimensions [3]
 
void * ExportVoidPointer
 
vtkMTimeType LastPipelineMTime
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Export VTK images to third-party systems.

vtkImageExport provides a way of exporting image data at the end of a pipeline to a third-party system or to a simple C array. Applications can use this to get direct access to the image data in memory. A callback interface is provided to allow connection of the VTK pipeline to a third-party pipeline. This interface conforms to the interface of vtkImageImport. In Python it is possible to use this class to write the image data into a python string that has been pre-allocated to be the correct size.

See also
vtkImageImport

Definition at line 38 of file vtkImageExport.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkImageExport.h.

◆ UpdateInformationCallbackType

typedef void(* vtkImageExport::UpdateInformationCallbackType) (void *)

These are function pointer types for the pipeline connection callbacks.

See further documentation in vtkImageImport.h.

Definition at line 152 of file vtkImageExport.h.

◆ PipelineModifiedCallbackType

typedef int(* vtkImageExport::PipelineModifiedCallbackType) (void *)

Definition at line 153 of file vtkImageExport.h.

◆ WholeExtentCallbackType

typedef int*(* vtkImageExport::WholeExtentCallbackType) (void *)

Definition at line 154 of file vtkImageExport.h.

◆ SpacingCallbackType

typedef double*(* vtkImageExport::SpacingCallbackType) (void *)

Definition at line 155 of file vtkImageExport.h.

◆ OriginCallbackType

typedef double*(* vtkImageExport::OriginCallbackType) (void *)

Definition at line 156 of file vtkImageExport.h.

◆ DirectionCallbackType

typedef double*(* vtkImageExport::DirectionCallbackType) (void *)

Definition at line 157 of file vtkImageExport.h.

◆ NumberOfComponentsCallbackType

typedef int(* vtkImageExport::NumberOfComponentsCallbackType) (void *)

Definition at line 159 of file vtkImageExport.h.

◆ PropagateUpdateExtentCallbackType

typedef void(* vtkImageExport::PropagateUpdateExtentCallbackType) (void *, int *)

Definition at line 160 of file vtkImageExport.h.

◆ UpdateDataCallbackType

typedef void(* vtkImageExport::UpdateDataCallbackType) (void *)

Definition at line 161 of file vtkImageExport.h.

◆ DataExtentCallbackType

typedef int*(* vtkImageExport::DataExtentCallbackType) (void *)

Definition at line 162 of file vtkImageExport.h.

◆ BufferPointerCallbackType

typedef void*(* vtkImageExport::BufferPointerCallbackType) (void *)

Definition at line 163 of file vtkImageExport.h.

Constructor & Destructor Documentation

◆ vtkImageExport()

vtkImageExport::vtkImageExport ( )
protected

◆ ~vtkImageExport()

vtkImageExport::~vtkImageExport ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkImageExport* vtkImageExport::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkImageExport::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkImageExport::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageAlgorithm.

◆ SafeDownCast()

static vtkImageExport* vtkImageExport::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImageExport::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageAlgorithm.

◆ NewInstance()

vtkImageExport* vtkImageExport::NewInstance ( ) const

◆ PrintSelf()

void vtkImageExport::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkImageAlgorithm.

◆ GetDataMemorySize()

vtkIdType vtkImageExport::GetDataMemorySize ( )

Get the number of bytes required for the output C array.

◆ GetDataDimensions() [1/2]

void vtkImageExport::GetDataDimensions ( int *  ptr)

Get the (x,y,z) index dimensions of the data.

Please note that C arrays are indexed in decreasing order, i.e. array[z][y][x].

◆ GetDataDimensions() [2/2]

int* vtkImageExport::GetDataDimensions ( )
inline

Definition at line 56 of file vtkImageExport.h.

◆ GetDataNumberOfScalarComponents()

int vtkImageExport::GetDataNumberOfScalarComponents ( )

Get the number of scalar components of the data.

Please note that when you index into a C array, the scalar component index comes last, i.e. array[z][y][x][c].

◆ GetDataScalarType()

int vtkImageExport::GetDataScalarType ( )

Get the scalar type of the data.

The scalar type of the C array must match the scalar type of the data.

◆ GetDataScalarTypeAsString()

const char* vtkImageExport::GetDataScalarTypeAsString ( )
inline

Definition at line 75 of file vtkImageExport.h.

◆ GetDataExtent() [1/2]

int* vtkImageExport::GetDataExtent ( )

Get miscellaneous additional information about the data.

◆ GetDataExtent() [2/2]

void vtkImageExport::GetDataExtent ( int *  ptr)

◆ GetDataSpacing() [1/2]

double* vtkImageExport::GetDataSpacing ( )

◆ GetDataSpacing() [2/2]

void vtkImageExport::GetDataSpacing ( double *  ptr)

◆ GetDataOrigin() [1/2]

double* vtkImageExport::GetDataOrigin ( )

◆ GetDataOrigin() [2/2]

void vtkImageExport::GetDataOrigin ( double *  ptr)

◆ GetDataDirection() [1/2]

double* vtkImageExport::GetDataDirection ( )

◆ GetDataDirection() [2/2]

void vtkImageExport::GetDataDirection ( double *  ptr)

◆ GetInput()

vtkImageData* vtkImageExport::GetInput ( )

Get the input object from the image pipeline.

◆ ImageLowerLeftOn()

virtual void vtkImageExport::ImageLowerLeftOn ( )
virtual

Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner.

Default: On. When this flag is Off, the image will be flipped vertically before it is exported. WARNING: this flag is used only with the Export() method, it is ignored by GetPointerToData().

◆ ImageLowerLeftOff()

virtual void vtkImageExport::ImageLowerLeftOff ( )
virtual

◆ GetImageLowerLeft()

virtual vtkTypeBool vtkImageExport::GetImageLowerLeft ( )
virtual

◆ SetImageLowerLeft()

virtual void vtkImageExport::SetImageLowerLeft ( vtkTypeBool  )
virtual

◆ SetExportVoidPointer()

void vtkImageExport::SetExportVoidPointer ( void *  )

Set the void pointer of the C array to export the data to.

From python, you can specify a pointer to a string that is large enough to hold the data.

◆ GetExportVoidPointer()

void* vtkImageExport::GetExportVoidPointer ( )
inline

Definition at line 120 of file vtkImageExport.h.

◆ Export() [1/2]

void vtkImageExport::Export ( )
inline

The main interface: update the pipeline and export the image to the memory pointed to by SetExportVoidPointer().

You can also specify a void pointer when you call Export().

Definition at line 129 of file vtkImageExport.h.

◆ Export() [2/2]

virtual void vtkImageExport::Export ( void *  )
virtual

◆ GetPointerToData()

void* vtkImageExport::GetPointerToData ( )

An alternative to Export(): Use with caution.

Update the pipeline and return a pointer to the image memory. The pointer is only valid until the next time that the pipeline is updated. WARNING: This method ignores the ImageLowerLeft flag.

◆ GetCallbackUserData()

void* vtkImageExport::GetCallbackUserData ( )

Get the user data that should be passed to the callback functions.

◆ GetUpdateInformationCallback()

UpdateInformationCallbackType vtkImageExport::GetUpdateInformationCallback ( ) const

Get pointers to the pipeline interface callbacks.

◆ GetPipelineModifiedCallback()

PipelineModifiedCallbackType vtkImageExport::GetPipelineModifiedCallback ( ) const

◆ GetWholeExtentCallback()

WholeExtentCallbackType vtkImageExport::GetWholeExtentCallback ( ) const

◆ GetSpacingCallback()

SpacingCallbackType vtkImageExport::GetSpacingCallback ( ) const

◆ GetOriginCallback()

OriginCallbackType vtkImageExport::GetOriginCallback ( ) const

◆ GetDirectionCallback()

DirectionCallbackType vtkImageExport::GetDirectionCallback ( ) const

◆ GetScalarTypeCallback()

ScalarTypeCallbackType vtkImageExport::GetScalarTypeCallback ( ) const

◆ GetNumberOfComponentsCallback()

NumberOfComponentsCallbackType vtkImageExport::GetNumberOfComponentsCallback ( ) const

◆ GetPropagateUpdateExtentCallback()

PropagateUpdateExtentCallbackType vtkImageExport::GetPropagateUpdateExtentCallback ( ) const

◆ GetUpdateDataCallback()

UpdateDataCallbackType vtkImageExport::GetUpdateDataCallback ( ) const

◆ GetDataExtentCallback()

DataExtentCallbackType vtkImageExport::GetDataExtentCallback ( ) const

◆ GetBufferPointerCallback()

BufferPointerCallbackType vtkImageExport::GetBufferPointerCallback ( ) const

◆ RequestData()

int vtkImageExport::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called in response to a REQUEST_DATA request from the executive.

Subclasses should override either this method or the ExecuteDataWithInformation method in order to generate data for their outputs. For images, the output arrays will already be allocated, so all that is necessary is to fill in the voxel values.

Reimplemented from vtkImageAlgorithm.

◆ UpdateInformationCallback()

virtual void vtkImageExport::UpdateInformationCallback ( )
protectedvirtual

◆ PipelineModifiedCallback()

virtual int vtkImageExport::PipelineModifiedCallback ( )
protectedvirtual

◆ UpdateDataCallback()

virtual void vtkImageExport::UpdateDataCallback ( )
protectedvirtual

◆ WholeExtentCallback()

virtual int* vtkImageExport::WholeExtentCallback ( )
protectedvirtual

◆ SpacingCallback()

virtual double* vtkImageExport::SpacingCallback ( )
protectedvirtual

◆ OriginCallback()

virtual double* vtkImageExport::OriginCallback ( )
protectedvirtual

◆ DirectionCallback()

virtual double* vtkImageExport::DirectionCallback ( )
protectedvirtual

◆ ScalarTypeCallback()

virtual const char* vtkImageExport::ScalarTypeCallback ( )
protectedvirtual

◆ NumberOfComponentsCallback()

virtual int vtkImageExport::NumberOfComponentsCallback ( )
protectedvirtual

◆ PropagateUpdateExtentCallback()

virtual void vtkImageExport::PropagateUpdateExtentCallback ( int *  )
protectedvirtual

◆ DataExtentCallback()

virtual int* vtkImageExport::DataExtentCallback ( )
protectedvirtual

◆ BufferPointerCallback()

virtual void* vtkImageExport::BufferPointerCallback ( )
protectedvirtual

Member Data Documentation

◆ ScalarTypeCallbackType

const typedef char*(* vtkImageExport::ScalarTypeCallbackType) (void *)

Definition at line 158 of file vtkImageExport.h.

◆ ImageLowerLeft

vtkTypeBool vtkImageExport::ImageLowerLeft
protected

Definition at line 205 of file vtkImageExport.h.

◆ DataDimensions

int vtkImageExport::DataDimensions[3]
protected

Definition at line 206 of file vtkImageExport.h.

◆ ExportVoidPointer

void* vtkImageExport::ExportVoidPointer
protected

Definition at line 207 of file vtkImageExport.h.

◆ LastPipelineMTime

vtkMTimeType vtkImageExport::LastPipelineMTime
protected

Definition at line 209 of file vtkImageExport.h.


The documentation for this class was generated from the following file: