Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
protocols::match::downstream::RigidLigandBuilder Class Reference

#include <RigidLigandBuilder.hh>

Inheritance diagram for protocols::match::downstream::RigidLigandBuilder:
Inheritance graph
[legend]

Public Types

typedef DownstreamBuilder parent
 
- Public Types inherited from protocols::match::downstream::DownstreamBuilder
typedef utility::VirtualBase parent
 
typedef core::id::AtomID AtomID
 
typedef core::Vector Vector
 
typedef core::Real Real
 
typedef
numeric::HomogeneousTransform
< Real
HTReal
 

Public Member Functions

 RigidLigandBuilder ()
 
 RigidLigandBuilder (RigidLigandBuilder const &)
 
 ~RigidLigandBuilder () override
 
DownstreamBuilderOP clone () const override
 
std::list< Hitbuild (HTReal const &atom3_frame, core::Size const scaffold_build_point_id, core::Size const upstream_conf_id, core::Size const external_geometry_id, core::conformation::Residue const &upstream_residue) const override
 
void set_bb_grid (BumpGridCOP bbgrid) override
 
bool hits_potentially_incompatible () const override
 In case downstream builders can return hits that are incompatible with each other (e.g. different ligand conformations ) the matcher needs to know about this to allow for speedy match enumeration. More...
 
bool compatible (Hit const &my_hit, DownstreamBuilder const &other, Hit const &other_hit, bool first_dispatch=true) const override
 
bool compatible (Hit const &my_hit, RigidLigandBuilder const &other, Hit const &other_hit, bool first_dispatch=true) const override
 
void require_atom_to_reside_in_active_site (core::id::AtomID const &id) override
 
ProbeRadius atom1_radius () const override
 
ProbeRadius atom2_radius () const override
 
ProbeRadius atom3_radius () const override
 
bool atom1_belongs_in_active_site () const override
 
bool atom2_belongs_in_active_site () const override
 
bool atom3_belongs_in_active_site () const override
 
Real atom1_atom2_distance () const override
 
Real atom2_atom3_distance () const override
 
Real atom1_atom2_atom3_angle () const override
 Returns an angle in degrees between the three downstream atoms. More...
 
void coordinates_from_hit (Hit const &hit, utility::vector1< AtomID > const &atom_indices, utility::vector1< Vector > &atom_coords) const override
 
core::pose::PoseCOP downstream_pose_from_hit (Hit const &hit) const override
 
core::Size n_possible_hits_per_at3frame () const override
 
toolbox::match_enzdes_util::LigandConformerOP get_lig_conformers (core::Size conf_id) const override
 
core::chemical::ResidueTypeCOP get_upstream_restype () const override
 
void initialize_from_residue (core::Size atom1, core::Size atom2, core::Size atom3, core::Size orientation_atom1, core::Size orientation_atom2, core::Size orientation_atom3, core::conformation::Residue const &residue)
 Specify the residue, with coordinates, that's being used as the downstream partner. This class is meant to be used in conjuction with the ClassicMatchAglrotihm, and therefore the initialization routines are specific for that algorithm. In this initialization function, one must list atoms "D1, D2 and D3" in the convention of describing the rigid-body orientation between three atoms of the upstream partner (atoms U3, U2 & U1) and three atoms of the downstream partner (atoms D1, D2 & D3) in terms of 2 angles, 1 distance, and 3 dihedrals. The user must also list the 3 atoms used to define the orientation frame of the downstream ligand. It is essential to the matching algorithm that the same three orientation atoms are used for all RigidLigandBuilders. More...
 
void initialize_upstream_residue (core::chemical::ResidueTypeCOP upstream_res, core::scoring::etable::count_pair::CountPairFunctionCOP count_pair=nullptr)
 
void ignore_h_collisions (bool setting)
 
- Public Member Functions inherited from protocols::match::downstream::DownstreamBuilder
 DownstreamBuilder ()
 
 DownstreamBuilder (DownstreamBuilder const &)
 
 ~DownstreamBuilder () override
 
void set_occupied_space_hash (OccupiedSpaceHashCOP occ_space)
 
void set_active_site_grid (ActiveSiteGridCOP active_site_grid)
 
virtual bool compatible (Hit const &my_hit, LigandConformerBuilder const &other, Hit const &other_hit, bool first_dispatch=true) const
 

Private Member Functions

void initialize_upstream_nonbonded_min_separation_d2 ()
 

Private Attributes

core::chemical::ResidueTypeCOP downstream_restype_
 
core::chemical::ResidueTypeCOP upstream_restype_
 
bool ignore_h_collisions_
 
