#include <ScoreCutoffFilter.hh>

Public Types
typedef protocols::filters::Filter	parent

Public Member Functions
	ScoreCutoffFilter ()
	c-tor and More...

	ScoreCutoffFilter (core::Real cutoff_in)

filters::FilterOP	clone () const

filters::FilterOP	fresh_instance () const

virtual void	report (std::ostream &ostr, core::pose::Pose const &pose) const

void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &, filters::Filters_map const &, protocols::moves::Movers_map const &, core::pose::Pose const &)

virtual bool	apply (core::pose::Pose const &pose) const
	Returns true if the given pose passes the filter, false otherwise. In this case, the test is the result of the following comparison: sc <= cutoff Where cutoff is the cutoff set for this filter, and sc is the value of the ScoreType from the Pose Energies object. More...

void	set_cutoff (core::Real cutoff_in)

void	set_cutoff (core::pose::Pose const &pose)

core::Real	cutoff () const

void	add_score_type (core::scoring::ScoreType scotype)

void	set_score_type (core::scoring::ScoreType scotype)

void	set_positions (utility::vector1< core::Size > const &positions)

void	set_unweighted (bool init)

core::Real	get_score (core::pose::Pose const &pose) const

virtual std::string	name () const

void	output_residue_pair_energies (std::ostream &ostr, core::pose::Pose const &pose) const

Public Member Functions inherited from protocols::filters::Filter
	Filter ()

	Filter (std::string const &)

	Filter (Filter const &)

virtual	~Filter ()

virtual core::Real	report_sm (core::pose::Pose const &) const
	used to report filter internals through a score or silent file More...

virtual std::string	get_type () const

std::string	get_user_defined_name () const

void	set_user_defined_name (std::string const &name)

virtual void	clear ()
	used to clear internal variables if needed. Using fresh_instance is preferred since it's a pure virtual More...

virtual void	apply (core::io::serialization::PipeMap &pmap)

virtual void	score (core::io::serialization::PipeMap &pmap)

virtual core::Real	score (core::pose::Pose &pose)

virtual void	parse_def (utility::lua::LuaObject const &def, utility::lua::LuaObject const &score_fxns, utility::lua::LuaObject const &tasks)

Private Attributes
core::Real	cutoff_

bool	report_residue_pair_energies_

utility::vector1 < core::scoring::ScoreType >	score_types_

utility::vector1< core::Size >	positions_

bool	total_score_

bool	unweighted_

Additional Inherited Members
Protected Attributes inherited from protocols::filters::Filter
std::string	scorename_

Member Typedef Documentation

typedef protocols::filters::Filter protocols::simple_filters::ScoreCutoffFilter::parent

Constructor & Destructor Documentation

protocols::simple_filters::ScoreCutoffFilter::ScoreCutoffFilter ( )

c-tor and

References positions_, score_types_, and core::scoring::total_score.

Referenced by clone(), protocols::simple_filters::ScoreCutoffFilterCreator::create_filter(), and fresh_instance().

protocols::simple_filters::ScoreCutoffFilter::ScoreCutoffFilter ( core::Real cutoff_in )

References positions_, score_types_, and core::scoring::total_score.

Member Function Documentation

void protocols::simple_filters::ScoreCutoffFilter::add_score_type ( core::scoring::ScoreType scotype )

References score_types_, total_score, total_score_, and protocols::simple_filters::tr.

Referenced by set_score_type().

bool protocols::simple_filters::ScoreCutoffFilter::apply ( core::pose::Pose const & pose ) const

virtual

Returns true if the given pose passes the filter, false otherwise. In this case, the test is the result of the following comparison: sc <= cutoff Where cutoff is the cutoff set for this filter, and sc is the value of the ScoreType from the Pose Energies object.

Implements protocols::filters::Filter.

References cutoff(), and get_score().

Referenced by protocols::docking::DockingHighResFilter::apply().

filters::FilterOP protocols::simple_filters::ScoreCutoffFilter::clone ( ) const

inlinevirtual

Implements protocols::filters::Filter.

References ScoreCutoffFilter().

core::Real protocols::simple_filters::ScoreCutoffFilter::cutoff ( ) const

inline

References cutoff_.

Referenced by apply(), and protocols::docking::DockingHighResFilter::set_score_margin().

filters::FilterOP protocols::simple_filters::ScoreCutoffFilter::fresh_instance ( ) const

inlinevirtual

Implements protocols::filters::Filter.

References ScoreCutoffFilter().

core::Real protocols::simple_filters::ScoreCutoffFilter::get_score ( core::pose::Pose const & pose ) const

