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