utility::fixedsizearray1
< core::Size, 3 > 
orientation_atoms_
 
utility::fixedsizearray1
< core::Size, 3 > 
atoms_123_
 
utility::fixedsizearray1
< ProbeRadius, 3 > 
radii_123_
 
utility::fixedsizearray1< bool, 3 > ats123_reqd_in_active_site_
 
utility::vector1< ProbeRadiusatom_radii_
 
utility::vector1< boolatom_required_in_active_site_
 
utility::vector1< core::Sizenon_collision_detection_atoms_reqd_in_active_site_
 
utility::vector1
< toolbox::match_enzdes_util::LigandConformerOP
lig_conformers_
 
utility::vector1
< utility::vector1< std::pair
< core::Size, Real > > > 
min_sep_d2_from_upstream_atoms_
 

Additional Inherited Members

- Protected Member Functions inherited from protocols::match::downstream::DownstreamBuilder
bool bbgrid_set () const
 
BumpGrid const & bbgrid () const
 
bool occ_space_set () const
 
OccupiedSpaceHash const & occ_space () const
 
bool active_site_grid_set () const
 
ActiveSiteGrid const & active_site_grid () const
 

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::match::downstream::RigidLigandBuilder::RigidLigandBuilder ( )
protocols::match::downstream::RigidLigandBuilder::RigidLigandBuilder ( RigidLigandBuilder const &  other)

References lig_conformers_.

protocols::match::downstream::RigidLigandBuilder::~RigidLigandBuilder ( )
overridedefault

Member Function Documentation

RigidLigandBuilder::Real protocols::match::downstream::RigidLigandBuilder::atom1_atom2_atom3_angle ( ) const
overridevirtual

Returns an angle in degrees between the three downstream atoms.

Implements protocols::match::downstream::DownstreamBuilder.

References downstream_restype_, and lig_conformers_.

RigidLigandBuilder::Real protocols::match::downstream::RigidLigandBuilder::atom1_atom2_distance ( ) const
overridevirtual
bool protocols::match::downstream::RigidLigandBuilder::atom1_belongs_in_active_site ( ) const
overridevirtual
ProbeRadius protocols::match::downstream::RigidLigandBuilder::atom1_radius ( ) const
overridevirtual
RigidLigandBuilder::Real protocols::match::downstream::RigidLigandBuilder::atom2_atom3_distance ( ) const
overridevirtual
bool protocols::match::downstream::RigidLigandBuilder::atom2_belongs_in_active_site ( ) const
overridevirtual
ProbeRadius protocols::match::downstream::RigidLigandBuilder::atom2_radius ( ) const
overridevirtual
bool protocols::match::downstream::RigidLigandBuilder::atom3_belongs_in_active_site ( ) const
overridevirtual
ProbeRadius protocols::match::downstream::RigidLigandBuilder::atom3_radius ( ) const
overridevirtual
std::list< Hit > protocols::match::downstream::RigidLigandBuilder::build ( HTReal const &  atom3_frame,
core::Size const  scaffold_build_point_id,
core::Size const  upstream_conf_id,
core::Size const  external_geometry_id,
core::conformation::Residue const &  upstream_residue 
) const
overridevirtual
DownstreamBuilderOP protocols::match::downstream::RigidLigandBuilder::clone ( ) const
overridevirtual
bool protocols::match::downstream::RigidLigandBuilder::compatible ( Hit const &  my_hit,
DownstreamBuilder const &  other,
Hit const &  other_hit,
bool  first_dispatch = true 
) const
overridevirtual
bool protocols::match::downstream::RigidLigandBuilder::compatible ( Hit const &  my_hit,
RigidLigandBuilder const &  other,
Hit const &  other_hit,
bool  first_dispatch = true 
) const
overridevirtual

RigidLigandBuilder hits are always compatible, because there is only one ligand conformation.

Reimplemented from protocols::match::downstream::DownstreamBuilder.

void protocols::match::downstream::RigidLigandBuilder::coordinates_from_hit ( Hit const &  hit,
utility::vector1< AtomID > const &  atom_indices,
utility::vector1< Vector > &  atom_coords 
) const
overridevirtual
core::pose::PoseCOP protocols::match::downstream::RigidLigandBuilder::downstream_pose_from_hit ( Hit const &  hit) const
overridevirtual
toolbox::match_enzdes_util::LigandConformerOP protocols::match::downstream::RigidLigandBuilder::get_lig_conformers ( core::Size  conf_id) const
overridevirtual
core::chemical::ResidueTypeCOP protocols::match::downstream::RigidLigandBuilder::get_upstream_restype ( ) const
overridevirtual
bool protocols::match::downstream::RigidLigandBuilder::hits_potentially_incompatible ( ) const
inlineoverridevirtual

