helper for extracting/sub-sampling structured datasets. More...

#include <vtkExtractStructuredGridHelper.h>

Inheritance diagram for vtkExtractStructuredGridHelper:

Collaboration diagram for vtkExtractStructuredGridHelper:

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.

vtkExtractStructuredGridHelper *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual int *	GetOutputWholeExtent ()

virtual void	GetOutputWholeExtent (int &, int &, int &, int &, int &, int &)

virtual void	GetOutputWholeExtent (int[6])

void	Initialize (int voi[6], int wholeExt[6], int sampleRate[3], bool includeBoundary)
	Initializes the index map.

bool	IsValid () const
	Returns true if the helper is properly initialized.

int	GetSize (int dim)
	Returns the size along a given dimension.

int	GetMappedIndex (int dim, int outIdx)
	Given a dimension and output index, return the corresponding extent index.

int	GetMappedIndexFromExtentValue (int dim, int outExtVal)
	Given a dimension and output extent value, return the corresponding input extent index.

int	GetMappedExtentValue (int dim, int outExtVal)
	Given a dimension and output extent value, return the corresponding input extent value.

int	GetMappedExtentValueFromIndex (int dim, int outIdx)
	Given a dimension and output extent index, return the corresponding input extent value.

void	ComputeBeginAndEnd (int inExt[6], int voi[6], int begin[3], int end[3])
	Returns the begin & end extent that intersects with the VOI.

void	CopyPointsAndPointData (int inExt[6], int outExt[6], vtkPointData pd, vtkPoints inpnts, vtkPointData outPD, vtkPoints outpnts)
	Copies the points & point data to the output.

void	CopyCellData (int inExt[6], int outExt[6], vtkCellData cd, vtkCellData outCD)
	Copies the cell data to the output.

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.

vtkCommand *	GetCommand (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 vtkExtractStructuredGridHelper *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkExtractStructuredGridHelper *	SafeDownCast (vtkObjectBase *o)

static void	GetPartitionedVOI (const int globalVOI[6], const int partitionedExtent[6], const int sampleRate[3], bool includeBoundary, int partitionedVOI[6])
	Calculate the VOI for a partitioned structured dataset.

static void	GetPartitionedOutputExtent (const int globalVOI[6], const int partitionedVOI[6], const int outputWholeExtent[6], const int sampleRate[3], bool includeBoundary, int partitionedOutputExtent[6])
	Calculate the partitioned output extent for a partitioned structured dataset.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () const

	vtkExtractStructuredGridHelper ()

	~vtkExtractStructuredGridHelper () override

void	Invalidate ()
	Invalidates the output extent.

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
int	VOI [6]

int	InputWholeExtent [6]

int	SampleRate [3]

bool	IncludeBoundary

int	OutputWholeExtent [6]

vtk::detail::vtkIndexMap *	IndexMap

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

helper for extracting/sub-sampling structured datasets.

vtkExtractStructuredGridHelper provides some common functionality that is used by filters that extract and sub-sample structured data. Specifically, it provides functionality for calculating the mapping from the output extent of each process to the input extent.

See also: vtkExtractGrid vtkExtractVOI vtkExtractRectilinearGrid

Definition at line 44 of file vtkExtractStructuredGridHelper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkExtractStructuredGridHelper::Superclass

Definition at line 48 of file vtkExtractStructuredGridHelper.h.

Constructor & Destructor Documentation

◆ vtkExtractStructuredGridHelper()

vtkExtractStructuredGridHelper::vtkExtractStructuredGridHelper ( )

protected

◆ ~vtkExtractStructuredGridHelper()

vtkExtractStructuredGridHelper::~vtkExtractStructuredGridHelper ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkExtractStructuredGridHelper * vtkExtractStructuredGridHelper::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkExtractStructuredGridHelper::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkExtractStructuredGridHelper * vtkExtractStructuredGridHelper::NewInstance ( ) const

◆ PrintSelf()

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

◆ GetOutputWholeExtent() [1/3]

virtual int * vtkExtractStructuredGridHelper::GetOutputWholeExtent ( )

virtual

◆ GetOutputWholeExtent() [2/3]

virtual void vtkExtractStructuredGridHelper::GetOutputWholeExtent	(	int &	,
		int &	,
		int &	,
		int &	,
		int &	,
		int &
	)

virtual

◆ GetOutputWholeExtent() [3/3]

virtual void vtkExtractStructuredGridHelper::GetOutputWholeExtent ( int [6] )

virtual

◆ Initialize()

void vtkExtractStructuredGridHelper::Initialize	(	int	voi[6],
		int	wholeExt[6],
		int	sampleRate[3],
		bool	includeBoundary
	)

Initializes the index map.

Parameters

voi	the extent of the volume of interest
wholeExt	the whole extent of the domain
sampleRate	the sampling rate
includeBoundary	indicates whether to include the boundary or not.

◆ IsValid()

bool vtkExtractStructuredGridHelper::IsValid ( ) const

Returns true if the helper is properly initialized.

◆ GetSize()

int vtkExtractStructuredGridHelper::GetSize ( int dim )

Returns the size along a given dimension.

Parameters

dim	the dimension in query

Precondition: dim >= 0 && dim < 3

◆ GetMappedIndex()

int vtkExtractStructuredGridHelper::GetMappedIndex	(	int	dim,
		int	outIdx
	)

Given a dimension and output index, return the corresponding extent index.

This method should be used to convert array indices, such as the coordinate arrays for rectilinear grids.

Parameters

dim	the data dimension
outIdx	The output index along the given dimension.

Precondition: dim >= 0 && dim < 3; outIdx >= 0 && outIdx < this->GetSize( dim )

Returns: The input extent index along the given dimension.

See also: GetMappedExtentValue; GetMappedExtentValueFromIndex

◆ GetMappedIndexFromExtentValue()

int vtkExtractStructuredGridHelper::GetMappedIndexFromExtentValue	(	int	dim,
		int	outExtVal
	)

Given a dimension and output extent value, return the corresponding input extent index.

This method should be used to compute extent indices from extent values.

Parameters

dim	the data dimension
outExtVal	The output extent value along the given dimension.

Precondition: dim >= 0 && dim < 3; outExtVal >= this->GetOutputWholeExtent()[2*dim] && outExtVal <= this->GetOutputWholeExtent()[2*dim+1]

Returns: The input extent index along the given dimension.

See also: GetMappedExtentValue; GetMappedExtentValueFromIndex

◆ GetMappedExtentValue()

int vtkExtractStructuredGridHelper::GetMappedExtentValue	(	int	dim,
		int	outExtVal
	)

Given a dimension and output extent value, return the corresponding input extent value.

This method should be used to convert extent values.

Parameters

dim	the data dimension.
outExtVal	The output extent value along the given dimension.

Precondition: dim >= 0 && dim < 3; outExtVal >= this->GetOutputWholeExtent()[2*dim] && outExtVal <= this->GetOutputWholeExtent()[2*dim+1]

Returns: The input extent value along the given dimension.

See also: GetMappedIndex; GetMappedExtentValueFromIndex

◆ GetMappedExtentValueFromIndex()

int vtkExtractStructuredGridHelper::GetMappedExtentValueFromIndex	(	int	dim,
		int	outIdx
	)

Given a dimension and output extent index, return the corresponding input extent value.

This method should be used to compute extent values from extent indices.

Parameters

dim	the data dimension.
outIdx	The output index along the given dimension.

Precondition: dim >= 0 && dim < 3; outIdx >= 0 && outIdx < this->GetSize( dim )

Returns: The input extent value along the given dimension.

See also: GetMappedIndex; GetMappedExtentValue

◆ ComputeBeginAndEnd()

void vtkExtractStructuredGridHelper::ComputeBeginAndEnd	(	int	inExt[6],
		int	voi[6],
		int	begin[3],
		int	end[3]
	)

Returns the begin & end extent that intersects with the VOI.

Parameters

inExt	the input extent
voi	the volume of interest
begin	the begin extent
end	the end extent

◆ CopyPointsAndPointData()

void vtkExtractStructuredGridHelper::CopyPointsAndPointData	(	int	inExt[6],
		int	outExt[6],
		vtkPointData *	pd,
		vtkPoints *	inpnts,
		vtkPointData *	outPD,
		vtkPoints *	outpnts
	)

Copies the points & point data to the output.

Parameters

inExt	the input grid extent.
outExt	the output grid extent.
pd	pointer to the input point data.
inpnts	pointer to the input points, or nullptr if uniform grid.
outPD	point to the output point data.
outpnts	pointer to the output points, or nullptr if uniform grid.

Precondition: pd != nullptr.; outPD != nullptr.

◆ CopyCellData()

void vtkExtractStructuredGridHelper::CopyCellData	(	int	inExt[6],
		int	outExt[6],
		vtkCellData *	cd,
		vtkCellData *	outCD
	)

Copies the cell data to the output.

Parameters

inExt	the input grid extent.
outExt	the output grid extent.
cd	the input cell data.
outCD	the output cell data.

Precondition: cd != nullptr.; outCD != nullptr.

◆ GetPartitionedVOI()

static void vtkExtractStructuredGridHelper::GetPartitionedVOI	(	const int	globalVOI[6],
		const int	partitionedExtent[6],
		const int	sampleRate[3],
		bool	includeBoundary,
		int	partitionedVOI[6]
	)

static

Calculate the VOI for a partitioned structured dataset.

This method sets partitionedVOI to the VOI that extracts as much of the partitionedExtent as possible while considering the globalVOI, the sampleRate, and the boundary conditions.

Parameters

globalVOI	The full VOI for the entire distributed dataset.
partitionedExtent	Extent of the process's partitioned input data.
sampleRate	The sampling rate in each dimension.
includeBoundary	Whether or not to include the boundary of the VOI, even if it doesn't fit the spacing.
partitionedVOI	The extent of the process's partitioned dataset that should be extracted by a serial extraction filter.

◆ GetPartitionedOutputExtent()

static void vtkExtractStructuredGridHelper::GetPartitionedOutputExtent	(	const int	globalVOI[6],
		const int	partitionedVOI[6],
		const int	outputWholeExtent[6],
		const int	sampleRate[3],
		bool	includeBoundary,
		int	partitionedOutputExtent[6]
	)

static

Calculate the partitioned output extent for a partitioned structured dataset.

This method sets partitionedOutputExtent to the correct extent of an extracted dataset, such that it properly fits with the other partitioned pieces while considering the globalVOI, the sampleRate, and the boundary conditions.

Parameters

globalVOI	The full VOI for the entire distributed dataset.
partitionedVOI	The VOI used in the serial extraction.
outputWholeExtent	The output extent of the full dataset.
sampleRate	The sampling rate in each dimension.
includeBoundary	Whether or not to include the boundary of the VOI, even if it doesn't fit the spacing.
partitionedOutputExtent	The correct output extent of the extracted dataset.

◆ Invalidate()

void vtkExtractStructuredGridHelper::Invalidate ( )

protected

Invalidates the output extent.

Member Data Documentation

◆ VOI

int vtkExtractStructuredGridHelper::VOI[6]

protected

Definition at line 205 of file vtkExtractStructuredGridHelper.h.

◆ InputWholeExtent

int vtkExtractStructuredGridHelper::InputWholeExtent[6]

protected

Definition at line 206 of file vtkExtractStructuredGridHelper.h.

◆ SampleRate

int vtkExtractStructuredGridHelper::SampleRate[3]

protected

Definition at line 207 of file vtkExtractStructuredGridHelper.h.

◆ IncludeBoundary

bool vtkExtractStructuredGridHelper::IncludeBoundary

protected

Definition at line 208 of file vtkExtractStructuredGridHelper.h.

◆ OutputWholeExtent

int vtkExtractStructuredGridHelper::OutputWholeExtent[6]

protected

Definition at line 210 of file vtkExtractStructuredGridHelper.h.

◆ IndexMap

vtk::detail::vtkIndexMap* vtkExtractStructuredGridHelper::IndexMap

protected

Definition at line 211 of file vtkExtractStructuredGridHelper.h.

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

Common/DataModel/vtkExtractStructuredGridHelper.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkExtractStructuredGridHelper()

◆ ~vtkExtractStructuredGridHelper()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetOutputWholeExtent() [1/3]

◆ GetOutputWholeExtent() [2/3]

◆ GetOutputWholeExtent() [3/3]

◆ Initialize()

◆ IsValid()

◆ GetSize()

◆ GetMappedIndex()

◆ GetMappedIndexFromExtentValue()

◆ GetMappedExtentValue()

◆ GetMappedExtentValueFromIndex()

◆ ComputeBeginAndEnd()

◆ CopyPointsAndPointData()

◆ CopyCellData()

◆ GetPartitionedVOI()

◆ GetPartitionedOutputExtent()

◆ Invalidate()

Member Data Documentation

◆ VOI

◆ InputWholeExtent

◆ SampleRate

◆ IncludeBoundary

◆ OutputWholeExtent

◆ IndexMap