View Javadoc
1   //******************************************************************************
2   //
3   // Title:       Force Field X.
4   // Description: Force Field X - Software for Molecular Biophysics.
5   // Copyright:   Copyright (c) Michael J. Schnieders 2001-2025.
6   //
7   // This file is part of Force Field X.
8   //
9   // Force Field X is free software; you can redistribute it and/or modify it
10  // under the terms of the GNU General Public License version 3 as published by
11  // the Free Software Foundation.
12  //
13  // Force Field X is distributed in the hope that it will be useful, but WITHOUT
14  // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15  // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16  // details.
17  //
18  // You should have received a copy of the GNU General Public License along with
19  // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
20  // Place, Suite 330, Boston, MA 02111-1307 USA
21  //
22  // Linking this library statically or dynamically with other modules is making a
23  // combined work based on this library. Thus, the terms and conditions of the
24  // GNU General Public License cover the whole combination.
25  //
26  // As a special exception, the copyright holders of this library give you
27  // permission to link this library with independent modules to produce an
28  // executable, regardless of the license terms of these independent modules, and
29  // to copy and distribute the resulting executable under terms of your choice,
30  // provided that you also meet, for each linked independent module, the terms
31  // and conditions of the license of that module. An independent module is a
32  // module which is not derived from or based on this library. If you modify this
33  // library, you may extend this exception to your version of the library, but
34  // you are not obligated to do so. If you do not wish to do so, delete this
35  // exception statement from your version.
36  //
37  //******************************************************************************
38  package ffx.algorithms.commands.test;
39  
40  import ffx.algorithms.cli.AlgorithmsCommand;
41  import ffx.algorithms.cli.ManyBodyOptions;
42  import ffx.algorithms.optimize.RotamerOptimization;
43  import ffx.potential.MolecularAssembly;
44  import ffx.potential.bonded.Residue;
45  import ffx.potential.bonded.RotamerLibrary;
46  import ffx.utilities.FFXBinding;
47  import picocli.CommandLine.Command;
48  import picocli.CommandLine.Mixin;
49  import picocli.CommandLine.Parameters;
50  
51  import java.util.List;
52  
53  import static ffx.potential.bonded.NamingUtils.renameAtomsToPDBStandard;
54  
55  /**
56   * The IdentifyRotamers script attempts to identify which rotamer each Residue in the system is in.
57   * <br>
58   * Usage:
59   * <br>
60   * ffxc test.IdentifyRotamers [options] &lt;filename&gt;
61   */
62  @Command(description = " Identify the rotamers a system is in.", name = "test.IdentifyRotamers")
63  public class IdentifyRotamers extends AlgorithmsCommand {
64  
65    @Mixin
66    private ManyBodyOptions mbOpts;
67  
68    /**
69     * The final argument(s) should be one or more filenames.
70     */
71    @Parameters(arity = "1", paramLabel = "files",
72        description = "The atomic coordinate file in PDB or XYZ format.")
73    private List<String> filenames;
74  
75    /**
76     * IdentifyRotamers Constructor.
77     */
78    public IdentifyRotamers() {
79      super();
80    }
81  
82    /**
83     * IdentifyRotamers Constructor.
84     * @param binding The Binding to use.
85     */
86    public IdentifyRotamers(FFXBinding binding) {
87      super(binding);
88    }
89  
90    /**
91     * IdentifyRotamers constructor that sets the command line arguments.
92     * @param args Command line arguments.
93     */
94    public IdentifyRotamers(String[] args) {
95      super(args);
96    }
97  
98    /**
99     * {@inheritDoc}
100    */
101   @Override
102   public IdentifyRotamers run() {
103 
104     if (!init()) {
105       return this;
106     }
107 
108     mbOpts.setOriginalCoordinates(false);
109 
110     if (filenames != null && !filenames.isEmpty()) {
111       MolecularAssembly[] assemblies = new MolecularAssembly[]{algorithmFunctions.open(filenames.get(0))};
112       activeAssembly = assemblies[0];
113       if (Boolean.parseBoolean(System.getProperty("standardizeAtomNames", "false"))) {
114         renameAtomsToPDBStandard(activeAssembly);
115       }
116     } else if (activeAssembly == null) {
117       logger.info(helpString());
118       return this;
119     }
120 
121     activeAssembly.getPotentialEnergy().setPrintOnFailure(false, false);
122 
123     RotamerOptimization rotopt = new RotamerOptimization(
124         activeAssembly, activeAssembly.getPotentialEnergy(), algorithmListener);
125     mbOpts.initRotamerOptimization(rotopt, activeAssembly);
126 
127     List<Residue> residues = rotopt.getResidues();
128     RotamerLibrary rLib = mbOpts.getRotamerLibrary(false);
129 
130     for (Residue residue : residues) {
131       RotamerLibrary.RotamerGuess guess = rLib.guessRotamer(residue);
132       logger.info(guess.toString());
133     }
134 
135     return this;
136   }
137 }