Rosetta
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
core::select::residue_selector::RandomResidueSelector Class Reference

The RandomResidueSelector returns a ResidueSubset, i.e. a utility::vector1< bool > containing 'true' for N randomly selected residue positions, where N is a user-specified integer. More...

#include <RandomResidueSelector.hh>

Inheritance diagram for core::select::residue_selector::RandomResidueSelector:
Inheritance graph
[legend]

Public Member Functions

 RandomResidueSelector ()
 
 RandomResidueSelector (ResidueSelectorCOP selector, Size const num_residues)
 
 RandomResidueSelector (ResidueSelectorCOP selector, Size const num_residues, bool const select_res_cluster, Real const distance_cutoff)
 
 ~RandomResidueSelector () override
 
ResidueSelectorOP clone () const override
 Clone operator. More...
 
ResidueSubset apply (core::pose::Pose const &pose) const override
 Return a ResidueSubset indicating a selection of Residues from the input Pose; the ResidueSubset is an array of booleans where a value of "true" for position i indicates that residue i is a part of the selected subset – and a value of "false" would indicate that it is not. More...
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data) override
 Initialize any data members of this instance from an input tag and a DataMap object. More...
 
std::string get_name () const override
 
- Public Member Functions inherited from core::select::residue_selector::ResidueSelector
 ResidueSelector ()
 Constructor. More...
 
 ~ResidueSelector () override
 Destructor. More...
 
utility::vector1< core::Sizeselection_positions (core::pose::Pose const &pose) const
 Calls apply and returns the Rosetta numbering corresponding to the selected residues. More...
 
virtual void provide_citation_info (basic::citation_manager::CitationCollectionList &) const
 Provide citations to the passed CitationCollectionList Subclasses should add the info for themselves and any other classes they use. More...
 

Static Public Member Functions

static std::string class_name ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 

Private Member Functions

ResidueSubset subset_from_randomized_vector (core::pose::Pose const &pose, ResidueVector const &random_order_residue_set) const
 

Private Attributes

ResidueSelectorCOP selector_
 
Size num_residues_
 
bool select_res_cluster_
 
Real distance_cutoff_
 

Detailed Description

The RandomResidueSelector returns a ResidueSubset, i.e. a utility::vector1< bool > containing 'true' for N randomly selected residue positions, where N is a user-specified integer.

Constructor & Destructor Documentation

◆ RandomResidueSelector() [1/3]

core::select::residue_selector::RandomResidueSelector::RandomResidueSelector ( )

◆ RandomResidueSelector() [2/3]

core::select::residue_selector::RandomResidueSelector::RandomResidueSelector ( ResidueSelectorCOP  selector,
Size const  num_residues 
)

◆ RandomResidueSelector() [3/3]

core::select::residue_selector::RandomResidueSelector::RandomResidueSelector ( ResidueSelectorCOP  selector,
Size const  num_residues,
bool const  select_res_cluster,
Real const  distance_cutoff 
)

◆ ~RandomResidueSelector()

core::select::residue_selector::RandomResidueSelector::~RandomResidueSelector ( )
overridedefault

Member Function Documentation

◆ apply()

ResidueSubset core::select::residue_selector::RandomResidueSelector::apply ( core::pose::Pose const &  pose) const
overridevirtual

Return a ResidueSubset indicating a selection of Residues from the input Pose; the ResidueSubset is an array of booleans where a value of "true" for position i indicates that residue i is a part of the selected subset – and a value of "false" would indicate that it is not.

Implements core::select::residue_selector::ResidueSelector.

References core::scoring::rg, selector_, and subset_from_randomized_vector().

◆ class_name()

std::string core::select::residue_selector::RandomResidueSelector::class_name ( )
static

◆ clone()

ResidueSelectorOP core::select::residue_selector::RandomResidueSelector::clone ( ) const
overridevirtual

Clone operator.

Copy this object and return an owning pointer to the new object.

Implements core::select::residue_selector::ResidueSelector.

◆ get_name()

std::string core::select::residue_selector::RandomResidueSelector::get_name ( ) const
overridevirtual

◆ parse_my_tag()

void core::select::residue_selector::RandomResidueSelector::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap datacache 
)
overridevirtual

Initialize any data members of this instance from an input tag and a DataMap object.

Noop implementation in the base class in the case that a derived class has no need to read data from an input tag

Reimplemented from core::select::residue_selector::ResidueSelector.

References distance_cutoff_, core::select::residue_selector::get_residue_selector(), num_residues_, select_res_cluster_, selector_, and core::select::residue_selector::TR().

◆ provide_xml_schema()

void core::select::residue_selector::RandomResidueSelector::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static

◆ subset_from_randomized_vector()

ResidueSubset core::select::residue_selector::RandomResidueSelector::subset_from_randomized_vector ( core::pose::Pose const &  pose,
ResidueVector const &  random_order_residue_set 
) const
private

Member Data Documentation

◆ distance_cutoff_

Real core::select::residue_selector::RandomResidueSelector::distance_cutoff_
private

◆ num_residues_

Size core::select::residue_selector::RandomResidueSelector::num_residues_
private

◆ select_res_cluster_

bool core::select::residue_selector::RandomResidueSelector::select_res_cluster_
private

◆ selector_

ResidueSelectorCOP core::select::residue_selector::RandomResidueSelector::selector_
private

Referenced by apply(), and parse_my_tag().


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