VTK  9.4.20241012
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAbstractImageInterpolator Class Referenceabstract

interpolate data values from images More...

#include <vtkAbstractImageInterpolator.h>

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

Public Types

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.
 
vtkAbstractImageInterpolatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void Initialize (vtkDataObject *data)
 Initialize the interpolator with the data that you wish to interpolate.
 
virtual void ReleaseData ()
 Release any data stored by the interpolator.
 
void DeepCopy (vtkAbstractImageInterpolator *obj)
 Copy the interpolator.
 
virtual void Update ()
 Update the interpolator.
 
double Interpolate (double x, double y, double z, int component)
 Get the result of interpolating the specified component of the input data, which should be set to zero if there is only one component.
 
bool Interpolate (const double point[3], double *value)
 Sample the input data.
 
void SetOutValue (double outValue)
 The value to return when the point is out of bounds.
 
double GetOutValue ()
 
void SetTolerance (double tol)
 The tolerance to apply when checking whether a point is out of bounds.
 
double GetTolerance ()
 
void SetComponentOffset (int offset)
 This method specifies which component of the input will be interpolated, or if ComponentCount is also set, it specifies the first component.
 
int GetComponentOffset ()
 
void SetComponentCount (int count)
 This method specifies the number of components to extract.
 
int GetComponentCount ()
 
int ComputeNumberOfComponents (int inputComponents)
 Compute the number of output components based on the ComponentOffset, ComponentCount, and the number of components in the input data.
 
int GetNumberOfComponents ()
 Get the number of components that will be returned when Interpolate() is called.
 
void SetSlidingWindow (bool x)
 Enable sliding window for separable kernels.
 
void SlidingWindowOn ()
 
void SlidingWindowOff ()
 
bool GetSlidingWindow ()
 
virtual void ComputeSupportSize (const double matrix[16], int support[3])=0
 Get the support size for use in computing update extents.
 
virtual bool IsSeparable ()=0
 True if the interpolation is separable, which means that the weights can be precomputed in order to accelerate the interpolation.
 
virtual void FreePrecomputedWeights (vtkInterpolationWeights *&weights)
 Free the weights that were provided by PrecomputeWeightsForExtent.
 
void InterpolateIJK (const double point[3], double *value)
 A version of Interpolate that takes structured coords instead of data coords.
 
void InterpolateIJK (const float point[3], float *value)
 A version of Interpolate that takes structured coords instead of data coords.
 
bool CheckBoundsIJK (const double x[3])
 Check an x,y,z point to see if it is within the bounds for the structured coords of the image.
 
bool CheckBoundsIJK (const float x[3])
 Check an x,y,z point to see if it is within the bounds for the structured coords of the image.
 
void SetBorderMode (vtkImageBorderMode mode)
 The border mode (default: clamp).
 
void SetBorderModeToClamp ()
 The border mode (default: clamp).
 
void SetBorderModeToRepeat ()
 The border mode (default: clamp).
 
void SetBorderModeToMirror ()
 The border mode (default: clamp).
 
vtkImageBorderMode GetBorderMode ()
 The border mode (default: clamp).
 
const char * GetBorderModeAsString ()
 The border mode (default: clamp).
 
virtual void PrecomputeWeightsForExtent (const double matrix[16], const int extent[6], int checkExtent[6], vtkInterpolationWeights *&weights)
 If the data is going to be sampled on a regular grid, then the interpolation weights can be precomputed.
 
virtual void PrecomputeWeightsForExtent (const float matrix[16], const int extent[6], int checkExtent[6], vtkInterpolationWeights *&weights)
 If the data is going to be sampled on a regular grid, then the interpolation weights can be precomputed.
 
void InterpolateRow (vtkInterpolationWeights *&weights, int xIdx, int yIdx, int zIdx, double *value, int n)
 Get a row of samples, using the weights that were precomputed by PrecomputeWeightsForExtent.
 
void InterpolateRow (vtkInterpolationWeights *&weights, int xIdx, int yIdx, int zIdx, float *value, int n)
 Get a row of samples, using the weights that were precomputed by PrecomputeWeightsForExtent.
 
virtual double * GetSpacing ()
 Get the spacing of the data being interpolated.
 
virtual void GetSpacing (double &, double &, double &)
 Get the spacing of the data being interpolated.
 
