IMP::em2d::Fine2DRegistrationRestraint Class Reference
#include <IMP/em2d/Fine2DRegistrationRestraint.h>
Inheritance diagram for IMP::em2d::Fine2DRegistrationRestraint:Public Member Functions | |
| Fine2DRegistrationRestraint () | |
| virtual void | do_show (std::ostream &out) const |
| unsigned int | get_calls () const |
| RegistrationResult | get_final_registration () const |
| ObjectsTemp | get_input_objects () const |
| void | set_subject_image (em2d::Image *subject) |
| void | setup (ParticlesTemp &ps, const ProjectingParameters ¶ms, Model *scoring_model, ScoreFunction *score_function, MasksManagerPtr masks=MasksManagerPtr()) |
| Public Member Functions inherited from IMP::kernel::Restraint | |
| Restraint (Model *m, std::string name) | |
| void | add_score_and_derivatives (ScoreAccumulator sa) const |
| 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 |
| ContainersTemp | get_input_containers () const |
| ParticlesTemp | get_input_particles () const |
| virtual double | get_last_score () const |
| double | get_score () 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::kernel::ModelObject | |
| ModelObject (Model *m, std::string name) | |
| ModelObjectsTemp | get_inputs () const |
| ModelObjectsTemps | get_interactions () const |
| Model * | get_model () const |
| ModelObjectsTemp | get_outputs () const |
| Public Member Functions inherited from IMP::base::Object | |
| virtual void | clear_caches () |
| virtual IMP::base::VersionInfo | get_version_info () const =0 |
| Get information about the module and version of the object. | |
| 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) |
Related Functions | |
(Note that these are not member functions.) | |
| typedef IMP::base::Vector < IMP::base::WeakPointer < Fine2DRegistrationRestraint > > | Fine2DRegistrationRestraintsTemp |
| Related Functions inherited from IMP::kernel::Restraint | |
| typedef IMP::base::Vector < IMP::base::WeakPointer < Restraint > > | RestraintsTemp |
| Related Functions inherited from IMP::kernel::ModelObject | |
| typedef IMP::base::Vector < IMP::base::WeakPointer < ModelObject > > | ModelObjectsTemp |
| Related Functions inherited from IMP::base::Object | |
| typedef IMP::base::Vector < IMP::base::WeakPointer < Object > > | ObjectsTemp |
Additional Inherited Members | |
| Protected Member Functions inherited from IMP::kernel::Restraint | |
| virtual void | do_add_score_and_derivatives (ScoreAccumulator sa) const |
| virtual Restraints | do_create_current_decomposition () const |
| virtual Restraints | do_create_decomposition () const |
| ModelObjectsTemp | do_get_outputs () const |
| virtual void | do_update_dependencies () |
Detailed Description
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.
Constructor & Destructor Documentation
| IMP::em2d::Fine2DRegistrationRestraint::Fine2DRegistrationRestraint | ( | ) |
Constructs the restraint. Use the setup() function after construction
Definition at line 33 of file Fine2DRegistrationRestraint.h.
Member Function Documentation
| unsigned int IMP::em2d::Fine2DRegistrationRestraint::get_calls | ( | ) | const |
Get the number of times that the function was called
- Returns
- The number of calls
Definition at line 81 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
- Returns
- The registration result
| 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
- 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
- Parameters
-
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.
Friends And Related Function Documentation
|
related |
Pass a set of objects.
Definition at line 103 of file Fine2DRegistrationRestraint.h.
The documentation for this class was generated from the following file: