IMP logo
IMP Reference Guide  develop.3e83b1f578,2019/10/15
The Integrative Modeling Platform
IMP::algebra::DefaultEmbeddingD< D > Class Template Reference

Embed a grid as an evenly spaced axis aligned grid. More...

#include <IMP/algebra/grid_embeddings.h>

+ Inheritance diagram for IMP::algebra::DefaultEmbeddingD< D >:

Detailed Description

template<int D>
class IMP::algebra::DefaultEmbeddingD< D >

Embed a grid as an evenly spaced axis aligned grid.

Definition at line 29 of file grid_embeddings.h.

Public Member Functions

 DefaultEmbeddingD (const VectorD< D > &origin, const VectorD< D > &cell)
 
unsigned int get_dimension () const
 
ExtendedGridIndexD< D > get_extended_index (const VectorD< D > &o) const
 Return the index that would contain the voxel if the grid extended there. More...
 
GridIndexD< D > get_index (const VectorD< D > &o) const
 
const VectorD< D > get_origin () const
 
const VectorD< D > & get_unit_cell () const
 Return the unit cell, relative to the origin. More...
 
void set_origin (const VectorD< D > &o)
 
void set_unit_cell (const VectorD< D > &o)
 
void show (std::ostream &out=std::cout) const
 

Center

Return the coordinates of the center of the voxel.

VectorD< D > get_center (const ExtendedGridIndexD< D > &ei) const
 
VectorD< D > get_center (const GridIndexD< D > &ei) const
 

Bounding box

Return the bounding box of the voxel.

BoundingBoxD< D > get_bounding_box (const ExtendedGridIndexD< D > &ei) const
 
BoundingBoxD< D > get_bounding_box (const GridIndexD< D > &ei) const
 

Member Function Documentation

template<int D>
ExtendedGridIndexD<D> IMP::algebra::DefaultEmbeddingD< D >::get_extended_index ( const VectorD< D > &  o) const

Return the index that would contain the voxel if the grid extended there.

For example vectors below the "lower left" corner of the grid have indexes with all negative components. This operation will always succeed.

Definition at line 93 of file grid_embeddings.h.

template<int D>
const VectorD<D>& IMP::algebra::DefaultEmbeddingD< D >::get_unit_cell ( ) const

Return the unit cell, relative to the origin.

That is, the unit cell is

BoundingBoxD<D>(get_zeros_vector_d<D>(),get_unit_cell());

Definition at line 87 of file grid_embeddings.h.


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