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

Create an image of a grid. More...

#include <vtkImageGridSource.h>

Inheritance diagram for vtkImageGridSource:
[legend]
Collaboration diagram for vtkImageGridSource:
[legend]

Public Types

typedef vtkImageAlgorithm Superclass
- Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm Superclass
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
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])
- Public Member Functions inherited from vtkImageAlgorithm
vtkDataObjectGetInput (int port)
vtkDataObjectGetInput ()
vtkImageDataGetImageDataInput (int port)
vtkImageDataGetOutput ()
vtkImageDataGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
virtual void AddInput (vtkDataObject *)
virtual void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
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 *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
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
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkImageGridSourceNew ()
static int IsTypeOf (const char *type)
static vtkImageGridSourceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImageGridSource ()
 ~vtkImageGridSource ()
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void ExecuteData (vtkDataObject *data)
- Protected Member Functions inherited from vtkImageAlgorithm
 vtkImageAlgorithm ()
 ~vtkImageAlgorithm ()
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void AllocateOutputData (vtkImageData *out, int *uExtent)
virtual vtkImageDataAllocateOutputData (vtkDataObject *out)
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void Execute ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

int GridSpacing [3]
int GridOrigin [3]
double LineValue
double FillValue
int DataScalarType
int DataExtent [6]
double DataSpacing [3]
double DataOrigin [3]

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
- Friends inherited from vtkObject

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 30 of file vtkImageGridSource.h.

Member Typedef Documentation

Definition at line 34 of file vtkImageGridSource.h.

Constructor & Destructor Documentation

vtkImageGridSource::vtkImageGridSource ( )
protected
vtkImageGridSource::~vtkImageGridSource ( )
inlineprotected

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

virtual const char* vtkImageGridSource::GetClassName ( )
virtual

Reimplemented from vtkImageAlgorithm.

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 ( vtkObject o)
static

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 66 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 67 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 68 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 69 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 71 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 74 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 ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

Reimplemented from vtkImageAlgorithm.

virtual void vtkImageGridSource::ExecuteData ( vtkDataObject output)
protectedvirtual

This method is the old style execute method

Reimplemented from vtkImageAlgorithm.

Member Data Documentation

int vtkImageGridSource::GridSpacing[3]
protected

Definition at line 99 of file vtkImageGridSource.h.

int vtkImageGridSource::GridOrigin[3]
protected

Definition at line 102 of file vtkImageGridSource.h.

double vtkImageGridSource::LineValue
protected

Definition at line 104 of file vtkImageGridSource.h.

double vtkImageGridSource::FillValue
protected

Definition at line 105 of file vtkImageGridSource.h.

int vtkImageGridSource::DataScalarType
protected

Definition at line 107 of file vtkImageGridSource.h.

int vtkImageGridSource::DataExtent[6]
protected

Definition at line 109 of file vtkImageGridSource.h.

double vtkImageGridSource::DataSpacing[3]
protected

Definition at line 110 of file vtkImageGridSource.h.

double vtkImageGridSource::DataOrigin[3]
protected

Definition at line 111 of file vtkImageGridSource.h.


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