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.xray.commands;
39  
40  import ffx.algorithms.cli.AlgorithmsCommand;
41  import ffx.numerics.Potential;
42  import ffx.potential.MolecularAssembly;
43  import ffx.potential.bonded.Atom;
44  import ffx.potential.bonded.MSNode;
45  import ffx.potential.bonded.Molecule;
46  import ffx.utilities.FFXBinding;
47  import picocli.CommandLine.Command;
48  import picocli.CommandLine.Parameters;
49  
50  import java.io.File;
51  import java.util.List;
52  
53  import static org.apache.commons.io.FilenameUtils.removeExtension;
54  
55  /**
56   * Deuterate changes exchangeable hydrogen atoms to deuterium atoms for a PDB file.
57   * <br>
58   * Usage:
59   * <br>
60   * ffxc xray.Deuterate &lt;pdbfile1&gt;
61   */
62  @Command(description = " Deuterate exchangable hydrogen of the PDB model.", name = "xray.Deuterate")
63  public class Deuterate extends AlgorithmsCommand {
64  
65    /**
66     * One or more filenames.
67     */
68    @Parameters(arity = "1..*", paramLabel = "files", description = "PDB input file.")
69    private List<String> filenames;
70  
71    private MolecularAssembly[] molecularAssemblies;
72  
73    /**
74     * Deuterate constructor.
75     */
76    public Deuterate() {
77      super();
78    }
79  
80    /**
81     * Deuterate constructor that sets the command line arguments.
82     *
83     * @param args Command line arguments.
84     */
85    public Deuterate(String[] args) {
86      super(args);
87    }
88  
89    /**
90     * Deuterate constructor.
91     *
92     * @param binding The Binding to use.
93     */
94    public Deuterate(FFXBinding binding) {
95      super(binding);
96    }
97  
98    /**
99     * Execute the script.
100    */
101   @Override
102   public Deuterate run() {
103 
104     if (!init()) {
105       return this;
106     }
107 
108     String filename;
109     if (filenames != null && !filenames.isEmpty()) {
110       molecularAssemblies = algorithmFunctions.openAll(filenames.get(0));
111       activeAssembly = molecularAssemblies[0];
112       filename = filenames.get(0);
113     } else if (activeAssembly == null) {
114       logger.info(helpString());
115       return this;
116     } else {
117       molecularAssemblies = new MolecularAssembly[]{activeAssembly};
118       filename = activeAssembly.getFile().getAbsolutePath();
119     }
120 
121     logger.info("\n Running xray.Deuterate on " + filename);
122 
123     for (MolecularAssembly molecularAssembly : molecularAssemblies) {
124       Atom[] atoms = molecularAssembly.getAtomArray();
125       for (Atom a : atoms) {
126         if (a.isHydrogen()) {
127           Atom b = a.getBonds().getFirst().get1_2(a);
128 
129           // Criteria for converting H to D
130           if (b.getAtomicNumber() == 7 || b.getAtomicNumber() == 8) {
131             String name = a.getName().replaceFirst("H", "D");
132             a.setName(name);
133           }
134         }
135       }
136 
137       List<MSNode> water = molecularAssembly.getWater();
138       for (MSNode node : water) {
139         Molecule wat = (Molecule) node;
140         wat.setName("DOD");
141       }
142     }
143 
144     algorithmFunctions.saveAsPDB(molecularAssemblies, new File(removeExtension(filename) + "_deuterate.pdb"));
145 
146     return this;
147   }
148 
149   @Override
150   public List<Potential> getPotentials() {
151     return getPotentialsFromAssemblies(molecularAssemblies);
152   }
153 }