References core::pose::Pose::energies(), positions_, core::scoring::Energies::residue_total_energies(), score_types_, core::scoring::EMapVector::sum(), core::scoring::Energies::total_energies(), total_score, total_score_, unweighted_, and core::scoring::Energies::weights().

Referenced by apply(), protocols::enzdes::EnzdesFlexBBProtocol::generate_ensemble_for_region(), and set_cutoff().

virtual std::string protocols::simple_filters::ScoreCutoffFilter::name ( ) const

inlinevirtual

Reimplemented from protocols::filters::Filter.

void protocols::simple_filters::ScoreCutoffFilter::output_residue_pair_energies	(	std::ostream &	ostr,
		core::pose::Pose const &	pose
	)		const

References core::pose::Pose::energies(), core::scoring::Energies::energy_graph(), core::scoring::Energies::long_range_container(), n_score_types, n_shortranged_2b_score_types, core::chemical::ResidueType::name1(), name_from_score_type(), core::pose::Pose::residue_type(), protocols::filters::Filter::score(), utility::to_string(), core::pose::Pose::total_residue(), weights, and core::scoring::Energies::weights().

Referenced by report().

void protocols::simple_filters::ScoreCutoffFilter::parse_my_tag	(	utility::tag::TagCOP	tag,
		basic::datacache::DataMap &	,
		filters::Filters_map const &	,
		protocols::moves::Movers_map const &	,
		core::pose::Pose const &
	)

virtual

Reimplemented from protocols::filters::Filter.

References cutoff_, and report_residue_pair_energies_.

void protocols::simple_filters::ScoreCutoffFilter::report	(	std::ostream &	ostr,
		core::pose::Pose const &	pose
	)		const

virtual

Reimplemented from protocols::filters::Filter.

References cutoff_, core::pose::Pose::energies(), output_residue_pair_energies(), report_residue_pair_energies_, score_types_, core::scoring::EMapVector::sum(), and core::scoring::Energies::total_energies().

void protocols::simple_filters::ScoreCutoffFilter::set_cutoff ( core::Real cutoff_in )

inline

References cutoff_.

Referenced by protocols::docking::DockingHighResFilter::DockingHighResFilter(), protocols::enzdes::EnzdesFlexBBProtocol::generate_ensemble_for_region(), protocols::docking::DockingHighResFilter::set_score_cutoff(), protocols::docking::DockingHighResFilter::set_score_margin(), and protocols::docking::DockingLowResFilter::set_use_constraints().

void protocols::simple_filters::ScoreCutoffFilter::set_cutoff ( core::pose::Pose const & pose )

inline

References cutoff_, and get_score().

void protocols::simple_filters::ScoreCutoffFilter::set_positions ( utility::vector1< core::Size > const & positions )

inline

References positions_.

Referenced by protocols::enzdes::EnzdesFlexBBProtocol::generate_ensemble_for_region().

void protocols::simple_filters::ScoreCutoffFilter::set_score_type ( core::scoring::ScoreType scotype )

References add_score_type(), and score_types_.

Referenced by protocols::docking::DockingHighResFilter::DockingHighResFilter(), protocols::enzdes::EnzdesFlexBBProtocol::generate_ensemble_for_region(), and protocols::docking::DockingLowResFilter::set_use_constraints().

void protocols::simple_filters::ScoreCutoffFilter::set_unweighted ( bool init )

inline

References protocols::init::init(), and unweighted_.

Referenced by protocols::docking::DockingLowResFilter::set_use_constraints().

Member Data Documentation

core::Real protocols::simple_filters::ScoreCutoffFilter::cutoff_

private

Referenced by cutoff(), parse_my_tag(), report(), and set_cutoff().

utility::vector1< core::Size > protocols::simple_filters::ScoreCutoffFilter::positions_

private

Referenced by get_score(), ScoreCutoffFilter(), and set_positions().

bool protocols::simple_filters::ScoreCutoffFilter::report_residue_pair_energies_

private

Referenced by parse_my_tag(), and report().

utility::vector1< core::scoring::ScoreType > protocols::simple_filters::ScoreCutoffFilter::score_types_

private

Referenced by add_score_type(), get_score(), report(), ScoreCutoffFilter(), and set_score_type().

bool protocols::simple_filters::ScoreCutoffFilter::total_score_

private

Referenced by add_score_type(), and get_score().

bool protocols::simple_filters::ScoreCutoffFilter::unweighted_

private

Referenced by get_score(), and set_unweighted().

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

symlinks/rosetta/src/protocols/simple_filters/ScoreCutoffFilter.hh
symlinks/rosetta/src/protocols/simple_filters/ScoreCutoffFilter.cc

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation