vtkImageGridSource Class Reference

Create an image of a grid. More...

#include <vtkImageGridSource.h>

Inheritance diagram for vtkImageGridSource:

Collaboration diagram for vtkImageGridSource:

List of all members.

Public Types
typedef vtkImageAlgorithm	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkImageGridSource *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetGridSpacing (int, int, int)
virtual void	SetGridSpacing (int[3])
virtual int *	GetGridSpacing ()
virtual void	GetGridSpacing (int &, int &, int &)
virtual void	GetGridSpacing (int[3])
virtual void	SetGridOrigin (int, int, int)
virtual void	SetGridOrigin (int[3])
virtual int *	GetGridOrigin ()
virtual void	GetGridOrigin (int &, int &, int &)
virtual void	GetGridOrigin (int[3])
virtual void	SetLineValue (double)
virtual double	GetLineValue ()
virtual void	SetFillValue (double)
virtual double	GetFillValue ()
virtual void	SetDataScalarType (int)
void	SetDataScalarTypeToDouble ()
void	SetDataScalarTypeToInt ()
void	SetDataScalarTypeToShort ()
void	SetDataScalarTypeToUnsignedShort ()
void	SetDataScalarTypeToUnsignedChar ()
virtual int	GetDataScalarType ()
const char *	GetDataScalarTypeAsString ()
virtual void	SetDataExtent (int, int, int, int, int, int)
virtual void	SetDataExtent (int[6])
virtual int *	GetDataExtent ()
virtual void	GetDataExtent (int &, int &, int &, int &, int &, int &)
virtual void	GetDataExtent (int[6])
virtual void	SetDataSpacing (double, double, double)
virtual void	SetDataSpacing (double[3])
virtual double *	GetDataSpacing ()
virtual void	GetDataSpacing (double &, double &, double &)
virtual void	GetDataSpacing (double[3])
virtual void	SetDataOrigin (double, double, double)
virtual void	SetDataOrigin (double[3])
virtual double *	GetDataOrigin ()
virtual void	GetDataOrigin (double &, double &, double &)
virtual void	GetDataOrigin (double[3])
Static Public Member Functions
static vtkImageGridSource *	New ()
static int	IsTypeOf (const char *type)
static vtkImageGridSource *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImageGridSource ()
	~vtkImageGridSource ()
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void	ExecuteDataWithInformation (vtkDataObject *data, vtkInformation *outInfo)
Protected Attributes
int	GridSpacing [3]
int	GridOrigin [3]
double	LineValue
double	FillValue
int	DataScalarType
int	DataExtent [6]
double	DataSpacing [3]
double	DataOrigin [3]

---

Detailed Description

Create an image of a grid.

vtkImageGridSource produces an image of a grid. The default output type is double.

Tests:

vtkImageGridSource (Tests)

Definition at line 31 of file vtkImageGridSource.h.

---

Member Typedef Documentation

typedef vtkImageAlgorithm vtkImageGridSource::Superclass

Reimplemented from vtkImageAlgorithm.

Definition at line 35 of file vtkImageGridSource.h.

---

Constructor & Destructor Documentation

vtkImageGridSource::vtkImageGridSource

(

)

[protected]

vtkImageGridSource::~vtkImageGridSource

(

)

[inline, protected]

Definition at line 100 of file vtkImageGridSource.h.

---

Member Function Documentation

static vtkImageGridSource* vtkImageGridSource::New

(

)

[static]

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

Reimplemented from vtkAlgorithm.

static int vtkImageGridSource::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 vtkImageAlgorithm.

virtual int vtkImageGridSource::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 vtkImageAlgorithm.

static vtkImageGridSource* vtkImageGridSource::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkImageAlgorithm.

virtual vtkObjectBase* vtkImageGridSource::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkImageAlgorithm.

vtkImageGridSource* vtkImageGridSource::NewInstance

(

)

const

Reimplemented from vtkImageAlgorithm.

void vtkImageGridSource::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 vtkImageAlgorithm.

