Package ffx.algorithms.commands
Class Histogram
java.lang.Object
ffx.utilities.FFXCommand
ffx.algorithms.cli.AlgorithmsCommand
ffx.algorithms.commands.Histogram
The Histogram script prints out a Orthogonal Space histogram from a *.his file.
Usage:
ffxc Histogram [options] <filename>
Usage:
ffxc Histogram [options] <filename>
-
Field Summary
Fields inherited from class ffx.algorithms.cli.AlgorithmsCommand
activeAssembly, algorithmFunctions, algorithmListener, baseDir
Fields inherited from class ffx.utilities.FFXCommand
args, binding, color, help, logger, parseResult, version
-
Constructor Summary
ConstructorsConstructorDescriptionHistogram Constructor.Histogram
(FFXBinding binding) Histogram Constructor.Histogram constructor that sets the command line arguments. -
Method Summary
Modifier and TypeMethodDescriptionReturns a List of all Potential objects associated with this script.run()
Execute this Command.Methods inherited from class ffx.algorithms.cli.AlgorithmsCommand
destroyPotentials, getActiveAssemblies, getActiveAssembly, init, saveDirFile, setActiveAssembly, setBaseDir, updateTitle
Methods inherited from class ffx.utilities.FFXCommand
getCommand, helpString, listCommands, setBinding
-
Constructor Details
-
Histogram
public Histogram()Histogram Constructor. -
Histogram
Histogram Constructor.- Parameters:
binding
- The Binding to use.
-
Histogram
Histogram constructor that sets the command line arguments.- Parameters:
args
- Command line arguments.
-
-
Method Details
-
run
Execute this Command.- Overrides:
run
in classFFXCommand
- Returns:
- The current FFXCommand.
-
getPotentials
Returns a List of all Potential objects associated with this script.- Overrides:
getPotentials
in classAlgorithmsCommand
- Returns:
- All Potentials. Sometimes empty, never null.
-