Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages

# vtkSphericalTransform Class Reference

`#include <vtkSphericalTransform.h>`

Inheritance diagram for vtkSphericalTransform:

[legend]
Collaboration diagram for vtkSphericalTransform:

[legend]
List of all members.

## Detailed Description

spherical to rectangular coords and back

Date:
  2002/03/25 19:37:49

Revision:
  1.1

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 cylindrical 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

Created by:
  - Gobbi, David

CVS contributions (if > 5%):
  - Gobbi, David (96%)

CVS logs (CVSweb):
  - .`cxx` (`/Common/vtkSphericalTransform.cxx)`
  - .`h` (`/Common/vtkSphericalTransform.h)`

Tests:
  vtkSphericalTransform (Tests)

Definition at line 53 of file vtkSphericalTransform.h.

## Public Types

typedef vtkWarpTransform | Superclass

## Public Methods

virtual const char * | GetClassName ()
virtual int | IsA (const char *type)
virtual void | PrintSelf (ostream &os, vtkIndent indent)
vtkAbstractTransform * | MakeTransform ()

## Static Public Methods

vtkSphericalTransform * | New ()
int | IsTypeOf (const char *type)
vtkSphericalTransform * | SafeDownCast (vtkObject *o)

## Protected Methods

| 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])

## Member Typedef Documentation

typedef vtkWarpTransform vtkSphericalTransform::Superclass

| Reimplemented from vtkWarpTransform. Definition at line 57 of file vtkSphericalTransform.h.

## Constructor & Destructor Documentation

vtkSphericalTransform::vtkSphericalTransform | ( |  | ) | `[protected]`

vtkSphericalTransform::~vtkSphericalTransform | ( |  | ) | `[protected]`

## Member Function Documentation

vtkSphericalTransform* vtkSphericalTransform::New | ( |  | ) | `[static]`

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

virtual const char* vtkSphericalTransform::GetClassName | ( |  | ) | `[virtual]`

| Reimplemented from vtkWarpTransform.

int vtkSphericalTransform::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 vtkWarpTransform.

virtual int vtkSphericalTransform::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 vtkWarpTransform.

vtkSphericalTransform* vtkSphericalTransform::SafeDownCast | ( | vtkObject * | o | ) | `[static]`

| Reimplemented from vtkWarpTransform.

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 vtkWarpTransform.

vtkAbstractTransform* vtkSphericalTransform::MakeTransform | ( |  | ) | `[virtual]`

| Make another transform of the same type. Implements vtkAbstractTransform.

void vtkSphericalTransform::InternalDeepCopy | ( | vtkAbstractTransform * | transform | ) | `[protected, virtual]`

| Copy this transform from another of the same type. Reimplemented from vtkAbstractTransform.

void vtkSphericalTransform::ForwardTransformPoint | ( | const float | in[3],
|  | float | out[3]
| ) | `[protected, virtual]`

| Internal functions for calculating the transformation. Implements vtkWarpTransform.

void vtkSphericalTransform::ForwardTransformPoint | ( | const double | in[3],
|  | double | out[3]
| ) | `[protected, virtual]`

| Internal functions for calculating the transformation. Implements vtkWarpTransform.

void vtkSphericalTransform::ForwardTransformDerivative | ( | const float | in[3],
|  | float | out[3],
|  | float | derivative[3][3]
| ) | `[protected, virtual]`

| 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]
| ) | `[protected, virtual]`

| Calculate the forward transform as well as the derivative. Implements vtkWarpTransform.

void vtkSphericalTransform::InverseTransformPoint | ( | const float | in[3],
|  | float | out[3]
| ) | `[protected, virtual]`

| 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]
| ) | `[protected, virtual]`

| 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]
| ) | `[protected, virtual]`

| 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]
| ) | `[protected, virtual]`

| 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:

- Common/vtkSphericalTransform.h