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

spherical to rectangular coords and back More...

#include <vtkSphericalTransform.h>

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

Public Types

typedef vtkWarpTransform Superclass
 
- Public Types inherited from vtkWarpTransform
typedef vtkAbstractTransform Superclass
 
- Public Types inherited from vtkAbstractTransform
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkSphericalTransform * NewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
vtkAbstractTransform * MakeTransform ()
 
- Public Member Functions inherited from vtkWarpTransform
vtkWarpTransform * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void Inverse ()
 
virtual int GetInverseFlag ()
 
virtual void SetInverseTolerance (double)
 
virtual double GetInverseTolerance ()
 
virtual void SetInverseIterations (int)
 
virtual int GetInverseIterations ()
 
void InternalTransformPoint (const float in[3], float out[3])
 
void InternalTransformPoint (const double in[3], double out[3])
 
void InternalTransformDerivative (const float in[3], float out[3], float derivative[3][3])
 
void InternalTransformDerivative (const double in[3], double out[3], double derivative[3][3])
 
void TemplateTransformPoint (const float in[3], float out[3])
 
void TemplateTransformPoint (const double in[3], double out[3])
 
void TemplateTransformPoint (const float in[3], float out[3], float derivative[3][3])
 
void TemplateTransformPoint (const double in[3], double out[3], double derivative[3][3])
 
void TemplateTransformInverse (const float in[3], float out[3])
 
void TemplateTransformInverse (const double in[3], double out[3])
 
void TemplateTransformInverse (const float in[3], float out[3], float derivative[3][3])
 
void TemplateTransformInverse (const double in[3], double out[3], double derivative[3][3])
 
- Public Member Functions inherited from vtkAbstractTransform
vtkAbstractTransform * NewInstance () const
 
double * TransformNormalAtPoint (const double point[3], const double normal[3])
 
double * TransformVectorAtPoint (const double point[3], const double vector[3])
 
virtual void TransformPoints (vtkPoints *inPts, vtkPoints *outPts)
 
vtkAbstractTransform * GetInverse ()
 
void SetInverse (vtkAbstractTransform *transform)
 
void DeepCopy (vtkAbstractTransform *)
 
void Update ()
 
virtual int CircuitCheck (vtkAbstractTransform *transform)
 
unsigned long GetMTime ()
 
virtual void UnRegister (vtkObjectBase *O)
 
void TransformPoint (const float in[3], float out[3])
 
void TransformPoint (const double in[3], double out[3])
 
double * TransformPoint (double x, double y, double z)
 
double * TransformPoint (const double point[3])
 
float * TransformFloatPoint (float x, float y, float z)
 
float * TransformFloatPoint (const float point[3])
 
double * TransformDoublePoint (double x, double y, double z)
 
double * TransformDoublePoint (const double point[3])
 
void TransformNormalAtPoint (const float point[3], const float in[3], float out[3])
 
void TransformNormalAtPoint (const double point[3], const double in[3], double out[3])
 
double * TransformDoubleNormalAtPoint (const double point[3], const double normal[3])
 
float * TransformFloatNormalAtPoint (const float point[3], const float normal[3])
 
void TransformVectorAtPoint (const float point[3], const float in[3], float out[3])
 
void TransformVectorAtPoint (const double point[3], const double in[3], double out[3])
 
double * TransformDoubleVectorAtPoint (const double point[3], const double vector[3])
 
float * TransformFloatVectorAtPoint (const float point[3], const float vector[3])
 
virtual void TransformPointsNormalsVectors (vtkPoints *inPts, vtkPoints *outPts, vtkDataArray *inNms, vtkDataArray *outNms, vtkDataArray *inVrs, vtkDataArray *outVrs)
 
- Public Member Functions inherited from vtkObject
vtkObject * NewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommand * GetCommand (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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(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)
 
virtual void Register (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkSphericalTransform * New ()
 
static int IsTypeOf (const char *type)
 
static vtkSphericalTransform * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkWarpTransform
static int IsTypeOf (const char *type)
 
static vtkWarpTransform * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractTransform
static int IsTypeOf (const char *type)
 
static vtkAbstractTransform * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObject * SafeDownCast (vtkObjectBase *o)
 
static vtkObject * New ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBase * New ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkSphericalTransform ()
 
 ~vtkSphericalTransform ()
 
void InternalDeepCopy (vtkAbstractTransform *transform)
 
void ForwardTransformDerivative (const float in[3], float out[3], float derivative[3][3])
 
void ForwardTransformDerivative (const double in[3], double out[3], double derivative[3][3])
 
void InverseTransformPoint (const float in[3], float out[3])
 
void InverseTransformPoint (const double in[3], double out[3])
 
void InverseTransformDerivative (const float in[3], float out[3], float derivative[3][3])
 
void InverseTransformDerivative (const double in[3], double out[3], double derivative[3][3])
 
void ForwardTransformPoint (const float in[3], float out[3])
 
void ForwardTransformPoint (const double in[3], double out[3])
 
- Protected Member Functions inherited from vtkWarpTransform
 vtkWarpTransform ()
 
 ~vtkWarpTransform ()
 
- Protected Member Functions inherited from vtkAbstractTransform
 vtkAbstractTransform ()
 
 ~vtkAbstractTransform ()
 
virtual void InternalUpdate ()
 
- 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 &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkWarpTransform
int InverseFlag
 
int InverseIterations
 
double InverseTolerance
 
- Protected Attributes inherited from vtkAbstractTransform
float InternalFloatPoint [3]
 
double InternalDoublePoint [3]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

spherical to rectangular coords and back

vtkSphericalTransform will convert (r,phi,theta) coordinates to (x,y,z) coordinates and back again. The angles are given in radians. By default, it converts spherical coordinates to rectangular, but GetInverse() returns a transform that will do the opposite. The equation that is used is x = r*sin(phi)*cos(theta), y = r*sin(phi)*sin(theta), z = r*cos(phi).

Warning
This transform is not well behaved along the line x=y=0 (i.e. along the z-axis)
See also
vtkCylindricalTransform vtkGeneralTransform
Examples:
vtkSphericalTransform (Examples)
Tests:
vtkSphericalTransform (Tests)

Definition at line 43 of file vtkSphericalTransform.h.

Member Typedef Documentation

typedef vtkWarpTransform vtkSphericalTransform::Superclass

Definition at line 47 of file vtkSphericalTransform.h.

Constructor & Destructor Documentation

vtkSphericalTransform::vtkSphericalTransform ( )
protected
vtkSphericalTransform::~vtkSphericalTransform ( )
protected

Member Function Documentation

static vtkSphericalTransform* vtkSphericalTransform::New ( )
static
static int vtkSphericalTransform::IsTypeOf ( const char *  type)
static
virtual int vtkSphericalTransform::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 vtkWarpTransform.

static vtkSphericalTransform* vtkSphericalTransform::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkSphericalTransform::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkWarpTransform.

vtkSphericalTransform* vtkSphericalTransform::NewInstance ( ) const
virtual void vtkSphericalTransform::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 vtkAbstractTransform.

vtkAbstractTransform* vtkSphericalTransform::MakeTransform ( )
virtual

Make another transform of the same type.

Implements vtkAbstractTransform.

void vtkSphericalTransform::InternalDeepCopy ( vtkAbstractTransform *  transform)
protectedvirtual

Copy this transform from another of the same type.

Reimplemented from vtkAbstractTransform.

void vtkSphericalTransform::ForwardTransformPoint ( const float  in[3],
float  out[3] 
)
protectedvirtual

Internal functions for calculating the transformation.

Implements vtkWarpTransform.

void vtkSphericalTransform::ForwardTransformPoint ( const double  in[3],
double  out[3] 
)
protectedvirtual

Internal functions for calculating the transformation.

Implements vtkWarpTransform.

void vtkSphericalTransform::ForwardTransformDerivative ( const float  in[3],
float  out[3],
float  derivative[3][3] 
)
protectedvirtual

Calculate the forward transform as well as the derivative.

Implements vtkWarpTransform.

void vtkSphericalTransform::ForwardTransformDerivative ( const double  in[3],
double  out[3],
double  derivative[3][3] 
)
protectedvirtual

Calculate the forward transform as well as the derivative.

Implements vtkWarpTransform.

void vtkSphericalTransform::InverseTransformPoint ( const float  in[3],
float  out[3] 
)
protectedvirtual

If the InverseFlag is set to 1, then a call to InternalTransformPoint results in a call to InverseTransformPoint. The inverse transformation is calculated from using Newton's method.

Reimplemented from vtkWarpTransform.

void vtkSphericalTransform::InverseTransformPoint ( const double  in[3],
double  out[3] 
)
protectedvirtual

If the InverseFlag is set to 1, then a call to InternalTransformPoint results in a call to InverseTransformPoint. The inverse transformation is calculated from using Newton's method.

Reimplemented from vtkWarpTransform.

void vtkSphericalTransform::InverseTransformDerivative ( const float  in[3],
float  out[3],
float  derivative[3][3] 
)
protectedvirtual

Calculate the inverse transform as well as the derivative of the forward transform (that's correct: the derivative of the forward transform, not of the inverse transform)

Reimplemented from vtkWarpTransform.

void vtkSphericalTransform::InverseTransformDerivative ( const double  in[3],
double  out[3],
double  derivative[3][3] 
)
protectedvirtual

Calculate the inverse transform as well as the derivative of the forward transform (that's correct: the derivative of the forward transform, not of the inverse transform)

Reimplemented from vtkWarpTransform.

The documentation for this class was generated from the following file:
Generated on Wed Dec 16 2015 17:19:50 for VTK by   doxygen 1.8.9.1