virtual void GetSpacing (double[3])
 Get the spacing of the data being interpolated.
 
virtual double * GetDirection ()
 Get the direction of the data being interpolated.
 
virtual void GetDirection (double data[9])
 Get the direction of the data being interpolated.
 
virtual double * GetOrigin ()
 Get the origin of the data being interpolated.
 
virtual void GetOrigin (double &, double &, double &)
 Get the origin of the data being interpolated.
 
virtual void GetOrigin (double[3])
 Get the origin of the data being interpolated.
 
virtual int * GetExtent ()
 Get the extent of the data being interpolated.
 
virtual void GetExtent (int &, int &, int &, int &, int &, int &)
 Get the extent of the data being interpolated.
 
virtual void GetExtent (int[6])
 Get the extent of the data being interpolated.
 
- 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.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractImageInterpolatorSafeDownCast (vtkObjectBase *o)
 
- 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
 
 vtkAbstractImageInterpolator ()
 
 ~vtkAbstractImageInterpolator () override
 
virtual void InternalUpdate ()=0
 Subclass-specific updates.
 
virtual void InternalDeepCopy (vtkAbstractImageInterpolator *obj)=0
 Subclass-specific copy.
 
void CoordinateToIJK (const double point[3], double ijk[3])
 Convert XYZ coordinate to IJK continuous index.
 
virtual void GetInterpolationFunc (void(**doublefunc)(vtkInterpolationInfo *, const double[3], double *))
 Get the interpolation functions.
 
virtual void GetInterpolationFunc (void(**floatfunc)(vtkInterpolationInfo *, const float[3], float *))
 Get the interpolation functions.
 
virtual void GetRowInterpolationFunc (void(**doublefunc)(vtkInterpolationWeights *, int, int, int, double *, int))
 Get the row interpolation functions.
 
virtual void GetRowInterpolationFunc (void(**floatfunc)(vtkInterpolationWeights *, int, int, int, float *, int))
 Get the row interpolation functions.
 
virtual void GetSlidingWindowFunc (void(**doublefunc)(vtkInterpolationWeights *, int, int, int, double *, int))
 Get the sliding window interpolation functions.
 
virtual void GetSlidingWindowFunc (void(**floatfunc)(vtkInterpolationWeights *, int, int, int, float *, int))
 Get the sliding window interpolation functions.
 
- 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

vtkDataArrayScalars
 
double StructuredBoundsDouble [6]
 
float StructuredBoundsFloat [6]
 
int Extent [6]
 
double Spacing [3]
 
double Direction [9]
 
double InverseDirection [9]
 
double Origin [3]
 
double OutValue
 
double Tolerance
 
vtkImageBorderMode BorderMode
 
int ComponentOffset
 
int ComponentCount
 
bool UseDirection
 
bool SlidingWindow
 
vtkInterpolationInfoInterpolationInfo
 
void(* InterpolationFuncDouble )(vtkInterpolationInfo *info, const double point[3], double *outPtr)
 
void(* InterpolationFuncFloat )(vtkInterpolationInfo *info, const float point[3], float *outPtr)
 
void(* RowInterpolationFuncDouble )(vtkInterpolationWeights *weights, int idX, int idY, int idZ, double *outPtr, int n)
 
void(* RowInterpolationFuncFloat )(vtkInterpolationWeights *weights, int idX, int idY, int idZ, float *outPtr, int n)
 
- 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

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

interpolate data values from images

vtkAbstractImageInterpolator provides an abstract interface for interpolating image data. You specify the data set you want to interpolate values from, then call Interpolate(x,y,z) to interpolate the data.

Thanks:
Thanks to David Gobbi at the Seaman Family MR Centre and Dept. of Clinical Neurosciences, Foothills Medical Centre, Calgary, for providing this class.
See also
vtkImageReslice vtkImageInterpolator vtkImageSincInterpolator
Examples:
vtkAbstractImageInterpolator (Examples)

Definition at line 41 of file vtkAbstractImageInterpolator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkAbstractImageInterpolator.h.

Constructor & Destructor Documentation

◆ vtkAbstractImageInterpolator()

vtkAbstractImageInterpolator::vtkAbstractImageInterpolator ( )
protected

◆ ~vtkAbstractImageInterpolator()

vtkAbstractImageInterpolator::~vtkAbstractImageInterpolator ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkAbstractImageInterpolator::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 vtkObjectBase.