virtual void vtkImageGridSource::SetGridSpacing	(	int	,
		int	,
		int
	)		[virtual]

Set/Get the grid spacing in pixel units. Default (10,10,0). A value of zero means no grid.

virtual void vtkImageGridSource::SetGridSpacing

(

int

[3]

)

[virtual]

Set/Get the grid spacing in pixel units. Default (10,10,0). A value of zero means no grid.

virtual int* vtkImageGridSource::GetGridSpacing

(

)

[virtual]

Set/Get the grid spacing in pixel units. Default (10,10,0). A value of zero means no grid.

virtual void vtkImageGridSource::GetGridSpacing	(	int &	,
		int &	,
		int &
	)		[virtual]

Set/Get the grid spacing in pixel units. Default (10,10,0). A value of zero means no grid.

virtual void vtkImageGridSource::GetGridSpacing

(

int

[3]

)

[virtual]

Set/Get the grid spacing in pixel units. Default (10,10,0). A value of zero means no grid.

virtual void vtkImageGridSource::SetGridOrigin	(	int	,
		int	,
		int
	)		[virtual]

Set/Get the grid origin, in ijk integer values. Default (0,0,0).

virtual void vtkImageGridSource::SetGridOrigin

(

int

[3]

)

[virtual]

Set/Get the grid origin, in ijk integer values. Default (0,0,0).

virtual int* vtkImageGridSource::GetGridOrigin

(

)

[virtual]

Set/Get the grid origin, in ijk integer values. Default (0,0,0).

virtual void vtkImageGridSource::GetGridOrigin	(	int &	,
		int &	,
		int &
	)		[virtual]

Set/Get the grid origin, in ijk integer values. Default (0,0,0).

virtual void vtkImageGridSource::GetGridOrigin

(

int

[3]

)

[virtual]

Set/Get the grid origin, in ijk integer values. Default (0,0,0).

virtual void vtkImageGridSource::SetLineValue

(

double

)

[virtual]

Set the grey level of the lines. Default 1.0.

virtual double vtkImageGridSource::GetLineValue

(

)

[virtual]

Set the grey level of the lines. Default 1.0.

virtual void vtkImageGridSource::SetFillValue

(

double

)

[virtual]

Set the grey level of the fill. Default 0.0.

virtual double vtkImageGridSource::GetFillValue

(

)

[virtual]

Set the grey level of the fill. Default 0.0.

virtual void vtkImageGridSource::SetDataScalarType

(

int

)

[virtual]

Set/Get the data type of pixels in the imported data. As a convenience, the OutputScalarType is set to the same value.

void vtkImageGridSource::SetDataScalarTypeToDouble

(

)

[inline]

Set/Get the data type of pixels in the imported data. As a convenience, the OutputScalarType is set to the same value.

Definition at line 67 of file vtkImageGridSource.h.

void vtkImageGridSource::SetDataScalarTypeToInt

(

)

[inline]

Set/Get the data type of pixels in the imported data. As a convenience, the OutputScalarType is set to the same value.

Definition at line 68 of file vtkImageGridSource.h.

void vtkImageGridSource::SetDataScalarTypeToShort

(

)

[inline]

Set/Get the data type of pixels in the imported data. As a convenience, the OutputScalarType is set to the same value.

Definition at line 69 of file vtkImageGridSource.h.

void vtkImageGridSource::SetDataScalarTypeToUnsignedShort

(

)

[inline]

Set/Get the data type of pixels in the imported data. As a convenience, the OutputScalarType is set to the same value.

Definition at line 70 of file vtkImageGridSource.h.

void vtkImageGridSource::SetDataScalarTypeToUnsignedChar

(

)

[inline]

Set/Get the data type of pixels in the imported data. As a convenience, the OutputScalarType is set to the same value.

Definition at line 72 of file vtkImageGridSource.h.

virtual int vtkImageGridSource::GetDataScalarType

(

)

[virtual]

Set/Get the data type of pixels in the imported data. As a convenience, the OutputScalarType is set to the same value.

const char* vtkImageGridSource::GetDataScalarTypeAsString

(

)

