IMP logo
IMP Reference Guide  develop.2640aaee5c,2019/11/13
The Integrative Modeling Platform
core/SurfaceDistancePairScore.h
Go to the documentation of this file.
1 /**
2  * \file IMP/core/SurfaceDistancePairScore.h
3  * \brief A score on the distance between a surface and a sphere.
4  *
5  * Copyright 2007-2019 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPCORE_SURFACE_DISTANCE_PAIR_SCORE_H
9 #define IMPCORE_SURFACE_DISTANCE_PAIR_SCORE_H
10 
11 #include <IMP/core/core_config.h>
12 #include "Surface.h"
13 #include "XYZR.h"
21 
22 IMPCORE_BEGIN_NAMESPACE
23 
24 typedef score_functor::PointToSphereDistance<score_functor::UnaryFunctionEvaluate>
25  PointToSphereDistanceScore;
26 
27 //! A score on the distance between a surface and a sphere.
28 /** \see Surface
29  \see XYZR
30  \see DistancePairScore
31  */
32 IMP_FUNCTOR_SURFACE_DISTANCE_PAIR_SCORE(SurfaceDistancePairScore,
33  SurfaceDistancePairScore,
34  PointToSphereDistanceScore,
35  (UnaryFunction *uf,
36  std::string name =
37  "SurfaceDistancePairScore%1%"),
39 
40 //! A score on the height of a sphere above a surface.
41 /** \see Surface
42  \see XYZR
43  \see SurfaceDistancePairScore
44  \see DistancePairScore
45  */
49  (UnaryFunction *uf,
50  std::string name =
51  "SurfaceHeightPairScore%1%"),
53 
54 //! A score on the depth of a sphere below a surface.
55 /** \see Surface
56  \see XYZR
57  \see SurfaceDistancePairScore
58  \see DistancePairScore
59  */
63  (UnaryFunction *uf,
64  std::string name =
65  "SurfaceDepthPairScore%1%"),
67 
68 
71 
72 //! A harmonic score on the distance between a surface and a sphere.
73 /** \see Surface
74  \see XYZR
75  \see Harmonic
76  \see SurfaceDistancePairScore
77  \see DistancePairScore
78  */
81  HarmonicSurfaceDistanceScore,
82  (double x0, double k,
83  std::string name =
84  "HarmonicSurfaceDistancePairScore%1%"),
87 
88 // //! A harmonic score on the height of a sphere above a surface.
89 // /** \see Surface
90 // \see XYZR
91 // \see Harmonic
92 // \see SurfaceHeightPairScore
93 // \see DistancePairScore
94 // */
97  HarmonicSurfaceDistanceScore,
98  (double x0, double k,
99  std::string name =
100  "HarmonicSurfaceHeightPairScore%1%"),
103 
104 // //! A harmonic score on the depth of a sphere below a surface.
105 // /** \see Surface
106 // \see XYZR
107 // \see Harmonic
108 // \see SurfaceDepthPairScore
109 // \see DistancePairScore
110 // */
113  HarmonicSurfaceDistanceScore,
114  (double x0, double k,
115  std::string name =
116  "HarmonicSurfaceDepthPairScore%1%"),
119 
122 
123 
124 //! A harmonic score that keeps a sphere above a surface.
125 /** This class is equivalent to, but faster than a
126  SurfaceHeightPairScore with a HarmonicLowerBound.
127 
128  \see HarmonicLowerBound
129  \see SurfaceHeightPairScore
130  \see SoftSpherePairScore
131 */
134  SoftSurfaceDistanceScore,
135  (double k,
136  std::string name = "SoftSuperSurfacePairScore%1%"),
138 
139 //! A harmonic score that keeps a sphere below a surface.
140 /** This class is equivalent to, but faster than a
141  SurfaceDepthPairScore with a HarmonicLowerBound.
142 
143  \see HarmonicLowerBound
144  \see SurfaceDepthPairScore
145  \see SoftSpherePairScore
146 */
149  SoftSurfaceDistanceScore,
150  (double k,
151  std::string name = "SoftSubSurfacePairScore%1%"),
153 
154 
155 IMPCORE_END_NAMESPACE
156 
157 #endif /* IMPCORE_SURFACE_DISTANCE_PAIR_SCORE_H */
A harmonic score that keeps a sphere below a surface.
Various important macros for implementing decorators.
A Score on the distance between a point and a sphere.
A Score on the distance between a pair of particles.
A harmonic score on the positive directed distance between a pair of particles. The score equals zero...
#define IMP_FUNCTOR_SURFACE_DISTANCE_PAIR_SCORE(Name, PName, Functor, Args, PassArgs)
A harmonic score on the directed distance between a pair of particles, centered at 0...
Simple surface decorator.
A harmonic score that keeps a sphere above a surface.
A score on the depth of a sphere below a surface.
A harmonic score on the negative directed distance between a pair of particles. The score equals zero...
A Score on the distance between a pair of particles.
A score on the distance between a surface and a sphere.
A score on the height of a sphere above a surface.
A harmonic score on the distance between a surface and a sphere.
Decorator for a sphere-like particle.
Abstract single variable functor class for score functions.
Definition: UnaryFunction.h:25