Reimplemented in vtkGenericImageInterpolator, vtkImageBSplineInterpolator, vtkImageInterpolator, and vtkImageSincInterpolator.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAbstractImageInterpolator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkAbstractImageInterpolator * vtkAbstractImageInterpolator::NewInstance ( ) const

◆ PrintSelf()

void vtkAbstractImageInterpolator::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 vtkObjectBase.

Reimplemented in vtkGenericImageInterpolator, vtkImageBSplineInterpolator, vtkImageInterpolator, and vtkImageSincInterpolator.

◆ Initialize()

virtual void vtkAbstractImageInterpolator::Initialize ( vtkDataObject data)
virtual

Initialize the interpolator with the data that you wish to interpolate.

◆ ReleaseData()

virtual void vtkAbstractImageInterpolator::ReleaseData ( )
virtual

Release any data stored by the interpolator.

◆ DeepCopy()

void vtkAbstractImageInterpolator::DeepCopy ( vtkAbstractImageInterpolator obj)

Copy the interpolator.

It is possible to duplicate an interpolator by calling NewInstance() followed by DeepCopy().

◆ Update()

virtual void vtkAbstractImageInterpolator::Update ( )
virtual

Update the interpolator.

If the interpolator has been modified by a Set method since Initialize() was called, you must call this method to update the interpolator before you can use it.

Reimplemented in vtkGenericImageInterpolator.

◆ Interpolate() [1/2]

double vtkAbstractImageInterpolator::Interpolate ( double  x,
double  y,
double  z,
int  component 
)

Get the result of interpolating the specified component of the input data, which should be set to zero if there is only one component.

If the point is not within the bounds of the data set, then OutValue will be returned. This method is primarily meant for use by the wrapper languages.

◆ Interpolate() [2/2]

bool vtkAbstractImageInterpolator::Interpolate ( const double  point[3],
double *  value 
)

Sample the input data.

This is an inline method that calls the function that performs the appropriate interpolation for the data type. If the point is not within the bounds of the data set, then the return value is false, and each component will be set to the OutValue.

◆ SetOutValue()

void vtkAbstractImageInterpolator::SetOutValue ( double  outValue)

The value to return when the point is out of bounds.

◆ GetOutValue()

double vtkAbstractImageInterpolator::GetOutValue ( )
inline

Definition at line 92 of file vtkAbstractImageInterpolator.h.

◆ SetTolerance()

void vtkAbstractImageInterpolator::SetTolerance ( double  tol)

The tolerance to apply when checking whether a point is out of bounds.

This is a fractional distance relative to the voxel size, so a tolerance of 1 expands the bounds by one voxel.

◆ GetTolerance()

double vtkAbstractImageInterpolator::GetTolerance ( )
inline

Definition at line 100 of file vtkAbstractImageInterpolator.h.

◆ SetComponentOffset()

void vtkAbstractImageInterpolator::SetComponentOffset ( int  offset)

This method specifies which component of the input will be interpolated, or if ComponentCount is also set, it specifies the first component.

When the interpolation is performed, it will be clamped to the number of available components.

◆ GetComponentOffset()

int vtkAbstractImageInterpolator::GetComponentOffset ( )
inline

Definition at line 109 of file vtkAbstractImageInterpolator.h.

◆ SetComponentCount()

void vtkAbstractImageInterpolator::SetComponentCount ( int  count)

This method specifies the number of components to extract.

The default value is -1, which extracts all available components. When the interpolation is performed, this will be clamped to the number of available components.

◆ GetComponentCount()

int vtkAbstractImageInterpolator::GetComponentCount ( )
inline

Definition at line 118 of file vtkAbstractImageInterpolator.h.

◆ ComputeNumberOfComponents()

int vtkAbstractImageInterpolator::ComputeNumberOfComponents ( int  inputComponents)

Compute the number of output components based on the ComponentOffset, ComponentCount, and the number of components in the input data.

◆ GetNumberOfComponents()

int vtkAbstractImageInterpolator::GetNumberOfComponents ( )

Get the number of components that will be returned when Interpolate() is called.

This is only valid after initialization. Before then, use ComputeNumberOfComponents instead.

◆ InterpolateIJK() [1/2]

void vtkAbstractImageInterpolator::InterpolateIJK ( const double  point[3],
double *  value 
)
inline

