ProSHADE  0.6.5 (NOV 2018)
Protein Shape Descriptors and Symmetry Detection
All Classes Namespaces Files Functions Variables Pages
overlayMaps.cpp
1 
15 //============================================ ProSHADE
16 #include "../proshade/ProSHADE.h"
17 
18 //============================================ Main
19 int main ( int argc,
20  char **argv )
21 {
22  //======================================== Default settings
24 
25  // ... Settings regarding resolutions
26  setUp->mapResolution = 2.0;
27 
28  // ... Settings regarding space around the structure in lattice
29  setUp->extraSpace = -777.7; // this is a magic number, which will make the ProSHADE overlay mode use the appropriate extra space for computing maps and their centering, but it will then remove this extra space, so that the user will not see it. Change at your own risk, you have been warned.
30 
31  // ... Settings regarding rotation module, these should to be set this way!
32  setUp->clearMapData = false;
33  setUp->useCOM = false;
34  setUp->rotChangeDefault = true;
35  setUp->overlayDefaults = true;
36  setUp->ignoreLs = std::vector<int> ();
37  setUp->maskBlurFactor = 500.0;
38  setUp->maskBlurFactorGiven = false;
39  setUp->maxRotError = 0;
40 
41  // ... Settings regarding the task
42  setUp->taskToPerform = ProSHADE::OverlayMap;
43 
44  // ... Settings regarding where and if to save the clear map
45  setUp->clearMapFile = "";
46 
47  // ... Settings regarding the map saving mode
48  setUp->axisOrder = "xyz";
49 
50  // ... Settings regarding the standard output amount
51  setUp->verbose = 2;
52  setUp->htmlReport = false;
53 
54  //======================================== Get files
55  if ( ( argc < 3 ) || ( argc > 4 ) )
56  {
57  std::cout << std::endl << "Usage: overlayMaps [filename1] [filename2] [filename3] to overlay [filename1] to [filename2] and save the resulting map in [filename3], where [filename3] is optional." << std::endl << std::endl;
58  exit ( 0 );
59  }
60  else
61  {
62  setUp->structFiles.emplace_back ( std::string ( argv[1] ) );
63  setUp->structFiles.emplace_back ( std::string ( argv[2] ) );
64  if ( argc == 4 )
65  {
66  setUp->clearMapFile = ( std::string ( argv[3] ) );
67  }
68  }
69 
70  //======================================== Run ProSHADE
71  ProSHADE::ProSHADE *run = new ProSHADE::ProSHADE ( setUp );
72 
73  //======================================== Print results
74  printf ( "ProSHADE library version: %s\n\n", run->getProSHADEVersion().c_str() );
75 
76  //======================================== Free memory
77  delete setUp;
78  delete run;
79 
80  //======================================== Done
81  return 0;
82 }
83 
double mapResolution
This is the internal resolution at which the calculations are done, not necessarily the resolution of...
Definition: ProSHADE.h:78
bool clearMapData
This value is used to decide whether the input maps should be cleared again, or not.
Definition: ProSHADE.h:146
std::string clearMapFile
If map features are to be extracted, should the clear map be saved (then give file name here)...
Definition: ProSHADE.h:144
bool overlayDefaults
If true, the shell spacing and distances will be doube to their typical values. This is to speed up m...
Definition: ProSHADE.h:176
bool htmlReport
Should HTML report for the run be created?
Definition: ProSHADE.h:186
int verbose
Should the software report on the progress, or just be quiet? Value between 0 (quiet) and 4 (loud) ...
Definition: ProSHADE.h:189
std::string getProSHADEVersion(void)
Miscellanous function allowing the user to get the ProSHADE version.
Definition: ProSHADE.cpp:2910
bool maskBlurFactorGiven
Was a specific value of the blurring factor requested by the user?
Definition: ProSHADE.h:148
std::vector< int > ignoreLs
This vector lists all the bandwidth values which should be ignored and not part of the computations...
Definition: ProSHADE.h:117
bool rotChangeDefault
If map rotation is selected, the default automatic parameter decision is changed. This variable state...
Definition: ProSHADE.h:170
unsigned int maxRotError
This is the maximum allowed error in degrees for the rotation computation. This can be used to speed ...
Definition: ProSHADE.h:179
std::string axisOrder
A string specifying the order of the axis. Must have three characters and any permutation of &#39;x&#39;...
Definition: ProSHADE.h:183
This class stores all the settings and is passed to the executive classes instead of multitude of par...
Definition: ProSHADE.h:74
bool useCOM
Should the Centre of Mass (COM) be used to center the structure in the cell?
Definition: ProSHADE.h:105
double maskBlurFactor
The is the amount of blurring to be used to create masks for maps.
Definition: ProSHADE.h:147
std::vector< std::string > structFiles
This vector should contain all the structures that are being dealt with, but this does not yet work! ...
Definition: ProSHADE.h:120
Task taskToPerform
This custom type variable determines which task to perfom (i.e. symmetry detection, distances computation or map features extraction).
Definition: ProSHADE.h:141
double extraSpace
What should be the distance added on both sides to the structure, so that the next cell density would...
Definition: ProSHADE.h:109