holds particular score components, weights and calculates the total score for a fragment candidate More...

#include <FragmentScoreManager.hh>

Inheritance diagram for protocols::frag_picker::scores::FragmentScoreManager:

Collaboration diagram for protocols::frag_picker::scores::FragmentScoreManager:

Public Member Functions
virtual	~FragmentScoreManager ()
	Automatically generated virtual destructor for class deriving directly from ReferenceCount. More...

	FragmentScoreManager ()
	creates an empty manager More...

FragmentScoreMapOP	create_empty_map ()
	creates an empty score map More...

void	add_scoring_method (FragmentScoringMethodOP, Real)
	registers a new scoring method in this manager More...

Size	count_components ()
	says how many scoring methods have already been registered More...

FragmentScoringMethodOP	get_component (Size index)
	Returns a desired scoring method. More...

utility::vector1< Real >	get_weights ()
	returns a vector of weights that are used to compute the total score More...

void	show_scoring_methods (std::ostream &out)
	prints a nice table showing the registered scores More...

Real	total_score (FragmentScoreMapOP)
	calculates the total score More...

virtual bool	score_fragment_from_cache (FragmentCandidateOP, FragmentScoreMapOP)
	calculates all the small scores for a given fragment More...

virtual bool	score_fragment (FragmentCandidateOP, FragmentScoreMapOP)
	calculates all the small scores for a given fragment More...

void	use_late_scoring_for_zeros (const bool if_true)
	those score metohods that have weight = 0.0 will be computed after the fragments are picked More...

bool	if_late_scoring_for_zeros ()
	says if late scoring is used or not More...

bool	score_zero_scores (FragmentCandidateOP, FragmentScoreMapOP)
	calculates all these small scores for a given fragment whose weight is 0.0 More...

void	register_score_maker (MakeFragmentScoringMethodOP)
	registers a maker object that will be used to create a scoring method object More...

void	create_scoring_method (std::string const &, Size, Real, Real, bool, FragmentPickerOP, std::string)
	creates a new scoring method object More...

void	create_scores (std::string const &, FragmentPickerOP)
	reads a config file and creates scoring methods More...

void	do_caching (VallChunkOP chunk)
	calls do_caching() for each FragmentScoringMethod object, if it is possible More...

void	clean_up ()
	calls clean_up() for each FragmentScoringMethod object, if it is possible More...

void	set_width (FragmentScoringMethodOP which_score, Size width)
	sets up a new number of characters spend to print fragment score value More...

void	set_precision (FragmentScoringMethodOP which_score, Size precision)
	sets up a new precision used to print fragment score value More...

virtual void	describe_fragments (utility::vector1< std::pair< FragmentCandidateOP, scores::FragmentScoreMapOP > > const &, std::ostream &)
	prints a flat table with all scores for all the fragments in a given vector More...

Public Attributes
Size	default_width_
	default width used to print a score value, equal to 6 More...

Size	default_precision_
	default precision used to print a score value, equal to 1 More...

Static Public Attributes
static const Size	TOTAL_PRECISION = 3
	precision used to display the total score for each fragment More...

Protected Attributes
utility::vector1 < FragmentScoringMethodOP >	scores_

std::map < FragmentScoringMethodOP, Size >	width_

std::map < FragmentScoringMethodOP, Size >	precision_

Private Attributes
utility::vector1< Real >	score_weights_

std::map< std::string, MakeFragmentScoringMethodOP >	registered_makers_

bool	zeros_score_later_

Detailed Description

holds particular score components, weights and calculates the total score for a fragment candidate

Detailed: a fragment picker object needs exactly one fragment manager to pick fragments. Adding new scoring methods: is supposed to be done FragmentPicker, which calls proper method from this class.

Definition at line 42 of file FragmentScoreManager.hh.

Constructor & Destructor Documentation

protocols::frag_picker::scores::FragmentScoreManager::~FragmentScoreManager ( )

virtual

Automatically generated virtual destructor for class deriving directly from ReferenceCount.

Auto-generated virtual destructor

Definition at line 84 of file FragmentScoreManager.cc.

protocols::frag_picker::scores::FragmentScoreManager::FragmentScoreManager ( )

creates an empty manager

Definition at line 287 of file FragmentScoreManager.cc.

References default_precision_, default_width_, register_score_maker(), and zeros_score_later_.

Member Function Documentation

void protocols::frag_picker::scores::FragmentScoreManager::add_scoring_method	(	FragmentScoringMethodOP	scoring_term,
		Real	weight
	)

registers a new scoring method in this manager

Definition at line 99 of file FragmentScoreManager.cc.

References default_precision_, default_width_, precision_, score_weights_, scores_, protocols::frag_picker::scores::sort_scores(), and width_.

Referenced by create_scoring_method().

void protocols::frag_picker::scores::FragmentScoreManager::clean_up ( )

calls clean_up() for each FragmentScoringMethod object, if it is possible

Detailed: FragmentPicker calls this method when a given chunk has been processed

Definition at line 153 of file FragmentScoreManager.cc.

References scores_.

Size protocols::frag_picker::scores::FragmentScoreManager::count_components ( )

inline

says how many scoring methods have already been registered

Definition at line 65 of file FragmentScoreManager.hh.

References scores_.

FragmentScoreMapOP protocols::frag_picker::scores::FragmentScoreManager::create_empty_map ( )

creates an empty score map

Detailed: this is the recommended way to create FragmentScoreMap objects since FragmentScoreManager knows exactly: what is the correct size of the map i.e. how many scoring terms have been registered.

Definition at line 89 of file FragmentScoreManager.cc.

References score_weights_.

void protocols::frag_picker::scores::FragmentScoreManager::create_scores	(	std::string const &	file_name,
		FragmentPickerOP	picker
	)

reads a config file and creates scoring methods

Definition at line 353 of file FragmentScoreManager.cc.

References create_scoring_method().

void protocols::frag_picker::scores::FragmentScoreManager::create_scoring_method	(	std::string const &	score_name,
		Size	priority,
		Real	weight,
		Real	lowest,
		bool	use_lowest,
		FragmentPickerOP	picker,
		std::string	config_line
	)

creates a new scoring method object

Definition at line 338 of file FragmentScoreManager.cc.

References add_scoring_method(), and registered_makers_.

Referenced by create_scores().

void protocols::frag_picker::scores::FragmentScoreManager::describe_fragments	(	utility::vector1< std::pair< FragmentCandidateOP, scores::FragmentScoreMapOP > > const &	,
		std::ostream &
	)

virtual

prints a flat table with all scores for all the fragments in a given vector

Reimplemented in protocols::frag_picker::scores::PValuedFragmentScoreManager.

Definition at line 175 of file FragmentScoreManager.cc.

References precision_, scores_, TOTAL_PRECISION, total_score(), protocols::frag_picker::scores::tr(), and width_.

void protocols::frag_picker::scores::FragmentScoreManager::do_caching ( VallChunkOP chunk)

calls do_caching() for each FragmentScoringMethod object, if it is possible

Detailed: FragmentPicker calls this method when a new chunk is to be processed

Definition at line 142 of file FragmentScoreManager.cc.

References score_weights_, scores_, and zeros_score_later_.

FragmentScoringMethodOP protocols::frag_picker::scores::FragmentScoreManager::get_component ( Size index)

inline

Returns a desired scoring method.

Detailed: Allowed index values are [1,count_components()]

Definition at line 71 of file FragmentScoreManager.hh.

References scores_.

utility::vector1<Real> protocols::frag_picker::scores::FragmentScoreManager::get_weights ( )

inline

returns a vector of weights that are used to compute the total score

Definition at line 77 of file FragmentScoreManager.hh.

References score_weights_.

bool protocols::frag_picker::scores::FragmentScoreManager::if_late_scoring_for_zeros ( )

inline

says if late scoring is used or not