A version of Interpolate that takes structured coords instead of data coords.

Structured coords are the data coords after subtracting the Origin and dividing by the Spacing.

Definition at line 343 of file vtkAbstractImageInterpolator.h.

◆ InterpolateIJK() [2/2]

void vtkAbstractImageInterpolator::InterpolateIJK ( const float  point[3],
float *  value 
)
inline

A version of Interpolate that takes structured coords instead of data coords.

Structured coords are the data coords after subtracting the Origin and dividing by the Spacing.

Definition at line 348 of file vtkAbstractImageInterpolator.h.

◆ CheckBoundsIJK() [1/2]

bool vtkAbstractImageInterpolator::CheckBoundsIJK ( const double  x[3])
inline

Check an x,y,z point to see if it is within the bounds for the structured coords of the image.

This is meant to be called prior to InterpolateIJK. The bounds that are checked against are the input image extent plus the tolerance.

Definition at line 353 of file vtkAbstractImageInterpolator.h.

◆ CheckBoundsIJK() [2/2]

bool vtkAbstractImageInterpolator::CheckBoundsIJK ( const float  x[3])
inline

Check an x,y,z point to see if it is within the bounds for the structured coords of the image.

This is meant to be called prior to InterpolateIJK. The bounds that are checked against are the input image extent plus the tolerance.

Definition at line 360 of file vtkAbstractImageInterpolator.h.

◆ SetBorderMode()

void vtkAbstractImageInterpolator::SetBorderMode ( vtkImageBorderMode  mode)

The border mode (default: clamp).

This controls how out-of-bounds lookups are handled, i.e. how data will be extrapolated beyond the bounds of the image. The default is to clamp the lookup point to the bounds. The other modes wrap around to the opposite boundary, or mirror the image at the boundary.

◆ SetBorderModeToClamp()

void vtkAbstractImageInterpolator::SetBorderModeToClamp ( )
inline

The border mode (default: clamp).

This controls how out-of-bounds lookups are handled, i.e. how data will be extrapolated beyond the bounds of the image. The default is to clamp the lookup point to the bounds. The other modes wrap around to the opposite boundary, or mirror the image at the boundary.

Definition at line 163 of file vtkAbstractImageInterpolator.h.

◆ SetBorderModeToRepeat()

void vtkAbstractImageInterpolator::SetBorderModeToRepeat ( )
inline

The border mode (default: clamp).

This controls how out-of-bounds lookups are handled, i.e. how data will be extrapolated beyond the bounds of the image. The default is to clamp the lookup point to the bounds. The other modes wrap around to the opposite boundary, or mirror the image at the boundary.

Definition at line 164 of file vtkAbstractImageInterpolator.h.

◆ SetBorderModeToMirror()

void vtkAbstractImageInterpolator::SetBorderModeToMirror ( )
inline

The border mode (default: clamp).

This controls how out-of-bounds lookups are handled, i.e. how data will be extrapolated beyond the bounds of the image. The default is to clamp the lookup point to the bounds. The other modes wrap around to the opposite boundary, or mirror the image at the boundary.

Definition at line 165 of file vtkAbstractImageInterpolator.h.

◆ GetBorderMode()

vtkImageBorderMode vtkAbstractImageInterpolator::GetBorderMode ( )
inline

The border mode (default: clamp).

This controls how out-of-bounds lookups are handled, i.e. how data will be extrapolated beyond the bounds of the image. The default is to clamp the lookup point to the bounds. The other modes wrap around to the opposite boundary, or mirror the image at the boundary.

Definition at line 166 of file vtkAbstractImageInterpolator.h.

◆ GetBorderModeAsString()

const char * vtkAbstractImageInterpolator::GetBorderModeAsString ( )

The border mode (default: clamp).

This controls how out-of-bounds lookups are handled, i.e. how data will be extrapolated beyond the bounds of the image. The default is to clamp the lookup point to the bounds. The other modes wrap around to the opposite boundary, or mirror the image at the boundary.

◆ SetSlidingWindow()

void vtkAbstractImageInterpolator::SetSlidingWindow ( bool  x)

Enable sliding window for separable kernels.

When this is enabled, the interpolator will cache partial sums in in order to accelerate the computation. It only makes sense to do this if the interpolator is used by calling InterpolateRow() while incrementing first the Y, and then the Z index with every call.

