Representation of a cartesian pixel plane and common operations on it. More...

#include <vtkPixelExtent.h>

Public Member Functions
	vtkPixelExtent ()

template<typename T >
	vtkPixelExtent (const T *ext)

template<typename T >
	vtkPixelExtent (T ilo, T ihi, T jlo, T jhi)

template<typename T >
	vtkPixelExtent (T width, T height)

	vtkPixelExtent (const vtkPixelExtent &other)

vtkPixelExtent &	operator= (const vtkPixelExtent &other)

int &	operator[] (int i)
	Element access. More...

const int &	operator[] (int i) const

void	SetData (const vtkPixelExtent &ext)
	Set the extent. More...

template<typename T >
void	SetData (const T *ext)

template<typename T >
void	SetData (T ilo, T ihi, T jlo, T jhi)

void	Clear ()

int *	GetData ()
	Direct access to internal data. More...

const int *	GetData () const

template<typename T >
void	GetData (T data[4]) const

unsigned int *	GetDataU ()

const unsigned int *	GetDataU () const

int	Empty () const
	Return true if empty. More...

bool	operator== (const vtkPixelExtent &other) const
	Test for equivalence. More...

int	Disjoint (vtkPixelExtent other) const
	Return non-zero if the extent is disjoint from the other. More...

template<typename T >
void	Size (T nCells[2]) const
	Get the number in each direction. More...

size_t	Size () const
	Get the total number. More...

void	operator&= (const vtkPixelExtent &other)
	In place intersection. More...

void	operator\|= (const vtkPixelExtent &other)
	In place union. More...

void	Shift ()
	Shifts by low corner of this, moving to the origin. More...

void	Shift (const vtkPixelExtent &ext)
	Shift by low corner of the given extent. More...

void	Shift (int *n)
	Shift by the given amount. More...

void	Shift (int q, int n)
	Shift by the given amount in the given direction. More...

vtkPixelExtent	Split (int dir)
	Divide the extent in half in the given direction. More...


void	GetStartIndex (int first[2]) const
	Get the start/end index. More...

void	GetStartIndex (int first[2], const int origin[2]) const
	Get the start/end index. More...

void	GetEndIndex (int last[2]) const
	Get the start/end index. More...


int	Contains (const vtkPixelExtent &other) const
	Return non-zero if this extent contains the other. More...

int	Contains (int i, int j) const
	Return non-zero if this extent contains the other. More...


void	Grow (int n)
	Expand the extents by n. More...

void	Grow (int q, int n)
	Expand the extents by n. More...

void	GrowLow (int q, int n)
	Expand the extents by n. More...

void	GrowHigh (int q, int n)
	Expand the extents by n. More...


void	Shrink (int n)
	Shrink the extent by n. More...

void	Shrink (int q, int n)
	Shrink the extent by n. More...


void	CellToNode ()
	In-place conversion from cell based to node based extent, and vise-versa. More...

void	NodeToCell ()
	In-place conversion from cell based to node based extent, and vise-versa. More...

Static Public Member Functions
template<typename T >
static void	Size (const vtkPixelExtent &ext, T nCells[2])
	Get the number in each direction. More...

static size_t	Size (const vtkPixelExtent &ext)
	Get the total number. More...

static vtkPixelExtent	Grow (const vtkPixelExtent &inputExt, int n)
	Add or remove ghost cells. More...

static vtkPixelExtent	Grow (const vtkPixelExtent &inputExt, const vtkPixelExtent &problemDomain, int n)

static vtkPixelExtent	GrowLow (const vtkPixelExtent &ext, int q, int n)

static vtkPixelExtent	GrowHigh (const vtkPixelExtent &ext, int q, int n)

static vtkPixelExtent	Shrink (const vtkPixelExtent &inputExt, const vtkPixelExtent &problemDomain, int n)
	Remove ghost cells. More...

static vtkPixelExtent	Shrink (const vtkPixelExtent &inputExt, int n)

static vtkPixelExtent	NodeToCell (const vtkPixelExtent &inputExt)
	Convert from point extent to cell extent while respecting the dimensionality of the data. More...

static vtkPixelExtent	CellToNode (const vtkPixelExtent &inputExt)
	Convert from cell extent to point extent while respecting the dimensionality of the data. More...

static void	Split (int i, int j, const vtkPixelExtent &ext, std::deque< vtkPixelExtent > &newExts)
	Split ext at i,j, resulting extents (up to 4) are appended to newExts. More...

static void	Subtract (const vtkPixelExtent &A, const vtkPixelExtent &B, std::deque< vtkPixelExtent > &newExts)
	A - B = C C is a set of disjoint extents such that the intersection of B and C is empty and the intersection of A and C is C. More...

static void	Merge (std::deque< vtkPixelExtent > &exts)
	Merge compatible extents in the list. More...


static void	Shift (int *ij, int n)
	Shift by the given amount while respecting mode. More...

static void	Shift (int ij, int n)
	Shift by the given amount while respecting mode. More...

Detailed Description

Representation of a cartesian pixel plane and common operations on it.

The implementation is intended to be fast and light so that it may be used in place of int[4] with little or no performance penalty.

NOTE in most cases operation on an empty object produces incorrect results. If it an issue query Empty() first.

Tests:: vtkPixelExtent (Tests)

Definition at line 41 of file vtkPixelExtent.h.

Constructor & Destructor Documentation

vtkPixelExtent::vtkPixelExtent ( )

inline

Definition at line 359 of file vtkPixelExtent.h.

template<typename T >

vtkPixelExtent::vtkPixelExtent ( const T * ext )

Definition at line 366 of file vtkPixelExtent.h.

template<typename T >

vtkPixelExtent::vtkPixelExtent	(	T	ilo,
		T	ihi,
		T	jlo,
		T	jhi
	)

Definition at line 373 of file vtkPixelExtent.h.

template<typename T >

vtkPixelExtent::vtkPixelExtent	(	T	width,
		T	height
	)

inline

Definition at line 53 of file vtkPixelExtent.h.

vtkPixelExtent::vtkPixelExtent ( const vtkPixelExtent & other )

inline

Definition at line 398 of file vtkPixelExtent.h.

Member Function Documentation

vtkPixelExtent & vtkPixelExtent::operator= ( const vtkPixelExtent & other )

inline

Definition at line 384 of file vtkPixelExtent.h.

int& vtkPixelExtent::operator[] ( int i )

inline

Element access.

Definition at line 63 of file vtkPixelExtent.h.

const int& vtkPixelExtent::operator[] ( int i ) const

inline

Definition at line 64 of file vtkPixelExtent.h.

void vtkPixelExtent::SetData ( const vtkPixelExtent & ext )

inline

Set the extent.

Definition at line 335 of file vtkPixelExtent.h.

template<typename T >

void vtkPixelExtent::SetData ( const T * ext )

Definition at line 317 of file vtkPixelExtent.h.

template<typename T >

void vtkPixelExtent::SetData	(	T	ilo,
		T	ihi,
		T	jlo,
		T	jhi
	)

Definition at line 327 of file vtkPixelExtent.h.

void vtkPixelExtent::Clear ( )

inline

Definition at line 352 of file vtkPixelExtent.h.

int* vtkPixelExtent::GetData ( )

inline

Direct access to internal data.

Definition at line 81 of file vtkPixelExtent.h.

const int* vtkPixelExtent::GetData ( ) const

inline

Definition at line 82 of file vtkPixelExtent.h.

template<typename T >

void vtkPixelExtent::GetData ( T data[4] ) const

Definition at line 342 of file vtkPixelExtent.h.

unsigned int* vtkPixelExtent::GetDataU ( )

inline

Definition at line 87 of file vtkPixelExtent.h.

const unsigned int* vtkPixelExtent::GetDataU ( ) const

inline

Definition at line 90 of file vtkPixelExtent.h.

void vtkPixelExtent::GetStartIndex ( int first[2] ) const

inline

Get the start/end index.

Definition at line 434 of file vtkPixelExtent.h.

void vtkPixelExtent::GetStartIndex	(	int	first[2],
		const int	origin[2]
	)		const

inline

Get the start/end index.

Definition at line 442 of file vtkPixelExtent.h.

void vtkPixelExtent::GetEndIndex ( int last[2] ) const

inline

Get the start/end index.

Definition at line 450 of file vtkPixelExtent.h.

int vtkPixelExtent::Empty ( ) const

inline

Return true if empty.

Definition at line 458 of file vtkPixelExtent.h.

bool vtkPixelExtent::operator== ( const vtkPixelExtent & other ) const

inline

Test for equivalence.

Definition at line 470 of file vtkPixelExtent.h.

int vtkPixelExtent::Contains ( const vtkPixelExtent & other ) const

inline

Return non-zero if this extent contains the other.

Definition at line 484 of file vtkPixelExtent.h.

int vtkPixelExtent::Contains	(	int	i,
		int	j
	)		const

inline

Return non-zero if this extent contains the other.

Definition at line 498 of file vtkPixelExtent.h.

int vtkPixelExtent::Disjoint ( vtkPixelExtent other ) const

inline

Return non-zero if the extent is disjoint from the other.

Definition at line 560 of file vtkPixelExtent.h.

template<typename T >

void vtkPixelExtent::Size ( T nCells[2] ) const

Get the number in each direction.

Definition at line 420 of file vtkPixelExtent.h.

size_t vtkPixelExtent::Size ( ) const

inline

Get the total number.

Definition at line 427 of file vtkPixelExtent.h.

void vtkPixelExtent::operator&= ( const vtkPixelExtent & other )

inline

In place intersection.

Definition at line 513 of file vtkPixelExtent.h.

void vtkPixelExtent::operator|= ( const vtkPixelExtent & other )

inline

In place union.

Definition at line 539 of file vtkPixelExtent.h.

void vtkPixelExtent::Grow ( int n )

inline

Expand the extents by n.

Definition at line 568 of file vtkPixelExtent.h.

void vtkPixelExtent::Grow	(	int	q,
		int	n
	)