late scoring means that some scores (those with weight=0, such as crmsd) are evaluated only for the selected fragments rather than for all the candidates

Definition at line 107 of file FragmentScoreManager.hh.

References zeros_score_later_.

void protocols::frag_picker::scores::FragmentScoreManager::register_score_maker ( MakeFragmentScoringMethodOP scoring_term_maker)

registers a maker object that will be used to create a scoring method object

Definition at line 281 of file FragmentScoreManager.cc.

References registered_makers_.

Referenced by FragmentScoreManager().

bool protocols::frag_picker::scores::FragmentScoreManager::score_fragment	(	FragmentCandidateOP	candidate,
		FragmentScoreMapOP	empty_map
	)

virtual

calculates all the small scores for a given fragment

results are properly stored inside a FragmentScoreMap object

Reimplemented in protocols::frag_picker::scores::PValuedFragmentScoreManager.

Definition at line 237 of file FragmentScoreManager.cc.

References score_weights_, scores_, and zeros_score_later_.

Referenced by protocols::frag_picker::scores::PValuedFragmentScoreManager::score_fragment().

bool protocols::frag_picker::scores::FragmentScoreManager::score_fragment_from_cache	(	FragmentCandidateOP	candidate,
		FragmentScoreMapOP	empty_map
	)

virtual

calculates all the small scores for a given fragment

results are properly stored inside a FragmentScoreMap object

Reimplemented in protocols::frag_picker::scores::PValuedFragmentScoreManager.

Definition at line 261 of file FragmentScoreManager.cc.

References score_weights_, scores_, and zeros_score_later_.

Referenced by protocols::frag_picker::scores::PValuedFragmentScoreManager::score_fragment_from_cache().

bool protocols::frag_picker::scores::FragmentScoreManager::score_zero_scores	(	FragmentCandidateOP	candidate,
		FragmentScoreMapOP	empty_map
	)

calculates all these small scores for a given fragment whose weight is 0.0

Detailed: When use_late_scoring_for_zeros() was used to set the flag to true,: all fragment scoring methods neglects zero-weighted scores. These will be evaluated by this function, that may be called after fragments are picked. This way some time consuming computations (e.g. crmsd for fragments) may be computed only for the selected fragments rather than for all of them

Definition at line 249 of file FragmentScoreManager.cc.

References score_weights_, and scores_.

void protocols::frag_picker::scores::FragmentScoreManager::set_precision	(	FragmentScoringMethodOP	which_score,
		Size	precision
	)

inline

sets up a new precision used to print fragment score value

Definition at line 143 of file FragmentScoreManager.hh.

References core::io::raw_data::precision(), and precision_.

void protocols::frag_picker::scores::FragmentScoreManager::set_width	(	FragmentScoringMethodOP	which_score,
		Size	width
	)

inline

sets up a new number of characters spend to print fragment score value

Definition at line 138 of file FragmentScoreManager.hh.

References width_.

void protocols::frag_picker::scores::FragmentScoreManager::show_scoring_methods ( std::ostream & out)

prints a nice table showing the registered scores

Detailed: the table shows also the order in which the scores are evaluated

Definition at line 163 of file FragmentScoreManager.cc.

References score_weights_, and scores_.

Real protocols::frag_picker::scores::FragmentScoreManager::total_score ( FragmentScoreMapOP f)

calculates the total score

Definition at line 125 of file FragmentScoreManager.cc.

References score_weights_.

Referenced by protocols::frag_picker::scores::PValuedFragmentScoreManager::describe_fragments(), and describe_fragments().

void protocols::frag_picker::scores::FragmentScoreManager::use_late_scoring_for_zeros ( const bool if_true)

inline

those score metohods that have weight = 0.0 will be computed after the fragments are picked

Detailed: if weight for a score is 0.0 than it does not affect the total score and thus has no: effect on fragments sorting, quota, etc. Such scores may be computed after fragment picking is finished

Definition at line 100 of file FragmentScoreManager.hh.

References zeros_score_later_.