◆ SlidingWindowOn()

void vtkAbstractImageInterpolator::SlidingWindowOn ( )
inline

Definition at line 178 of file vtkAbstractImageInterpolator.h.

◆ SlidingWindowOff()

void vtkAbstractImageInterpolator::SlidingWindowOff ( )
inline

Definition at line 179 of file vtkAbstractImageInterpolator.h.

◆ GetSlidingWindow()

bool vtkAbstractImageInterpolator::GetSlidingWindow ( )
inline

Definition at line 180 of file vtkAbstractImageInterpolator.h.

◆ ComputeSupportSize()

virtual void vtkAbstractImageInterpolator::ComputeSupportSize ( const double  matrix[16],
int  support[3] 
)
pure virtual

Get the support size for use in computing update extents.

If the data will be sampled on a regular grid, then pass a matrix describing the structured coordinate transformation between the output and the input. Otherwise, pass nullptr as the matrix to retrieve the full kernel size.

Implemented in vtkImageBSplineInterpolator, vtkImageInterpolator, and vtkImageSincInterpolator.

◆ IsSeparable()

virtual bool vtkAbstractImageInterpolator::IsSeparable ( )
pure virtual

True if the interpolation is separable, which means that the weights can be precomputed in order to accelerate the interpolation.

Any interpolator which is separable will implement the methods PrecomputeWeightsForExtent and InterpolateRow

Implemented in vtkImageBSplineInterpolator, vtkImageInterpolator, and vtkImageSincInterpolator.

◆ PrecomputeWeightsForExtent() [1/2]

virtual void vtkAbstractImageInterpolator::PrecomputeWeightsForExtent ( const double  matrix[16],
const int  extent[6],
int  checkExtent[6],
vtkInterpolationWeights *&  weights 
)
virtual

If the data is going to be sampled on a regular grid, then the interpolation weights can be precomputed.

A matrix must be supplied that provides a transformation between the provided extent and the structured coordinates of the input. This matrix must perform only permutation, scale, and translation, i.e. each of the three columns must have only one non-zero value. A checkExtent is provided that can be used to check which indices in the extent map to out-of-bounds coordinates in the input data.

Reimplemented in vtkImageBSplineInterpolator, vtkImageInterpolator, and vtkImageSincInterpolator.

◆ PrecomputeWeightsForExtent() [2/2]

virtual void vtkAbstractImageInterpolator::PrecomputeWeightsForExtent ( const float  matrix[16],
const int  extent[6],
int  checkExtent[6],
vtkInterpolationWeights *&  weights 
)
virtual

If the data is going to be sampled on a regular grid, then the interpolation weights can be precomputed.

A matrix must be supplied that provides a transformation between the provided extent and the structured coordinates of the input. This matrix must perform only permutation, scale, and translation, i.e. each of the three columns must have only one non-zero value. A checkExtent is provided that can be used to check which indices in the extent map to out-of-bounds coordinates in the input data.

Reimplemented in vtkImageBSplineInterpolator, vtkImageInterpolator, and vtkImageSincInterpolator.

◆ FreePrecomputedWeights()

virtual void vtkAbstractImageInterpolator::FreePrecomputedWeights ( vtkInterpolationWeights *&  weights)
virtual

Free the weights that were provided by PrecomputeWeightsForExtent.

Reimplemented in vtkImageBSplineInterpolator, vtkImageInterpolator, and vtkImageSincInterpolator.

◆ InterpolateRow() [1/2]

void vtkAbstractImageInterpolator::InterpolateRow ( vtkInterpolationWeights *&  weights,
int  xIdx,
int  yIdx,
int  zIdx,
double *  value,
int  n 
)
inline

Get a row of samples, using the weights that were precomputed by PrecomputeWeightsForExtent.

Note that each sample may have multiple components. It is possible to select which components will be returned by setting the ComponentOffset and ComponentCount.

Definition at line 367 of file vtkAbstractImageInterpolator.h.

◆ InterpolateRow() [2/2]

void vtkAbstractImageInterpolator::InterpolateRow ( vtkInterpolationWeights *&  weights,
int  xIdx,
int  yIdx,
int  zIdx,
float *  value,
int  n 
)
inline

Get a row of samples, using the weights that were precomputed by PrecomputeWeightsForExtent.

Note that each sample may have multiple components. It is possible to select which components will be returned by setting the ComponentOffset and ComponentCount.

