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

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

#include <vtkExtractStructuredGridHelper.h>

Inheritance diagram for vtkExtractStructuredGridHelper:
[legend]
Collaboration diagram for vtkExtractStructuredGridHelper:
[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. More...
 
vtkExtractStructuredGridHelperNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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. More...
 
bool IsValid () const
 Returns true if the helper is properly initialized. More...
 
int GetSize (const int dim)
 Returns the size along a given dimension. More...
 
int GetMappedIndex (int dim, int outIdx)
 Given a dimension and output index, return the corresponding extent index. More...
 
int GetMappedIndexFromExtentValue (int dim, int outExtVal)
 Given a dimension and output extent value, return the corresponding input extent index. More...
 
int GetMappedExtentValue (int dim, int outExtVal)
 Given a dimension and output extent value, return the corresponding input extent value. More...
 
int GetMappedExtentValueFromIndex (int dim, int outIdx)
 Given a dimension and output extent index, return the corresponding input extent value. More...
 
void ComputeBeginAndEnd (int inExt[6], int voi[6], int begin[3], int end[3])
 Returns the begin & end extent that intersects with the VOI. More...
 
void CopyPointsAndPointData (int inExt[6], int outExt[6], vtkPointData *pd, vtkPoints *inpnts, vtkPointData *outPD, vtkPoints *outpnts)
 Copies the points & point data to the output. More...
 
void CopyCellData (int inExt[6], int outExt[6], vtkCellData *cd, vtkCellData *outCD)
 Copies the cell data to the output. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkExtractStructuredGridHelperNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkExtractStructuredGridHelperSafeDownCast (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. More...
 
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. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkExtractStructuredGridHelper ()
 
 ~vtkExtractStructuredGridHelper () override
 
void Invalidate ()
 Invalidates the output extent. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 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
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

Member Typedef Documentation

◆ Superclass

Definition at line 55 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 vtkObject.

◆ 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
voithe extent of the volume of interest
wholeExtthe whole extent of the domain
smapleRatethe sampling rate
includeBoundaryindicates whether to include the boundary or not.

◆ IsValid()

bool vtkExtractStructuredGridHelper::IsValid ( ) const

Returns true if the helper is properly initialized.

◆ GetSize()

int vtkExtractStructuredGridHelper::GetSize ( const int  dim)

Returns the size along a given dimension.

Parameters
dimthe 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
dimthe data dimension
outIdxThe 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
dimthe data dimension
outExtValThe 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
dimthe data dimension.
outExtValThe 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
dimthe data dimension.
outIdxThe 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
inExtthe input extent
voithe volume of interest
beginthe begin extent
endthe 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
inExtthe input grid extent.
outExtthe output grid extent.
pdpointer to the input point data.
inpntspointer to the input points, or nullptr if uniform grid.
outPDpoint to the output point data.
outpntspointer 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
inExtthe input grid extent.
outExtthe output grid extent.
cdthe input cell data.
outCDthe 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
globalVOIThe full VOI for the entire distributed dataset.
partitionedExtentExtent of the process's partitioned input data.
sampleRateThe sampling rate in each dimension.
includeBoundaryWhether or not to include the boundary of the VOI, even if it doesn't fit the spacing.
partitionedVOIThe 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
globalVOIThe full VOI for the entire distributed dataset.
partitionedVOIThe VOI used in the serial extraction.
outputWholeExtentThe output extent of the full dataset.
sampleRateThe sampling rate in each dimension.
includeBoundaryWhether or not to include the boundary of the VOI, even if it doesn't fit the spacing.
partitionedOutputExtentThe 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 212 of file vtkExtractStructuredGridHelper.h.

◆ InputWholeExtent

int vtkExtractStructuredGridHelper::InputWholeExtent[6]
protected

Definition at line 213 of file vtkExtractStructuredGridHelper.h.

◆ SampleRate

int vtkExtractStructuredGridHelper::SampleRate[3]
protected

Definition at line 214 of file vtkExtractStructuredGridHelper.h.

◆ IncludeBoundary

bool vtkExtractStructuredGridHelper::IncludeBoundary
protected

Definition at line 215 of file vtkExtractStructuredGridHelper.h.

◆ OutputWholeExtent

int vtkExtractStructuredGridHelper::OutputWholeExtent[6]
protected

Definition at line 217 of file vtkExtractStructuredGridHelper.h.

◆ IndexMap

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

Definition at line 218 of file vtkExtractStructuredGridHelper.h.


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