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.utilities.FFXBinding;
44  import ffx.xray.DiffractionData;
45  import ffx.xray.cli.XrayOptions;
46  import ffx.xray.parsers.MTZWriter;
47  import ffx.xray.parsers.MTZWriter.MTZType;
48  import org.apache.commons.configuration2.CompositeConfiguration;
49  import picocli.CommandLine.Command;
50  import picocli.CommandLine.Mixin;
51  import picocli.CommandLine.Parameters;
52  
53  import java.util.ArrayList;
54  import java.util.Arrays;
55  import java.util.List;
56  import java.util.stream.Collectors;
57  
58  import static org.apache.commons.io.FilenameUtils.getBaseName;
59  
60  /**
61   * The X-ray ComputeFc script.
62   * <br>
63   * Usage:
64   * <br>
65   * ffxc xray.ComputeFc [options] &lt;filename [file2...]&gt;
66   */
67  @Command(description = " Write out computed structure factors.", name = "xray.ComputeFc")
68  public class ComputeFc extends AlgorithmsCommand {
69  
70    @Mixin
71    private XrayOptions xrayOptions;
72  
73    /**
74     * One or more filenames.
75     */
76    @Parameters(arity = "1..*", paramLabel = "files", description = "PDB and Diffraction input files.")
77    private List<String> filenames;
78  
79    private MolecularAssembly[] molecularAssemblies;
80    private DiffractionData diffractionData;
81  
82    /**
83     * ComputeFc constructor.
84     */
85    public ComputeFc() {
86      super();
87    }
88  
89    /**
90     * ComputeFc constructor that sets the command line arguments.
91     * @param args Command line arguments.
92     */
93    public ComputeFc(String[] args) {
94      super(args);
95    }
96  
97    /**
98     * ComputeFc constructor.
99     * @param binding The Binding to use.
100    */
101   public ComputeFc(FFXBinding binding) {
102     super(binding);
103   }
104 
105   @Override
106   public ComputeFc run() {
107 
108     if (!init()) {
109       return this;
110     }
111 
112     xrayOptions.init();
113 
114     String filename;
115     if (filenames != null && !filenames.isEmpty()) {
116       molecularAssemblies = algorithmFunctions.openAll(filenames.get(0));
117       activeAssembly = molecularAssemblies[0];
118       filename = filenames.get(0);
119     } else if (activeAssembly == null) {
120       logger.info(helpString());
121       return this;
122     } else {
123       molecularAssemblies = new MolecularAssembly[]{activeAssembly};
124       filename = activeAssembly.getFile().getAbsolutePath();
125     }
126 
127     // Load parsed X-ray properties.
128     CompositeConfiguration properties = activeAssembly.getProperties();
129     xrayOptions.setProperties(parseResult, properties);
130 
131     // Set up diffraction data (can be multiple files)
132     diffractionData = xrayOptions.getDiffractionData(filenames, molecularAssemblies, properties);
133 
134     logger.info("\n Running xray.ComputeFc on " + filename);
135 
136     // Compute structure factors
137     diffractionData.computeAtomicDensity();
138     diffractionData.getReflectionList();
139 
140     // Output Fcs
141     MTZWriter mtzWriter = new MTZWriter(diffractionData.getReflectionList()[0],
142         diffractionData.getRefinementData()[0], getBaseName(filename) + "_fc.mtz", MTZType.FCONLY);
143 
144     mtzWriter.write();
145     return this;
146   }
147 
148   @Override
149   public List<Potential> getPotentials() {
150     if (molecularAssemblies == null) {
151       return new ArrayList<>();
152     } else {
153       return Arrays.stream(molecularAssemblies)
154           .filter(a -> a != null)
155           .map(a -> a.getPotentialEnergy())
156           .filter(e -> e != null)
157           .collect(Collectors.toList());
158     }
159   }
160 
161   @Override
162   public boolean destroyPotentials() {
163     return diffractionData == null ? true : diffractionData.destroy();
164   }
165 }