inline

Expand the extents by n.

Definition at line 578 of file vtkPixelExtent.h.

void vtkPixelExtent::GrowLow	(	int	q,
		int	n
	)

inline

Expand the extents by n.

Definition at line 588 of file vtkPixelExtent.h.

void vtkPixelExtent::GrowHigh	(	int	q,
		int	n
	)

inline

Expand the extents by n.

Definition at line 595 of file vtkPixelExtent.h.

void vtkPixelExtent::Shrink ( int n )

inline

Shrink the extent by n.

Definition at line 602 of file vtkPixelExtent.h.

void vtkPixelExtent::Shrink	(	int	q,
		int	n
	)

inline

Shrink the extent by n.

Definition at line 612 of file vtkPixelExtent.h.

void vtkPixelExtent::Shift ( )

inline

Shifts by low corner of this, moving to the origin.

Definition at line 654 of file vtkPixelExtent.h.

void vtkPixelExtent::Shift ( const vtkPixelExtent & ext )

inline

Shift by low corner of the given extent.

Definition at line 640 of file vtkPixelExtent.h.

void vtkPixelExtent::Shift ( int * n )

inline

Shift by the given amount.

Definition at line 621 of file vtkPixelExtent.h.

void vtkPixelExtent::Shift	(	int	q,
		int	n
	)

inline

Shift by the given amount in the given direction.

Definition at line 631 of file vtkPixelExtent.h.

vtkPixelExtent vtkPixelExtent::Split ( int dir )

inline

Divide the extent in half in the given direction.

The operation is done in-place the other half of the split extent is returned. The return will be empty if the split could not be made.

Definition at line 668 of file vtkPixelExtent.h.

void vtkPixelExtent::CellToNode ( )

inline

In-place conversion from cell based to node based extent, and vise-versa.

Definition at line 689 of file vtkPixelExtent.h.

void vtkPixelExtent::NodeToCell ( )

inline

In-place conversion from cell based to node based extent, and vise-versa.

Definition at line 697 of file vtkPixelExtent.h.

template<typename T >

void vtkPixelExtent::Size	(	const vtkPixelExtent &	ext,
		T	nCells[2]
	)

static

Get the number in each direction.

Definition at line 405 of file vtkPixelExtent.h.

size_t vtkPixelExtent::Size ( const vtkPixelExtent & ext )

inlinestatic

Get the total number.

Definition at line 413 of file vtkPixelExtent.h.

static vtkPixelExtent vtkPixelExtent::Grow	(	const vtkPixelExtent &	inputExt,
		int	n
	)

static

Add or remove ghost cells.

If a problem domain is provided then the result is clipled to be within the problem domain.

static vtkPixelExtent vtkPixelExtent::Grow	(	const vtkPixelExtent &	inputExt,
		const vtkPixelExtent &	problemDomain,
		int	n
	)

static

static vtkPixelExtent vtkPixelExtent::GrowLow	(	const vtkPixelExtent &	ext,
		int	q,
		int	n
	)

static

static vtkPixelExtent vtkPixelExtent::GrowHigh	(	const vtkPixelExtent &	ext,
		int	q,
		int	n
	)

static

static vtkPixelExtent vtkPixelExtent::Shrink	(	const vtkPixelExtent &	inputExt,
		const vtkPixelExtent &	problemDomain,
		int	n
	)

static

Remove ghost cells.

If a problem domain is provided the input is pinned at the domain.

static vtkPixelExtent vtkPixelExtent::Shrink	(	const vtkPixelExtent &	inputExt,
		int	n
	)

static

static vtkPixelExtent vtkPixelExtent::NodeToCell ( const vtkPixelExtent & inputExt )

static

Convert from point extent to cell extent while respecting the dimensionality of the data.

static vtkPixelExtent vtkPixelExtent::CellToNode ( const vtkPixelExtent & inputExt )

static

Convert from cell extent to point extent while respecting the dimensionality of the data.

static void vtkPixelExtent::Shift	(	int *	ij,
		int	n
	)

static

Shift by the given amount while respecting mode.

static void vtkPixelExtent::Shift	(	int *	ij,
		int *	n
	)

static

Shift by the given amount while respecting mode.

static void vtkPixelExtent::Split	(	int	i,
		int	j,
		const vtkPixelExtent &	ext,
		std::deque< vtkPixelExtent > &	newExts
	)

static

Split ext at i,j, resulting extents (up to 4) are appended to newExts.

If i,j is outside ext, ext is passed through unmodified.

static void vtkPixelExtent::Subtract	(	const vtkPixelExtent &	A,
		const vtkPixelExtent &	B,
		std::deque< vtkPixelExtent > &	newExts
	)

static

A - B = C C is a set of disjoint extents such that the intersection of B and C is empty and the intersection of A and C is C.

static void vtkPixelExtent::Merge ( std::deque< vtkPixelExtent > & exts )

static

Merge compatible extents in the list.

Extents are compatible if they are directly adjacent nad have the same extent along the adjacent edge.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Common/DataModel/vtkPixelExtent.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation