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

Resamples an image to be larger or smaller. More...

#include <vtkImageResample.h>

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

Public Types

typedef vtkImageReslice Superclass
 
- Public Types inherited from vtkImageReslice
typedef vtkThreadedImageAlgorithm Superclass
 
- Public Types inherited from vtkThreadedImageAlgorithm
typedef vtkImageAlgorithm Superclass
 
- 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.
 
vtkImageResampleNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
double GetAxisMagnificationFactor (int axis, vtkInformation *inInfo=nullptr)
 Get the computed magnification factor for a specific axis.
 
void SetOutputSpacing (double sx, double sy, double sz) override
 Set desired spacing.
 
void SetOutputSpacing (const double spacing[3]) override
 Set desired spacing.
 
void SetAxisOutputSpacing (int axis, double spacing)
 Set desired spacing.
 
void SetMagnificationFactors (double fx, double fy, double fz)
 Set/Get Magnification factors.
 
void SetMagnificationFactors (const double f[3])
 Set/Get Magnification factors.
 
virtual double * GetMagnificationFactors ()
 Set/Get Magnification factors.
 
virtual void GetMagnificationFactors (double &, double &, double &)
 Set/Get Magnification factors.
 
virtual void GetMagnificationFactors (double[3])
 Set/Get Magnification factors.
 
void SetAxisMagnificationFactor (int axis, double factor)
 Set/Get Magnification factors.
 
virtual void SetDimensionality (int)
 Dimensionality is the number of axes which are considered during execution.
 
virtual int GetDimensionality ()
 Dimensionality is the number of axes which are considered during execution.
 
- Public Member Functions inherited from vtkImageReslice
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkImageResliceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void SetInterpolationMode (int)
 Set interpolation mode (default: nearest neighbor).
 
virtual int GetInterpolationMode ()
 
void SetInterpolationModeToNearestNeighbor ()
 
void SetInterpolationModeToLinear ()
 
void SetInterpolationModeToCubic ()
 
virtual const char * GetInterpolationModeAsString ()
 
vtkMTimeType GetMTime () override
 When determining the modified time of the filter, this check the modified time of the transform and matrix.
 
void ReportReferences (vtkGarbageCollector *) override
 Report object referenced by instances of this class.
 
virtual void SetResliceAxes (vtkMatrix4x4 *)
 This method is used to set up the axes for the output voxels.
 
virtual vtkMatrix4x4GetResliceAxes ()
 This method is used to set up the axes for the output voxels.
 
void SetResliceAxesDirectionCosines (double x0, double x1, double x2, double y0, double y1, double y2, double z0, double z1, double z2)
 Specify the direction cosines for the ResliceAxes (i.e.
 
void SetResliceAxesDirectionCosines (const double x[3], const double y[3], const double z[3])
 Specify the direction cosines for the ResliceAxes (i.e.
 
void SetResliceAxesDirectionCosines (const double xyz[9])
 Specify the direction cosines for the ResliceAxes (i.e.
 
void GetResliceAxesDirectionCosines (double x[3], double y[3], double z[3])
 Specify the direction cosines for the ResliceAxes (i.e.
 
void GetResliceAxesDirectionCosines (double xyz[9])
 Specify the direction cosines for the ResliceAxes (i.e.
 
double * GetResliceAxesDirectionCosines ()
 Specify the direction cosines for the ResliceAxes (i.e.
 
void SetResliceAxesOrigin (double x, double y, double z)
 Specify the origin for the ResliceAxes (i.e.
 
void SetResliceAxesOrigin (const double xyz[3])
 Specify the origin for the ResliceAxes (i.e.
 
void GetResliceAxesOrigin (double xyz[3])
 Specify the origin for the ResliceAxes (i.e.
 
double * GetResliceAxesOrigin ()
 Specify the origin for the ResliceAxes (i.e.
 
virtual void SetResliceTransform (vtkAbstractTransform *)
 Set a transform to be applied to the resampling grid that has been defined via the ResliceAxes and the output Origin, Spacing and Extent.
 
virtual vtkAbstractTransformGetResliceTransform ()
 Set a transform to be applied to the resampling grid that has been defined via the ResliceAxes and the output Origin, Spacing and Extent.
 
virtual void SetInformationInput (vtkImageData *)
 Set a vtkImageData from which the default Spacing, Origin, and WholeExtent of the output will be copied.
 
virtual vtkImageDataGetInformationInput ()
 Set a vtkImageData from which the default Spacing, Origin, and WholeExtent of the output will be copied.
 
virtual void SetTransformInputSampling (vtkTypeBool)
 Specify whether to transform the spacing, origin and extent of the Input (or the InformationInput) according to the direction cosines and origin of the ResliceAxes before applying them as the default output spacing, origin and extent (default: On).
 
virtual void TransformInputSamplingOn ()
 Specify whether to transform the spacing, origin and extent of the Input (or the InformationInput) according to the direction cosines and origin of the ResliceAxes before applying them as the default output spacing, origin and extent (default: On).
 
virtual void TransformInputSamplingOff ()
 Specify whether to transform the spacing, origin and extent of the Input (or the InformationInput) according to the direction cosines and origin of the ResliceAxes before applying them as the default output spacing, origin and extent (default: On).
 
virtual vtkTypeBool GetTransformInputSampling ()
 Specify whether to transform the spacing, origin and extent of the Input (or the InformationInput) according to the direction cosines and origin of the ResliceAxes before applying them as the default output spacing, origin and extent (default: On).
 
virtual void SetAutoCropOutput (vtkTypeBool)
 Turn this on if you want to guarantee that the extent of the output will be large enough to ensure that none of the data will be cropped (default: Off).
 
virtual void AutoCropOutputOn ()
 Turn this on if you want to guarantee that the extent of the output will be large enough to ensure that none of the data will be cropped (default: Off).
 
virtual void AutoCropOutputOff ()
 Turn this on if you want to guarantee that the extent of the output will be large enough to ensure that none of the data will be cropped (default: Off).
 
virtual vtkTypeBool GetAutoCropOutput ()
 Turn this on if you want to guarantee that the extent of the output will be large enough to ensure that none of the data will be cropped (default: Off).
 
virtual void SetWrap (vtkTypeBool)
 Turn on wrap-pad feature (default: Off).
 
virtual vtkTypeBool GetWrap ()
 Turn on wrap-pad feature (default: Off).
 
virtual void WrapOn ()
 Turn on wrap-pad feature (default: Off).
 
virtual void WrapOff ()
 Turn on wrap-pad feature (default: Off).
 
virtual void SetMirror (vtkTypeBool)
 Turn on mirror-pad feature (default: Off).
 
virtual vtkTypeBool GetMirror ()
 Turn on mirror-pad feature (default: Off).
 
virtual void MirrorOn ()
 Turn on mirror-pad feature (default: Off).
 
virtual void MirrorOff ()
 Turn on mirror-pad feature (default: Off).
 
virtual void SetBorder (vtkTypeBool)
 Extend the apparent input border by a half voxel (default: On).
 
virtual vtkTypeBool GetBorder ()
 Extend the apparent input border by a half voxel (default: On).
 
virtual void BorderOn ()
 Extend the apparent input border by a half voxel (default: On).
 
virtual void BorderOff ()
 Extend the apparent input border by a half voxel (default: On).
 
virtual void SetBorderThickness (double)
 Set the border thickness for BorderOn() (default: 0.5).
 
virtual double GetBorderThickness ()
 Set the border thickness for BorderOn() (default: 0.5).
 
virtual void SetInterpolator (vtkAbstractImageInterpolator *sampler)
 Set the interpolator to use.
 
virtual vtkAbstractImageInterpolatorGetInterpolator ()
 Set the interpolator to use.
 
virtual void SetSlabMode (int)
 Set the slab mode, for generating thick slices.
 
virtual int GetSlabMode ()
 Set the slab mode, for generating thick slices.
 
void SetSlabModeToMin ()
 Set the slab mode, for generating thick slices.
 
void SetSlabModeToMax ()
 Set the slab mode, for generating thick slices.
 
void SetSlabModeToMean ()
 Set the slab mode, for generating thick slices.
 
void SetSlabModeToSum ()
 Set the slab mode, for generating thick slices.
 
virtual const char * GetSlabModeAsString ()
 Set the slab mode, for generating thick slices.
 
virtual void SetSlabNumberOfSlices (int)
 Set the number of slices that will be combined to create the slab.
 
virtual int GetSlabNumberOfSlices ()
 Set the number of slices that will be combined to create the slab.
 
virtual void SetSlabTrapezoidIntegration (vtkTypeBool)
 Use trapezoid integration for slab computation.
 
virtual void SlabTrapezoidIntegrationOn ()
 Use trapezoid integration for slab computation.
 
virtual void SlabTrapezoidIntegrationOff ()
 Use trapezoid integration for slab computation.
 
virtual vtkTypeBool GetSlabTrapezoidIntegration ()
 Use trapezoid integration for slab computation.
 
virtual void SetSlabSliceSpacingFraction (double)
 The slab spacing as a fraction of the output slice spacing.
 
virtual double GetSlabSliceSpacingFraction ()
 The slab spacing as a fraction of the output slice spacing.
 
virtual void SetOptimization (vtkTypeBool)
 Turn on and off optimizations (default on, they should only be turned off for testing purposes).
 
virtual vtkTypeBool GetOptimization ()
 Turn on and off optimizations (default on, they should only be turned off for testing purposes).
 
virtual void OptimizationOn ()
 Turn on and off optimizations (default on, they should only be turned off for testing purposes).
 
virtual void OptimizationOff ()
 Turn on and off optimizations (default on, they should only be turned off for testing purposes).
 
virtual void SetScalarShift (double)
 Set a value to add to all the output voxels.
 
virtual double GetScalarShift ()
 Set a value to add to all the output voxels.
 
virtual void SetScalarScale (double)
 Set multiplication factor to apply to all the output voxels.
 
virtual double GetScalarScale ()
 Set multiplication factor to apply to all the output voxels.
 
virtual void SetOutputScalarType (int)
 Set the scalar type of the output to be different from the input.
 
virtual int GetOutputScalarType ()
 Set the scalar type of the output to be different from the input.
 
virtual void SetBackgroundColor (double, double, double, double)
 Set the background color (for multi-component images).
 
virtual void SetBackgroundColor (double[4])
 Set the background color (for multi-component images).
 
virtual double * GetBackgroundColor ()
 Set the background color (for multi-component images).
 
virtual void GetBackgroundColor (double &, double &, double &, double &)
 Set the background color (for multi-component images).
 
virtual void GetBackgroundColor (double[4])
 Set the background color (for multi-component images).
 
void SetBackgroundLevel (double v)
 Set background grey level (for single-component images).
 
double GetBackgroundLevel ()
 Set background grey level (for single-component images).
 
virtual double * GetOutputSpacing ()
 Set the voxel spacing for the output data.
 
virtual void GetOutputSpacing (double &, double &, double &)
 Set the voxel spacing for the output data.
 
virtual void GetOutputSpacing (double[3])
 Set the voxel spacing for the output data.
 
void SetOutputSpacingToDefault ()
 Set the voxel spacing for the output data.
 
virtual void SetOutputDirection (double xx, double xy, double xz, double yx, double yy, double yz, double zx, double zy, double zz)
 Set the direction for the output data.
 
virtual void SetOutputDirection (const double a[9])
 Set the direction for the output data.
 
virtual double * GetOutputDirection ()
 Set the direction for the output data.
 
virtual void GetOutputDirection (double &, double &, double &)
 Set the direction for the output data.
 
virtual void GetOutputDirection (double[3])
 Set the direction for the output data.
 
void SetOutputDirectionToDefault ()
 Set the direction for the output data.
 
virtual void SetOutputOrigin (double x, double y, double z)
 Set the origin for the output data.
 
virtual void SetOutputOrigin (const double a[3])
 Set the origin for the output data.
 
virtual double * GetOutputOrigin ()
 Set the origin for the output data.
 
virtual void GetOutputOrigin (double &, double &, double &)
 Set the origin for the output data.
 
virtual void GetOutputOrigin (double[3])
 Set the origin for the output data.
 
void SetOutputOriginToDefault ()
 Set the origin for the output data.
 
virtual void SetOutputExtent (int a, int b, int c, int d, int e, int f)
 Set the extent for the output data.
 
virtual void SetOutputExtent (const int a[6])
 Set the extent for the output data.
 
virtual int * GetOutputExtent ()
 Set the extent for the output data.
 
virtual void GetOutputExtent (int &, int &, int &, int &, int &, int &)
 Set the extent for the output data.
 
virtual void GetOutputExtent (int[6])
 Set the extent for the output data.
 
void SetOutputExtentToDefault ()
 Set the extent for the output data.
 
virtual void SetOutputDimensionality (int)
 Force the dimensionality of the output to either 1, 2, 3 or 0 (default: 3).
 
virtual int GetOutputDimensionality ()
 Force the dimensionality of the output to either 1, 2, 3 or 0 (default: 3).
 
void SetInterpolate (int t)
 Convenient methods for switching between nearest-neighbor and linear interpolation.
 
void InterpolateOn ()
 Convenient methods for switching between nearest-neighbor and linear interpolation.
 
void InterpolateOff ()
 Convenient methods for switching between nearest-neighbor and linear interpolation.
 
int GetInterpolate ()
 Convenient methods for switching between nearest-neighbor and linear interpolation.
 
void SetStencilData (vtkImageStencilData *stencil)
 Use a stencil to limit the calculations to a specific region of the output.
 
vtkImageStencilDataGetStencil ()
 Use a stencil to limit the calculations to a specific region of the output.
 
virtual void SetGenerateStencilOutput (vtkTypeBool)
 Generate an output stencil that defines which pixels were interpolated and which pixels were out-of-bounds of the input.
 
virtual vtkTypeBool GetGenerateStencilOutput ()
 Generate an output stencil that defines which pixels were interpolated and which pixels were out-of-bounds of the input.
 
virtual void GenerateStencilOutputOn ()
 Generate an output stencil that defines which pixels were interpolated and which pixels were out-of-bounds of the input.
 
virtual void GenerateStencilOutputOff ()
 Generate an output stencil that defines which pixels were interpolated and which pixels were out-of-bounds of the input.
 
vtkAlgorithmOutputGetStencilOutputPort ()
 Get the output stencil.
 
vtkImageStencilDataGetStencilOutput ()
 Get the output stencil.
 
void SetStencilOutput (vtkImageStencilData *stencil)
 Get the output stencil.
 
- Public Member Functions inherited from vtkThreadedImageAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkThreadedImageAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void ThreadedRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int extent[6], int threadId)
 If the subclass does not define an Execute method, then the task will be broken up, multiple threads will be spawned, and each thread will call this method.
 
virtual void ThreadedExecute (vtkImageData *inData, vtkImageData *outData, int extent[6], int threadId)
 
virtual int SplitExtent (int splitExt[6], int startExt[6], int num, int total)
 Putting this here until I merge graphics and imaging streaming.
 
virtual bool GetEnableSMP ()
 Enable/Disable SMP for threading.
 
virtual void SetEnableSMP (bool)
 Enable/Disable SMP for threading.
 
virtual void SetMinimumPieceSize (int, int, int)
 The minimum piece size when volume is split for execution.
 
virtual void SetMinimumPieceSize (int[3])
 The minimum piece size when volume is split for execution.
 
virtual int * GetMinimumPieceSize ()
 The minimum piece size when volume is split for execution.
 
virtual void GetMinimumPieceSize (int &, int &, int &)
 The minimum piece size when volume is split for execution.
 
virtual void GetMinimumPieceSize (int[3])
 The minimum piece size when volume is split for execution.
 
virtual void SetDesiredBytesPerPiece (vtkIdType)
 The desired bytes per piece when volume is split for execution.
 
virtual vtkIdType GetDesiredBytesPerPiece ()
 The desired bytes per piece when volume is split for execution.
 
virtual void SetSplitMode (int)
 Set the method used to divide the volume into pieces.
 
void SetSplitModeToSlab ()
 Set the method used to divide the volume into pieces.
 
void SetSplitModeToBeam ()
 Set the method used to divide the volume into pieces.
 
void SetSplitModeToBlock ()
 Set the method used to divide the volume into pieces.
 
virtual int GetSplitMode ()
 Set the method used to divide the volume into pieces.
 
virtual void SetNumberOfThreads (int)
 Get/Set the number of threads to create when rendering.
 
virtual int GetNumberOfThreads ()
 Get/Set the number of threads to create when rendering.
 
- Public Member Functions inherited from vtkImageAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkImageAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Process a request from the executive.
 
vtkImageDataGetOutput ()
 Get the output data object for a port on this algorithm.
 
vtkImageDataGetOutput (int)
 Get the output data object for a port on this algorithm.
 
virtual void SetOutput (vtkDataObject *d)
 Get the output data object for a port on this algorithm.
 
void SetInputData (vtkDataObject *)
 Assign a data object as input.
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input.
 
vtkDataObjectGetInput (int port)
 Get a data object for one of the input port connections.
 
vtkDataObjectGetInput ()
 Get a data object for one of the input port connections.
 
vtkImageDataGetImageDataInput (int port)
 Get a data object for one of the input port connections.
 
virtual void AddInputData (vtkDataObject *)
 Assign a data object as input.
 
virtual void AddInputData (int, vtkDataObject *)
 Assign a data object as input.
 
- Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive.
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive.
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive.
 
virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped.
 
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.
 
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.
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port.
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port.
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm.
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm.
 
void SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime.
 
void UpdateProgress (double amount)
 Update the progress of the process object.
 
bool CheckAbort ()
 Checks to see if this filter should abort.
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
 
void RemoveAllInputs ()
 Remove all the input data.
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection.
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index.
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx.
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections.
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index.
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port.
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm.
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port.
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm.
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0).
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection.
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0)
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection.
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0)
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port.
 
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).
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port.
 
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.
 
virtual VTK_UNBLOCKTHREADS int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual VTK_UNBLOCKTHREADS 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.
 
virtual VTK_UNBLOCKTHREADS void UpdateInformation ()
 Bring the algorithm's information up-to-date.
 
virtual void UpdateDataObject ()
 Create output object(s).
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream.
 
virtual VTK_UNBLOCKTHREADS void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date.
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
 
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm.
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm.
 
bool UsesGarbageCollector () const override
 Participate in garbage collection.
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object.
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object.
 
virtual double GetProgress ()
 Get the execution progress of a process object.
 
void SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm.
 
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm.
 
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive.
 
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive.
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state.
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state.
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file.
 
void SetInputArrayToProcess (const char *name, int fieldAssociation)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual VTK_UNBLOCKTHREADS void Update (int port)
 Bring this algorithm's outputs up-to-date.
 
virtual VTK_UNBLOCKTHREADS void Update ()
 Bring this algorithm's outputs up-to-date.
 
virtual void SetReleaseDataFlag (vtkTypeBool)
 Turn release data flag on or off for all output ports.
 
virtual vtkTypeBool GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports.
 
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.
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 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.
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents.
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents.
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkImageResampleNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageResampleSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageReslice
static vtkImageResliceNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageResliceSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkThreadedImageAlgorithm
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkThreadedImageAlgorithmSafeDownCast (vtkObjectBase *o)
 
static void SetGlobalDefaultEnableSMP (bool enable)
 Global Disable SMP for all derived Imaging filters.
 
static bool GetGlobalDefaultEnableSMP ()
 Global Disable SMP for all derived Imaging filters.
 
- 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.
 
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.
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
 
static vtkInformationIntegerKeyABORTED ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
 
- 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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImageResample ()
 
 ~vtkImageResample () override=default
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.
 
- Protected Member Functions inherited from vtkImageReslice
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImageReslice ()
 
 ~vtkImageReslice () override
 
virtual int ConvertScalarInfo (int &scalarType, int &numComponents)
 This should be overridden by derived classes that operate on the interpolated data before it is placed in the output.
 
virtual void ConvertScalars (void *inPtr, void *outPtr, int inputType, int inputNumComponents, int count, int idX, int idY, int idZ, int threadId)
 This should be overridden by derived classes that operate on the interpolated data before it is placed in the output.
 
void ConvertScalarsBase (void *inPtr, void *outPtr, int inputType, int inputNumComponents, int count, int idX, int idY, int idZ, int threadId)
 
int RequestInformationBase (vtkInformationVector **, vtkInformationVector *)
 For derived classes, this should be called at the very end of RequestInformation() to ensure that various bit and pieces of state information are correctly set prior to execution.
 
void GetAutoCroppedOutputBounds (vtkInformation *inInfo, const double outDirection[9], double bounds[6])
 
void AllocateOutputData (vtkImageData *output, vtkInformation *outInfo, int *uExtent) override
 Allocate the output data.
 
vtkImageDataAllocateOutputData (vtkDataObject *, vtkInformation *) override
 Allocate the output data.
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.
 
int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Subclasses can reimplement this method to translate the update extent requests from each output port into update extent requests for the input connections.
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called in response to a REQUEST_DATA request from the executive.
 
void ThreadedRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int ext[6], int id) override
 If the subclass does not define an Execute method, then the task will be broken up, multiple threads will be spawned, and each thread will call this method.
 
int FillInputPortInformation (int port, vtkInformation *info) override
 These method should be reimplemented by subclasses that have more than a single input or single output.
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 These method should be reimplemented by subclasses that have more than a single input or single output.
 
vtkMatrix4x4GetIndexMatrix (vtkInformation *inInfo, vtkInformation *outInfo)
 
vtkAbstractTransformGetOptimizedTransform ()
 
- Protected Member Functions inherited from vtkThreadedImageAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkThreadedImageAlgorithm ()
 
 ~vtkThreadedImageAlgorithm () override
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 This is called by the superclass.
 
virtual void SMPRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, vtkIdType begin, vtkIdType end, vtkIdType pieces, int extent[6])
 Execute ThreadedRequestData for the given set of pieces.
 
virtual void PrepareImageData (vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inDataObjects=nullptr, vtkImageData **outDataObjects=nullptr)
 Allocate space for output data and copy attributes from first input.
 
- Protected Member Functions inherited from vtkImageAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 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.
 
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.
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
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.
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 This is called in response to a REQUEST_DATA request from the executive.
 
virtual void ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
 This is a convenience method that is implemented in many subclasses instead of RequestData.
 
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
 Copy the other point and cell data.
 
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.
 
virtual void Execute ()
 This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers.
 
- Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted.
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm.
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm.
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm.
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm.
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive.
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port.
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port.
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input.
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
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.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
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.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file.
 
- 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double MagnificationFactors [3]
 
int Dimensionality
 
- Protected Attributes inherited from vtkImageReslice
vtkMatrix4x4ResliceAxes
 
double ResliceAxesDirectionCosines [9]
 
double ResliceAxesOrigin [3]
 
vtkAbstractTransformResliceTransform
 
vtkAbstractImageInterpolatorInterpolator
 
vtkImageDataInformationInput
 
vtkTypeBool Wrap
 
vtkTypeBool Mirror
 
vtkTypeBool Border
 
int InterpolationMode
 
vtkTypeBool Optimization
 
int SlabMode
 
int SlabNumberOfSlices
 
vtkTypeBool SlabTrapezoidIntegration
 
double SlabSliceSpacingFraction
 
double ScalarShift
 
double ScalarScale
 
double BorderThickness
 
double BackgroundColor [4]
 
double OutputDirection [9]
 
double OutputOrigin [3]
 
double OutputSpacing [3]
 
int OutputExtent [6]
 
int OutputScalarType
 
int OutputDimensionality
 
vtkTypeBool TransformInputSampling
 
vtkTypeBool AutoCropOutput
 
int HitInputExtent
 
int UsePermuteExecute
 
int ComputeOutputSpacing
 
bool PassDirectionToOutput
 
int ComputeOutputOrigin
 
int ComputeOutputExtent
 
vtkTypeBool GenerateStencilOutput
 
vtkMatrix4x4IndexMatrix
 
vtkAbstractTransformOptimizedTransform
 
vtkTypeBool HasConvertScalars
 This should be set to 1 by derived classes that override the ConvertScalars method.
 
- Protected Attributes inherited from vtkThreadedImageAlgorithm
vtkMultiThreaderThreader
 
int NumberOfThreads
 
bool EnableSMP
 
int SplitMode
 
int SplitPath [3]
 
int SplitPathLength
 
int MinimumPieceSize [3]
 
vtkIdType DesiredBytesPerPiece
 
- Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
 
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file.
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBoolAbortExecute
 
- Protected Types inherited from vtkThreadedImageAlgorithm
enum  SplitModeEnum { SLAB = 0 , BEAM = 1 , BLOCK = 2 }
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Static Protected Attributes inherited from vtkThreadedImageAlgorithm
static bool GlobalDefaultEnableSMP
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp LastAbortTime
 
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Resamples an image to be larger or smaller.

This filter produces an output with different spacing (and extent) than the input. Linear interpolation can be used to resample the data. The Output spacing can be set explicitly or relative to input spacing with the SetAxisMagnificationFactor method.

Online Examples:

Tests:
vtkImageResample (Tests)

Definition at line 42 of file vtkImageResample.h.

Member Typedef Documentation

◆ Superclass

Definition at line 46 of file vtkImageResample.h.

Constructor & Destructor Documentation

◆ vtkImageResample()

vtkImageResample::vtkImageResample ( )
protected

◆ ~vtkImageResample()

vtkImageResample::~vtkImageResample ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkImageResample * vtkImageResample::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkImageResample::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 vtkImageReslice.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkImageResample::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageReslice.

◆ NewInstance()

vtkImageResample * vtkImageResample::NewInstance ( ) const

◆ PrintSelf()

void vtkImageResample::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.

◆ SetOutputSpacing() [1/2]

void vtkImageResample::SetOutputSpacing ( double  sx,
double  sy,
double  sz 
)
overridevirtual

Set desired spacing.

Zero is a reserved value indicating spacing has not been set.

Reimplemented from vtkImageReslice.

◆ SetOutputSpacing() [2/2]

void vtkImageResample::SetOutputSpacing ( const double  spacing[3])
inlineoverridevirtual

Set desired spacing.

Zero is a reserved value indicating spacing has not been set.

Reimplemented from vtkImageReslice.

Definition at line 55 of file vtkImageResample.h.

◆ SetAxisOutputSpacing()

void vtkImageResample::SetAxisOutputSpacing ( int  axis,
double  spacing 
)

Set desired spacing.

Zero is a reserved value indicating spacing has not been set.

◆ SetMagnificationFactors() [1/2]

void vtkImageResample::SetMagnificationFactors ( double  fx,
double  fy,
double  fz 
)

Set/Get Magnification factors.

Zero is a reserved value indicating values have not been computed.

◆ SetMagnificationFactors() [2/2]

void vtkImageResample::SetMagnificationFactors ( const double  f[3])
inline

Set/Get Magnification factors.

Zero is a reserved value indicating values have not been computed.

Definition at line 68 of file vtkImageResample.h.

◆ GetMagnificationFactors() [1/3]

virtual double * vtkImageResample::GetMagnificationFactors ( )
virtual

Set/Get Magnification factors.

Zero is a reserved value indicating values have not been computed.

◆ GetMagnificationFactors() [2/3]

virtual void vtkImageResample::GetMagnificationFactors ( double &  ,
double &  ,
double &   
)
virtual

Set/Get Magnification factors.

Zero is a reserved value indicating values have not been computed.

◆ GetMagnificationFactors() [3/3]

virtual void vtkImageResample::GetMagnificationFactors ( double  [3])
virtual

Set/Get Magnification factors.

Zero is a reserved value indicating values have not been computed.

◆ SetAxisMagnificationFactor()

void vtkImageResample::SetAxisMagnificationFactor ( int  axis,
double  factor 
)

Set/Get Magnification factors.

Zero is a reserved value indicating values have not been computed.

◆ GetAxisMagnificationFactor()

double vtkImageResample::GetAxisMagnificationFactor ( int  axis,
vtkInformation inInfo = nullptr 
)

Get the computed magnification factor for a specific axis.

The input information is required to compute the value.

◆ SetDimensionality()

virtual void vtkImageResample::SetDimensionality ( int  )
virtual

Dimensionality is the number of axes which are considered during execution.

To process images dimensionality would be set to 2. This has the same effect as setting the magnification of the third axis to 1.0

◆ GetDimensionality()

virtual int vtkImageResample::GetDimensionality ( )
virtual

Dimensionality is the number of axes which are considered during execution.

To process images dimensionality would be set to 2. This has the same effect as setting the magnification of the third axis to 1.0

◆ RequestInformation()

int vtkImageResample::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.

Reimplemented from vtkImageAlgorithm.

Member Data Documentation

◆ MagnificationFactors

double vtkImageResample::MagnificationFactors[3]
protected

Definition at line 97 of file vtkImageResample.h.

◆ Dimensionality

int vtkImageResample::Dimensionality
protected

Definition at line 98 of file vtkImageResample.h.


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