ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPVExtractVOI Class Reference

select piece (e.g., volume of interest) and/or subsample structured dataset More...

#include <vtkPVExtractVOI.h>

Inherits vtkDataSetAlgorithm.

Public Types

typedef vtkDataSetAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetVOI (int, int, int, int, int, int)
 Specify i-j-k (min,max) pairs to extract. More...
 
virtual void SetVOI (int [6])
 Specify i-j-k (min,max) pairs to extract. More...
 
virtual int * GetVOI ()
 Specify i-j-k (min,max) pairs to extract. More...
 
virtual void GetVOI (int data[6])
 Specify i-j-k (min,max) pairs to extract. More...
 
virtual void SetSampleRate (int, int, int)
 Set the sampling rate in the i, j, and k directions. More...
 
virtual void SetSampleRate (int [3])
 Set the sampling rate in the i, j, and k directions. More...
 
virtual int * GetSampleRate ()
 Set the sampling rate in the i, j, and k directions. More...
 
virtual void GetSampleRate (int data[3])
 Set the sampling rate in the i, j, and k directions. More...
 
void SetSampleRateI (int ratei)
 Set/get the individual components of the sample rate. More...
 
void SetSampleRateJ (int ratej)
 Set/get the individual components of the sample rate. More...
 
void SetSampleRateK (int ratek)
 Set/get the individual components of the sample rate. More...
 
int GetSampleRateI ()
 Set/get the individual components of the sample rate. More...
 
int GetSampleRateJ ()
 Set/get the individual components of the sample rate. More...
 
int GetSampleRateK ()
 Set/get the individual components of the sample rate. More...
 
virtual void SetIncludeBoundary (int)
 Control whether to enforce that the "boundary" of the grid is output in the subsampling process. More...
 
virtual int GetIncludeBoundary ()
 Control whether to enforce that the "boundary" of the grid is output in the subsampling process. More...
 
virtual void IncludeBoundaryOn ()
 Control whether to enforce that the "boundary" of the grid is output in the subsampling process. More...
 
virtual void IncludeBoundaryOff ()
 Control whether to enforce that the "boundary" of the grid is output in the subsampling process. More...
 

Static Public Member Functions

static vtkPVExtractVOINew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVExtractVOISafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPVExtractVOI ()
 
 ~vtkPVExtractVOI ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual void ReportReferences (vtkGarbageCollector *)
 

Protected Attributes

int VOI [6]
 
int SampleRate [3]
 
int IncludeBoundary
 
vtkExtractVOI * ExtractVOI
 
vtkExtractGrid * ExtractGrid
 
vtkExtractRectilinearGrid * ExtractRG
 

Detailed Description

select piece (e.g., volume of interest) and/or subsample structured dataset

vtkPVExtractVOI is a wrapper around vtkExtractVOI, vtkExtractGrid and vtkExtractRectilinearGrid. It choose the right filter depending on input and passes the necessary parameters.

See also
vtkExtractVOI vtkExtractGrid vtkExtractRectilinearGrid

Definition at line 39 of file vtkPVExtractVOI.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataSetAlgorithm vtkPVExtractVOI::Superclass

Definition at line 44 of file vtkPVExtractVOI.h.

Constructor & Destructor Documentation

◆ vtkPVExtractVOI()

vtkPVExtractVOI::vtkPVExtractVOI ( )
protected

◆ ~vtkPVExtractVOI()

vtkPVExtractVOI::~vtkPVExtractVOI ( )
protected

Member Function Documentation

◆ New()

static vtkPVExtractVOI* vtkPVExtractVOI::New ( )
static

◆ GetClassName()

virtual const char* vtkPVExtractVOI::GetClassName ( )
virtual

◆ IsTypeOf()

static int vtkPVExtractVOI::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkPVExtractVOI::IsA ( const char *  type)
virtual

◆ SafeDownCast()

static vtkPVExtractVOI* vtkPVExtractVOI::SafeDownCast ( vtkObject *  o)
static

◆ PrintSelf()

void vtkPVExtractVOI::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ SetVOI() [1/2]

virtual void vtkPVExtractVOI::SetVOI ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
)
virtual

Specify i-j-k (min,max) pairs to extract.

The resulting structured grid dataset can be of any topological dimension (i.e., point, line, plane, or 3D grid).

◆ SetVOI() [2/2]

virtual void vtkPVExtractVOI::SetVOI ( int  [6])
virtual

Specify i-j-k (min,max) pairs to extract.

The resulting structured grid dataset can be of any topological dimension (i.e., point, line, plane, or 3D grid).

◆ GetVOI() [1/2]

virtual int* vtkPVExtractVOI::GetVOI ( )
virtual

Specify i-j-k (min,max) pairs to extract.

The resulting structured grid dataset can be of any topological dimension (i.e., point, line, plane, or 3D grid).

◆ GetVOI() [2/2]

virtual void vtkPVExtractVOI::GetVOI ( int  data[6])
virtual

Specify i-j-k (min,max) pairs to extract.

The resulting structured grid dataset can be of any topological dimension (i.e., point, line, plane, or 3D grid).

◆ SetSampleRate() [1/2]

virtual void vtkPVExtractVOI::SetSampleRate ( int  ,
int  ,
int   
)
virtual

Set the sampling rate in the i, j, and k directions.

If the rate is > 1, then the resulting VOI will be subsampled representation of the input. For example, if the SampleRate=(2,2,2), every other point will be selected, resulting in a volume 1/8th the original size.

