IMP logo
IMP Reference Guide  develop.d247202c1c,2019/10/23
The Integrative Modeling Platform
IMP::algebra::ReferenceFrame3D Class Reference

A reference frame in 3D. More...

#include <IMP/algebra/ReferenceFrame3D.h>

Detailed Description

A reference frame in 3D.

See geometric primitives for more information.

Definition at line 21 of file ReferenceFrame3D.h.

Public Member Functions

 ReferenceFrame3D ()
 Create the default reference frame. More...
 
 ReferenceFrame3D (const Transformation3D &tr)
 A reference frame specified by a transformation matrix. More...
 
Vector3D get_global_coordinates (const Vector3D &v) const
 
ReferenceFrame3D get_global_reference_frame (const ReferenceFrame3D &v) const
 
Vector3D get_local_coordinates (const Vector3D &v) const
 
ReferenceFrame3D get_local_reference_frame (const ReferenceFrame3D &v) const
 
const Transformation3Dget_transformation_from () const
 Return the transformation from global to local coordinates. More...
 
const Transformation3Dget_transformation_to () const
 Return transformation from local to global coordinates. More...
 
void show (std::ostream &out=std::cout) const
 

Constructor & Destructor Documentation

IMP::algebra::ReferenceFrame3D::ReferenceFrame3D ( )

Create the default reference frame.

That is, the origin with x,y,z axis as the principal axes.

Definition at line 37 of file ReferenceFrame3D.h.

IMP::algebra::ReferenceFrame3D::ReferenceFrame3D ( const Transformation3D tr)
explicit

A reference frame specified by a transformation matrix.

Constructs a reference frame using transformation tr

Parameters
tra transformation from local coordinates in this constructed reference frame to the global coordinates (equiv., tr brings the origin of the global frame to the origin of this frame, in global coordinates),

Definition at line 48 of file ReferenceFrame3D.h.

Member Function Documentation

Vector3D IMP::algebra::ReferenceFrame3D::get_global_coordinates ( const Vector3D v) const

Convert the vector v from local to global coordinates (i.e., v is specified in this reference frame)

Definition at line 70 of file ReferenceFrame3D.h.

ReferenceFrame3D IMP::algebra::ReferenceFrame3D::get_global_reference_frame ( const ReferenceFrame3D v) const

Convert reference frame v from local to global (i.e., v is specified in this reference frame)

Definition at line 82 of file ReferenceFrame3D.h.

Vector3D IMP::algebra::ReferenceFrame3D::get_local_coordinates ( const Vector3D v) const

Convert the vector v from global to local coordinates (i.e., the returned vector is specified in this reference frame)

Definition at line 76 of file ReferenceFrame3D.h.

ReferenceFrame3D IMP::algebra::ReferenceFrame3D::get_local_reference_frame ( const ReferenceFrame3D v) const

Convert reference frame v from global to local (i.e. the returned reference frame is speficied in this reference frame)

Definition at line 88 of file ReferenceFrame3D.h.

const Transformation3D& IMP::algebra::ReferenceFrame3D::get_transformation_from ( ) const

Return the transformation from global to local coordinates.

Get the transformation from the origin of this reference frame to the origin of the global frame (both in global coordinates).

Definition at line 64 of file ReferenceFrame3D.h.

const Transformation3D& IMP::algebra::ReferenceFrame3D::get_transformation_to ( ) const

Return transformation from local to global coordinates.

Get the transformation that brings the origin of the global reference frame to the origin of this frame (both in global coordinates).

Definition at line 57 of file ReferenceFrame3D.h.


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