IMP  2.0.0
The Integrative Modeling Platform
symmetric_multifit.h
Go to the documentation of this file.
1 /**
2  * \file symmetric_multifit.h \brief Build cyclic symmetric complexes.
3  *
4  * Copyright 2007-2013 IMP Inventors. All rights reserved.
5  *
6  */
7 
8 #ifndef IMPCNMULTIFIT_SYMMETRIC_MULTIFIT_H
9 #define IMPCNMULTIFIT_SYMMETRIC_MULTIFIT_H
10 
11 #include <IMP/cnmultifit/cnmultifit_config.h>
12 #include <string>
13 
14 IMPCNMULTIFIT_BEGIN_NAMESPACE
15 
16 //! High level interface to build cyclic symmetric complexes.
17 /** Given a parameter file, this function does all the work to build a number
18  of fits of the monomer into a density map of the symmetric complex.
19 
20  \param param_filename Name of a parameter file.
21  \param chimera_filename If not empty, the name of a file that will be
22  generated containing Chimera-compatible fit
23  information.
24  */
25 void IMPCNMULTIFITEXPORT
26 do_all_fitting(const std::string param_filename,
27  const std::string chimera_filename = "");
28 
29 IMPCNMULTIFIT_END_NAMESPACE
30 
31 #endif /* IMPCNMULTIFIT_SYMMETRIC_MULTIFIT_H */