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::ZClippedWaterFilter Class Reference

Restrict waters to be within a given z-range. More...

#include <internal-water-filter.hpp>

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

Public Member Functions

 ZClippedWaterFilter (WaterFilterBase *p, const double zmin, const double zmax)
 
std::string name (void) const
 Just states the name of the filter/picker.
 
std::vector< int > filter (const loos::AtomicGroup &, const loos::AtomicGroup &)
 Given a molecule and a set of waters, pick which waters are inside.
 
std::vector< loos::GCoordboundingBox (const loos::AtomicGroup &)
 Calculate the appropriate bounding box (given the molecule)
 
double volume (void)
 Calculate the volume of the region we can pick waters from...
 
- Public Member Functions inherited from loos::DensityTools::WaterFilterDecorator
 WaterFilterDecorator (WaterFilterBase *p)
 

Additional Inherited Members

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

Detailed Description

Restrict waters to be within a given z-range.

Member Function Documentation

◆ boundingBox()

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

Calculate the appropriate bounding box (given the molecule)

Reimplemented from loos::DensityTools::WaterFilterDecorator.

◆ filter()

vector< int > loos::DensityTools::ZClippedWaterFilter::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)

Reimplemented from loos::DensityTools::WaterFilterDecorator.

◆ name()

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

Just states the name of the filter/picker.

Reimplemented from loos::DensityTools::WaterFilterDecorator.

◆ volume()

double loos::DensityTools::ZClippedWaterFilter::volume ( void )
inlinevirtual

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

Reimplemented from loos::DensityTools::WaterFilterDecorator.


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