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

filter used to generate text annotation from Python expressions. More...

#include <vtkPythonAnnotationFilter.h>

Inheritance diagram for vtkPythonAnnotationFilter:
Inheritance graph
[legend]

Public Types

typedef vtkTableAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int GetNumberOfTimeSteps ()
 
double GetTimeStep (int index)
 
virtual bool GetTimeRangeValid ()
 
virtual double * GetTimeRange ()
 
virtual void GetTimeRange (double &, double &)
 
virtual void GetTimeRange (double [2])
 
virtual vtkDataObject * GetCurrentInputDataObject ()
 
void SetComputedAnnotationValue (const char *value)
 
virtual void SetExpression (const char *)
 Set the expression to evaluate. More...
 
virtual char * GetExpression ()
 Set the expression to evaluate. More...
 
virtual void SetArrayAssociation (int)
 Set the input array association. More...
 
virtual int GetArrayAssociation ()
 Set the input array association. More...
 
virtual char * GetComputedAnnotationValue ()
 Get the value that is going to be printed to the output. More...
 
virtual bool GetDataTimeValid ()
 Get methods for use in annotation.py. More...
 
virtual double GetDataTime ()
 Get methods for use in annotation.py. More...
 

Static Public Member Functions

static vtkPythonAnnotationFilterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPythonAnnotationFilterSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPythonAnnotationFilter ()
 
 ~vtkPythonAnnotationFilter ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual void EvaluateExpression ()
 

Protected Attributes

char * Expression
 
char * ComputedAnnotationValue
 
int ArrayAssociation
 

Detailed Description

filter used to generate text annotation from Python expressions.

vtkPythonAnnotationFilter is designed to generate vtkTableAlgorithm with a single string in it. The goal is that user will write a Python expression, similar to an expression in Python Calculator (vtkPythonCalculator). The generated result is converted to string and placed in the output.

The variables available in the expression evaluation scope are as follows:

Examples of valid expressions are:

Definition at line 43 of file vtkPythonAnnotationFilter.h.

Member Typedef Documentation

§ Superclass

typedef vtkTableAlgorithm vtkPythonAnnotationFilter::Superclass

Definition at line 47 of file vtkPythonAnnotationFilter.h.

Constructor & Destructor Documentation

§ vtkPythonAnnotationFilter()

vtkPythonAnnotationFilter::vtkPythonAnnotationFilter ( )
protected

§ ~vtkPythonAnnotationFilter()

vtkPythonAnnotationFilter::~vtkPythonAnnotationFilter ( )
protected

Member Function Documentation

§ New()

static vtkPythonAnnotationFilter* vtkPythonAnnotationFilter::New ( )
static

§ GetClassName()

virtual const char* vtkPythonAnnotationFilter::GetClassName ( )
virtual

§ IsTypeOf()

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

§ IsA()

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

§ SafeDownCast()

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

§ PrintSelf()

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

§ SetExpression()

virtual void vtkPythonAnnotationFilter::SetExpression ( const char *  )
virtual

Set the expression to evaluate.

Here is a set of common expressions:

  • "Momentum %s" % str(Momentum[available_timesteps.index(provided_time)])

§ GetExpression()

virtual char* vtkPythonAnnotationFilter::GetExpression ( )
virtual

Set the expression to evaluate.

Here is a set of common expressions:

  • "Momentum %s" % str(Momentum[available_timesteps.index(provided_time)])

§ SetArrayAssociation()

virtual void vtkPythonAnnotationFilter::SetArrayAssociation ( int  )
virtual

Set the input array association.

This dictates which array names are made available in the namespace by default. You can still use input.PointData['foo'] or input.CellData['bar'] explicitly to pick a specific array in your expression.

§ GetArrayAssociation()

virtual int vtkPythonAnnotationFilter::GetArrayAssociation ( )
virtual

Set the input array association.

This dictates which array names are made available in the namespace by default. You can still use input.PointData['foo'] or input.CellData['bar'] explicitly to pick a specific array in your expression.

§ GetComputedAnnotationValue()

virtual char* vtkPythonAnnotationFilter::GetComputedAnnotationValue ( )
virtual

Get the value that is going to be printed to the output.

§ GetDataTimeValid()

virtual bool vtkPythonAnnotationFilter::GetDataTimeValid ( )
virtual

Get methods for use in annotation.py.

The values are only valid during RequestData().

§ GetDataTime()

virtual double vtkPythonAnnotationFilter::GetDataTime ( )
virtual

Get methods for use in annotation.py.

The values are only valid during RequestData().

§ GetNumberOfTimeSteps()

virtual int vtkPythonAnnotationFilter::GetNumberOfTimeSteps ( )
virtual

§ GetTimeStep()

double vtkPythonAnnotationFilter::GetTimeStep ( int  index)
inline

Definition at line 89 of file vtkPythonAnnotationFilter.h.

§ GetTimeRangeValid()

virtual bool vtkPythonAnnotationFilter::GetTimeRangeValid ( )
virtual

§ GetTimeRange() [1/3]

virtual double* vtkPythonAnnotationFilter::GetTimeRange ( )
virtual

§ GetTimeRange() [2/3]

virtual void vtkPythonAnnotationFilter::GetTimeRange ( double &  ,
double &   
)
virtual

§ GetTimeRange() [3/3]

virtual void vtkPythonAnnotationFilter::GetTimeRange ( double  [2])
virtual

§ GetCurrentInputDataObject()

virtual vtkDataObject* vtkPythonAnnotationFilter::GetCurrentInputDataObject ( )
virtual

§ SetComputedAnnotationValue()

void vtkPythonAnnotationFilter::SetComputedAnnotationValue ( const char *  value)

§ FillInputPortInformation()

virtual int vtkPythonAnnotationFilter::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

§ RequestData()

virtual int vtkPythonAnnotationFilter::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

§ EvaluateExpression()

virtual void vtkPythonAnnotationFilter::EvaluateExpression ( )
protectedvirtual

Member Data Documentation

§ Expression

char* vtkPythonAnnotationFilter::Expression
protected

Definition at line 109 of file vtkPythonAnnotationFilter.h.

§ ComputedAnnotationValue

char* vtkPythonAnnotationFilter::ComputedAnnotationValue
protected

Definition at line 110 of file vtkPythonAnnotationFilter.h.

§ ArrayAssociation

int vtkPythonAnnotationFilter::ArrayAssociation
protected

Definition at line 111 of file vtkPythonAnnotationFilter.h.


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