IMP  2.0.1
The Integrative Modeling Platform
IMP::algebra::ReferenceFrame3D Class Reference

A reference frame in 3D. More...

#include <IMP/algebra/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
 
const Transformation3Dget_transformation_to () const
 
void show (std::ostream &out=std::cout) const
 

Detailed Description

Note
This class is a geometric primitive. Also, this class is not not initialized by its default constructor.

Definition at line 22 of file ReferenceFrame3D.h.

Constructor & Destructor Documentation

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

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

Definition at line 36 of file ReferenceFrame3D.h.

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

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 47 of file ReferenceFrame3D.h.

Member Function Documentation

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

Assume the input vector is in local coordinates and transform it to global ones.

Definition at line 62 of file ReferenceFrame3D.h.

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

Assume the input vector is in local coordinates and transform it to global ones.

Definition at line 72 of file ReferenceFrame3D.h.

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

Assume the input vector is in global coordinates and get the local coordinates.

Definition at line 67 of file ReferenceFrame3D.h.

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

Assume the input vector is in global coordinates and get the local coordinates.

Definition at line 77 of file ReferenceFrame3D.h.

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

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

Definition at line 57 of file ReferenceFrame3D.h.

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

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 52 of file ReferenceFrame3D.h.


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