 |
|
IMP Reference Guide
2.11.1
The Integrative Modeling Platform
|
#include <IMP/em2d/Fine2DRegistrationRestraint.h>
Inheritance diagram for IMP::em2d::Fine2DRegistrationRestraint:Performs the fine search for the registration values in order to register a model projection with an image
Definition at line 26 of file Fine2DRegistrationRestraint.h.
Public Member Functions | |
| Fine2DRegistrationRestraint (Model *m) | |
| virtual IMP::ModelObjectsTemp | do_get_inputs () const |
| unsigned int | get_calls () const |
| RegistrationResult | get_final_registration () const |
| virtual std::string | get_type_name () const |
| virtual ::IMP::VersionInfo | get_version_info () const |
| Get information about the module and version of the object. More... | |
| void | set_subject_image (em2d::Image *subject) |
| void | setup (ParticlesTemp &ps, const ProjectingParameters ¶ms, Model *scoring_model, ScoreFunction *score_function, MasksManagerPtr masks=MasksManagerPtr()) |
| virtual double | unprotected_evaluate (IMP::DerivativeAccumulator *accum) const |
| Public Member Functions inherited from IMP::Restraint | |
| Restraint (Model *m, std::string name) | |
| void | add_score_and_derivatives (ScoreAccumulator sa) const |
| Perform the actual restraint scoring. More... | |
| Restraint * | create_current_decomposition () const |
| Decompose this restraint into constituent terms for the current conf. More... | |
| Restraint * | create_decomposition () const |
| Decompose this restraint into constituent terms. More... | |
| virtual ScoringFunction * | create_scoring_function (double weight=1.0, double max=NO_MAX) const |
| Create a scoring function with only this restraint. More... | |
| virtual RestraintInfo * | get_dynamic_info () const |
| virtual double | get_last_score () const |
| double | get_score () const |
| virtual RestraintInfo * | get_static_info () const |
| bool | get_was_good () const |
| void | set_weight (Float weight) |
| Float | get_weight () const |
| double | get_maximum_score () const |
| void | set_maximum_score (double s) |
| Public Member Functions inherited from IMP::ModelObject | |
| ModelObject (Model *m, std::string name) | |
| bool | get_has_dependencies () const |
| Return whether this object has dependencies computed. More... | |
| bool | get_has_required_score_states () const |
| Return whether score states are computed. More... | |
| ModelObjectsTemp | get_inputs () const |
| ModelObjectsTemps | get_interactions () const |
| Get the interacting sets induced by this ModelObject. More... | |
| Model * | get_model () const |
| ModelObjectsTemp | get_outputs () const |
| const ScoreStatesTemp & | get_required_score_states () const |
| Get the score states that are ancestors of this in the dependency graph. More... | |
| void | set_has_dependencies (bool tf) |
| Either invalidate the dependencies or ensure they are correct. More... | |
| void | set_has_required_score_states (bool tf) |
| Compute the required score states. More... | |
| Public Member Functions inherited from IMP::Object | |
| virtual void | clear_caches () |
| CheckLevel | get_check_level () const |
| LogLevel | get_log_level () const |
| void | set_check_level (CheckLevel l) |
| void | set_log_level (LogLevel l) |
| Set the logging level used in this object. More... | |
| void | set_was_used (bool tf) const |
| void | show (std::ostream &out=std::cout) const |
| const std::string & | get_name () const |
| void | set_name (std::string name) |
Additional Inherited Members | |
| Protected Member Functions inherited from IMP::Restraint | |
| virtual void | do_add_score_and_derivatives (ScoreAccumulator sa) const |
| A restraint should override this to compute the score and derivatives. More... | |
| virtual Restraints | do_create_current_decomposition () const |
| virtual Restraints | do_create_decomposition () const |
| ModelObjectsTemp | do_get_outputs () const |
| Protected Member Functions inherited from IMP::ModelObject | |
| virtual ModelObjectsTemps | do_get_interactions () const |
| virtual void | handle_set_has_required_score_states (bool) |
| Protected Member Functions inherited from IMP::Object | |
| Object (std::string name) | |
| Construct an object with the given name. More... | |
| virtual void | do_destroy () |
| IMP::em2d::Fine2DRegistrationRestraint::Fine2DRegistrationRestraint | ( | Model * | m | ) |
Constructs the restraint. Use the setup() function after construction
|
virtual |
Get any Particle, Container or other ModelObjects read by this during evaluation. If you read everything in a container, you can just return that container.
Implements IMP::ModelObject.
| unsigned int IMP::em2d::Fine2DRegistrationRestraint::get_calls | ( | ) | const |
Get the number of times that the function was called
Definition at line 70 of file Fine2DRegistrationRestraint.h.
| RegistrationResult IMP::em2d::Fine2DRegistrationRestraint::get_final_registration | ( | ) | const |
Get the final values for the parameters after the optimization performed by this restraint
|
virtual |
Get information about the module and version of the object.
Reimplemented from IMP::Object.
Definition at line 64 of file Fine2DRegistrationRestraint.h.
| void IMP::em2d::Fine2DRegistrationRestraint::set_subject_image | ( | em2d::Image * | subject | ) |
Sets the image to use by the restraint to perform the fine search of the projection registration parameters
| subject | The subject image |
| void IMP::em2d::Fine2DRegistrationRestraint::setup | ( | ParticlesTemp & | ps, |
| const ProjectingParameters & | params, | ||
| Model * | scoring_model, | ||
| ScoreFunction * | score_function, | ||
| MasksManagerPtr | masks = MasksManagerPtr() |
||
| ) |
Initialization function. To be called after setting the model for the restraint
| ps | The particles used for the registration |
| params | The parameters used to project the images |
| scoring_model | The model that is projected. |
| score_function | The function that is used to score the similarity between a projection of the model and the EM image |
| masks | A manager containing the masks used for projecting. |