LOOS 4.1.0
The Lightweight Object Oriented Structural analysis library/toolkit
Loading...
Searching...
No Matches
Public Member Functions | List of all members
loos::DensityTools::WaterFilterBox Class Reference

Pick waters inside a bounding box. More...

#include <internal-water-filter.hpp>

Inheritance diagram for loos::DensityTools::WaterFilterBox:
Inheritance graph
[legend]
Collaboration diagram for loos::DensityTools::WaterFilterBox:
Collaboration graph
[legend]

Public Member Functions

 WaterFilterBox (const double pad)
 
virtual std::vector< int > filter (const loos::AtomicGroup &, const loos::AtomicGroup &)
 Given a molecule and a set of waters, pick which waters are inside.
 
virtual std::vector< loos::GCoordboundingBox (const loos::AtomicGroup &)
 Calculate the appropriate bounding box (given the molecule)
 
virtual double volume (void)
 Calculate the volume of the region we can pick waters from...
 
virtual std::string name (void) const
 Just states the name of the filter/picker.
 

Additional Inherited Members

- Protected Attributes inherited from loos::DensityTools::WaterFilterBase
std::vector< loos::GCoordbdd_
 

Detailed Description

Pick waters inside a bounding box.

The bounding box is defined by the molecule. Any water that lies within that bounding box is then assumed to be internal. The bounding box size can be adjusted by a padding value.

Member Function Documentation

◆ boundingBox()

vector< GCoord > loos::DensityTools::WaterFilterBox::boundingBox ( const loos::AtomicGroup & )
virtual

Calculate the appropriate bounding box (given the molecule)

Implements loos::DensityTools::WaterFilterBase.

◆ filter()

vector< int > loos::DensityTools::WaterFilterBox::filter ( const loos::AtomicGroup & ,
const loos::AtomicGroup &  )
virtual

Given a molecule and a set of waters, pick which waters are inside.

The result is a map of which waters are inside (1 = inside, 0 = not)

Implements loos::DensityTools::WaterFilterBase.

◆ name()

string loos::DensityTools::WaterFilterBox::name ( void ) const
virtual

Just states the name of the filter/picker.

Implements loos::DensityTools::WaterFilterBase.

◆ volume()

double loos::DensityTools::WaterFilterBox::volume ( void )
virtual

Calculate the volume of the region we can pick waters from...

Implements loos::DensityTools::WaterFilterBase.


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