vtkIntensityTransferFunction Class Reference

#include <vtkIntensityTransferFunction.h>

Inheritance diagram for vtkIntensityTransferFunction:

Inheritance graph
[legend]
Collaboration diagram for vtkIntensityTransferFunction:

Collaboration graph
[legend]
List of all members.

Detailed Description

Defines a 1D piecewise function for processing a volume's intensity.

Defines a piecewise linear function mapping. Used for transfer functions in volume rendering.

Definition at line 41 of file vtkIntensityTransferFunction.h.

Public Types

typedef vtkPiecewiseFunction Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void Initialize ()
void DeepCopy (vtkDataObject *f)
void ShallowCopy (vtkDataObject *f)
int GetDataObjectType ()
int GetSize ()
void RemoveAllPoints ()
int GetValue (int x)
void ComputeFunction (void)
int IsIdentical (void)
virtual int * GetReferencePoint ()
virtual void GetReferencePoint (int &, int &)
virtual void GetReferencePoint (int[2])
int f4 (int x, int gx1, int gy1, int gx2, int gy2)
void Reset (void)
int * GetDataPointer ()
unsigned long GetMTime ()
double GetFirstNonZeroValue ()
virtual void SetMinimumValue (int)
virtual int GetMinimumValue ()
virtual void SetMaximumValue (int)
virtual int GetMaximumValue ()
virtual void SetMinimumThreshold (int)
virtual int GetMinimumThreshold ()
virtual void SetMaximumThreshold (int)
virtual int GetMaximumThreshold ()
virtual void SetProcessingThreshold (int)
virtual int GetProcessingThreshold ()
virtual void SetContrast (double)
virtual double GetContrast ()
virtual void SetBrightness (int)
virtual double GetBrightness ()
virtual void SetGamma (double)
virtual double GetGamma ()
virtual void SetSmoothStartGamma (double)
virtual double GetSmoothStartGamma ()
virtual void SetSmoothEndGamma (double)
virtual double GetSmoothEndGamma ()
virtual void SetSmoothStart (int)
virtual int GetSmoothStart ()
virtual void SetSmoothEnd (int)
virtual int GetSmoothEnd ()
virtual int * GetGammaStart ()
virtual void GetGammaStart (int &, int &)
virtual void GetGammaStart (int[2])
virtual int * GetGammaEnd ()
virtual void GetGammaEnd (int &, int &)
virtual void GetGammaEnd (int[2])
int GammaValue (int x0, int y0, int x1, int y1, int x, double gamma)

Static Public Member Functions

static vtkIntensityTransferFunctionNew ()
static int IsTypeOf (const char *type)
static vtkIntensityTransferFunctionSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkIntensityTransferFunction ()
 ~vtkIntensityTransferFunction ()
void IncreaseArraySize ()
void GetGammaPoints (int *gx0, int *gy0, int *gx1, int *gy1)
void GetSlopeStart (int *x, int *y)
void GetSlopeEnd (int *x, int *y)

Protected Attributes

int ArraySize
int * Function
int FunctionRange [2]
int MinimumValue
int MaximumValue
int MinimumThreshold
int MaximumThreshold
int ProcessingThreshold
int Brightness
int SmoothStart
int SmoothEnd
double Gamma
double SmoothStartGamma
double SmoothEndGamma
double Contrast
int GammaStart [2]
int GammaEnd [2]
int ReferencePoint [2]
vtkTimeStamp BuildTime


Member Typedef Documentation

typedef vtkPiecewiseFunction vtkIntensityTransferFunction::Superclass

Reimplemented from vtkPiecewiseFunction.

Definition at line 45 of file vtkIntensityTransferFunction.h.


Constructor & Destructor Documentation

vtkIntensityTransferFunction::vtkIntensityTransferFunction (  )  [protected]

vtkIntensityTransferFunction::~vtkIntensityTransferFunction (  )  [protected]


Member Function Documentation

static vtkIntensityTransferFunction* vtkIntensityTransferFunction::New (  )  [static]

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

Reimplemented from vtkPiecewiseFunction.

virtual const char* vtkIntensityTransferFunction::GetClassName (  )  [virtual]

Reimplemented from vtkPiecewiseFunction.

static int vtkIntensityTransferFunction::IsTypeOf ( const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPiecewiseFunction.

virtual int vtkIntensityTransferFunction::IsA ( const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPiecewiseFunction.

static vtkIntensityTransferFunction* vtkIntensityTransferFunction::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkPiecewiseFunction.

void vtkIntensityTransferFunction::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 vtkPiecewiseFunction.

void vtkIntensityTransferFunction::Initialize (  )  [virtual]

Restore data object to initial state,

Reimplemented from vtkPiecewiseFunction.

void vtkIntensityTransferFunction::DeepCopy ( vtkDataObject f  )  [virtual]

Shallow and Deep copy. These copy the data, but not any of the pipeline connections.

Reimplemented from vtkPiecewiseFunction.

void vtkIntensityTransferFunction::ShallowCopy ( vtkDataObject f  )  [virtual]

Shallow and Deep copy. These copy the data, but not any of the pipeline connections.

Reimplemented from vtkPiecewiseFunction.

int vtkIntensityTransferFunction::GetDataObjectType (  )  [inline, virtual]

Return what type of dataset this is.

Reimplemented from vtkPiecewiseFunction.

Definition at line 53 of file vtkIntensityTransferFunction.h.

References VTK_PIECEWISE_FUNCTION.

int vtkIntensityTransferFunction::GetSize (  ) 

Get the number of points used to specify the function

Reimplemented from vtkPiecewiseFunction.

void vtkIntensityTransferFunction::RemoveAllPoints (  ) 

Removes all points from the function.

Reimplemented from vtkPiecewiseFunction.

int vtkIntensityTransferFunction::GetValue ( int  x  ) 

Returns the value of the function at the specified location using the specified interpolation. Returns zero if the specified location is outside the min and max points of the function.

void vtkIntensityTransferFunction::ComputeFunction ( void   ) 

Calculates the function table based on the Minimum / Maximum Value and Threshold and the Brightness, Constrast and Gamma and the Processing Threshold

int vtkIntensityTransferFunction::IsIdentical ( void   ) 

Returns true if this is an identical function, i.e. y = x

int* vtkIntensityTransferFunction::GetDataPointer (  )  [inline]

Returns a pointer to the data stored in the table. Fills from a pointer to data stored in a similar table.

Reimplemented from vtkPiecewiseFunction.

Definition at line 78 of file vtkIntensityTransferFunction.h.

unsigned long vtkIntensityTransferFunction::GetMTime (  )  [virtual]

Get the mtime of this object - override to consider the mtime of the source as well.

Reimplemented from vtkDataObject.

double vtkIntensityTransferFunction::GetFirstNonZeroValue (  ) 

Returns the first point location which precedes a non-zero segment of the function. Note that the value at this point may be zero.

Reimplemented from vtkPiecewiseFunction.

virtual void vtkIntensityTransferFunction::SetMinimumValue ( int   )  [virtual]

Set / Get the minimum value of the function

virtual int vtkIntensityTransferFunction::GetMinimumValue (  )  [virtual]

Returns a pointer to the data stored in the table. Fills from a pointer to data stored in a similar table.

virtual void vtkIntensityTransferFunction::SetMaximumValue ( int   )  [virtual]

Returns a pointer to the data stored in the table. Fills from a pointer to data stored in a similar table.

virtual int vtkIntensityTransferFunction::GetMaximumValue (  )  [virtual]

Returns a pointer to the data stored in the table. Fills from a pointer to data stored in a similar table.

virtual void vtkIntensityTransferFunction::SetMinimumThreshold ( int   )  [virtual]

Returns a pointer to the data stored in the table. Fills from a pointer to data stored in a similar table.

virtual int vtkIntensityTransferFunction::GetMinimumThreshold (  )  [virtual]

Returns a pointer to the data stored in the table. Fills from a pointer to data stored in a similar table.

virtual void vtkIntensityTransferFunction::SetMaximumThreshold ( int   )  [virtual]

Set / Get the maximum threshold of the function

virtual int vtkIntensityTransferFunction::GetMaximumThreshold (  )  [virtual]

Set / Get the maximum threshold of the function

virtual void vtkIntensityTransferFunction::SetProcessingThreshold ( int   )  [virtual]

Set / Get the maximum threshold of the function

virtual int vtkIntensityTransferFunction::GetProcessingThreshold (  )  [virtual]

Set / Get the maximum threshold of the function

virtual void vtkIntensityTransferFunction::SetContrast ( double   )  [virtual]

Set / Get the maximum threshold of the function

virtual double vtkIntensityTransferFunction::GetContrast (  )  [virtual]

Set / Get the maximum threshold of the function

virtual void vtkIntensityTransferFunction::SetBrightness ( int   )  [virtual]

Set / Get the maximum threshold of the function

virtual double vtkIntensityTransferFunction::GetBrightness (  )  [virtual]

Set / Get the maximum threshold of the function

virtual void vtkIntensityTransferFunction::SetGamma ( double   )  [virtual]

Set / Get the maximum threshold of the function

virtual double vtkIntensityTransferFunction::GetGamma (  )  [virtual]

Set / Get the maximum threshold of the function

virtual void vtkIntensityTransferFunction::SetSmoothStartGamma ( double   )  [virtual]

Set / Get the smooth start gamma

virtual double vtkIntensityTransferFunction::GetSmoothStartGamma (  )  [virtual]

Set / Get the smooth start gamma

virtual void vtkIntensityTransferFunction::SetSmoothEndGamma ( double   )  [virtual]

Set / Get the smooth end gamma

virtual double vtkIntensityTransferFunction::GetSmoothEndGamma (  )  [virtual]

Set / Get the smooth end gamma

virtual void vtkIntensityTransferFunction::SetSmoothStart ( int   )  [virtual]

Set / Get the smooth start

virtual int vtkIntensityTransferFunction::GetSmoothStart (  )  [virtual]

Set / Get the smooth start

virtual void vtkIntensityTransferFunction::SetSmoothEnd ( int   )  [virtual]

Set / Get the smooth start

virtual int vtkIntensityTransferFunction::GetSmoothEnd (  )  [virtual]

Set / Get the smooth start

virtual int* vtkIntensityTransferFunction::GetGammaStart (  )  [virtual]

Get the point where the gamma curve starts

virtual void vtkIntensityTransferFunction::GetGammaStart ( int &  ,
int &   
) [virtual]

Get the point where the gamma curve starts

virtual void vtkIntensityTransferFunction::GetGammaStart ( int  [2]  )  [virtual]

Get the point where the gamma curve starts

virtual int* vtkIntensityTransferFunction::GetGammaEnd (  )  [virtual]

Get the point where the gamma curve starts

virtual void vtkIntensityTransferFunction::GetGammaEnd ( int &  ,
int &   
) [virtual]

Get the point where the gamma curve starts

virtual void vtkIntensityTransferFunction::GetGammaEnd ( int  [2]  )  [virtual]

Get the point where the gamma curve starts

virtual int* vtkIntensityTransferFunction::GetReferencePoint (  )  [virtual]

virtual void vtkIntensityTransferFunction::GetReferencePoint ( int &  ,
int &   
) [virtual]

virtual void vtkIntensityTransferFunction::GetReferencePoint ( int  [2]  )  [virtual]

int vtkIntensityTransferFunction::GammaValue ( int  x0,
int  y0,
int  x1,
int  y1,
int  x,
double  gamma 
)

A method that returns the y from the following formula: (y2-y1) y = ---------- * (x-x1)^g +y1 (x2-x1)^g I.e the y coord of the gamma curve at point x, when the gamma curve starts at (x0,y0) and ends at (x1,y1) and the gamma value is g Parameters: x0,y0 The starting point of the gamma curve x1,y1 The end point of the gamma curve x The point from which we want the gamma curves y coord g The gamma value

int vtkIntensityTransferFunction::f4 ( int  x,
int  gx1,
int  gy1,
int  gx2,
int  gy2 
)

void vtkIntensityTransferFunction::Reset ( void   ) 

void vtkIntensityTransferFunction::IncreaseArraySize (  )  [protected]

Reimplemented from vtkPiecewiseFunction.

void vtkIntensityTransferFunction::GetSlopeStart ( int *  x,
int *  y 
) [protected]

Returns the starting point of the slope

void vtkIntensityTransferFunction::GetSlopeEnd ( int *  x,
int *  y 
) [protected]

Returns the starting point of the slope

void vtkIntensityTransferFunction::GetGammaPoints ( int *  gx0,
int *  gy0,
int *  gx1,
int *  gy1 
) [protected]

Returns the starting and ending point of the gamma curve


Member Data Documentation

int vtkIntensityTransferFunction::ArraySize [protected]

Reimplemented from vtkPiecewiseFunction.

Definition at line 190 of file vtkIntensityTransferFunction.h.

int* vtkIntensityTransferFunction::Function [protected]

Reimplemented from vtkPiecewiseFunction.

Definition at line 193 of file vtkIntensityTransferFunction.h.

int vtkIntensityTransferFunction::FunctionRange[2] [protected]

Reimplemented from vtkPiecewiseFunction.

Definition at line 196 of file vtkIntensityTransferFunction.h.

int vtkIntensityTransferFunction::MinimumValue [protected]

Definition at line 213 of file vtkIntensityTransferFunction.h.

int vtkIntensityTransferFunction::MaximumValue [protected]

Definition at line 214 of file vtkIntensityTransferFunction.h.

int vtkIntensityTransferFunction::MinimumThreshold [protected]

Definition at line 215 of file vtkIntensityTransferFunction.h.

int vtkIntensityTransferFunction::MaximumThreshold [protected]

Definition at line 216 of file vtkIntensityTransferFunction.h.

int vtkIntensityTransferFunction::ProcessingThreshold [protected]

Definition at line 217 of file vtkIntensityTransferFunction.h.

int vtkIntensityTransferFunction::Brightness [protected]

Definition at line 218 of file vtkIntensityTransferFunction.h.

int vtkIntensityTransferFunction::SmoothStart [protected]

Definition at line 219 of file vtkIntensityTransferFunction.h.

int vtkIntensityTransferFunction::SmoothEnd [protected]

Definition at line 220 of file vtkIntensityTransferFunction.h.

double vtkIntensityTransferFunction::Gamma [protected]

Definition at line 221 of file vtkIntensityTransferFunction.h.

double vtkIntensityTransferFunction::SmoothStartGamma [protected]

Definition at line 222 of file vtkIntensityTransferFunction.h.

double vtkIntensityTransferFunction::SmoothEndGamma [protected]

Definition at line 223 of file vtkIntensityTransferFunction.h.

double vtkIntensityTransferFunction::Contrast [protected]

Definition at line 224 of file vtkIntensityTransferFunction.h.

int vtkIntensityTransferFunction::GammaStart[2] [protected]

Definition at line 225 of file vtkIntensityTransferFunction.h.

int vtkIntensityTransferFunction::GammaEnd[2] [protected]

Definition at line 226 of file vtkIntensityTransferFunction.h.

int vtkIntensityTransferFunction::ReferencePoint[2] [protected]

Definition at line 227 of file vtkIntensityTransferFunction.h.

vtkTimeStamp vtkIntensityTransferFunction::BuildTime [protected]

Definition at line 228 of file vtkIntensityTransferFunction.h.


The documentation for this class was generated from the following file:
Generated on Sat Dec 30 06:37:52 2006 for VTK by  doxygen 1.5.1