◆ SetSampleRate() [2/2]

virtual void vtkPVExtractVOI::SetSampleRate ( int  [3])
virtual

Set the sampling rate in the i, j, and k directions.

If the rate is > 1, then the resulting VOI will be subsampled representation of the input. For example, if the SampleRate=(2,2,2), every other point will be selected, resulting in a volume 1/8th the original size.

◆ GetSampleRate() [1/2]

virtual int* vtkPVExtractVOI::GetSampleRate ( )
virtual

Set the sampling rate in the i, j, and k directions.

If the rate is > 1, then the resulting VOI will be subsampled representation of the input. For example, if the SampleRate=(2,2,2), every other point will be selected, resulting in a volume 1/8th the original size.

◆ GetSampleRate() [2/2]

virtual void vtkPVExtractVOI::GetSampleRate ( int  data[3])
virtual

Set the sampling rate in the i, j, and k directions.

If the rate is > 1, then the resulting VOI will be subsampled representation of the input. For example, if the SampleRate=(2,2,2), every other point will be selected, resulting in a volume 1/8th the original size.

◆ SetSampleRateI()

void vtkPVExtractVOI::SetSampleRateI ( int  ratei)

Set/get the individual components of the sample rate.

◆ SetSampleRateJ()

void vtkPVExtractVOI::SetSampleRateJ ( int  ratej)

Set/get the individual components of the sample rate.

◆ SetSampleRateK()

void vtkPVExtractVOI::SetSampleRateK ( int  ratek)

Set/get the individual components of the sample rate.

◆ GetSampleRateI()

int vtkPVExtractVOI::GetSampleRateI ( )
inline

Set/get the individual components of the sample rate.

Definition at line 75 of file vtkPVExtractVOI.h.

◆ GetSampleRateJ()

int vtkPVExtractVOI::GetSampleRateJ ( )
inline

Set/get the individual components of the sample rate.

Definition at line 76 of file vtkPVExtractVOI.h.

◆ GetSampleRateK()

int vtkPVExtractVOI::GetSampleRateK ( )
inline

Set/get the individual components of the sample rate.

Definition at line 77 of file vtkPVExtractVOI.h.

◆ SetIncludeBoundary()

virtual void vtkPVExtractVOI::SetIncludeBoundary ( int  )
virtual

Control whether to enforce that the "boundary" of the grid is output in the subsampling process.

(This ivar only has effect when the SampleRate in any direction is not equal to 1.) When this ivar IncludeBoundary is on, the subsampling will always include the boundary of the grid even though the sample rate is not an even multiple of the grid dimensions. (By default IncludeBoundary is off.)

◆ GetIncludeBoundary()

virtual int vtkPVExtractVOI::GetIncludeBoundary ( )
virtual

Control whether to enforce that the "boundary" of the grid is output in the subsampling process.

(This ivar only has effect when the SampleRate in any direction is not equal to 1.) When this ivar IncludeBoundary is on, the subsampling will always include the boundary of the grid even though the sample rate is not an even multiple of the grid dimensions. (By default IncludeBoundary is off.)

◆ IncludeBoundaryOn()

virtual void vtkPVExtractVOI::IncludeBoundaryOn ( )
virtual

Control whether to enforce that the "boundary" of the grid is output in the subsampling process.

(This ivar only has effect when the SampleRate in any direction is not equal to 1.) When this ivar IncludeBoundary is on, the subsampling will always include the boundary of the grid even though the sample rate is not an even multiple of the grid dimensions. (By default IncludeBoundary is off.)

◆ IncludeBoundaryOff()

virtual void vtkPVExtractVOI::IncludeBoundaryOff ( )
virtual

Control whether to enforce that the "boundary" of the grid is output in the subsampling process.

(This ivar only has effect when the SampleRate in any direction is not equal to 1.) When this ivar IncludeBoundary is on, the subsampling will always include the boundary of the grid even though the sample rate is not an even multiple of the grid dimensions. (By default IncludeBoundary is off.)

◆ RequestData()

virtual int vtkPVExtractVOI::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

◆ RequestInformation()

virtual int vtkPVExtractVOI::RequestInformation ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

◆ RequestUpdateExtent()

virtual int vtkPVExtractVOI::RequestUpdateExtent ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

◆ ReportReferences()

virtual void vtkPVExtractVOI::ReportReferences ( vtkGarbageCollector *  )
protectedvirtual

Member Data Documentation

◆ VOI

int vtkPVExtractVOI::VOI[6]
protected

Definition at line 102 of file vtkPVExtractVOI.h.

◆ SampleRate

int vtkPVExtractVOI::SampleRate[3]
protected

Definition at line 103 of file vtkPVExtractVOI.h.

◆ IncludeBoundary

int vtkPVExtractVOI::IncludeBoundary
protected

Definition at line 104 of file vtkPVExtractVOI.h.

◆ ExtractVOI

vtkExtractVOI* vtkPVExtractVOI::ExtractVOI
protected

Definition at line 106 of file vtkPVExtractVOI.h.

◆ ExtractGrid

vtkExtractGrid* vtkPVExtractVOI::ExtractGrid
protected

Definition at line 107 of file vtkPVExtractVOI.h.

◆ ExtractRG

vtkExtractRectilinearGrid* vtkPVExtractVOI::ExtractRG
protected

Definition at line 108 of file vtkPVExtractVOI.h.


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