IMP  2.0.0
The Integrative Modeling Platform
core/python_only.h
Go to the documentation of this file.
1 /**
2  * \file IMP/core/python_only.h
3  * \brief functionality only availble in python.
4  *
5  * Copyright 2007-2013 IMP Inventors. All rights reserved.
6  *
7  */
8 
9 #ifndef IMPCORE_PYTHON_ONLY_H
10 #define IMPCORE_PYTHON_ONLY_H
11 
12 #include <IMP/core/core_config.h>
13 
14 IMPCORE_BEGIN_NAMESPACE
15 
16 /** \name Python Only
17  The following functions are only availale in Python as the
18  equivalent C++ functionality is provided via template
19  functions or in other ways that don't directly map to
20  python.
21  @{
22 */
23 #ifdef IMP_DOXYGEN
24 /** Align any combination of XYZ objects and algebra::Vector3D
25  objects to one another.
26 
27  \note each of the two lists must all have the same type.
28  That is, list "a" cannot be a
29  mix of algebra::Vector3D objects and XYZ objects.
30 \code
31 IMP::algebra::get_transformation_aligning_first_to_second(a,b);
32 \endcode
33  */
34 algebra::Transformation3D
35 get_transformation_aligning_first_to_second(XYZsOrVector3ds a,
36  XYZsOrVector3ds b);
37 #endif
38 /** @} */
39 
40 IMPCORE_END_NAMESPACE
41 
42 #endif /* IMPCORE_PYTHON_ONLY_H */