Definition at line 373 of file vtkAbstractImageInterpolator.h.

◆ GetSpacing() [1/3]

virtual double * vtkAbstractImageInterpolator::GetSpacing ( )
virtual

Get the spacing of the data being interpolated.

◆ GetSpacing() [2/3]

virtual void vtkAbstractImageInterpolator::GetSpacing ( double &  ,
double &  ,
double &   
)
virtual

Get the spacing of the data being interpolated.

◆ GetSpacing() [3/3]

virtual void vtkAbstractImageInterpolator::GetSpacing ( double  [3])
virtual

Get the spacing of the data being interpolated.

◆ GetDirection() [1/2]

virtual double * vtkAbstractImageInterpolator::GetDirection ( )
virtual

Get the direction of the data being interpolated.

◆ GetDirection() [2/2]

virtual void vtkAbstractImageInterpolator::GetDirection ( double  data[9])
virtual

Get the direction of the data being interpolated.

◆ GetOrigin() [1/3]

virtual double * vtkAbstractImageInterpolator::GetOrigin ( )
virtual

Get the origin of the data being interpolated.

◆ GetOrigin() [2/3]

virtual void vtkAbstractImageInterpolator::GetOrigin ( double &  ,
double &  ,
double &   
)
virtual

Get the origin of the data being interpolated.

◆ GetOrigin() [3/3]

virtual void vtkAbstractImageInterpolator::GetOrigin ( double  [3])
virtual

Get the origin of the data being interpolated.

◆ GetExtent() [1/3]

virtual int * vtkAbstractImageInterpolator::GetExtent ( )
virtual

Get the extent of the data being interpolated.

◆ GetExtent() [2/3]

virtual void vtkAbstractImageInterpolator::GetExtent ( int &  ,
int &  ,
int &  ,
int &  ,
int &  ,
int &   
)
virtual

Get the extent of the data being interpolated.

◆ GetExtent() [3/3]

virtual void vtkAbstractImageInterpolator::GetExtent ( int  [6])
virtual

Get the extent of the data being interpolated.

◆ InternalUpdate()

virtual void vtkAbstractImageInterpolator::InternalUpdate ( )
protectedpure virtual

Subclass-specific updates.

Implemented in vtkImageBSplineInterpolator, vtkImageInterpolator, and vtkImageSincInterpolator.

◆ InternalDeepCopy()

virtual void vtkAbstractImageInterpolator::InternalDeepCopy ( vtkAbstractImageInterpolator obj)
protectedpure virtual

Subclass-specific copy.

Implemented in vtkImageBSplineInterpolator, vtkImageInterpolator, and vtkImageSincInterpolator.

◆ CoordinateToIJK()

void vtkAbstractImageInterpolator::CoordinateToIJK ( const double  point[3],
double  ijk[3] 
)
protected

Convert XYZ coordinate to IJK continuous index.

◆ GetInterpolationFunc() [1/2]

virtual void vtkAbstractImageInterpolator::GetInterpolationFunc ( void(**)(vtkInterpolationInfo *, const double[3], double *)  doublefunc)
protectedvirtual

◆ GetInterpolationFunc() [2/2]

virtual void vtkAbstractImageInterpolator::GetInterpolationFunc ( void(**)(vtkInterpolationInfo *, const float[3], float *)  floatfunc)
protectedvirtual

◆ GetRowInterpolationFunc() [1/2]

virtual void vtkAbstractImageInterpolator::GetRowInterpolationFunc ( void(**)(vtkInterpolationWeights *, int, int, int, double *, int)  doublefunc)
protectedvirtual

Get the row interpolation functions.

Reimplemented in vtkGenericImageInterpolator, vtkImageBSplineInterpolator, vtkImageInterpolator, and vtkImageSincInterpolator.

◆ GetRowInterpolationFunc() [2/2]

virtual void vtkAbstractImageInterpolator::GetRowInterpolationFunc ( void(**)(vtkInterpolationWeights *, int, int, int, float *, int)  floatfunc)
protectedvirtual

Get the row interpolation functions.

Reimplemented in vtkGenericImageInterpolator, vtkImageBSplineInterpolator, vtkImageInterpolator, and vtkImageSincInterpolator.

◆ GetSlidingWindowFunc() [1/2]