[inline]

Set/Get the data type of pixels in the imported data. As a convenience, the OutputScalarType is set to the same value.

Definition at line 75 of file vtkImageGridSource.h.

virtual void vtkImageGridSource::SetDataExtent	(	int	,
		int	,
		int	,
		int	,
		int	,
		int
	)		[virtual]

Set/Get the extent of the whole output image, Default: (0,255,0,255,0,0)

virtual void vtkImageGridSource::SetDataExtent

(

int

[6]

)

[virtual]

Set/Get the extent of the whole output image, Default: (0,255,0,255,0,0)

virtual int* vtkImageGridSource::GetDataExtent

(

)

[virtual]

Set/Get the extent of the whole output image, Default: (0,255,0,255,0,0)

virtual void vtkImageGridSource::GetDataExtent	(	int &	,
		int &	,
		int &	,
		int &	,
		int &	,
		int &
	)		[virtual]

Set/Get the extent of the whole output image, Default: (0,255,0,255,0,0)

virtual void vtkImageGridSource::GetDataExtent

(

int

[6]

)

[virtual]

Set/Get the extent of the whole output image, Default: (0,255,0,255,0,0)

virtual void vtkImageGridSource::SetDataSpacing	(	double	,
		double	,
		double
	)		[virtual]

Set/Get the pixel spacing.

virtual void vtkImageGridSource::SetDataSpacing

(

double

[3]

)

[virtual]

Set/Get the pixel spacing.

virtual double* vtkImageGridSource::GetDataSpacing

(

)

[virtual]

Set/Get the pixel spacing.

virtual void vtkImageGridSource::GetDataSpacing	(	double &	,
		double &	,
		double &
	)		[virtual]

Set/Get the pixel spacing.

virtual void vtkImageGridSource::GetDataSpacing

(

double

[3]

)

[virtual]

Set/Get the pixel spacing.

virtual void vtkImageGridSource::SetDataOrigin	(	double	,
		double	,
		double
	)		[virtual]

Set/Get the origin of the data.

virtual void vtkImageGridSource::SetDataOrigin

(

double

[3]

)

[virtual]

Set/Get the origin of the data.

virtual double* vtkImageGridSource::GetDataOrigin

(

)

[virtual]

Set/Get the origin of the data.

virtual void vtkImageGridSource::GetDataOrigin	(	double &	,
		double &	,
		double &
	)		[virtual]

Set/Get the origin of the data.

virtual void vtkImageGridSource::GetDataOrigin

(

double

[3]

)

[virtual]

Set/Get the origin of the data.

virtual int vtkImageGridSource::RequestInformation	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		[protected, virtual]

Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.

Reimplemented from vtkImageAlgorithm.

virtual void vtkImageGridSource::ExecuteDataWithInformation	(	vtkDataObject *	output,
		vtkInformation *	outInfo
	)		[protected, virtual]

This is a convenience method that is implemented in many subclasses instead of RequestData. It is called by RequestData.

Reimplemented from vtkImageAlgorithm.

---

Member Data Documentation

int vtkImageGridSource::GridSpacing[3] [protected]

Definition at line 100 of file vtkImageGridSource.h.

int vtkImageGridSource::GridOrigin[3] [protected]

Definition at line 103 of file vtkImageGridSource.h.

double vtkImageGridSource::LineValue [protected]

Definition at line 105 of file vtkImageGridSource.h.

double vtkImageGridSource::FillValue [protected]

Definition at line 106 of file vtkImageGridSource.h.

int vtkImageGridSource::DataScalarType [protected]

Definition at line 108 of file vtkImageGridSource.h.

int vtkImageGridSource::DataExtent[6] [protected]

Definition at line 110 of file vtkImageGridSource.h.

double vtkImageGridSource::DataSpacing[3] [protected]

Definition at line 111 of file vtkImageGridSource.h.

double vtkImageGridSource::DataOrigin[3] [protected]

Definition at line 112 of file vtkImageGridSource.h.

---

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

• dox/Imaging/Sources/vtkImageGridSource.h