IMP Reference Guide  develop.b708a66810,2021/08/02 The Integrative Modeling Platform
IMP::algebra::SphericalVector3D Class Reference

Class to represent a 3D point in spherical coordinates. More...

#include <IMP/algebra/SphericalVector3D.h>

Inheritance diagram for IMP::algebra::SphericalVector3D:

## Detailed Description

Class to represent a 3D point in spherical coordinates.

The order assumed for the representation is radial distance, zenith, and azimuth (r, theta, psi). zenith - angle with axis z azimuth - angle with axis x See geometric primitives for more information.

Definition at line 29 of file SphericalVector3D.h.

## Public Member Functions

SphericalVector3D (const Vector3D &v)
Construct from a Cartesian coordinate vector. More...

SphericalVector3D (double r, double theta, double psi, bool apply_check=true)
Construct from provided spherical coordinates. More...

Vector3D get_cartesian_coordinates () const
Returns a vector with the Cartesian coordinates. More...

double operator[] (unsigned int i) const

double & operator[] (unsigned int i)

void show (std::ostream &out=std::cout) const

## Constructor & Destructor Documentation

 IMP::algebra::SphericalVector3D::SphericalVector3D ( const Vector3D & v )

Construct from a Cartesian coordinate vector.

Definition at line 36 of file SphericalVector3D.h.

 IMP::algebra::SphericalVector3D::SphericalVector3D ( double r, double theta, double psi, bool apply_check = true )

Construct from provided spherical coordinates.

A check for the validity of the coords is done by default. Set apply_check to false if you do not want the check.

Definition at line 42 of file SphericalVector3D.h.

## Member Function Documentation

 Vector3D IMP::algebra::SphericalVector3D::get_cartesian_coordinates ( ) const

Returns a vector with the Cartesian coordinates.

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