home
about
news
download
doc
source
systems
tests
bugs
contact
IMP Reference Guide
2.6.1
The Integrative Modeling Platform
IMP Manual
Reference Guide
Modules
Classes
Examples
include
IMP
atom
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-2016 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/Particle.h
>
14
#include <
IMP/base_types.h
>
15
#include <
IMP/OptimizerState.h
>
16
17
IMPATOM_BEGIN_NAMESPACE
18
19
//! Removes rigid translation from the particles.
20
/** Recenters the bunch of particles by putting the very first particle
21
at the origin and rigidly translating all the others.
22
*/
23
class
IMPATOMEXPORT
RemoveTranslationOptimizerState
:
public
OptimizerState
{
24
public
:
25
RemoveTranslationOptimizerState
(
Model
*m,
26
ParticleIndexesAdaptor
pis);
27
28
//! Set the particles to use.
29
void
set_particles
(
const
Particles
&pis) { pis_ = pis; }
30
31
//! Remove translation now
32
void
remove_translation()
const
;
33
34
IMP_OBJECT_METHODS
(
RemoveTranslationOptimizerState
);
35
36
protected
:
37
virtual
void
do_update
(
unsigned
int
call)
IMP_OVERRIDE
;
38
39
private
:
40
Particles
pis_;
41
};
42
43
IMP_OBJECTS
(
RemoveTranslationOptimizerState
,
RemoveTranslationOptimizerStates
);
44
45
IMPATOM_END_NAMESPACE
46
47
#endif
/* IMPATOM_REMOVE_TRANSLATION_OPTIMIZER_STATE_H */
base_types.h
Basic types used by IMP.
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition:
object_macros.h:25
IMP::OptimizerState::do_update
virtual void do_update(unsigned int)
Definition:
OptimizerState.h:120
IMP::Vector< Pointer< Particle > >
IMP::ParticleIndexesAdaptor
Definition:
particle_index.h:50
IMP::Model
Class for storing model, its restraints, constraints, and particles.
Definition:
Model.h:72
IMP::atom::RemoveTranslationOptimizerState::set_particles
void set_particles(const Particles &pis)
Set the particles to use.
Definition:
RemoveTranslationOptimizerState.h:29
Particle.h
Classes to handle individual model particles. (Note that implementation of inline functions is in int...
IMP_OBJECTS
#define IMP_OBJECTS(Name, PluralName)
Define the types for storing sets of objects.
Definition:
object_macros.h:42
IMP::atom::RemoveTranslationOptimizerState
Removes rigid translation from the particles.
Definition:
RemoveTranslationOptimizerState.h:23
IMP::OptimizerState
Shared optimizer state that is invoked upon commitment of new coordinates.
Definition:
OptimizerState.h:43
OptimizerState.h
Shared optimizer state.
IMP_OVERRIDE
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Definition:
compiler_macros.h:80