IMP  2.1.0
The Integrative Modeling Platform
RemoveTranslationOptimizerState.h
Go to the documentation of this file.
1 /**
2  * \file IMP/atom/RemoveTranslationOptimizerState.h
3  * \brief Remove rigid translation during optimization.
4  *
5  * Copyright 2007-2013 IMP Inventors. All rights reserved.
6  *
7  */
8 
9 #ifndef IMPATOM_REMOVE_TRANSLATION_OPTIMIZER_STATE_H
10 #define IMPATOM_REMOVE_TRANSLATION_OPTIMIZER_STATE_H
11 
12 #include <IMP/atom/atom_config.h>
13 #include <IMP/kernel/Particle.h>
14 #include <IMP/base_types.h>
15 #include <IMP/OptimizerState.h>
17 
18 IMPATOM_BEGIN_NAMESPACE
19 
20 //! Removes rigid translation from the particles.
21 /** Recenters the bunch of particles by putting the very first particle
22  at the origin and rigidly translating all the others.
23  */
24 class IMPATOMEXPORT RemoveTranslationOptimizerState : public OptimizerState {
25  public:
26  /** \deprecated_at{2.1} Use set_period() instead. */
27  IMPATOM_DEPRECATED_FUNCTION_DECL(2.1)
29  unsigned skip_steps);
32 
33  //! Set the particles to use.
34  void set_particles(const kernel::Particles &pis) { pis_ = pis; }
35 
36  //! Remove translation now
37  void remove_translation() const;
38 
40 
41  protected:
42  virtual void do_update(unsigned int call) IMP_OVERRIDE;
43 
44  private:
45  kernel::Particles pis_;
46 };
47 
49 
50 IMPATOM_END_NAMESPACE
51 
52 #endif /* IMPATOM_REMOVE_TRANSLATION_OPTIMIZER_STATE_H */
Import IMP/kernel/base_types.h in the namespace.
virtual void do_update(unsigned int)
Shared optimizer state that is invoked upon commitment of new coordinates.
void set_particles(const kernel::Particles &pis)
Set the particles to use.
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Import IMP/kernel/optimizer_state_macros.h in the namespace.
Classes to handle individual model particles.
#define IMP_OBJECTS(Name, PluralName)
Define the types for storing sets of objects.
Removes rigid translation from the particles.
Import IMP/kernel/OptimizerState.h in the namespace.
Class for storing model, its restraints, constraints, and particles.