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 int	IsA (const char *type)
vtkExtractStructuredGridHelper *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int *	GetOutputWholeExtent ()
virtual void	GetOutputWholeExtent (int &, int &, int &, int &, int &, int &)
virtual void	GetOutputWholeExtent (int[6])
bool	IsValid () const
int	GetSize (const 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. This method should be used to convert array indices, such as the coordinate arrays for rectilinear grids.
int	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.
int	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.
int	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.
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	Initialize (int voi[6], int wholeExt[6], int sampleRate[3], bool includeBoundary)
	Initializes the index map.

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

void	CopyCellData (int inExt[6], int outExt[6], vtkCellData cd, vtkCellData outCD, int sampleRate[3]=NULL)
	Copies the cell data to the output.
Static Public Member Functions
static vtkExtractStructuredGridHelper *	New ()
static int	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])

static void	GetPartitionedOutputExtent (const int globalVOI[6], const int partitionedVOI[6], const int outputWholeExtent[6], const int sampleRate[3], bool includeBoundary, int partitionedOutputExtent[6])
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkExtractStructuredGridHelper ()
	~vtkExtractStructuredGridHelper ()
void	Invalidate ()
	Invalidates the output extent.
Protected Attributes
int	VOI [6]
int	InputWholeExtent [6]
int	SampleRate [3]
bool	IncludeBoundary
int	OutputWholeExtent [6]
vtk::detail::vtkIndexMap *	IndexMap

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 50 of file vtkExtractStructuredGridHelper.h.

Member Typedef Documentation

typedef vtkObject vtkExtractStructuredGridHelper::Superclass

Reimplemented from vtkObject.

Definition at line 55 of file vtkExtractStructuredGridHelper.h.

Constructor & Destructor Documentation

vtkExtractStructuredGridHelper::vtkExtractStructuredGridHelper ( ) [protected]

vtkExtractStructuredGridHelper::~vtkExtractStructuredGridHelper ( ) [protected]

Member Function Documentation

static vtkExtractStructuredGridHelper* vtkExtractStructuredGridHelper::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

static int vtkExtractStructuredGridHelper::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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 vtkObject.

virtual int 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 vtkObject.

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

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkExtractStructuredGridHelper::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

vtkExtractStructuredGridHelper* vtkExtractStructuredGridHelper::NewInstance ( ) const

Reimplemented from vtkObject.

void vtkExtractStructuredGridHelper::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

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 vtkObject.

virtual int* vtkExtractStructuredGridHelper::GetOutputWholeExtent ( ) [virtual]

virtual void vtkExtractStructuredGridHelper::GetOutputWholeExtent	(	int &	,
		int &	,
		int &	,
		int &	,
		int &	,
		int &
	)		`[virtual]`

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

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
smapleRate	the sampling rate
includeBoundary	indicates whether to include the boundary or not.

bool vtkExtractStructuredGridHelper::IsValid ( ) const

Returns true if the helper is properly initialized.

int vtkExtractStructuredGridHelper::GetSize ( const int dim )

Returns the size along a given dimension.

Parameters:

dim	the dimension in query

Precondition:: dim >= 0 && dim < 3

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

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

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

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

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

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

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 NULL if uniform grid.
outPD	point to the output point data.
outpnts	pointer to the output points, or NULL if uniform grid.
sampleRate	The sample rate in each dimension. Optional, used to optimizing copy operations if present.

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

void vtkExtractStructuredGridHelper::CopyCellData	(	int	inExt[6],
		int	outExt[6],
		vtkCellData *	cd,
		vtkCellData *	outCD,
		int	sampleRate[3] = `NULL`
	)

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.
sampleRate	The sample rate in each dimension. Optional, used to optimizing copy operations if present.

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

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.

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.