In case downstream builders can return hits that are incompatible with each other (e.g. different ligand conformations ) the matcher needs to know about this to allow for speedy match enumeration.

Implements protocols::match::downstream::DownstreamBuilder.

void protocols::match::downstream::RigidLigandBuilder::ignore_h_collisions ( bool  setting)
void protocols::match::downstream::RigidLigandBuilder::initialize_from_residue ( core::Size  atom1,
core::Size  atom2,
core::Size  atom3,
core::Size  orientation_atom1,
core::Size  orientation_atom2,
core::Size  orientation_atom3,
core::conformation::Residue const &  residue 
)

Specify the residue, with coordinates, that's being used as the downstream partner. This class is meant to be used in conjuction with the ClassicMatchAglrotihm, and therefore the initialization routines are specific for that algorithm. In this initialization function, one must list atoms "D1, D2 and D3" in the convention of describing the rigid-body orientation between three atoms of the upstream partner (atoms U3, U2 & U1) and three atoms of the downstream partner (atoms D1, D2 & D3) in terms of 2 angles, 1 distance, and 3 dihedrals. The user must also list the 3 atoms used to define the orientation frame of the downstream ligand. It is essential to the matching algorithm that the same three orientation atoms are used for all RigidLigandBuilders.

References core::conformation::Residue::atom(), atom_radii_, atom_required_in_active_site_, core::conformation::Residue::atom_type(), atoms_123_, downstream_restype_, core::chemical::AtomType::element(), ignore_h_collisions_, lig_conformers_, core::conformation::Residue::natoms(), orientation_atoms_, protocols::match::probe_radius_for_atom_type(), radii_123_, core::conformation::Atom::type(), core::conformation::Residue::type_ptr(), and protocols::match::ZERO.

void protocols::match::downstream::RigidLigandBuilder::initialize_upstream_nonbonded_min_separation_d2 ( )
private
void protocols::match::downstream::RigidLigandBuilder::initialize_upstream_residue ( core::chemical::ResidueTypeCOP  upstream_res,
core::scoring::etable::count_pair::CountPairFunctionCOP  count_pair = nullptr 
)
core::Size protocols::match::downstream::RigidLigandBuilder::n_possible_hits_per_at3frame ( ) const
overridevirtual
void protocols::match::downstream::RigidLigandBuilder::require_atom_to_reside_in_active_site ( core::id::AtomID const &  id)
overridevirtual
void protocols::match::downstream::RigidLigandBuilder::set_bb_grid ( BumpGridCOP  bbgrid)
overridevirtual

Member Data Documentation

utility::vector1< ProbeRadius > protocols::match::downstream::RigidLigandBuilder::atom_radii_
private
utility::vector1< bool > protocols::match::downstream::RigidLigandBuilder::atom_required_in_active_site_
private
utility::fixedsizearray1< core::Size, 3 > protocols::match::downstream::RigidLigandBuilder::atoms_123_
private
utility::fixedsizearray1< bool, 3 > protocols::match::downstream::RigidLigandBuilder::ats123_reqd_in_active_site_
private
core::chemical::ResidueTypeCOP protocols::match::downstream::RigidLigandBuilder::downstream_restype_
private
bool protocols::match::downstream::RigidLigandBuilder::ignore_h_collisions_
private
utility::vector1< toolbox::match_enzdes_util::LigandConformerOP > protocols::match::downstream::RigidLigandBuilder::lig_conformers_
private
utility::vector1< utility::vector1< std::pair< core::Size, Real > > > protocols::match::downstream::RigidLigandBuilder::min_sep_d2_from_upstream_atoms_
private

Detect collision between the upstream residue (sidechain?!) conformation and the atoms of the downstream residue

Referenced by build(), initialize_upstream_nonbonded_min_separation_d2(), and initialize_upstream_residue().

utility::vector1< core::Size > protocols::match::downstream::RigidLigandBuilder::non_collision_detection_atoms_reqd_in_active_site_
private
utility::fixedsizearray1< core::Size, 3 > protocols::match::downstream::RigidLigandBuilder::orientation_atoms_
private

The indices of the three atoms defining the orientation of the ligand in the global coordinate frame These indices are in the restype indexing of atoms.

Referenced by initialize_from_residue().

utility::fixedsizearray1< ProbeRadius, 3 > protocols::match::downstream::RigidLigandBuilder::radii_123_
private
core::chemical::ResidueTypeCOP protocols::match::downstream::RigidLigandBuilder::upstream_restype_
private

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