virtual void vtkAbstractImageInterpolator::GetSlidingWindowFunc ( void(**)(vtkInterpolationWeights *, int, int, int, double *, int)  doublefunc)
protectedvirtual

Get the sliding window interpolation functions.

◆ GetSlidingWindowFunc() [2/2]

virtual void vtkAbstractImageInterpolator::GetSlidingWindowFunc ( void(**)(vtkInterpolationWeights *, int, int, int, float *, int)  floatfunc)
protectedvirtual

Get the sliding window interpolation functions.

Member Data Documentation

◆ Scalars

vtkDataArray* vtkAbstractImageInterpolator::Scalars
protected

Definition at line 310 of file vtkAbstractImageInterpolator.h.

◆ StructuredBoundsDouble

double vtkAbstractImageInterpolator::StructuredBoundsDouble[6]
protected

Definition at line 311 of file vtkAbstractImageInterpolator.h.

◆ StructuredBoundsFloat

float vtkAbstractImageInterpolator::StructuredBoundsFloat[6]
protected

Definition at line 312 of file vtkAbstractImageInterpolator.h.

◆ Extent

int vtkAbstractImageInterpolator::Extent[6]
protected

Definition at line 313 of file vtkAbstractImageInterpolator.h.

◆ Spacing

double vtkAbstractImageInterpolator::Spacing[3]
protected

Definition at line 314 of file vtkAbstractImageInterpolator.h.

◆ Direction

double vtkAbstractImageInterpolator::Direction[9]
protected

Definition at line 315 of file vtkAbstractImageInterpolator.h.

◆ InverseDirection

double vtkAbstractImageInterpolator::InverseDirection[9]
protected

Definition at line 316 of file vtkAbstractImageInterpolator.h.

◆ Origin

double vtkAbstractImageInterpolator::Origin[3]
protected

Definition at line 317 of file vtkAbstractImageInterpolator.h.

◆ OutValue

double vtkAbstractImageInterpolator::OutValue
protected

Definition at line 318 of file vtkAbstractImageInterpolator.h.

◆ Tolerance

double vtkAbstractImageInterpolator::Tolerance
protected

Definition at line 319 of file vtkAbstractImageInterpolator.h.

◆ BorderMode

vtkImageBorderMode vtkAbstractImageInterpolator::BorderMode
protected

Definition at line 320 of file vtkAbstractImageInterpolator.h.

◆ ComponentOffset

int vtkAbstractImageInterpolator::ComponentOffset
protected

Definition at line 321 of file vtkAbstractImageInterpolator.h.

◆ ComponentCount

int vtkAbstractImageInterpolator::ComponentCount
protected

Definition at line 322 of file vtkAbstractImageInterpolator.h.

◆ UseDirection

bool vtkAbstractImageInterpolator::UseDirection
protected

Definition at line 323 of file vtkAbstractImageInterpolator.h.

◆ SlidingWindow

bool vtkAbstractImageInterpolator::SlidingWindow
protected

Definition at line 324 of file vtkAbstractImageInterpolator.h.

◆ InterpolationInfo

vtkInterpolationInfo* vtkAbstractImageInterpolator::InterpolationInfo
protected

Definition at line 327 of file vtkAbstractImageInterpolator.h.

◆ InterpolationFuncDouble

void(* vtkAbstractImageInterpolator::InterpolationFuncDouble) (vtkInterpolationInfo *info, const double point[3], double *outPtr)
protected

Definition at line 329 of file vtkAbstractImageInterpolator.h.

◆ InterpolationFuncFloat

void(* vtkAbstractImageInterpolator::InterpolationFuncFloat) (vtkInterpolationInfo *info, const float point[3], float *outPtr)
protected

Definition at line 331 of file vtkAbstractImageInterpolator.h.

◆ RowInterpolationFuncDouble

void(* vtkAbstractImageInterpolator::RowInterpolationFuncDouble) (vtkInterpolationWeights *weights, int idX, int idY, int idZ, double *outPtr, int n)
protected

Definition at line 333 of file vtkAbstractImageInterpolator.h.

◆ RowInterpolationFuncFloat

void(* vtkAbstractImageInterpolator::RowInterpolationFuncFloat) (vtkInterpolationWeights *weights, int idX, int idY, int idZ, float *outPtr, int n)
protected

Definition at line 335 of file vtkAbstractImageInterpolator.h.


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