Next: Introduction, Up: (dir) [Contents][Index]
Next: Mousing and Keyboarding, Previous: Top, Up: Top [Contents][Index]
This document is the Coot User Manual, giving an overview of the interactive features. Other documentation includes the Coot Reference Manual and the Coot Tutorial. These documents should be distributed with the source code.
• Citing Coot: | ||
• What is Coot?: | ||
• What Coot is Not: | ||
• Hardware Requirements: | ||
• Environment Variables: | ||
• Command Line Arguments: | ||
• Web Page: | ||
• Crash: |
Next: What is Coot?, Up: Introduction [Contents][Index]
If have found this software to be useful, you are requested (if appropriate) to cite:
"Features and Development of Coot" P Emsley, B Lohkamp, W Scott, and K Cowtan Acta Cryst. (2010). D66, 486-501 Acta Crystallographica Section D-Biological Crystallography 66: 486-501
The reference for the REFMAC5 Dictionary is:
REFMAC5 dictionary: "Organization of Prior Chemical Knowledge and Guidelines for its Use" Vagin AA, Steiner RA, Lebedev AA, Potterton L, McNicholas S Long F, Murshudov GN Acta Crystallographica Section D-Biological Crystallography 60: 2184-2195 Part 12 Sp. Iss. 1 DEC 2004"
If using "SSM Superposition", please cite:
"Secondary-structure matching (SSM), a new tool for fast protein structure alignment in three dimensions" Krissinel E, Henrick K Acta Crystallographica Section D-Biological Crystallography 60: 2256-2268 Part 12 Sp. Iss. 1 DEC 2004
The reference for the the Electron Density Server is:
GJ Kleywegt, MR Harris, JY Zou, TC Taylor, A Wählby, TA Jones (2004), "The Uppsala Electron-Density Server", Acta Crystallographica Section D-Biological Crystallography 60, 2240-2249.
Please also cite the primary literature for the received structures.
Next: What Coot is Not, Previous: Citing Coot, Up: Introduction [Contents][Index]
Coot is a molecular graphics application. Its primary focus is crystallographic macromolecular model-building and manipulation rather than representation i.e. more like Frodo than Rasmol. Having said that, Coot can work with small molecule (SHELXL) and electron microscopy data, be used for homology modelling, make passably pretty pictures and display NMR structures.
Coot is Free Software. You can give it away. If you don’t like the way it behaves, you can fix it yourself.
Next: Hardware Requirements, Previous: What is Coot?, Up: Introduction [Contents][Index]
Coot is not:
Next: Environment Variables, Previous: What Coot is Not, Up: Introduction [Contents][Index]
The code is designed to be portable to any Unix-like operating system. Coot certainly runs on RedHat Linux of various sorts, Fedora, Ubuntu, Debian, SuSe Linux and MacOS X. There is also a Window port (called WinCoot).
If you want to port to some other operating system, you are welcome 4. Note that your task will be eased by using GNU GCC to compile the programs components.
Coot works best with a 3-button mouse and works better if it has a scroll-wheel too (see Chapter 2 for more details) 5.
Next: Command Line Arguments, Previous: Hardware Requirements, Up: Introduction [Contents][Index]
Coot responds to several environment variables that modify its behaviour.
COOT_STANDARD_RESIDUES
The filename of the pdb file
containing the standard amino acid residues in “standard
conformation” 6
COOT_SCHEME_DIR
The directory containing standard (part of the distribution) scheme
files
COOT_SCHEME_EXTRAS_DIR
A ’:’-separated list of directories containing bespoke scheme files.
This variable is not set by default. If you set it, Coot will test
each ’:’-separated string that it points to a directory, and if it does,
Coot will load all the .scm files in that directory.
COOT_PYTHON_EXTRAS_DIR
A ’:’-separated list of directories containing bespoke python files.
This variable is not set by default. If you set it, Coot will test
each ’:’-separated string that it points to a directory, and if it does,
Coot will load all the .py files in that directory.
COOT_REF_STRUCTS
The directory containing a set of high resolution pdb files used as
reference structures to build backbone atoms from
C\alpha positions
COOT_REF_SEC_STRUCTS
The directory containing a set of high-quality structures to be used
as templates for fitting beta strands. If this is not set, then the
directory COOT_REF_SEC_STRUCTS will be used to find the reference pdb
files.
COOT_REFMAC_LIB_DIR
Refmac’s CIF directory containing the monomers and link descriptions.
In the future this may simply be the same directory in which refmac
looks to find the library dictionary.
COOT_SBASE_DIR
The directory to find the SBASE dictionary (often comes with CCP4).
COOT_RESOURCES_DIR
The directory that contains the
splash screen image and the GTK+ application resources.
COOT_BACKUP_DIR
The directory to which backup are
written (if it exists as a directory). If it is not, then backups
are written to the current directory (the directory in which coot
was started).
And of course extension language environment variables are used too:
PYTHONPATH
(for python modules)
GUILE_LOAD_PATH
(for guile modules)
Normally, these environment variables will be set correctly in the coot shell script.
Next: Web Page, Previous: Environment Variables, Up: Introduction [Contents][Index]
Rather that using the GUI to read in information, you can use the following command line arguments:
--c cmd
to run a command cmd
on start up
--script filename
to run a script on start up (but see Section Scripting)
--no-state-script
don’t run the 0-coot.state.scm script on start up.
Don’t save a state script on exit either.
--pdb filename
for pdb/coordinates file
--coords filename
for SHELX .ins/.res and CIF files
--data filename
for mtz, phs or mmCIF data file
--auto filename
for auto-reading mtz files (mtz file has the default labels FWT, PHWT)
--map filename
for a map (currently CCP4-format only)
--dictionary filename
read in a cif monomer dictionary
--help
print command line options
--stereo
start up in hardware stereo mode
--version
print the version of coot and exit
--code accession-code
on starting Coot, get the pdb file
and mtz file (if it exists) from the EDS
--no-guano
don’t leave “Coot droppings” i.e. don’t write state
and history files on exit
--side-by-side
start in side-by-side stereo mode
--update-self
command-line mode to update the coot to the latest
pre-release on the server
--python
an argument with no parameters - used to tell Coot that
the -c arguments should be process as python (rather than as scheme).
--small-screen
start with smaller icons and font to fit on small
screen displays
--zalman-stereo
start in Zalman stereo mode
So, for example, one might use:
coot --pdb post-refinement.pdb --auto refmac-2.mtz --dictionary lig.cif
Next: Crash, Previous: Command Line Arguments, Up: Introduction [Contents][Index]
Coot has a web page:
There you can read more about the CCP4 molecular graphics project in general and other projects which are important for Coot 7.
Previous: Web Page, Up: Introduction [Contents][Index]
Coot might crash on you - it shouldn’t.
Whenever Coot manipulates the model, it saves a backup pdb file.
There are backup files in
the directory coot-backup 8. You can recover the session (until the last
edit) by reading in the pdb file that you started with last time and
then use File -> Recover Session…
.
I would like to know about coot crashing 9 so that I can fix it as soon as possible. If you want your problem fixed, this involves some work on your part sadly.
First please make sure that you are using the most recent version of coot. I will often need to know as much as possible about what you did to cause the bug. If you can reproduce the bug and send me the files that are needed to cause it, I can almost certainly fix it 10 - especially if you use the debugger (gdb) and send a backtrace too11. Note that you may have to source the contents of bin/coot so that the libraries are can be found when the executable dynamically links.
Next: General Features, Previous: Introduction, Up: Top [Contents][Index]
How do we move around and select things?
Left-mouse Drag
Rotate view
Ctrl Left-Mouse Drag
Translates view
Shift Left-Mouse
Label Atom
Right-Mouse Drag
Zoom in and out
Ctrl Shift Right-Mouse Drag
Rotate View around Screen Z axis
Middle-mouse
Centre on atom
Scroll-wheel Forward
Increase map contour level
Scroll-wheel Backward
Decrease map contour level
See also Chapter Hints and Usage Tips for more help.
• Next Residue: | ||
• Keyboard Contouring: | ||
• Mouse Z Translation: | ||
• Keyboard Z Translation: | ||
• Keyboard Zoom and Clip: | ||
• Scrollwheel: | ||
• Selecting Atoms: | ||
• Virtual Trackball: | ||
• more on zooming: |
Next: Keyboard Contouring, Up: Mousing and Keyboarding [Contents][Index]
``Space''
Next Residue
``Shift'' ``Space''
Previous Residue
See also “Recentring View” (Section Recentring View).
Next: Mouse Z Translation, Previous: Next Residue, Up: Mousing and Keyboarding [Contents][Index]
Use + or - on the keyboard if you don’t have a scroll-wheel.
Next: Keyboard Z Translation, Previous: Keyboard Contouring, Up: Mousing and Keyboarding [Contents][Index]
Here we can change the clipping and Translate in Screen Z
Ctrl Right-Mouse Drag Up/Down
changes the slab (clipping planes)
Ctrl Right-Mouse Drag Left/Right
translates the view in screen Z
Next: Keyboard Zoom and Clip, Previous: Mouse Z Translation, Up: Mousing and Keyboarding [Contents][Index]
Keypad 3
Push View (+Z translation)
Keypad .
Pull View (-Z translation)
Next: Scrollwheel, Previous: Keyboard Z Translation, Up: Mousing and Keyboarding [Contents][Index]
N
Zoom out
M
Zoom in
D
Slim clip
F
Fatten clip
Next: Selecting Atoms, Previous: Keyboard Zoom and Clip, Up: Mousing and Keyboarding [Contents][Index]
When there is no map, using the scroll-wheel has no effect. If there
is exactly one map displayed,
the scroll-wheel
will change the contour level of that map. If there are two or more
maps, the map for which the contour level is changed can be set using either
HID -> Scrollwheel -> Attach scroll-wheel
to which map?
and selecting a map number or clicking the "Scroll"
radio button for the map in the Display Manager.
You can turn off the map contour level changing by the scroll wheel using:
(set-scroll-by-wheel-mouse 0)
(the default is 1 [on]).
Next: Virtual Trackball, Previous: Scrollwheel, Up: Mousing and Keyboarding [Contents][Index]
Several Coot functions require the selecting of atoms to specify a residue range (for example: Regularize, Refine (Section Regularization and Real Space Refinement) or Rigid Body Fit Zone (Section Rigid Body Refinement)). Select atoms with the Left-mouse. See also Picking (Section sec_picking).
Use the scripting function
(quanta-buttons)
to make the mouse
functions more like other molecular graphics programs to which you may
be more accustomed 12.
Next: more on zooming, Previous: Selecting Atoms, Up: Mousing and Keyboarding [Contents][Index]
You may not completely like the way the
molecule is moved by the mouse movement 13. To change this, try:
HID -> Virtual Trackball -> Flat
. To
do this from the scripting interface: (vt-surface
1)
14.
If you do want screen-z rotation
screen-z rotation, you can either use Shift Right-Mouse Drag or set
the Virtual Trackball to Spherical Surface mode and move the mouse
along the bottom edge of the screen.
Previous: Virtual Trackball, Up: Mousing and Keyboarding [Contents][Index]
The function (quanta-like-zoom)
adds the ability to zoom the
view using just Shift + Mouse movement 15.
There is also a Zoom slider
(Draw -> Zoom
) for those without a right-mouse button.
Next: Coordinate-Related Features, Previous: Mousing and Keyboarding, Up: Top [Contents][Index]
The map-fitting and model-building tools can be accessed by using
Calculate -> Model/Fit/Refine…
. Many functions have
tooltips 16
describing the particular features and are documented in Chapter
Modelling and Building.
F5:
posts the Model/Fit/Refine dialog
F6:
posts the Go To Atom Window
F7:
posts the Display Control Window
• Version number: | ||
• Antialiasing: | ||
• Molecule Number: | ||
• Display Issues: | ||
• Screenshot: | ||
• Raster3D: | ||
• Display Manager: | ||
• The Modelling Toolbar: | ||
• The file selector: | ||
• Scripting: | ||
• Backups and Undo: | ||
• View Matrix: | ||
• Space Group and Symmetry: | ||
• Recentring View: | ||
• Views: | ||
• Clipping Manipulation: | ||
• Background colour: | ||
• Unit Cell: | ||
• Rotation Centre Pointer: | ||
• Orientation Axes: | ||
• Pointer Distances: | ||
• Crosshairs: | ||
• 3D Annotations: | ||
• Frame Rate: | ||
• Program Output: |
Next: Antialiasing, Up: General Features [Contents][Index]
The version number of Coot can be found at the top of the “About”
window (Help -> About
).
This will return the version of coot:
$ coot --version
There is also a script function to return the version of coot:
(coot-version)
Next: Molecule Number, Previous: Version number, Up: General Features [Contents][Index]
The built-in antialiasing (for what it’s worth) can be enabled using:
(set-do-anti-aliasing 1)
The default is 0
(off).
This can also be activated using Edit Preferences -> Others ->
Antialiasing -> Yes
.
If you have an nVidia graphics card, external antialiasing can be actived setting the environment variable __GL_FSAA_MODE. For me a setting of 5 works nicely and gives a better image than using Coot’s built-in antialiasing.
Also for nVidia graphics card users, there is the application nvidia-settings:
Antialiasing Setting -> Override Application Settings
and
slide the slider to the right. On restarting Coot, it should be in
antialias mode 17.
Next: Display Issues, Previous: Antialiasing, Up: General Features [Contents][Index]
Coot is based on the concept of molecules. Maps and coordinates are different representations of molecules. The access to the molecule is via the molecule number. It is often important therefore to know the molecule number of a particular molecule.
The Molecule Number of a molecule can be found by clicking on an atom of that molecule (if it has coordinates of course). The first number in brackets in the resulting text in the status bar and console is the Molecule Number. The Molecule Number can also be found in Display Control window (Section Display Manager). It is also displayed on the left-hand side of the molecule name in the option menus of the “Save Coordinates” and “Go To Atom” windows.
Next: Screenshot, Previous: Molecule Number, Up: General Features [Contents][Index]
The “graphics” window is drawn using OpenGL. It is considerably smoother (i.e. more frames/sec) when using a 3D accelerated X server.
The view is orthographic (i.e. the back is the same size as the front). The default clipping is about right for viewing coordinate data, but is often a little too “thick” for viewing electron density. It is easily changed (see Section Clipping Manipulation).
Depth-cueing is linear and fixed on.
The graphics window can be resized, but it has a minimum size of 400x400 pixels.
Hardware Stereo is an option for Coot (Draw -> Stereo… ->
Hardware Stereo -> OK
), side-by-side stereo is not an option.
The angle between the stereo pairs (the stereo separation) can be changed to suit your personal tastes using:
(set-hardware-stereo-angle-factor angle-factor)
where angle-factor
would typically be between 1.0 and 2.0
When asked to pick a residue or atom, the cursor changes from the normal arrow shape to a "pick" cursor. Sometimes it is difficult to see the default pick cursor, so you can change it using the function
(set-pick-cursor-index i)
where i
is an integer less than 256. The cursors can be
viewed using an external X program:
xfd -fn cursor
A yellow box called the “origin marker” marks the origin. It can be removed using:
(set-show-origin-marker 0)
Its state can be queried like this:
(show-origin-marker-state)
which returns an number (0 if it is not displayed, 1 if it is).
Next: Raster3D, Previous: Display Issues, Up: General Features [Contents][Index]
A simple screenshot (image dump) can be made using Draw ->
Screenshot -> Simple…
. Note that in side by side stereo mode you
only get the left-hand image.
Next: Display Manager, Previous: Screenshot, Up: General Features [Contents][Index]
Output suitable for use by Raster3D’s “render” can be generated using the scripting function
(raster3d file-name)
where file-name
is such as "test.r3d"
18.
There is a keyboard key to generate this file, run “render” and display the image: Function key F8.
You can also use the function
(render-image)
which will create a file coot.r3d, from which “render” produces coot.png. This png file is displayed using ImageMagick’s display program (by default). Use something like:
(set! coot-png-display-program "gqview")
to change that to different display program ("gqview" in this case).
(set! coot-png-display-program "open")
would use Preview (by default) on Macintosh.
To change the widths of the bonds and density “lines” use (for example):
(set-raster3d-bond-thickness 0.1)
and
(set-raster3d-density-thickness 0.01)
Similarly for bones:
(set-raster3d-bone-thickness 0.05)
To turn off the representations of the atoms (spheres):
(set-renderer-show-atoms 0)
Next: The Modelling Toolbar, Previous: Raster3D, Up: General Features [Contents][Index]
This is also known as “Map and molecule (coordinates) display control”. Here you can select which maps and molecules you can see and how they are drawn 19. The “Display” and “Active” are toggle buttons, either depressed (active) or undepressed (inactive). The “Display” buttons control whether a molecule (or map) is drawn and the “Active” button controls if the molecule is clickable 20 (i.e. if the molecule’s atoms can be labeled).
The "Scroll" radio buttons sets which map is has its contour level changed by scrolling the mouse scroll wheel.
By default, the path names of the files are not displayed in the Display Manager. To turn them on:
(set-show-paths-in-display-manager 1)
If you pull across the horizontal scrollbar in a Molecule view, you will see the “Render as” menu. You can use this to change between normal “Bonds (Colour by Atom)”,“Bonds (Colour by Chain)” and “C\alpha” representation There is also available “No Waters” and “C\alpha + ligands” representations.
Next: The file selector, Previous: Display Manager, Up: General Features [Contents][Index]
You might not want to have the right-hand-side vertical toolbar that contains icons for some modelling operations 21 displayed:
(hide-modelling-toolbar)
to bring it back again:
(show-modelling-toolbar)
Next: Scripting, Previous: The Modelling Toolbar, Up: General Features [Contents][Index]
The “Filter” button in the fileselection filters the filenames according to extension. For coordinates files the extensions are “.pdb” “.brk” “.mmcif” and others. For data: “.mtz”, “.hkl”, “.phs”, “.cif” and for (CCP4) maps “.ext”, “.msk” and “.map”. If you want to add to the extensions, the following functions are available:
(add-coordinates-glob-extension extension)
(add-data-glob-extension extension)
(add-map-glob-extension extension)
(add-dictionary-glob-extension extension)
where extension
is something like: ".mycif"
.
If you want the fileselection to be filtered without having to use the "Filter" button, use the scripting function
(set-filter-fileselection-filenames 1)
If you like your files initially sorted by date (rather than lexicographically, which is the default) use:
(set-sticky-sort-by-date)
Some people prefer that the fileselection for saving coordinates starts in the original directory (rather than the directory from which they last imported coordinates). This option is for them:
(set-save-coordinates-in-original-directory 1)
Next: Backups and Undo, Previous: The file selector, Up: General Features [Contents][Index]
• Python: | ||
• Scheme: | ||
• Coot State: | ||
• Key Binding: | ||
• User-Defined Functions: |
There is an compile-time option of adding a script interpreter. Currently the options are python and guile. It seems possible that in future you will be able to use both in the same executable. The binary distribution of Coot are linked with guile, others with python.
Hundreds of commands are made available for use in scripting by using SWIG, some of which are documented here. Other functions documented less well, but descriptions for them can be found at the end of this manual.
Commands described throughout this manual (such as (vt-surface
1))
can be evaluated
directly by Coot by using the “Scripting Window” (Calculate
-> Scripting…
). Note that you type the commands in the upper
entry widget and the command gets echoed (in red) and the return value
and any output is displayed in the text widget lower (green). The typed
command should be terminated with a carriage return 22. Files 23 can be evaluated (executed)
using Calculate -> Run Script…
.
Note that in scheme (the usual scripting language of Coot), the parentheses are important.
To execute a script file from the command line use the --script
filename
arguments
(except when also using the command line
argument --no-graphics
, in which case you should use -s
filename
).
After you have used the scripting window, you may have noticed that you can no longer kill Coot by using Ctrl-C in the console. To recover this ability:
(exit)
in the scripting window.
* Python Commands |
---|
Coot has an (optional) embedded python interpreter.
Thus the full power of python is available to you. Coot will look for
an initialization script
($HOME/.coot.py
) and
will execute it if found. This file should contain python commands
that set your personal preferences.
The scripting functions described in this manual are formatted suitable for use with guile, i.e.:
(function arg1 arg2…)
If you are using Python instead: the format needs to be changed to:
function(arg1,arg2…)
Note that dashes in guile function names become underscores for
python, so that (for example) (raster-screen-shot)
becomes
raster_screen_shot()
.
Next: Coot State, Previous: Python, Up: Scripting [Contents][Index]
The scheme interpreter is made available by embedding
guile. The initialization script used by this interpreter is
$HOME/.coot
. This file should contain scheme commands that
set your personal preferences.
Next: Key Binding, Previous: Scheme, Up: Scripting [Contents][Index]
The “state”
of Coot is saved on Exit and written to a
file called 0-coot.state.scm
(scheme)
0-coot.state.py
(python). This
state file contains information about the screen centre, the
clipping, colour map rotation size, the symmetry radius, and other
molecule related parameters such as filename, column labels,
coordinate filename etc..
Use Calculate -> Run Script…
to use this file
to re-create the loaded maps and models that you had when you finished
using Coot 24 last time.
A state file can be saved at any time using (save-state)
which saves to file 0-coot.state.scm
or
(save-state-filename "thing.scm")
which saves to file
thing.scm
.
When Coot starts it can optionally run the commands in
0-coot.state.scm
.
Use (set-run-state-file-status i)
to change the behaviour: i
is 0
to never run this
state file at
startup, i
is
1
to get a dialog option (this is the default) and i
is 2
to run the commands without question.
Next: User-Defined Functions, Previous: Coot State, Up: Scripting [Contents][Index]
“Power users” of Coot might like to write their own functions and bind that function to a keyboard key. How do they do that?
By using the add-key-binding function:
(add-key-binding function-name key function)
where key
is a quoted string (note that upper case and
lower case keys are distinguished - activate get upper case key binding
you need to chord the shift key 25).
for example:
(add-key-binding "Refine Active Residue with Auto-accept" "x" refine-active-residue)
Have a look at the key bindings section on the Coot wiki for several more examples.
Previous: Key Binding, Up: Scripting [Contents][Index]
“Power users” of Coot might also like to write their own functions that occur after picking an atom (or a number of atoms)
(user-defined-click n_clicks udfunc)
define a function func
which runs after the user has
made n_clicked
atom picks. func
is called
with a list of atom specifiers - the first member of which is the
molecule number.
Next: View Matrix, Previous: Scripting, Up: General Features [Contents][Index]
* Redo:: * Restoring from Backup:: |
---|
By default, each time a modification is made to a model, the old coordinates are written out 26. The backups are kept in a backup directory and are tagged with the date and the history number (lower numbers are more ancient 27). The “Undo” function discards the current molecule and loads itself from the most recent backup coordinates. Thus you do not have to remember to “Save Changes” - coot will do it for you 28.
If you have made changes to more than one molecule, Coot will pop-up a dialog box in which you should set the “Undo Molecule” i.e. the molecule to which the Undo operations will apply. Further Undo operations will continue to apply to this molecule until there are none left. If another Undo is requested Coot checks to see if there are other molecules that can be undone, if there is exactly one, then that molecule becomes the “Undo Molecule”, if there are more than one, then another Undo selection dialog will be displayed.
You can set the undo molecule using the scripting function:
(set-undo-molecule imol)
If for reasons of strange system29 requirements you want to remove the path components of the backup file name you can do so using:
(set-unpathed-backup-file-names 1)
The “undone” modifications can be re-done using this button. This is not available immediately after a modification 30.
There may be certain
circumstances 31 in which you
wish to restore from a backup but can’t get it by the “Undo”
mechanism described above. In that case, start coot as normal and
then open the (typically most recent) coordinates file in the
directory coot-backup
(or the directory pointed to the
environment variable COOT_BACKUP_DIR
if it was set) .
This file should contain your most recent edits. In such a case, it
is sensible for neatness purposes to immediately save the coordinates
(probably to the current directory) so that you are not modifying a
file in the backup directory.
See also Section Crash.
Next: Space Group and Symmetry, Previous: Backups and Undo, Up: General Features [Contents][Index]
It is sometimes useful to use this to orient the view and export this orientation to other programs. The orientation matrix of the view can be displayed (in the console) using:
(view-matrix)
Also, the internal representation of the view can be returned and set using:
(view-quaternion)
to return a 4-element list
(set-view-quaternion i j k l)
which sets the view quaternion.
So the usage of these functions would be something like:
(let ((v (view-quaternion))) ;; manipulate v here, maybe (apply set-view-quaternion v))
Next: Recentring View, Previous: View Matrix, Up: General Features [Contents][Index]
Occasionally you may want to know the space group of a particular molecule. Interactively (for maps) you can see it using the Map Properties button in the Molecule Display Control dialog.
There is a scripting interface function that returns the space group for a given molecule 32:
(show-spacegroup imol)
You can force a space group onto a molecule using the following:
(set-space-group imol space-group)
where space-group
is one of the standard CCP4 space group
names (e.g. "P 21 21 21"
).
To show the symmetry operators of a particular molecule use:
(get-symmetry imol)
which will return a list of strings.
Sometimes molecular replacement solutions (for example) create models with chains non-optimally placed relative to each other - a symmetry-related copy would be more apealling (but would be equivalent, crystalographically). For example, to move the B chain to a symmetry-related position:
Centre on an atom in the symmetry-related B chain (where you want the B chain to be)
Extensions -> Modelling -> Symm Shift Reference Chain Here.
Next: Views, Previous: Space Group and Symmetry, Up: General Features [Contents][Index]
Draw -> Go To Atom…
to select an atom
using the keyboard. Note that you can subsequently use “Space” in
the “graphics” window (OpenGL canvas) to recentre on the next
C\alpha.
(set-rotation-centre x y z)
.
If you don’t want smooth recentring (sliding)
Edit -> Preferences -> Smooth Recentring -> Off
. You
can also use this dialog to speed it up a bit (by decreasing the
number of steps instead of turning it off).
Next: Clipping Manipulation, Previous: Recentring View, Up: General Features [Contents][Index]
Coot has a views interface (you might call them ”scenes“) that define a particular orientation, zoom and view centre. Coot and linearly interpolate between the views. The animation play back speed can be set with the ”Views Play Speed“ menu item - default is a speed of 10.
The views interface can be found under the Extensions menu item.
Next: Background colour, Previous: Views, Up: General Features [Contents][Index]
The clipping planes (a.k.a. “slab”
) can
be adjusted using Edit -> Clipping
and adjusting
the slider. There is only one parameter to change and it affects both
the front and the back clipping planes 33.
The clipping can also be changed using keyboard “D” and “F”.
It can also be changed with Ctrl + Right-mouse drag up and down. Likewise the screen-Z can be changed with Ctrl + Right-mouse left and right 34.
One can “push” and “pull” the view in the screen-Z direction using keypad 3 and keypad “.” (see Section Keyboard Z Translation).
Next: Unit Cell, Previous: Clipping Manipulation, Up: General Features [Contents][Index]
The background colour can be set either using a GUI dialog
(Edit$ -> Background Colour
) or the function
(set-background-colour 0.00 0.00 0.00)
, where the arguments
are 3 numbers between 0.0 and 1.0, which respectively represent the
red, green and blue components of the background colour. The default
is (0.0, 0.0, 0.0) (black).
Next: Rotation Centre Pointer, Previous: Background colour, Up: General Features [Contents][Index]
If coordinates have symmetry available then unit
cells can be drawn for molecules (Draw -> Cell &
Symmetry -> Show Unit Cell?
).
Next: Orientation Axes, Previous: Unit Cell, Up: General Features [Contents][Index]
There is a pink pointer
at the centre of the screen that marks the rotation centre.
The size of the pointer can be changed using Edit
-> Pink Pointer Size…
or using scripting commands:
(set-rotation-centre-size 0.3)
.
Next: Pointer Distances, Previous: Rotation Centre Pointer, Up: General Features [Contents][Index]
The green axes showing the orientation of the molecule are displayed by default. To remove them use the scripting function;
(set-draw-axes 0)
Next: Crosshairs, Previous: Orientation Axes, Up: General Features [Contents][Index]
The Rotation Centre Pointer is sometimes called simply “Pointer”. One can find distances to the pointer from any active set of atoms using “Pointer Distances” (under Measures). If you move the Pointer (e.g. by centering on an atom) and want to update the distances to it, you have to toggle off and on the “Show Pointer Distances” on the Pointer Distances dialog.
Next: 3D Annotations, Previous: Pointer Distances, Up: General Features [Contents][Index]
Crosshairs can be drawn at the centre of the screen, using either the
C key35 in graphics
window or Draw -> Crosshairs…
. The ticks are at
1.54Å, 2.7Å and 3.8Å.
Next: Frame Rate, Previous: Crosshairs, Up: General Features [Contents][Index]
Positions in 3D space can be annotated with 3D text. The mechanism to do this can be found under Extensions -> Representations -> 3D Annotations. 3D Annotations can be saved to and loaded from a file.
Next: Program Output, Previous: 3D Annotations, Up: General Features [Contents][Index]
Sometimes, you might as yourself “how fast is the computer?”
36. Using Calculate ->
Frames/Sec
you can see how fast the molecule is rotating, giving an
indication of graphics performance. It is often better to use a map
that is more realistic and stop the picture whizzing round. The output
is written to the status bar and the console, you need to give it a few
seconds to “settle down”. It is best not to have other widgets
overlaying the GL canvas as you do this.
The contouring elapsed time 37 gives an indication of CPU performance.
Previous: Frame Rate, Up: General Features [Contents][Index]
Due to its “in development” nature (at the moment), Coot produces a lot of “console” 38 output - much of it debugging or “informational”. This will go away in due course. You are advised to run Coot so that you can see the console and the graphics window at the same time, since feedback from atom clicking (for example) is often written there rather than displayed in the graphics window.
Next: Modelling and Building, Previous: General Features, Up: Top [Contents][Index]
Next: Atom Info, Up: Coordinate-Related Features [Contents][Index]
The format
of coordinates that can be read by coot is either PDB or mmCIF. To read
coordinates, choose File -> Read Coordinates
from the
menu-bar. Immediately after the coordinates have been read, the view is
(by default) recentred to the centre of this new molecule and the
molecule is displayed. The recentring of the view after the coordinates
have been read can be turned off by unclicking the "Recentre?"
radio-button.
To disable the recentring of the view on reading a coordinates file via
scripting, use: (set-recentre-on-read-pdb 0)
. However, when
reading a coordinates file from a script it is just as good (if not
better) to use (handle-read-draw-molecule-with-recentre
filename 0)
- the additional 0
means “don’t recentre”.
And that affects just the reading of filename
and not
subsequent files.
By default coot does not allow reading coordinates with duplicated sequence numbers. To enable the reading of files with duplicated sequence numbers use the function:
(allow-duplicate-sequence-numbers)
Coot can read MDL mol files.
Coot uses the space group on the “CRYST1” line of the pdb file. The space group should be one of the xHM symbols listed (for example) in the CCP4 dictionary file syminfo.lib. So, for example, "R 3 2 :H" should be used in preference to "H32".
The reading multiple files using the GUI is not available (at the moment). However the following scripting functions are available:
(read-pdb-all)
which reads all the “*.pdb” files in the current directory
(multi-read-pdb glob-pattern dir)
which reads all the files matching glob-pattern
in
directory dir
. Typical usage of this might be:
(multi-read-pdb "a*.pdb" ".")
Alternatively you can specify the files to be opened on the command line when you start coot (see Section Command Line Arguments).
SHELX ".res" (and ".ins" of course) files can be read into Coot, either
using the GUI File -> Open Coordinates…
or by the
scripting function:
(read-shelx-ins-file file-name)
where file-name
is quoted, such as "thox.ins"
.
Although Coot should be able to read any SHELX ".res" file, it may currently have trouble displaying the bonds for centro-symmetric structures.
ShelxL atoms with negative PART
numbers are given alternative
configuration identifiers in lower case.
To write a SHELX ".ins" file:
(write-shelx-ins-file imol file-name)
where imol
is the number of the molecule you wish to
export.
This will be a rudimentary file if the coordinates were initially from a "PDB" file, but will contain substantial SHELX commands if the coordinates were initially generated from a SHELX ins file.
Next: Atom Labeling, Previous: Reading coordinates, Up: Coordinate-Related Features [Contents][Index]
Information about about a particular atom is displayed in the text
console when you click using middle-mouse. Information for all the
atoms in a residue is available using Info -> Residue
Info…
.
The temperature factors
and occupancy of the atoms in a residue can be set by using
Edit -> Residue Info…
.
Next: Atom Colouring, Previous: Atom Info, Up: Coordinate-Related Features [Contents][Index]
Use Shift + left-mouse to label atom. Do the same to toggle off the
label. The font size is changeable using Edit ->
Font Size…
. The newly centred atom is labelled by default.
To turn this off use:
(set-label-on-recentre-flag 0)
Some people prefer to have atom labels that are shorter, without the slashes and residue name:
(set-brief-atom-labels 1)
To change the atom label colour, use:
(set-font-colour 0.9 0.9 0.9)
Next: Bond Parameters, Previous: Atom Labeling, Up: Coordinate-Related Features [Contents][Index]
The atom colouring system in coot is unsophisticated. Typically, atoms are coloured by element: carbons are yellow, oxygens red, nitrogens blue, hydrogens white and everything else green (see Section Display Manager for colour by chain). However, it is useful to be able to distinguish different molecules by colour, so by default coot rotates the colour map of the atoms (i.e. changes the H value in the HSV 39 colour system). The amount of the rotation depends on the molecule number and a user-settable parameter:
(set-colour-map-rotation-on-read-pdb 30)
.
The default value is 31^\circ.
Also one is able to select only the Carbon atoms to change colour in
this manner: (set-colour-map-rotation-on-read-pdb-c-only-flag
1)
.
The colour map rotation can be set individually for each molecule by
using the GUI: Edit -> Bond Colours...
.
Next: Download coordinates, Previous: Atom Colouring, Up: Coordinate-Related Features [Contents][Index]
The various bond parameters can be set using the GUI dialog
Draw -> Bond Parameters
or via scripting
functions.
The represention style of the molecule that has the active residue (if any) can be changed using the scroll wheel with Ctrl and Shift.
The thickness (width) of
bonds of individual molecules can be changed. This can be done via the
Bond Parameters
dialog or the scripting interface:
(set-bond-thickness thickness imol)
where imol
is the molecule number.
The default thickness is 3 pixels. The bond thickness also applies to the symmetry atoms of the molecule. The default bond thickness for new molecules can be set using:
(set-default-bond-thickness thick)
where thick
is an integer.
There is no means to change the bond thickness of a residue selection within a molecule.
Initially, hydrogens are displayed. They can be undisplayed using
(set-draw-hydrogens mol-no 0)
40
where mol-no
is the molecule number.
There is a GUI to control this too, under “Edit -> Bond Parameters”.
It is occasionally useful when analysing non-crystallographically related molecules to have “images” of the other related molecules appear matched onto the current coordinates. It is important to understand that these ghosts are for displaying differences of NCS-related molecules by structure superposition, not displaying neighbouring NCS related molecules. As you read in coordinates in Coot, they are checked for NCS relationships and clicking on “Edit -> Bond Parameters -> Show NCS Ghosts” -> “Yes” -> “Apply” will create “ghost” copies of them over the reference chain 41.
Sometimes SSM does not provide a good (or even useful) matrix. In that
case, we can specify the residue range ourselves and let the LSQ
algorithm provide the matrix. A gui dialog for this operation can be
found under Extensions -> NCS -> NCS Ghosts by Residue
Range…
.
The scripting function is used like this:
(manual-ncs-ghosts imol resno-start resno-end ncs-chain-ids)
Typical usage: (manual-ncs-ghosts 0 1 10 (list "A" "B" "C"))
note that in ncs-chain-ids
, the NCS master/reference
chain-id goes first.
Coot can use the relative transformations of the NCS-related molecules
in a coordinates molecule to transform maps. Use Calculate
-> NCS Maps…
to do this (note the NCS maps
only make sense in the region of the reference chain (see above).
Note also that the internal representation of the map is not transformed. If you try to export a NCS overlay map you will get an untransformed map. A transformed map only makes sense around a given point (and when using transformed maps in Coot, this reference point is changed on the fly, thus allowing map transformations on the fly). [This applies to NCS overlap maps, NCS averaged maps are transformed].
This will also create an NCS averaged map 42.
Coot can use a set of strict NCS matrices to specify NCS which means that NCS-related molecules can appear like convention symmetry-related molecules.
(add-strict-ncs-matrix imol ncs-chain-id ncs-target-chain-id m11 m12 m13 m21 m22 m23 m31 m32 m33 t1 t2 t3)
where ncs-chain-id
might be "B", "C" "D" (etc.) and
ncs-target-chain-id
is "A", i.e. the B, C, D molecules are
NCS copies of the A chain.
for icosahedral symmetry the translation components t1
,
t2
, t3
will be 0.
You need to turn on symmetry for molecule imol
and set the
displayed symmetry object type to "Display Near Chains".
Next: Get Coordinates and Map from EDS, Previous: Bond Parameters, Up: Coordinate-Related Features [Contents][Index]
Coot provides the possibility to download coordinates from an
OCA 43.
(e.g. EBI) server 44 (File
-> Get PDB Using Code…
). A pop-up entry box is
displayed into which you can type a PDB accession code. Coot will
then connect to the web server and transfer the file. Coot blocks as
it does this (which is not ideal) but on a semi-decent internet
connection, it’s not too bad. The downloaded coordinates are saved
into a directory called coot-download.
It is also possible to download mmCIF data and generate a map. This currently requires a properly formatted database structure factors mmCIF file 45.
Next: Save coordinates, Previous: Download coordinates, Up: Coordinate-Related Features [Contents][Index]
Using this function we have the ability to download coordinates and view the map from structures in the Electron Density Server (EDS) at Uppsala University. This is a much more robust and faster way to see maps from deposited structures. This function can be found under the File menu item.
This feature was added with the assistance of Gerard Kleywegt. If you use the EDS, please cite GJ Kleywegt, MR Harris, JY Zou, TC Taylor, A Wählby & TA Jones (2004), "The Uppsala Electron-Density Server", Acta Cryst. D60, 2240-2249.
Next: Setting the Space Group, Previous: Get Coordinates and Map from EDS, Up: Coordinate-Related Features [Contents][Index]
On selecting from the menus File -> Save
Coordinates…
you are first presented with a list of molecules
which have coordinates. As well as the molecule number, there is the
molecule name - very frequently the name of the file that was read in
to generate the coordinates in coot initially. However, this is only
a molecule name and should not be confused with the filename to
which the coordinates are saved. The coordinates filename can
be selected using the Select Filename…
button.
If your filename ends in .cif
, .mmcif
or
.mmCIF
then an mmCIF file will be written (not a “PDB”
file).
Next: Anisotropic Atoms, Previous: Save coordinates, Up: Coordinate-Related Features [Contents][Index]
If for some reason, the pdb file that you read does not have a space group, or has the wrong space group, then you can set it using the following function:
(set-space-group imol symbol)
e.g.:
(set-space-group 0 "P 41 21 2")
Next: Symmetry, Previous: Setting the Space Group, Up: Coordinate-Related Features [Contents][Index]
By default anisotropic atom information is
not represented 46. To turn them on,
use Draw -> Anisotropic Atoms -> Show
Anisotropic Atoms? -> Yes
, or the command:
(set-show-aniso 1)
.
You cannot currently display thermal ellipsoids 47 for isotropic atoms.
Next: Sequence View, Previous: Anisotropic Atoms, Up: Coordinate-Related Features [Contents][Index]
Coordinates symmetry is “dynamic”. Symmetry atoms can be labeled 48.
Every time you recentre, the symmetry coordinates are updated. The
information shown contains the atom information and the symmetry
operation number and translations needed to generate the atom in that
position. To show the symmetry operator as a string (rather than a
(1-based) index into the list of symmetry operators (as is the default))
Use Draw -> Show Symmetry> -> Expanded Symmetry Atom Labels
.
Coot generates symmetry related atoms by moving the current set close to
the origin by a translation, performing the symmetry expansion around
the origin and moving the the symmetry coordinates back by applying the
inverse of the origin translation. The origin translation is also
displayed in curly braces, e.g. “{1 -1 0}”.
By default symmetry atoms are not displayed.
If you want coot to display symmetry coordinates without having to use the gui, add to your ~/.coot the following:
(set-show-symmetry-master 1)
The symmetry can be represented as C\alphas. This along with representation of the molecule as C\alphas (Section Display Manager) allow the production of a packing diagram.
Sometimes (rarely) coot misses symmetry-related molecules that should be displayed. In that case you need to expand the shift search (the default is 1):
(set-symmetry-shift-search-size 2)
This is a hack, until the symmetry search algorithm is improved.
Next: Print Sequence, Previous: Symmetry, Up: Coordinate-Related Features [Contents][Index]
The protein is represented by one letter codes and coloured according to secondary structure. These one letter codes are active - if you click on them, they will change the centre of the graphics window - in much the same way as clicking on a residue in the Ramachandran plot.
Next: Environment Distances, Previous: Sequence View, Up: Coordinate-Related Features [Contents][Index]
The single letter code (of the imol
th molecule) is written
out to the console in FASTA format. Use can use this to cut and paste
into other applications:
(print-sequence imol)
Next: Distances and Angles, Previous: Print Sequence, Up: Coordinate-Related Features [Contents][Index]
Environment distances are turned on using Info -> Environment
Distances…
. Contacts to other residues are shown and to
symmetry-related atoms if symmetry is being displayed. The contacts
are coloured by atom type 49.
Next: Zero Occupancy Marker, Previous: Environment Distances, Up: Coordinate-Related Features [Contents][Index]
The distance between atoms can be found using Info
-> Distance
50. The result is displayed graphically, and written to the
console.
Next: Atomic Dots, Previous: Distances and Angles, Up: Coordinate-Related Features [Contents][Index]
Atoms of zero occupancy are marked with a grey spot. To turn off these markers, use:
(set-draw-zero-occ-markers 0)
Use an argument of 1 to turn them on.
Next: Ball and Stick Representation, Previous: Zero Occupancy Marker, Up: Coordinate-Related Features [Contents][Index]
You can draw dots round arbitrary atom selections
(dots imol atom-selection dot-density radius)
The function returns a handle.
e.g. put a sphere of dots around all atoms of the 0th molecule (it might be a set of heavy atom coordinates) at the default dot density and radius:
(dots 0 "/1" "heavy-atom-sites" 1 1)
You can’t change the colour of the dots.
There is no internal mechanism to change the radius according to atom type. With some cleverness you might be able to call this function several times and change the radius according to the atom selection.
There is a function to clear up the dots for a particular molecule
imol
and dots set identifier dots-handle
(clear-dots imol dots-handle)
There is a function to return how many dots sets there are for a
particular molecule imol
:
(n-dots-set imol)
Next: Mean and Median Temperature Factors, Previous: Atomic Dots, Up: Coordinate-Related Features [Contents][Index]
Fragments of the molecule can be rendered as a “ball and stick” molecule:
(make-ball-and-stick imol atom-selection bond-thickness sphere-size draw-spheres-flag)
e.g.
(make-ball-and-stick 0 "/1/A/10-20" 0.3 0.4 1)
The ball-and-stick representation can be cleared using:
(clear-ball-and-stick imol)
Next: Secondary Structure Matching (SSM), Previous: Ball and Stick Representation, Up: Coordinate-Related Features [Contents][Index]
Coot can be used to calculate the mean (average) and median temperatures factors:
(average-temperature-factor imol)
(median-temperature-factor imol)
-1 is returned if there was a problem 51.
Next: Least-Squares Fitting, Previous: Mean and Median Temperature Factors, Up: Coordinate-Related Features [Contents][Index]
The excellent SSM alogrithm52 of Eugene Krissinel is available in Coot. The GUI interface
is straight-forward and can be found under Calculate -> SSM
Superpose
. You can specify the specific chains that you wish to match
using the "Use Specific Chain" check-button.
There is a scripting level function which gives even finer control:
(superpose-with-atom-selection imol1 imol2
mmdb-atom-selection-string-1 mmdb-atom-selection-string-2
move-copy-flag )
the move-copy-flag
should be 1 if you want to apply the
transformation to a copy of imol2
(rather than
imol2
itself). Otherwise, move-copy-flag
should be 0.
mmdb atom selection strings (Coordinate-IDs) are explained in detail in the mmdb manual.
Briefly, the string should be formed in this manner:
/mdl/chn/seq(res).ic/atm[elm]:aloc
e.g. "/1/A/12-130/CA"
<p><a href="http://www.ebi.ac.uk/~keb/cldoc/object/cl_obj_surf.html#CoordinateID">The mmdb manual CoordinateID description</a>.</p>
Next: Ligand Overlaying, Previous: Secondary Structure Matching (SSM), Up: Coordinate-Related Features [Contents][Index]
There is a simple GUI for this Calculate -> LSQ Superpose…
The scripting interface to LSQ fitting is as follows:
(simple-lsq-match ref-start-resno ref-end-resno ref-chain-id imol-ref
mov-start-resno mov-end-resno mov-chain-id imol-mov
match-type)
where:
ref-start-resno
is the starting residue number
of the reference molecule
ref-end-resno
is the last residue number
of the reference molecule
mov-start-resno
is the starting residue number
of the moving molecule
mov-end-resno
is the last residue number
of the moving molecule
match-type
is one of 'CA
,
'main
, or 'all
.
e.g.:
(simple-lsq-match 940 950 "A" 0 940 950 "A" 1 'main)
More sophisticated (match molecule number 1 chain “B” on to molecule number 0 chain “A”):
(define match1 (list 840 850 "A" 440 450 "B" 'all))
(define match2 (list 940 950 "A" 540 550 "B" 'main))
(clear-lsq-matches)
(set-match-element match1)
(set-match-element match2)
(apply-lsq-matches 0 1)
; match molecule number 1 onto molecule number 0.
Next: Writing PDB files, Previous: Least-Squares Fitting, Up: Coordinate-Related Features [Contents][Index]
The scripting function
(overlap-ligands imol-ligand imol-ref chain-id-ref resno-ref)
returns a rotation+translation operator which can be applied to other
molecules (and maps). Here, imol-ligand
is the molecule
number of the ligand (which is presumed to be a a molecule on its own -
Coot simply takes the first residue that it finds). imol-ref
chain-id-ref resno-ref
collectively describe the target position for
the moving imol-ligand
molecule.
The convenience function
(overlay-my-ligands imol-mov chain-id-mov resno-mov imol-ref chain-id-ref resno-ref)
wraps overlap-ligands
.
The GUI for the function can be found under
Extensions -> Modelling -> Supperpose Ligands…
Previous: Ligand Overlaying, Up: Coordinate-Related Features [Contents][Index]
As well as the GUI option File -> Save Coordinates…
there
is a scripting options available:
(write-pdb-file imol pdb-file-name)
which writes the imol
th coordinates molecule to
filename
.
To write a specific residue range:
(write-residue-range-to-pdb-file imol chain-id start-resno
endresno pdb-file-name)
Next: Map-Related Features, Previous: Coordinate-Related Features, Up: Top [Contents][Index]
The functions described in this chapter manipulate, extend or build
molecules and can be found under Calculate ->
Model/Fit/Refine…
. When activated, the dialog "stays on top"
of the main graphics window 53. Some people think that this is not always desirable, so
this behaviour can be undone using:
(set-model-fit-refine-dialog-stays-on-top 0)
• Dictionary: | ||
• Sphere Refinement: | ||
• Refining Specific Residues: | ||
• Refining Carbohydrates: | ||
• Planar Peptide Restraints: | ||
• The UNK residue type: | ||
• Moving Zero Occupancy Atoms: |
Coot will read the geometry restraints for
refmac and use them in fragment (zone) idealization - this is called
“Regularization”.
The geometrical restraints
are, by default, bonds, angles, planes
and non-bonded
contacts. You can additionally use torsion restraints
by Calculate -> Model/Fit/Refine… -> Refine/Regularize Control
-> Use Torsion Restraints
. Truth to tell, this has not been
successful in my hands (sadly).
“RS (Real Space) Refinement” (after Diamond, 1971 54) in Coot is the use of the map in addition to geometry terms to improve the positions of the atoms. Select “Regularize” from the “Model/Fit/Refine” dialog and click on 2 atoms to define the zone (you can of course click on the same atom twice if you only want to regularize one residue). Coot then regularizes the residue range. At the end Coot, displays the intermediate atoms in white and also displays a dialog, in which you can accept or reject this regularization. In the console are displayed the \chi^2 values of the various geometrical restraints for the zone before and after the regularization. Usually the \chi^2 values are considerably decreased - structure idealization such as this should drive the \chi^2 values toward zero.
The use of “Refinement” is similar - with the addition of using a map. The map used to refine the structure is set by using the “Refine/Regularize Control” dialog. If you have read/created only one map into Coot, then that map will be used (there is no need to set it explicitly).
Use, for example,
(set-matrix 20.0)
to change the weight of the map gradients to geometric gradients. The higher the number the more weight that is given to the map terms 55. The default is 60.0. This will be needed for maps generated from data not on (or close to) the absolute scale or maps that have been scaled (for example so that the sigma level has been scaled to 1.0).
For both “Regularize Zone” and “Refine Zone” one is able to use a
single click to
refine a residue range. Pressing A on the keyboard while
selecting an atom in a residue will automatically create a residue
range with that residue in the middle. By default the zone is
extended one residue either size of the central residue. This can be
changed to 2 either side using (set-refine-auto-range-step
2)
.
Intermediate (white) atoms can be moved around with the mouse (click and drag with left-mouse, by default). Refinement will proceed from the new atom positions when the mouse button is released. It is possible to create incorrect atom nomenclature and/or chiral volumes in this manner - so some care must be taken. Press the A key as you left-mouse click to move atoms more “locally” (rather than a linear shear) and Ctrl key as you left-mouse click to move just one atom.
In more up to date versions, Coot will display colour patches (something like a traffic light system) representing the chi squared values of each of types of geometric feature refined. Typically “5 greens” is the thing to aim for, the colour changes occurring at chi squared values 2, 5 and 8 (8 being the most red).
To prevent the unintentional refinement of a large number of residues,
there is a “heuristic fencepost” of 20 residues. A selection of
than 20 residues will not be regularized or refined. The limit can be
changed using the scripting function: e.g.
(set-refine-max-residues 30)
.
The geometry description for residues, monomers and links used by Coot are in the standard mmCIF format. Because this format alows multiple comp_ids (residue types) to be described within a cif loop, it is hard to tell when a dictionary entry needs to be overwritten when reading a new file. Therefore Coot makes this extra constraint: that the “chem_comp” loop should appear first in the comp list data item - if this is the case, then Coot can overwrite an old restraint table for a particular comp_id/residue-type when a new one is read.
By default,
the geometry dictionary entries for only the standard
residues are read in at the start 56. It may be that your particular ligand is not amongst
these. To interactively add a dictionary entry use File
-> Import CIF Dictionary
.
There is a selector in the cif dictionary file chooser that allow you to select the molecule to which molecule refers. Each of the indididual molecules can be specifically selected. “All“ means that the dictionary refers to all loaded molecules and “Auto“ means that the dictionary will be applied to all model molecules if the comp_id/residue name is not on the non-auto-load list and will choose the latest model molecule if the comp_id/residue name is on the non-auto-load list. By default the non-auto-load list consists of INH, LIG, DRG, XXX, and the series LG0-9.
Alternatively, you can use the function:
(read-cif-dictionary filename)
and add this to your .coot
file (this may be the preferred
method if you want to read the file on more than one occasion).
Note: the dictionary also provides the description of the ligand’s torsions.
Next: Refining Specific Residues, Previous: Dictionary, Up: Regularization and Real Space Refinement [Contents][Index]
Sphere refinement selects residues within a certain distance of the residue at the centre of the screen and includes them for real space refinement. In this way, one can select residues that are not in a linear range. This technique is useful for refining disulfide bonds and glycosidic linkages.
To enable sphere refinement, Right-mouse click in the right hand side of the horizontal toolbutton menu, Manage buttons -> [Tick] Sphere Refine -> Apply. You will need a python-enabled Coot to do this.
The following adds a key binding (Shift-R) that refines resides that are within 3.5Å of the residue at the centre of the screen:
(define *sphere-refine-radius* 3.5) (add-key-binding "Refine residues in a sphere" "R" (lambda () (using-active-atom (let* ((rc-spec (list aa-chain-id aa-res-no aa-ins-code)) (ls (residues-near-residue aa-imol rc-spec *sphere-refine-radius*))) (refine-residues aa-imol (cons rc-spec ls))))))
Next: Refining Carbohydrates, Previous: Sphere Refinement, Up: Regularization and Real Space Refinement [Contents][Index]
You can specify the residues that you want to refine without using a
linear or sphere selection usine refine-residues
. For example:
(refine-residues 0 '(("L" 501 "") ("L" 503 "")))
will refine residues A501 and A503 (and residue A502 (if it exists) will be an anchoring residue - used in optimizing the link geometry of the atoms in A501 and A503).
Next: Planar Peptide Restraints, Previous: Refining Specific Residues, Up: Regularization and Real Space Refinement [Contents][Index]
Refining carbohydrates monomers should be as straightforward as refining a protein residue. Coot will look in the dictionary for the 3-letter code for the particular residue type, if it does not find it, Coot will try to search for dictionary files using “-b-D” or “-a-L” extensions.
When refining a group of carbohydrates, the situation needs a bit more explanation. For each residue pair with tandem residue numbers specified in the refinement range selection, Coot checks if these residue types are are furanose or pyranose in the dictionary, and if the are both one or the other, then it tries to see if there are any of the 11 link types (BETA1-4, BETA2-3, ALPHA1-2 and so on) specified in the dictionary. It does this by a distance check of the potentially bonding atoms. If the distance is less than 3.0Å, then a glycosidic bond is made and used in the refinement.
Bonds between protein and carbohydrate and branched carbohydrates can be refined using “Sphere Refinement”.
Instead of using a sphere to make a residue selection, you can specify
the residues directly using refine-residues
, for example:
(refine-residues 0 '(("L" 501 "") ("L" 503 "")))
LINK and LINKR cards are not yet used to determine the geometry of the restraints.
Next: The UNK residue type, Previous: Refining Carbohydrates, Up: Regularization and Real Space Refinement [Contents][Index]
By default, Coot uses a 5 atom (CA-1, C-1, O-1, N-2, CA-2) planar peptide restraints. These restraints should help in low resolution fitting (the main-chains becomes less distorted), reduce accidental cis-peptides and may help “clean up” Ramachandran plots.
(add-planar-peptide-restraints)
And similarly they can be removed:
(remove-planar-peptide-restraints)
There is also a GUI to add and remove these restraints in
Extensions -> Refine… -> Peptide Restraints…
Next: Moving Zero Occupancy Atoms, Previous: Planar Peptide Restraints, Up: Regularization and Real Space Refinement [Contents][Index]
The UNK
residue type is a special residue type to Coot. It has
been added for use with Buccaneer. Don’t give you ligand (or anything
else) the 3-letter-code UNK
or confusion will result
57.
Previous: The UNK residue type, Up: Regularization and Real Space Refinement [Contents][Index]
By default, atoms with zero occupancy are moved when refining and regularizing. This can sometimes be inconvenient. To turn of the movement of atoms with zero occupancy when refining and regularizing:
(set-refinement-move-atoms-with-zero-occupancy 0)
Next: Rotate/Translate Zone, Previous: Regularization and Real Space Refinement, Up: Modelling and Building [Contents][Index]
You can change the map that is used for the fitting and refinement tools
using the Select Map...
button on the Model/Fit/Refine
dialog.
Next: Rigid Body Refinement, Previous: Changing the Map for Building/Refinement, Up: Modelling and Building [Contents][Index]
“Rotate/Translate Zone” from the “Model/Fit/Refine” menu allows manual movement of a zone. After pressing the “Rotate/Translate Zone” button, select two atoms in the graphics canvas to define a residue range 58, the second atom that you click will be the local rotation centre for the zone. The atoms selected in the moving fragment have the same alternate conformation code as the first atom you click. To actuate a transformation, click and drag horizontally across the relevant button in the newly-created “Rotation & Translation” dialog. The axis system of the rotations and translations are the screen coordinates. Alternatively 59, you can click using left-mouse on an atom in the fragment and drag the fragment around. Use Control Left-mouse to move just one atom, rather than the whole fragment. If you click Control Left-mouse whilst not over an atom then you can rotate the fragment using mouse drag. Click “OK” (or press Return) when the transformation is complete.
To change the rotation point to the centre of the intermediate atoms (rather than the second clicked atom), use the setting:
(set-rotate-translate-zone-rotates-about-zone-centre 1)
Next: Simplex Refinement, Previous: Rotate/Translate Zone, Up: Modelling and Building [Contents][Index]
“Rigid Body Fit Zone” from the “Model/Fit/Refine” dialog provides rigid body refinement. The selection is zone-based 60. So to refine just one residue, click on one atom twice.
Sometimes no results are displayed after Rigid Body Fit Zone. This is because the final model positions had too many final atom positions in negative density. If you want to over-rule the default fraction of atoms in the zone that have an acceptable fit (0.75), to be (say) 0.25:
(set-rigid-body-fit-acceptable-fit-fraction 0.25)
Next: Post-manipulation-hook, Previous: Rigid Body Refinement, Up: Modelling and Building [Contents][Index]
Rigid body refinement via Nelder-Mead Simplex minimization is available
in Coot. Simplex refinement has a larger radius of convergence and thus
is useful in a position where simple rigid body refinement finds the
wrong minimum. However the Simplex algorithm is much slower. Simplex
refinement for a residue range start-resno
to
end-resno
(inclusive) in chain chain-id
can
be accessed as follows:
(fit-residue-range-to-map-by-simplex start-resno end-resno alt-loc
chain-id imol imol-for-map)
There is currently no GUI interface to Simplex refinement.
Next: Baton Building, Previous: Simplex Refinement, Up: Modelling and Building [Contents][Index]
If you wanted automatically run a function after a model has been manipulated then you can do so using by creating a function that takes 2 arguments, such as:
(post-manipulation-hook imol manipulation-mode)
manipulation-mode
is one of (DELETED)
,
(MUTATED)
or (MOVINGATOMS)
.
And of course imol
is the model number of the maniplated
molecule.
(It would of course be far more useful if this function was also passed a list of residues - that is something for the future).
Next: Reversing Direction of Fragment, Previous: Post-manipulation-hook, Up: Modelling and Building [Contents][Index]
Baton build is most useful if a skeleton is already calculated and displayed (see Section Skeletonization). When three or more atoms have been built in a chain, Coot will use a prior probability distribution for the next position based on the position of the previous three. The analysis is similar to that of Oldfield & Hubbard (1994) 61, however it is based on a more recent and considerably larger database.
Little crosses are drawn representing directions in which is is
possible that the chain goes, and a baton is drawn from the current
point to one of these new positions. If you don’t like this
particular direction 62, use Try Another
. The
list of directions is scored according to the above criterion and
sorted so that the most likely is at the top of the list and displayed
first as the baton direction.
When starting baton building, be sure to be about 3.8Å from the position of the first-placed C\alpha, this is because the next C\alpha is placed at the end of the baton, the baton root being at the centre of the screen. So, when trying to baton-build a chain starting at residue 1, centre the screen at about the position of residue 2.
It seems like a good idea to increase the map sampling to 2 or even 2.5
(before reading in your mtz file) [a grid sampling of about 0.5Å
seems reasonable] when trying to baton-build a low resolution map. You
can set the map sampling using Edit -> Map Parameters -> Map
Sampling
.
Occasionally, every point is not where you want to position the next atom. In that case you can either shorten or lengthen the baton, or position it yourself using the mouse. Use “b” on the keyboard to swap to baton mode for the mouse 63.
Baton-built atoms are placed into a molecule called “Baton Atom” and it is often sensible to save the coordinates of this molecule before quitting coot.
If you try to trace a high resolution map (1.5Å or better) you will need to increase the skeleton search depth from the default (10), for example:
(set-max-skeleton-search-depth 20)
Alternatively, you could generate a new map using data to a more moderate resolution (2Å), the map may be easier to interpret at that resolution anyhow 64.
The guide positions are updated every time the “Accept” button is clicked. The molecule name for these atoms is “Baton Build Guide Points” and is is not usually necessary to keep them.
There is also an “Undo” button for baton-building. Pressing this will delete the most recently placed C\alpha and the guide points will be recalculated for the previous position. The number of “Undo”s is unlimited. Note that you should use the “Undo” button in the Baton Build dialog, not the one in the “Model/Fit/Refine” dialog (Section Backups and Undo).
Sometimes (especially at loops) you can see
the direction in which the chain should go, but there is no skeleton
(see Section Skeletonization) is displayed (and consequently no
guide points) in that direction. In that case, “Undo” the previous
atom and decrease the skeletonization level (Edit
-> Skeleton Parameters -> Skeletonization
Level
). Accept the atom (in the same place as last time) and now
when the new guide points are displayed, there should be an option to
build in a new direction.
The following scenario is not uncommon: you find a nice stretch of density and start baton building in it. After a while you come to a point where you stop (dismissing the baton build dialog). You want to go back to where you started and build the other way. How do you do that?
(set-baton-build-params start-resno
chain-id "backwards")
where start-resno
would typically
be 0 65 and chain-id
would be
""
(default).
Next: C-alpha -> Mainchain, Previous: Baton Building, Up: Modelling and Building [Contents][Index]
After you’ve build a fragment, sometimes you might want to change the direction of that fragment (this function changes an already existing fragment, as opposed to Backwards Building which sets up Baton Building to place new points in reverse order).
The fragment is defined as a contiguous set of residues numbers. So that you should be sure that other partial fragments which have the same chain id and that are not connected to this fragment have residue numbers that are not contiguous with the fragment you are trying to reverse.
Next: Backbone Torsion Angles, Previous: Reversing Direction of Fragment, Up: Modelling and Building [Contents][Index]
Mainchain can be generated using a set of C\alphas as guide-points (such as those from Baton-building) along the line of Esnouf 66 or Jones and coworkers 67. Briefly, 6-residue fragments of are generated from a list of high-quality 68 structures. The C\alpha atoms of these fragments are matched against overlapping sets of the guide-point C\alphas. The resulting matches are merged to provide positions for the mainchain (and C\beta) atoms. This procedure works well for helices and strands, but less well 69 for less common structural features.
This function is also available from the scripting interface:
(db-mainchain imol chain-id resno-start resno-end direction)
where direction is either "backwards"
or "forwards"
.
Recall that the chain-id
needs to be quoted, i.e.
use "A"
not A
. Note that chain-id
is
""
when the C\alphas have been built with Baton Mode in
Coot.
Next: Docking Sidechains, Previous: C-alpha -> Mainchain, Up: Modelling and Building [Contents][Index]
It is possible to edit the backbone \phi and \psi angles indirectly using an option in the Model/Fit/Refine’s dialog: “Edit Backbone Torsions..”. When clicked and an atom of a peptide is selected, this produces a new dialog that offers “Rotate Peptide” which changes this residues \psi and “Rotate Carbonyl” which changes \phi. Click and drag across the button 70 to rotate the moving atoms in the graphics window. You should know, of course, that making these modifications alter the \phi/\psi angles of more than one residue.
Next: Rotamers, Previous: Backbone Torsion Angles, Up: Modelling and Building [Contents][Index]
Docking sidechains means adding sidechains to a model or fragment that has currently only poly-Ala, where the sequence assignment is unknown. The algorithm is basically the same as in Cowtan’s Buccaneer, but with some corners cut to make things (more or less) interactive. The algorithm uses the shape of the density around the C-beta position to estimate the probability of each sidechain type at that position.
The function is accessed via the Extensions -> Dock Sequence
menu item. First, a sequence should be assigned from a PIR file to a
particular chain-id and model number. Secondly Extensions ->
Dock Sequence -> Dock Sequence on this fragment…
. Choose the
model to build on and then Dock Sequence!
If all goes well,
the model will be updated with mutated residues and undergo rotamer
seach for each of the new residues. If the sequence alignment is not
sufficiently clear, then you will get a dialog suggesting that you
extend or improve the fragment.
Next: Editing Chi Angles, Previous: Docking Sidechains, Up: Modelling and Building [Contents][Index]
The rotamers are generated 71 from the backbone independent sidechain library of the Richardsons group 72.
The m, t and p stand for “minus (-60)”, “trans (180)” and “plus (+60)”. There is one letter per \chi angle.
Use keyboard . and , to cycle round the rotamers.
“Auto Fit Rotamer” will try to fit the rotamer to the electron density. Each rotamer is generated, rigid body refined and scored according to the fit to the map. Fitting the second conformation of a dual conformation in this way will often fail - the algorithm will pick the best fit to the density - ignoring the position of the other atoms.
The algorithm doesn’t know if the other atoms in the structure are in
sensible positions. If they are, then it is sensible not to put this
residue too close to them, if they are not then there should be no
restriction from the other atoms as to the position of this residue -
the default is “are sensible”, which means that the algorithm is
prevented from finding solutions that are too close to the atoms of
other residues. (set-rotamer-check-clashes 0)
will stop this.
There is a scripting interface to auto-fitting rotamers:
(auto-fit-best-rotamer resno alt-loc ins-code chain-id
imol-coords
imol-map clash-flag lowest-rotamer-probability)
where:
resno
is the residue number
alt-loc
is the alternate/alternative location symbol
(e.g. "A"
or "B"
, but most often ""
)
ins-code
is the insertion code (usually ""
)
imol-coords
is the molecule number of the coordinates molecule
imol-map
is the molecule number of the map to which
you wish to fit the side chains
clash-flag
should the positions of other residues be
included in the scoring of the rotamers (i.e. clashing with other
other atoms gets marked as bad/unlikely)
lowest-rotamer-probability
: some rotamers of some side
chains are so unlikely that they shouldn’t be considered - typically
0.01 (1%).
You can change the auto-fit rotamer fitting algorithms using
(set-rotamer-search-mode mode)
where mode
is one of (ROTAMERSEARCHAUTOMATIC)
,
(ROTAMERSEARCHLOWRES)
(i.e. "Backrub Rotamers"
(vide infra)) or (ROTAMERSEARCHHIGHRES)
(the
conventional/high-resolution method using rigid-body fitting).
By default, the auto-fit rotamer method is (ROTAMERSEARCHAUTOMATIC)
.
By default, Auto Fit Rotamer will switch to “Backrub Rotamer” 73 mode when fitting against a map of worse than 2.7Å. This search mode moves the some atoms of the mainchain of the neighbouring residues. After rotation of the central residue and neighbouring atoms around the “backrub vector”, the individual peptides are back-rotated (along the peptide axis) so that the carbonyl oxygen are placed as near as possible to their original position. The Ramachandran plot is not used in this fitting algorithm.
Sometimes you don’t have a map 74 but nevertheless there are clashing residues 75 (for example after mutation of a residue range) and you need to rotate side-chains to a non-clashing rotamer. There is a scripting interface:
(de-clash imol chain-id start-resno end-resno)
start-resno
is the residue number of the first residue
you wish to de-clash
end-resno
is the residue number of the last residue
you wish to de-clash
imol
is the molecule number of the coordinates molecule
This interface will not change residues with insertion codes or
alternate conformation. The
lowest-rotamer-probability
is set to 0.01.
Next: Torsion General, Previous: Rotamers, Up: Modelling and Building [Contents][Index]
Instead of using Rotamers, one can instead change the \chi angles (often called “torsions”) “by hand” (using “Edit Chi Angles” from the “Model/Fit/Refine” dialog). To edit a residue’s \chi_1 press “1”: to edit \chi_2, “2”: \chi_3 “3” and \chi_4 “4”. Use left-mouse click and drag to change the \chi value. Use keyboard “0” 76 to go back to ordinary view mode at any time during the editing. Alternatively, one can use the “View Rotation Mode” or use the Ctrl key when moving the mouse in the graphics window. Use the Accept/Reject dialog when you have finished editing the \chi angles.
For non-standard residues, the clicked atom defines the base of the atom tree, which defines the “head” of the molecule (it’s the “tail” (twigs/leaves) that wags). To emphasise, then: it matters on which atom you click!
By default torsions for hydrogen atoms are turned off. To turn them on:
(set-find-hydrogen-torsions 1)
To edit the rotatable bonds of a ligand using this tool, you will need to have read in the mmCIF dictionary beforehand.
Next: Pep-flip, Previous: Editing Chi Angles, Up: Modelling and Building [Contents][Index]
You need to click on the torsion-general button, then click 4 atoms that describe the torsion - the first atom will be the base (non moving) part of the atom tree, on clicking the 4th atom a dialog will pop up with a "Reverse" button. Move this dialog out of the way and then left mouse click and drag in the main window will rotate the "top" part of the residue round the clicked atoms 2 and 3. When you are happy, click "Accept".
If you are torsion generaling a residue that has an alt conf, then the atoms of residue that are moved are those that have the same alt conf as the 4th clicked atom (or have an blank alt conf).
For ligands, you will need to read the mmCIF file that contains a description of the ligand’s geometry (see Section Regularization and Real Space Refinement). By default, torsions that move hydrogens are not included. Only 9 torsion angles are available from the keyboard torsion angle selection.
Next: Adding Alternative Conformations, Previous: Torsion General, Up: Modelling and Building [Contents][Index]
Coot uses the same pepflip scheme
as is used in O
(i.e. the C, N and O atoms are rotated
180^o round a line joining the C\alpha atoms of the residues
involved in the peptide). Flip the peptide again to return the atoms
to their previous position.
Next: Mutation, Previous: Pep-flip, Up: Modelling and Building [Contents][Index]
The allows the addition alternate (dual, triple etc.) conformations to the picked residue. By default, this provides a choice of rotamer (Section Rotamers). If there are not the correct main chain atoms a rotamer choice cannot be provided, and Coot falls back to providing intermediate atoms.
The default occupancy for new atoms is 0.5. This can be changed by using use slider on the rotamer selection window or by using the scripting function:
(set-add-alt-conf-new-atoms-occupancy 0.4)
The remaining occupancy of the atoms (after the new occupancy has been added) is split amongst the atoms that existed in the residue before the split. It is important therefore that the residues atoms have sane occupancies before adding an alternative conformation.
The default Split Type is to split the whole residue. If you want the default to be to split a residue after (and including) the CA, then add to your .coot file:
(set-add-alt-conf-split-type-number 0)
Next: Importing Ligands/Monomers, Previous: Adding Alternative Conformations, Up: Modelling and Building [Contents][Index]
Mutations are available on a 1-by-1 basis using the graphics. After selecting “Mutate…” from the “Model/Fit/Refine” dialog, click on an atom in the graphics. A “Residue Type” window will now appear. Select the new residue type you wish and the residue in the graphics is updated to the new residue type 77. The initial position of the new rotamer is the a priori most likely rotamer. Note that in interactive mode, such as this, a residue type match 78 will not stop the mutation action occurring.
Mutation of DNA or RNA can be performed using “Simple Mutate” from the Model/Fit/Refine dialog. Residues need to be named "Ad", "Gr", "Ur" etc.
This dialog can be found under Calculate -> Mutate
Residue Range
. A residue range can be assigned a sequence and
optionally fitted to the map. This is useful converting a poly-ALA
model to the correct sequence 79.
Multiple mutations
are also supported via
the scripting interface. Unlike the single residue mutation function,
a residue type match will prevent a modification of the
residue 80.
Two functions are provided: To mutate a whole chain, use
(mutate-chain imol chain-id sequence)
where:
chain-id
is the chain identifier of the chain that you wish
to mutate (e.g. "A"
) and
imol
is molecule number.
sequence
is a list of single-letter residue codes,
such as "GYRESDF"
(this should be a straight string with no
additional spaces or carriage returns).
Note that the number of residues in the sequence chain and those in the chain of the protein must match exactly (i.e. the whole of the chain is mutated (except residues that have a matching residue type).)
To mutate a residue range, use
(mutate-residue-range imol chain-id
start-res-no stop-res-no sequence)
where
start-res-no
is the starting residue for mutation
stop-res-no
is the last residue for mutation, i.e.
using values of 2 and 3 for start-res-no
and
stop-res-no
respectively will mutate 2 residues.
Again, the length of the sequence must correspond to the residue range length. Note also that this is a protein sequence - not nucleic acid.
For mutation of nucleic acids, use:
(mutate-nucleotide-range imol chain-id resno-start
resno-end sequence)
Sometimes one might like to model post-translational or other such modifications. How is that done, if the new residue type is not one of the standard residue types?
There is a scripting function:
(mutate-by-overlap imol chain-id resno new-three-letter-code)
This imports a model residue for the new residue type and overlays it on to the given residue by using graph-matching to determine the equivalent atoms.
The GUI for this can be found under Extensions -> Modelling
-> Replace Residue...
(for this to work, you need to be centred on
the residue you wish to replace).
Note that if you are replacing are conventional protein residue with a
modified form (e.g. replacing a TYR with a phoso-tyrosine or a
LYS with an acetyl-lysine) you will need to make sure that the group
of the resulting restraints is an L-peptide
(use Edit
-> Restraints
to check and modify the restraints group. Likewise for
modified RNA/DNA nucleotides, you need to specify the group as
RNA or DNA as appropriate.
The function combines Mutation and Auto Fit Rotamer and is the easiest way to make a mutation and then fit to the map. You can currently only “Mutate and Autofit” protein residues (i.e. things with a rotamer dictionary.
Renumbering is straightforward using the
renumber dialog available under Calculate ->
Renumber Residue Range…
. There is also a scripting interface:
(renumber-residue-range imol chain-id start-res-no
last-resno offset)
Next: Ligand from SMILES strings, Previous: Mutation, Up: Modelling and Building [Contents][Index]
You can import monomers (often ligands) using File -> Get
Monomer…
81 by providing
the 3-letter code of your monomer/ligand. The resulting molecule will
be moved so that it placed at the current screen centre.
Typically, when you are happy about the placement of the ligand, you’d
then use Merge Molecules
to add the ligand/monomer to the main
set of coordinates.
This procedure creates a pdb file monomer-XXX.pdb and a dictionary file libcheck_XXX.cif in the directory in which Coot was started.
A future invocation of Get Monomer uses these file so that the monomer appears quickly 82.
Next: Find Ligands, Previous: Importing Ligands/Monomers, Up: Modelling and Building [Contents][Index]
Similarly, you can generate ligands using File -> SMILES...
and providing a SMILES string and a code for the residue name (this is
your name for the residue type and a dictionary will be generated for
the monomer of this type). This function is also a wrapper to
LIBCHECK.
Next: Flip Ligand, Previous: Ligand from SMILES strings, Up: Modelling and Building [Contents][Index]
You are offered a selection of maps to search (you can only choose one at a time) and a selection of molecules that act as a mask to this map. Finally you must choose which ligand types you are going to search for in this map 83. Only molecules with less than 400 atoms are suggested as potential ligands.
If you do not have any molecules with less that 400 atoms loaded in Coot, you will get the message:
"Error: you must have at least one ligand to search for!"
New ligands are placed where the map density is and protein (mask) atoms are not). The masked map is searched for clusters using a default cut-off of 1.0\sigma. In weak density this cut-off may be too high and in such a case the cut-off value can be changed using something such as:
(set-ligand-cluster-sigma-level 0.8)
However, if the map to be searched for ligands is a difference map, a cluster level of 2.0 or 3.0 would probably be more appropriate (less likely to generate spurious sites).
Each ligand is fitted with rigid body refinement to each potential ligand site in the map and the best one for each site selected and written out as a pdb file. The clusters are sorted by size, the biggest one first (with an index of 0). The output placed ligands files have a prefix “best-overall” and are tagged by the cluster index and residue type of the best fit ligand in that site.
By default, the top 10 sites are tested for ligands - to increase this use:
(set-ligand-n-top-ligands 20)
If the “Flexible?” checkbutton is activated, coot will generate a number of variable conformations (default 100) by rotating around the rotatable bonds (torsions). Each of these conformations will be fitted to each of the potential ligand sites in the map and the best one will be selected (again, if it passes the fitting criteria above).
Before you search for flexible ligands you must have read the mmCIF
dictionary for that particular ligand residue type (File
-> Import CIF dictionary
).
Use:
(set-ligand-flexible-ligand-n-samples n-samples)
where n-samples
is the number of samples of flexibility
made for each ligand. Generally speaking, The more the number of
rotatable bonds, the bigger this number should be.
By default the options to change these values are not in the GUI. To enable these GUI options, use the scripting function:
(ligand-expert)
After successful ligand searching, one may well want to add that displayed ligand to the current model (the coordinates set that provided the map mask). To do so, use Merge Molecules (Section Merge Molecules).
Next: Find Waters, Previous: Find Ligands, Up: Modelling and Building [Contents][Index]
Sometimes a ligand is placed more or less in the correct position, but the orientation is wrong - or at least you might want to explore other possible orientation. To do that easily a function has been provided:
(flip-ligand imol chain-id residue-number)
This will flip the orientation of the residue around the Eigen vector corresponding to the largest Eigen value, exploring 4 possible orientations.
This function has been further wrapped to provide flipping for the active residue:
(flip-active-ligand)
This function can easily be bound to a key.
Next: Add Terminal Residue, Previous: Flip Ligand, Up: Modelling and Building [Contents][Index]
As with finding ligands, you are given a choice of maps, protein (masking) atoms. A final selection has to be made for the cut-off level, note that this value is the number of standard deviation of the density of the map before the map has been masked. The default sigma level (water positions must have density above this level) is set for a “2Fo-Fc”-style map. If you want to use a difference map, you must change the sigma level (typically to 3 sigma) otherwise you run the risk of fitting waters to difference map noise peaks.
Then the map is masked by the masking atoms and a search is made of features in the map about the electron density cut-off value. Waters are added if the feature is approximately water-sized and can make sensible hydrogen bonds to the protein atoms. The new waters are optionally created in a new molecule called “Waters”.
You have control over several parameters used in the water finding:
(set-write-peaksearched-waters)
which writes ligand-waters-peaksearch-results.pdb
, which
contains the water peaks (from the clusters) without any filtering and
ligand-waters.pdb
which are a disk copy filtered waters that
have been either added to the molecule or from which a new molecule
has been created.
(set-ligand-water-to-protein-distance-limits min-d max-d)
sets
the minimum and maximum allowable distances between new waters and the
masking molecule (usually the protein). Defaults are 2.4 and 3.2Å.
(set-ligand-water-spherical-variance-limit varlim)
sets the
upper limit for the density variance around water atoms. The default
is 0.12.
The map that is marked by the protein and is searched to find the
waters is written out in CCP4 format as "masked-for-waters.map"
.
Sometimes as a result of water fitting, you may see something like:
WARNING:: refinement failure start pos: xyz = ( 17.1, 34.76, 60.42) final pos: xyz = ( 17.19, 34.61, 60.59)
When Coot finds a blob, it does a crude positioning of an atom at the centre of the grid points. It then proceeds to move to the peak of the blob by a series of translations. There are a certain number of cycles, and if it doesn’t reach convergence by the end of those cycles then you get the error message.
Often when you go to the position indicated, you can see why Coot had a problem in the refinement.
After a water search, Coot will create a blobs dialog (see Section sec_blobs).
Next: Add OXT Atom to Residue, Previous: Find Waters, Up: Modelling and Building [Contents][Index]
This creates a new residue at the C or N terminal extension of the residue clicked by fitting to the map. \phi,\psi angle pairs are selected at random based on the Ramachandran plot probability (for a generic residue) and fitted to the density. By default there are 100 trials. It is possible that a wrong position will be selected for the terminal residue and if so, you can reject this fit and try again with Fit Terminal Residue 84. Each of the trial positions are scored according to their fit to the map 85 and the best one selected. It is probably a good idea to run “Refine Zone” on these new residues.
If you use the Extensions (Dock Sequence... -> Associate
Sequence with Model
) to apply a PIR sequence file to a model then
Add Terminal Residue
will use the sequence alignment to
determine the residue type of the added residue.
Sometimes, particularly with low resolution maps, the added terminal residue will wander off to somewhere inappropriate. This can be addressed in a number of ways:
(set-terminal-residue-do-rigid-body-refine 0)
will disable
rigid body fitting of the terminal residue fragment for
each trial residue position (the default is 1 (on)) - this may help if
the search does not provide good results.
(set-add-terminal-residue-do-post-refine 1)
(set-add-terminal-residue-n-phi-psi-trials 200)
will change the
number of trials (default is 100). This is useful if you think that
Coot needs to search harder to find a good solution to the positioning
of the next residue.
Next: Add Atom at Pointer, Previous: Add Terminal Residue, Up: Modelling and Building [Contents][Index]
At the C-terminus of a chain of amino-acid residues, there is a “modification” so that the C-O becomes a carbonyl, i.e. an extra (terminal) oxygen (OXT) needs to be added. This atom is added so that it is in the plane of the C\alpha, C and O atoms of the residue.
Scripting usage:
(add-OXT-to-residue imol residue-number insertion-code
chain-id)
86,
where insertion-code
is typically ""
.
Note, in order to place OXT, the N, CA, C and O atoms must be present in the residue - if (for example) the existing carbonyl oxygen atom is called “OE1” then this function will not work.
Next: Place Helix, Previous: Add OXT Atom to Residue, Up: Modelling and Building [Contents][Index]
By default, “Add Atom At Pointer” will pop-up a dialog from which
you can choose the atom type you wish to insert 87. Using
(set-pointer-atom-is-dummy 1)
you can by-pass this dialog and
immediately create a dummy atom at the pointer position. Use an
argument of 0
to revert to using the atom type selection
pop-up on a button press.
The atoms are added to a new molecule called “Pointer Atoms”. They should be saved and merged with your coordinates outside of Coot.
Next: Building Ideal DNA and RNA, Previous: Add Atom at Pointer, Up: Modelling and Building [Contents][Index]
The idea is to place a helix more or less “here” (the screen centre) by fitting to the electron density map. The algorithm is straightforward. First we move to the local centre of density, then examine the density for characteristic directions and fit ideal helices (of length 20 residues) to these directions. The helix is then extended if possible (by checking the fit to the map of residues added in ideal helix conformation) and chopped back if not. If the fit is successful, the helix is created in a new molecule called “Helix”. If the fit is not successful, there is instead a message added to the status bar. You can build the majority of a helical protein in a few minutes using this method (you will of course have to assemble the helices and assign residue numbers and sequence later).
This is available as a scripting function (place-helix-here)
and
in the GUI (in the “Other Modelling Tools” dialog).
Next: Merge Molecules, Previous: Place Helix, Up: Modelling and Building [Contents][Index]
The interface to building ideal polynucleotides can be found by pressing the “Ideal RNA/DNA…” button on the “Other Modelling Tools” dialog.
For a given sequence, a choice of DNA or RNA, A or B form, single or double stranded is presented.
The interface may not gracefully handle uracils in DNA, thymines in RNA or B form RNA.
The ideal B-form DNA is somewhat under-wound, needing 11 base-pairs to repeat (instead of the expected 10.5). There is no easy fix for this currently.
Next: Temperature Factor for New Atoms, Previous: Building Ideal DNA and RNA, Up: Modelling and Building [Contents][Index]
The dialog for this opperation can be found under “Calculate” in the main menubar. This is typically used to add molecule fragments or residues that are in one molecule to the “working” coordinates 88.
The scripting interface is used like this
(merge-molecules molecule-list target-molecule)
e.g.
(merge-molecules (list 1 2 ) 0)
merges molecules 1 and 2 into molecule 0.
Next: Applying NCS Edits, Previous: Merge Molecules, Up: Modelling and Building [Contents][Index]
The default temperature factor for new atoms is 30.0. This can be changed by the following
(set-default-temperature-factor-for-new-atoms 50.0)
Next: Running Refmac, Previous: Temperature Factor for New Atoms, Up: Modelling and Building [Contents][Index]
Let’s imagine that you have 3-fold NCS. You have molecule “A” as your master molecule and you make edits to that molecule. Now you want to apply the edits that you made to “A” (the NCS master chain ID) to the “B” and “C” molecules (i.e. you want the “B” and “C” molecules to be rotated/translated versions of the “A” molecule). How is that done?
There are now guis to NCS command to help you out (under Extensions). However, for completeness here are the scripting versions:
(copy-from-ncs-master-to-others imol master-chain-id)
If you have only a range of residues, rather than a whole chain to replace:
(copy-residue-range-from-ncs-master-to-others imol
master-chain-id start-resno end-resno)
e.g.
(copy-residue-range-from-ncs-master-to-others 0 "A" 1 5)
If you want to copy a residue range to a specific chain, or specific list of chains (rather than all NCS peer chains) then make a list of the chain-ids that you wish replaced:
(copy-residue-range-from-ncs-master-to-chains 0 "A" 1 5 (list "C"))
in this case, just the residues in the "C" chain is replaced.
Next: Running SHELXL, Previous: Applying NCS Edits, Up: Modelling and Building [Contents][Index]
Use the “Run Refmac...” button to select the dataset and the coordinates on which you would like to run Refmac. Note that here Coot only allows the use of datasets which has Refmac parameters set as the MTZ file was read. By default, Coot displays the new coordinates and the new map generated from refmac’s output MTZ file. Optionally, you can also display the difference map.
You can add extra parameters
(data lines) to
refmac’s input by storing them in a file called
refmac-extra-params
in the directory in which you started
coot.
You can also provide extra/replacement parameters for refmac by setting
the variable refmac-extra-params
to a list of strings, for
example:
(set! refmac-extra-params (list "REFINE MATRIX 0.1" "MAKE HYDROGENS NO"))
Coot “blocks” 89 until Refmac has terminated 90.
The default refmac executable
is refmac5
it is presumed to be in the
path. If you don’t want this, it can be overridden using a
re-definition either at the scripting interface or in one’s
~/.coot
file e.g.:
(define refmac-exec "/e/refmac-new/bin/refmac5.6.3")
After running refmac several times, you may find that you prefer if the new map that refmac creates (after refmac refinement) is the same colour as the previous one (from before this refmac refinement). If so, use:
(set-keep-map-colour-after-refmac 1)
which will swap the colours of then new and old refmac map so that the post-refmac map has the same colour as the pre-refmac map and the pre-refmac map is coloured with a different colour.
Next: Clear Pending Picks, Previous: Running Refmac, Up: Modelling and Building [Contents][Index]
Coot can read shelx .res files and write .ins files, and thus one can refine using SHELXL in a convenient manner using the function
(shelxl-refine imol . hkl-file-name)
(the hkl-file-name
is an optional argument)
e.g.
(shelxl-refine 0)
or
(shelxl-refine 0 "insulin.hkl")
In the former case, coot will presume that there is a SHELX hkl file corresponding to the res file that you read in; if there is not coot will print a warning and not try to run shelxl. In the latter case, you can specify the location of the hkl file.
After shelxl has finished, coot will automatically read in the resulting res coordinates, the fcf file, convert the data to mmCIF format and read that, which generates a \sigma_A map and a difference map.
Coot creates a time stamped ins file and a time-stamped sym-link to
the hkl file in the coot-shelxl
directory.
Please note that the output ins file will not be particularly useful (and thus shelxl will fail) if the input file was not in SHELX ins format.
There is a GUI for this operation under the “Extensions” menu item.
Next: Delete, Previous: Running SHELXL, Up: Modelling and Building [Contents][Index]
Sometimes one can click on a button 91 unintentionally. This button is there for such a case. It clears the expectation of an atom pick. This works not only for modelling functions, but also geometry functions (such as Distance and Angle).
Next: Sequence Assignment, Previous: Clear Pending Picks, Up: Modelling and Building [Contents][Index]
Single atoms or residues can be deleted from the molecule using “Delete…” from the “Model/Fit/Refine”dialog. Pressing this button results in a new dialog, with the options of “Residue” (the default), “Atom” and “Hydrogen Atoms”. Now click on an atom in the graphics - the deleted object will be the whole residue of the atom if “Residue” was selected and just that atom if “Atom” was selected. Note that if a residue has an alternative conformation, then “Delete Residue” will delete only the conformation that matches that alternative conformation specifier of the clicked atom.
Only waters are deletable if the "Water" check button is active and waters are not deletable if the "Residue/Monomer" check button is active. This is to reduce mis-clicking.
To rotate the view when in “Delete Mode”, use Ctrl left-mouse.
If you want to delete multiple items you can use check the “Keep Delete Active” check-button on this dialog This will will keep the dialog open, ready for deletion of next item.
An atom can be delete using the scripting
(delete-atom imol chain-id residue-no ins-code atom-name alt-conf)
Residues can be deleted using the scripting
(delete-residue imol chain-id residue-no ins-code)
Residue ranges can be deleted using the scripting
(delete-residue-range imol chain-id residue-no-start residue-no-end)
Chains can be deleted using the scripting
(delete-chain imol chain-id)
Sidechains can be deleted from a region:
(delete-side-chain-range imol chain-id residue-no-start residue-no-end)
or for a chain
(delete-sidechains-for-chain imol chain-id)
Next: Building Links and Loops, Previous: Delete, Up: Modelling and Building [Contents][Index]
You can assign a (FASTA format) sequence to a molecule using:
(assign-fasta-sequence imol chain-id fasta-seq)
This function has been provided as a precursor to functions that will (as automatically as possible) mutate your current coordinates to one that has the desired sequence. It will be used in automatic side-chain assignment (at some stage in the future).
Next: Fill Partial Residues, Previous: Sequence Assignment, Up: Modelling and Building [Contents][Index]
Coot can build missing linking regions or loops
92. The function can be found under Calculate -> Fit Loop -> Fit Loop by Rama Search
or the scripting function:
(fit-gap imol chain-id start-resno stop-resno)
and
(fit-gap imol chain-id start-resno stop-resno sequence)
the second form will also mutate and try to rotamer fit the provided sequence.
Example usage: let’s say for molecule number 0 in chain "A"
we have residues up to 56 and then a gap after which we have residues
62 and beyond:
(fit-gap 0 "A" 57 61 "TYPWS")
Next: Changing Chain IDs, Previous: Building Links and Loops, Up: Modelling and Building [Contents][Index]
After molecular replacement, the residues of your protein could well have the correct sequence but be chopped back to CG or CB atoms. There is a function to fill such partially-filled residues:
(fill-partial-residues imol)
This identifies residues with missing atoms, then fills them and does a rotamer fit and real-space refinement.
If you want to fill the side chain of just one residue
(fill-partial-residue imol chain-id res-no ins-code)
this does a auto-fit-best-rotamer and a refinement on the resulting side-chain position.
Next: Setting Occupancies, Previous: Fill Partial Residues, Up: Modelling and Building [Contents][Index]
You can change the chain ids of chains using Calculate ->
Change Chain IDs…
. Coot will block an attempt to change the
whole of a chain and the target chain id already exists in the
molecule.
If you use the "Residue Range" option then you can insert residues with non-conflicting residue number into pre-existing chains.
Next: Fix Nomenclature Errors, Previous: Changing Chain IDs, Up: Modelling and Building [Contents][Index]
As well as the editing “Residue Info” to change occupancies of individual atoms, one can use a scripting function to change occupancies of a whole residue range:
(zero-occupancy-residue-range imol chain-id
resno-start resno-last)
example usage:
(zero-occupancy-residue-range 0 "A" 23 28)
This is often useful to zero out a questionable loop before submitting for refinement. After refinement (with refmac) there should be relatively unbiased density in the resulting 2Fo-Fc-style and difference maps.
Similarly there is a function to reverse this operation:
(fill-occupancy-residue-range imol chain-id
resno-start resno-last)
Next: Rotamer Fix Whole Protein, Previous: Setting Occupancies, Up: Modelling and Building [Contents][Index]
Currently this is available only in scripting form:
(fix-nomenclature-errors imol)
This will fix atoms nomenclature problems in molecule number
imol
according to the same criteria as WATCHECK
93
e.g. Chi-2 for Phe, Tyr, Asp, and Glu should be between -90 and
90 degrees. Note that Val and Leu nomenclature errors are also corrected.
Next: Refine All Waters, Previous: Fix Nomenclature Errors, Up: Modelling and Building [Contents][Index]
There is an experimental scripting function
(fit-protein imol)
which does a auto-fit rotamer and Real Space Refinement for each residue. The graphics follow the refinement.
Next: Moving Molecules/Ligands, Previous: Rotamer Fix Whole Protein, Up: Modelling and Building [Contents][Index]
All the waters in a model can be refined (that is, moved to the local density peak) using
(fit-waters imol)
This is a non-interactive function (the waters are moved without user intervention).
Next: Modifying the Labels on the Model/Fit/Refine dialog, Previous: Refine All Waters, Up: Modelling and Building [Contents][Index]
Often you want to move a ligand (or some such) from wherever it was read
in to the position of interest in your molecule (i.e. the current view
centre). There is a GUI to do this: Calculate -> Move Molecule
Here
.
There are scripting functions available for this sort of thing:
(molecule-centre imol)
will tell you the molecule centre
of the
imol
th molecule.
(translate-molecule-by
imol x-shift y-shift z-shift
)
will translate all the atoms in molecule imol
by the
given amount (in Ångströms).
(move-molecule-to-screen-centre imol)
will move the imol
th molecule to the current centre of
the screen (sometimes useful for imported ligands). Note that this
moves the atoms of the molecule - not just the view of the molecule.
Previous: Moving Molecules/Ligands, Up: Modelling and Building [Contents][Index]
If you don’t like the labels "Rotate/Translate Zone" or "Place Atom at Pointer" and rather they said something else, you can change the button names using:
(set-model-fit-refine-rotate-translate-zone-label "Move Zone")
and
(set-model-fit-refine-place-atom-at-pointer "Add Atom")
Next: Validation, Previous: Modelling and Building, Up: Top [Contents][Index]
Next: Create a Map, Up: Map-Related Features [Contents][Index]
Maps are “infinite,” not limited to pre-calculated volume (the “Everywhere You Click - There Is Electron Density” (EYC-TIED) paradigm) symmetry-related electron density is generated automatically. Maps are easily re-contoured. Simply use the scroll wheel on you mouse to alter the contour level (or -/+ on the keyboard).
Maps follow the molecule. As you recentre or move about the crystal,
the map quickly follows. If your computer is not up to re-contouring
all the maps for every frame, then use Draw ->
Dragged Map…
to turn off this feature.
Unfortunately, there is a bug in map-reading. If the map is not a bona-fide CCP4 map 94, then coot will crash. Sorry. A fix is in the works but “it’s complicated”. That’s why maps are limited to the extension ".ext" and ".map", to make it less likely a non-CCP4 map is read.
Next: Map Contouring, Previous: Maps in General, Up: Map-Related Features [Contents][Index]
From MTZ, mmCIF and .phs
data use File -> Open MTZ, CIF or phs…
. You can then
choose the MTZ columns for the Fourier synthesis. The button “Expert
mode” also adds to the options any anomalous columns you may have in
the MTZ file (a -90 degree phase shift will be applied). It also
provides the option to apply resolution limits.
From a CCP4
map use File -> Read Map
. After being
generated/read, the map is immediately contoured and centred on the
current rotation centre.
This function allows Coot to read an MTZ file and make a map directly (without going through the column selection procedure). The default column labels for auto-reading are "FWT" and "PHWT" for the 2Fo-Fc-style map, "DELFWT" and "PHDELWT" for the difference map. You can change the column labels that Coot uses for auto-reading - here is an example of how to do that:
(set-auto-read-column-labels "2FOFCWT" "PHIWT" 0)
(set-auto-read-column-labels "FOFCWT" "DELPHIWT" 1)
By default the difference map is created in auto-reading the MTZ file. If you don’t want a difference map, you can use the function:
(set-auto-read-do-difference-map-too 0)
There are several maps that can be generated from CIF files that contain observed Fs, calculated Fs and calculated phases:
(read-cif-data-with-phases-fo-alpha-calc
cif-file-name)
Calculate an atom map using F_obs and
\alpha_calc
(read-cif-data-with-phases-2fo-fc cif-file-name)
Calculate an atom map using F_obs, F_calc and
\alpha_calc
(read-cif-data-with-phases-fo-fc cif-file-name)
Calculate an difference map using F_obs, F_calc and
\alpha_calc.
There are 2 ways to read data by scripting:
(read-phs-and-make-map-using-cell-symm phs-file-name space-group-name a b c alpha beta gamma)
(read-pdb-and-make-map-with-reso-limits imol-previous phs-file-name reso-limit-low reso-limit-high)
The first specifies the cell explicitly, and alpha, beta
and gamma
are specified in degrees.
The second form allows the specification of resolution limits and takes the cell and symmetry from a previous molecule (typically a pdb file).
Next: Map Extent, Previous: Create a Map, Up: Map-Related Features [Contents][Index]
Maps can be re-contoured using the middle-mouse
scroll-wheel (buttons 4 and 5 in X Window System(TM)
terminology). Scrolling the mouse wheel will change the map contour
level and the map it redrawn. If you have several maps displayed then
the map that has its contour level changed can be set using
HID -> Scrollwheel -> Attach scroll-wheel
to which map?
. If there is only one map displayed, then that is
the map that has its contour level changed (no matter what the
scroll-wheel is attached to in the menu). The level of the electron
density is displayed in the top right hand corner of the OpenGL canvas.
Use keyboard + or - to change the contour level if you don’t have a scroll-wheel 95.
If you are creating your map from an MTZ file, you can choose to click on the “is difference map” button on the Column Label selection widget (after a data set filename has been selected) then this map will be displayed in 2 colours corresponding to + and - the map contour level.
If you read in a map and it is a difference map then there is a checkbutton to tell Coot that.
If you want to tell Coot that a map is a difference map after it has been read, use:
(set-map-is-difference-map imol)
where imol
is the molecule number.
By default the change of the contour level is determined from the sigma of the map. You can change this in the map properties dialog or by using the scripting function:
(set-contour-by-sigma-step-by-mol step on/off? imol)
where
step
is the difference in sigma from one level to the next
(typically 0.2)
on/off?
is either 0 (sigma stepping off) or 1 (sigma stepping on)
By default the map radius 96 is 10Å.
The default increment to the electron density depends on whether or
not this is a difference map (0.05 e^-/\AA^3 for a “2Fo-Fc”
style map and 0.005 e^-/\AA^3 for a difference map). You can
change these using Edit -> Map Parameters
or by
using the “Properties” button of a particular map in the Display
Control (Display Manager) window.
Next: Map Contour ``Scrolling'' Limits, Previous: Map Contouring, Up: Map-Related Features [Contents][Index]
The extent of the map can be set using the GUI (Edit -> Map
Parameters -> Map Radius
) or by using the scripting function,
e.g.:
(set-map-radius 13.2)
Next: Map Line Width, Previous: Map Extent, Up: Map-Related Features [Contents][Index]
Usually one doesn’t want to look at negative contour levels of a map97, so Coot has by default a limit that stops the contour level going beyond (less than) 0. To remove the limit:
(set-stop-scroll-iso-map 0)
for a 2Fo-Fc style map
(set-stop-scroll-diff-map 0)
for a difference map
To set the limits to negative (e.g. -0.6) levels:
(set-stop-scroll-iso-map-level -0.6)
and similarly:
(set-stop-scroll-diff-map-level -0.6)
where the level is specified in e^-/\AA^3.
Next: Map colouring, Previous: Map Contour ``Scrolling'' Limits, Up: Map-Related Features [Contents][Index]
The width of the lines that describe the density can be changed like this:
(set-map-line-width 2)
The default line width is 1.
Next: Difference Map Colouring, Previous: Map Line Width, Up: Map-Related Features [Contents][Index]
By default, maps get coloured according to
their molecule number. The starting colour (i.e. for molecule
0) is blue. The colour of a map can be changed by Edit
-> Map Colour..
. The map colour gets updated as you
change the value in the colour selector 98. Use “OK” to fix that colour.
As subsequent maps are read, they are coloured by rotation round a colour wheel. The default colour map step is 31 degrees. You can change this using:
(set-colour-map-rotation-for-map step)
Next: Make a Difference Map, Previous: Map colouring, Up: Map-Related Features [Contents][Index]
For some strange reason, some crystallographers 99 like to have their difference maps coloured with red as positive and green as negative, this option is for them:
(set-swap-difference-map-colours 1)
This option will allow the “blue is positive, red is negative” colour scheme on “Edit -> Map Colour”.
Next: Make an Averaged Map, Previous: Difference Map Colouring, Up: Map-Related Features [Contents][Index]
Using the “Make a Difference Map” function in the Extensions menu, one can make a difference from two arbitrary maps. The maps need not be on the same griding, or in the same space group even. The resulting map will be on the same griding and space group as the “Reference” map.
Next: Map Sampling, Previous: Make a Difference Map, Up: Map-Related Features [Contents][Index]
There is a scripting interface to the generation of map averages. As above, the maps need not be on the same grid or in the same space group. The resulting map will have the same gridding and space group as the first map in the list. Typical usage:
(average-map '((1 1.0) (2 1.0))))
The argument to (average-map
is a list of lists, each list
element is a list of the map number and a weighting factor (1.0 in this
case).
Next: Dragged Map, Previous: Make an Averaged Map, Up: Map-Related Features [Contents][Index]
By default, the Shannon sampling factor is the conventional 1.5. Use
larger values (Edit -> Map Parameters ->
Sampling Rate
) for smoother maps 100.
This value can be set by the scripting command
(set-map-sampling-rate 2.5)
Next: Dynamic Map Sampling and Display Size, Previous: Map Sampling, Up: Map-Related Features [Contents][Index]
By default, the map is re-contoured at every frame during a drag (Ctrl
Left-mouse). Sometimes this can be annoyingly slow and jerky so it is
possible to turn it off: Draw -> Dragged Map
-> No
.
To change this by scripting:
(set-active-map-drag-flag 0)
Next: Skeletonization, Previous: Dragged Map, Up: Map-Related Features [Contents][Index]
If activated (Edit -> Map Parameters ->
Dynamic Map Sampling
) the map will be re-sampled on a more coarse grid
when the view is zoomed out. If “Display Size” is also activated,
the box of electron density will be increased in size also. In this
way, you can see electron density for
big maps (many
unit cells) and the graphics still remain rotatable.
If you want to have these functions active for all maps, add the following to your initialization file Scheme:
(set-dynamic-map-sampling-on)
(set-dynamic-map-size-display-on)
Next: Map Sharpening, Previous: Dynamic Map Sampling and Display Size, Up: Map-Related Features [Contents][Index]
The skeleton (also known as
“Bones” 101) can be displayed for any map. A map can be skeletonized using
Calculate -> Map Skeleton…
. Use the option
menu to choose the map and click “On” then “OK” to the generate
the map (the skeleton is off by default).
The level of the skeleton can be changed by using Edit
-> Skeleton Parameters… ->
Skeletonization Level…
and corresponds to the electron density
level in the map. By default this value is 1.2 map standard
deviations. The amount of map can be changed using Edit
-> Skeleton Parameters… -> Skeleton Box
Radius…
102. The units are in
Ångströms, with 40 as the default value.
The skeleton is often recalculated as the screen centre changes - but not always since it can be an irritatingly slow calculation. If you want to force a regeneration of the displayed skeleton, simply centre on an atom (using the middle mouse button) or press the S key.
Next: Pattersons, Previous: Skeletonization, Up: Map-Related Features [Contents][Index]
It can be educational (even useful at lower resolutions)
to sharpen or blur a map. This can be achieved with the sharpening
tool Calculate -> Map Sharpening…
. By default, the
maximum and minimum sharpness is +/- 200Å^2, this can be
changed (in this case to 300) using:
(set-map-sharpening-scale-limit 300)
This currently only works on maps created by reading an MTZ (or other) reflection data file.
Next: Map Re-Interpolation, Previous: Map Sharpening, Up: Map-Related Features [Contents][Index]
Pattersons can be generated using the make-and-draw-patterson
function. Example usage:
(make-and-draw-patterson mtz-file-name f-col sig-f-col)
where use-weights-flag
is either 0
or 1
.
e.g.
(make-and-draw-patterson "native.mtz" "FP_nat" "SIGFP_nat")
Next: masks, Previous: Pattersons, Up: Map-Related Features [Contents][Index]
Maps can be re-interpolated to match a reference map.
(reinterp-map map-no reference-map-no)
will create a copy of map-no
in the same cell, spacegroup and grid spacing as
the reference-map-no
map.
Next: Trimming Atoms, Previous: Map Re-Interpolation, Up: Map-Related Features [Contents][Index]
A map can be masked by a set of coordinates. Use the scripting function:
(mask-map-by-molecule imol-map imol-model invert-mask?)
If invert-mask?
is 0, this will create a new map that has
density only where there are no (close) coordinates. If
invert-mask?
is 1 then the map density values will be set
to zero everywhere except close to the atoms of molecule number
imol-model.
The radius of the mask around each atom is 2.0Å by default. You can change this using:
(set-map-mask-atom-radius radius)
There is a GUI interface to Map Masking under the Extensions menu.
If one wanted to show just the density around a ligand:
(mask-map-by-molecule 2 1 1)
This creates a new map. Turn the other maps off, leaving only the masked map.
To get a nice rendered image, press F8 (see Section Raster3D).
Next: Map Transformation, Previous: masks, Up: Map-Related Features [Contents][Index]
If you want to remove all the atoms 103 that lie “outside the map” (i.e. in low density) you can use
(trim-molecule-by-map imol-coords imol-map density-level delete/zero-occ?)
where delete/zero-occ?
is 0
to remove the atoms and
1
to set their occupancy to zero.
There is a GUI interface for this feature under the “Extensions” menu item.
Next: Export Map, Previous: Trimming Atoms, Up: Map-Related Features [Contents][Index]
If you want to transform a map, you can do it thusly:
(transform-map imol rotation-matrix trans point radius)
where:
rotation-matrix
is a 9-membered list of numbers for an orthogonal rotation matrix.
trans
is a 3-membered list of numbers (distances in Ångstöms).
point
is a 3-membered list of numbers (centre point in Ångstöms).
radius
is a single number (also in Ångstöms).
This applies the rotation rotation-matrix
and a
translation trans
to a map fragment, so that when the
transformation is applied the centre of the new map is at
point
.
Example usage:
(transform-map 2 '(1 0 0 0 1 0 0 0 1) '(0 0 1) (rotation-centre) 10)
which transforms map number 2 by a translation of 1Å along the Z axis, centred at the screen centre for 10Å around that centre.
Here’s a more real-world example:
Let’s say we want to tranform the density over the “B” molecule to a position over the “A” molecule. First we do a LSQ transformation to get the rotation and translation that moves the “B” coordinates over the “A” coordinates:
In the terminal output we get:
| 0.9707, 0.2351, 0.05033| | -0.04676, 0.39, -0.9196| | -0.2358, 0.8903, 0.3896| ( -33.34, 21.14, 18.82)
The centre of the “A” molecule is at (58.456, 5.65, 11.108). So we do:
(transform-map 3 (list 0.9707 0.2351 0.05033 -0.04676 0.39 -0.9196
-0.2358 0.8903 0.3896) (list -33.34 21.14 18.82) (list 58.456 5.65
11.108) 8)
Which creates a map over the middle of the “A” molecule. Note that
using a too high radius
can cause overlap problems, so try
with a small radius
(e.g. 5.0) if the resulting map
looks problematic.
Alternatively, instead of typing the whole matrix, you can use a
coordinates least-squares fit to generate the matrix for you.
(transform-map-using-lsq-matrix)
does just that.
Heres how to use it:
(transform-map-using-lsq-matrix imol-ref ref-chain
ref-resno-start ref-resno-end imol-mov mov-chain mov-resno-start
mov-resno-end imol-map about-pt radius)
Hopefully the arguments are self explanatory (ref
refers
to the reference molecule, of course and about-pt
is a
3-number list such as is returned by (rotation-centre)
).
We can now export that map, if we want.
Previous: Map Transformation, Up: Map-Related Features [Contents][Index]
You can write out a map from Coot (e.g. one from NCS averaging, or masking or general transformation) using the export map function:
(export-map imol filename)
e.g.
(export-map 4 "ncs-averaged.map")
Next: Representation, Previous: Map-Related Features, Up: Top [Contents][Index]
The validation functions are still being added to from time to time. In future there will be more functions, particularly those that will interface to other programs.
Next: Geometry Analysis, Up: Validation [Contents][Index]
Ramachandran plots are “dynamic”. When you edit the molecule (i.e. move the coordinates of some of atoms) the Ramachandran plot gets updated to reflect those changes. Also the underlying \phi/\psi probability density changes according to the selected residue type (i.e. the residue under the mouse in the plot). There are 3 different residue types: GLY, PRO, and not-GLY-or-PRO 104.
When you mouse over a representation of a residue (a little square or triangle 105) the residue label pops up. The residue is “active” i.e. it can be clicked. The “graphics” view changes so that the C\alpha of the selected residue is centred. In the Ramachandran plot window, the current residue is highlighted by a green square.
The underlying distributions are taken from the Richardson’s Top500 structures http://kinemage.biochem.duke.edu/databases/top500.php.
The probability levels for acceptable (yellow) and preferred (red) are 0.2% and 2% respectively.
You can change the contour levels:
(set-ramachandran-plot-contour-levels 0.025 0.003)
You can change the “blocksize” (the default is 10 degrees) of the contours using
(set-ramachandran-plot-background-block-size 5)
These comes into effect when a new plot is created (it doesn’t change plots currently displayed).
Next: Chiral Volumes, Previous: Ramachandran Plots, Up: Validation [Contents][Index]
A restraints-based geometry analysis of the molecule. The distortion is weighted by atom occupancy. The distortion of the geometry due to links is shared between the contributing residues.
Note that only the first model of a multi-model molecule is analysed.
Next: sec_blobs, Previous: Geometry Analysis, Up: Validation [Contents][Index]
The dictionary is used to identify the chiral atoms of each of the model’s residues. A clickable list is created of atoms whose chiral volume in the model is of a different sign to that in the dictionary.
During refinement and regularization, Coot will pop-up dialogs warning about chiral volume errors - if you have them. This can be annoying 106. You can inhibit this dialog like this:
(set-show-chiral-volume-errors-dialog 0)
There are two obvious ways:
1) mutate and auto-fit rotamer (mutate it to the residue type that it is)
2) RS Refine the residue and invert the chiral centre by pulling an atom. Usually you can pull the CA to the other side of the plane made by the chiral neighbouring atoms (using ctrl left-click). Sometimes giving the CB a good old tweak is the easier way.
Inverting the CB of THR is easier, just move the OG so that the plane of the neighbours is on the other side of the CB (again with ctrl left-click).
Next: Difference Map Peaks, Previous: Chiral Volumes, Up: Validation [Contents][Index]
This is an interface to the Blobs dialog. A map and a set of coordinates that model the protein are required.
A blob is region of relatively high residual election density that cannot be explained by a simple water. So, for example, sulfates, ligands, mis-placed sidechains or unbuilt terminal residues might appear as blobs. The blobs are in order, the biggest 107 at the top.
Next: Check Waters by Difference Map, Previous: sec_blobs, Up: Validation [Contents][Index]
This is one of the fastest ways to validate a model and its data (presuming that the difference map comes from a post-refinement mFo-DFc map). It highlights regions where the model and the data do not agree.
Lesser peaks within a certain distance (by default, 2.0Å) of a large peak are not shown. This cuts down on the number of times one is navigated to a particular region because of ripple or other noise peaks around a central peak.
This value can be queried:
(difference-map-peaks-max-closeness)
and adjusted:
(set-difference-map-peaks-max-closeness 0.1)
Next: Molprobity Tools Interface, Previous: Difference Map Peaks, Up: Validation [Contents][Index]
Sometimes waters can be misplaced - taking the place of sidechains or ligands or crystallization agents such as phosphate for example 108. In such cases the variance of the difference map can be used to identify these problems.
This function is also useful to check anomalous maps. Often waters are placed in density that is really a something else, perhaps a cation, anion, sulphate or a ligand. If such an atom diffracts anomalously this can be identified and corrected.
By default the waters with a map variance greater than 3.5\sigma are listed. One can be more rigorous by using a lower cut-off:
(set-check-waters-by-difference-map-sigma-level 3.0)
The scripting interface is:
(check-waters-by-difference-map imol-coords
imol-diff-map)
where imol-coords
is the molecule number of the
coordinates that contain the waters to be checked
imol-diff-map
is the molecule number of the difference
map (it must be a difference map, not an “ordinary” map). This
difference map must have been calculated using the waters. So there is
no point in doing this check immediately after “Find Waters”. You
will need to run Refmac or some other refinement first first
109.
Next: GLN and ASN B-factor Outliers, Previous: Check Waters by Difference Map, Up: Validation [Contents][Index]
The molprobity tools probe and reduce have been interfaced into Coot (currently, the interface is not as slick as it might be). However, the tools are useful and can be used in the following way:
first we need to tell Coot where to find the relevant executables (typically you would add the following lines to you ~/.coot file):
(define *probe-command* "/path/to/probe/executable")
(define *reduce-command* "/path/to/reduce/executable")
now the probe hydrogens and probe dots can be generated using
Validate -> Probe Clashes
(or in the Scripting Window):
(probe imol)
where imol
is the molecule number of coordinates to be
probed. A new molecule with Hydrogens is created (by reduce) and
read in.
By default Coot creates a new molecule for the molecule that now has hydrogens. To change this:
(set! reduce-molecule-updates-current #t)
and that, as you can guess, replaces, rather than adds to the “probed” molecule.
This gives a "static" view of the molecule’s interactions.
To get a dynamic view (which is currently only enabled on rotating chi angles) add these to your ~/.coot file:
(set-do-probe-dots-on-rotamers-and-chis 1)
To get a semi-static view (dots are regenerated in the region of zone after a "Real Space Refinement"):
(set-do-probe-dots-post-refine 1)
Next: Validation Graphs, Previous: Molprobity Tools Interface, Up: Validation [Contents][Index]
It is often difficult to detect by eye the correct orientation of the amino-carbonylo group of GLN and ASNs. However, we can use (properly refined) temperature factors to detect outliers. We take the Z value as half the difference between the B-factor of the NE2 and OE1 divided by the standard deviation of the B-factors of the rest of the residue. An analysis of GLNs and ASNs of high resolutions structures indicates that a Z value of greater than 2.25 indicates a potential (if not probable) flip. A “Fix” button is provided in the resultant dialog make this easy to do.
This analysis was added after discussions with Atsushi Nakagawa and so is called “Nakagawa’s Bees”.
The analysis does not check residues with multiple conformations.
Previous: GLN and ASN B-factor Outliers, Up: Validation [Contents][Index]
Coot provides several graphs that are useful for model validation (on a residue by residue basis): residue density fit, geometry distortion, temperature factor variance, peptide distortion and rotamer analysis.
The density fit graph shows the density fit for residues. The score is the average electron density level at the atom centres of the atoms in the residue. The height of the blocks is inversely proportional to the density average.
The residue density fit is by default scaled to a map that is calculated on the absolute scale. Sometimes you might be using a map with density levels considerably different to this, which makes the residue density fit graph less useful. To correct for this you can use the scripting function:
(set-residue-density-fit-scale-factor factor)
where factor
would be 1/(4* rmd_{map}) (as a rule
of thumb).
(residue-density-fit-scale-factor)
returns the current scale
factor (default 1.0).
There is also a GUI to this:
Extensions -> Refine… -> Set Density Fit Graph Weight…
Residue rotamers are scored according to the prior likelihood. Note that when CD1 and CD2 of a PHE residue are exchanged (simply a nomenclature error) this can lead to large red blocks in the graph (apparently due to very unlikely rotamers). There are several other residues that can have nomenclature errors like this. To fix these problems use
(fix-nomenclature-errors imol)
This idea is from Eleanor Dodson, who liked to use the standard deviation of a residue’s temperature factors to highlight regions of questionable structure.
Note that Hydrogens are ignored in this analysis.
Some variability of the \omega is to be expected in the peptide bond. But not too much. Anything more than 13 degrees is suspicicous. Unexpected peptide bonds show up red by default. If cis peptides are to be expected, and should not marked as bad, then you can tell this to Coot using:
Edit -> Preferences -> Geometry -> Cis-Peptides -> No
Next: Hints and Usage Tips, Previous: Validation, Up: Top [Contents][Index]
• Surfaces: |
Up: Representation [Contents][Index]
Coot uses the surface code from Gruber and Noble (2004).
Coot uses the partial charges of the atoms (the partial_charge field in the _chem_comp_atom block) from the charge dictionary item in the refmac (or other) cif dictionary. However, partial charges are only used under certain conditions
1) the molecule consists of less than 100 atoms
or
2) the number of atoms in the molecule that are hydrogens is at least 15% of the total number of atoms in the molecule
If partial charges are not used, then the fall-back is to use charges from side-chains charged at physiological pH (Arg, Lys, Asp, Glu).
Next: Other Programs, Previous: Representation, Up: Top [Contents][Index]
Next: Low Resolution, Up: Hints and Usage Tips [Contents][Index]
This manual is on the web where it can be searched:
In the Menu item “About”, under “Online Docs URL...” there is a entry bar that can be used to search the Coot documentation via Google. The results are returned as a web page in web browser. The browser type can be specified as in this example:
(set-browser-interface "firefox")
Example usage can be found in xxx/share/coot/scheme/group-settings.scm
Next: Coot Droppings, Previous: Documentation, Up: Hints and Usage Tips [Contents][Index]
Building structures using low resolution data is a pain. We hope to make it less of a pain in future, but there are some things that you can do now.
(set-matrix 20.0)
[Default is 60, the lower the number the more the geometry is idealised]
Next: Clearing Backups, Previous: Low Resolution, Up: Hints and Usage Tips [Contents][Index]
This describes the files and directory that coot leaves behind after it has been fed (sorry, I mean “used”). Everything except the 0-coot.state.scm state file can comfortably be deleted if needed after coot has finished.
You can stop the state and history files being written if you start coot
with the --no-guano
option.
Next: Getting out of ``Translate'' Mode, Previous: Coot Droppings, Up: Hints and Usage Tips [Contents][Index]
Coot will occasionally ask you to clear up the coot-backup directory. You can adjust the behaviour in a number of ways:
(define *clear-out-backup-run-n-days* 3)
will run the backup clearance every 3 days (the default is every 7).
(define *clear-out-backup-old-days* 1)
will clear out files older then 1 day (rather than the default 7 days).
(clear-backups-maybe)
So, if you wanted to clear out everything more than 1 day old, every time, without Coot asking you about it:
(define *clear-out-backup-run-n-days* 0) (define *clear-out-backup-old-days* 1) (define (clear-backups-maybe) (delete-coot-backup-files 'delete) (coot-real-exit 0))
Next: Getting out of ``Continuous Rotation'' Mode, Previous: Clearing Backups, Up: Hints and Usage Tips [Contents][Index]
If you get stuck in "translate" mode in the GL canvas (i.e. mouse does not rotate the view as you would expect) simply press and release the Ctrl key to return to "rotate" mode.
Next: Label Atom Only Mode, Previous: Getting out of ``Translate'' Mode, Up: Hints and Usage Tips [Contents][Index]
The keyboard I key toggles the “continuous rotation” mode. The
menu item Draw -> Spin View On/Off
does the same thing.
Next: Button Labels, Previous: Getting out of ``Continuous Rotation'' Mode, Up: Hints and Usage Tips [Contents][Index]
Similarly, if you are stuck in a mode where the “Model/Fit/Refine” buttons don’t work (the atoms are not selected, only the atom gets labelled), press and release the Shift key.
Next: sec_picking, Previous: Label Atom Only Mode, Up: Hints and Usage Tips [Contents][Index]
Button labels ending in “…” mean that a new dialog will pop-up when this button is pressed.
Next: Resizing View, Previous: Button Labels, Up: Hints and Usage Tips [Contents][Index]
Note that left-mouse in the graphics window is used for both atom picking and rotating the view, so try not to click over an atom when trying to rotate the view when in atom selection mode.
Next: Scroll-wheel, Previous: sec_picking, Up: Hints and Usage Tips [Contents][Index]
Click and drag using right-mouse (up and down or left and right) to zoom in and out.
Next: Slow Computer Configuration, Previous: Resizing View, Up: Hints and Usage Tips [Contents][Index]
To change the map to which the scroll-wheel is attached, use the scroll
check button in the Display Manager or use HID -> Scrollwheel
-> Attach Scrollwheel to which map?
Previous: Scroll-wheel, Up: Hints and Usage Tips [Contents][Index]
Several of the parameters of Coot are chosen because they are reasonable on my “middle-ground” development machine. However, these parameters can be tweaked so that slower computers perform better:
(set-use-stroke-characters 1) ; default is to use bitmap characters
(set-smooth-scroll-steps 8) ; default 40
(set-smooth-scroll-limit 30) ; Angstroms
(set-residue-selection-flash-frames-number 3);
(set-skeleton-box-size 20.0) ; A (default 40).
(set-active-map-drag-flag 0) ; turn off recontouring every step
(set-idle-function-rotate-angle 1.5) ; continuous spin speed
Next: Scripting Functions, Previous: Hints and Usage Tips, Up: Top [Contents][Index]
• findligand: |
Up: Other Programs [Contents][Index]
findligand
is a stand-alone command-line program that uses the
libraries of Coot.
findligand
provides a number of command line arguments for
increased flexibility:
--pdbin pdb-in-filename
where pdb-in-filename
is the protein (typically)
--hklin mtz-filename
--f f_col_label
--phi phi_col_label
--clusters nclust
where nclust
is the number of density clusters
(potential ligand sites) to search for
--sigma sigma-level
where sigma-level
the density level (in sigma) above
which the map is searched for ligands
--fit-fraction frac
where frac
is the minimum fraction of atoms in
density allowed after fit [default 0.75]
--flexible
means use torsional conformation ligand search
--samples nsamples
nsamples
is the number of flexible conformation samples [default 30]
--dictionary cif-dictionary-name
the file containing the CIF ligand dictionary description
One uses findligand
like this:
|
i.e. the example ligand pdb files that you wish to search for are given at the end of the command line.
Next: More Scripting Functions, Previous: Other Programs, Up: Top [Contents][Index]
Next: File System Functions, Up: Scripting Functions [Contents][Index]
• set-prefer-python: | ||
• prefer-python: |
Next: prefer-python, Up: Startup Functions [Contents][Index]
tell coot that you prefer to run python scripts if/when there is an option to do so.
Previous: set-prefer-python, Up: Startup Functions [Contents][Index]
the python-prefered mode.
This is available so that the scripting functions know whether on not to put themselves onto in as menu items.
If you consider using this, consider in preference use_gui_qm == 2, which is used elsewhere to stop python functions adding to the gui, when guile-gtk functions have alread done so. We should clean up this (rather obscure) interface at some stage.
return 1 for python is prefered, 0 for not.
Next: Widget Utilities, Previous: Startup Functions, Up: Scripting Functions [Contents][Index]
Next: set-show-paths-in-display-manager, Up: File System Functions [Contents][Index]
Where dir is a string
make a directory dir (if it doesn’t exist) and return error code
If it can be created, create the directory dir, return the success status like mkdir: mkdir
Returns: zero on success, or -1 if an error occurred. If dir already exists as a directory, return 0 of course.
Next: show-paths-in-display-manager-state, Previous: make-directory-maybe, Up: File System Functions [Contents][Index]
Where i is an integer number
Show Paths in Display Manager?
Some people don’t like to see the full path names in the display manager here is the way to turn them off, with an argument of 1.
Next: add-coordinates-glob-extension, Previous: set-show-paths-in-display-manager, Up: File System Functions [Contents][Index]
return the internal state
What is the internal flag?
Returns: 1 for "yes, display paths" , 0 for not
Next: add-data-glob-extension, Previous: show-paths-in-display-manager-state, Up: File System Functions [Contents][Index]
Where ext is a string
add an extension to be treated as coordinate files
Next: add-dictionary-glob-extension, Previous: add-coordinates-glob-extension, Up: File System Functions [Contents][Index]
Where ext is a string
add an extension to be treated as data (reflection) files
Next: add-map-glob-extension, Previous: add-data-glob-extension, Up: File System Functions [Contents][Index]
Where ext is a string
add an extension to be treated as geometry dictionary files
Next: remove-coordinates-glob-extension, Previous: add-dictionary-glob-extension, Up: File System Functions [Contents][Index]
Where ext is a string
add an extension to be treated as geometry map files
Next: remove-data-glob-extension, Previous: add-map-glob-extension, Up: File System Functions [Contents][Index]
Where ext is a string
remove an extension to be treated as coordinate files
Next: remove-dictionary-glob-extension, Previous: remove-coordinates-glob-extension, Up: File System Functions [Contents][Index]
Where ext is a string
remove an extension to be treated as data (reflection) files
Next: remove-map-glob-extension, Previous: remove-data-glob-extension, Up: File System Functions [Contents][Index]
Where ext is a string
remove an extension to be treated as geometry dictionary files
Next: set-sticky-sort-by-date, Previous: remove-dictionary-glob-extension, Up: File System Functions [Contents][Index]
Where ext is a string
remove an extension to be treated as geometry map files
Next: unset-sticky-sort-by-date, Previous: remove-map-glob-extension, Up: File System Functions [Contents][Index]
sort files in the file selection by date?
some people like to have their files sorted by date by default
Next: set-filter-fileselection-filenames, Previous: set-sticky-sort-by-date, Up: File System Functions [Contents][Index]
do not sort files in the file selection by date?
removes the sorting of files by date
Next: filter-fileselection-filenames-state, Previous: unset-sticky-sort-by-date, Up: File System Functions [Contents][Index]
Where istate is an integer number
on opening a file selection dialog, pre-filter the files.
set to 1 to pre-filter, [0 (off, non-pre-filtering) is the default
Next: file-type-coords, Previous: set-filter-fileselection-filenames, Up: File System Functions [Contents][Index]
, return the state of the above variable
Next: open-coords-dialog, Previous: filter-fileselection-filenames-state, Up: File System Functions [Contents][Index]
Where file_name is a string
is the given file name suitable to be read as coordinates?
Next: set-file-chooser-selector, Previous: file-type-coords, Up: File System Functions [Contents][Index]
display the open coordinates dialog
Previous: open-coords-dialog, Up: File System Functions [Contents][Index]
Where istate is an integer number
this flag set chooser as default for windows, otherwise use selector 0 is selector 1 is chooser
Next: MTZ and data handling utilities, Previous: File System Functions, Up: Scripting Functions [Contents][Index]
• set-main-window-title: |
Up: Widget Utilities [Contents][Index]
Where s is a string
set the main window title.
function added for Lothar Esser
Next: Molecule Info Functions, Previous: Widget Utilities, Up: Scripting Functions [Contents][Index]
• manage-column-selector: |
Where filename is a string
given a filename, try to read it as a data file
We try as .phs and .cif files first
Next: Library and Utility Functions, Previous: MTZ and data handling utilities, Up: Scripting Functions [Contents][Index]
Next: molecule-centre-internal, Up: Molecule Info Functions [Contents][Index]
Where:
the number of residues in chain chain_id and molecule number imol
Returns: the number of residues
Next: seqnum-from-serial-number, Previous: chain-n-residues, Up: Molecule Info Functions [Contents][Index]
Where:
internal function for molecule centre
Returns: status, less than -9999 is for failure (eg. bad imol);
Next: insertion-code-from-serial-number, Previous: molecule-centre-internal, Up: Molecule Info Functions [Contents][Index]
Where:
a residue seqnum (normal residue number) from a residue serial number
Returns: < -9999 on failure
Next: chain-id-scm, Previous: seqnum-from-serial-number, Up: Molecule Info Functions [Contents][Index]
Where:
the insertion code of the residue.
Returns: NULL (scheme False) on failure.
Next: n-models, Previous: insertion-code-from-serial-number, Up: Molecule Info Functions [Contents][Index]
Where:
the chain_id (string) of the ichain-th chain molecule number imol
Returns: the chain-id
Next: n-chains, Previous: chain-id-scm, Up: Molecule Info Functions [Contents][Index]
Where imol is an integer number
return the number of models in molecule number imol
useful for NMR or other such multi-model molecules.
return the number of models or -1 if there was a problem with the given molecule.
Next: is-solvent-chain-p, Previous: n-models, Up: Molecule Info Functions [Contents][Index]
Where imol is an integer number
number of chains in molecule number imol
Returns: the number of chains
Next: is-protein-chain-p, Previous: n-chains, Up: Molecule Info Functions [Contents][Index]
Where:
is this a solvent chain? [Raw function]
This is a raw interface function, you should generally not use this, but instead use (is-solvent-chain? imol chain-id)
This wraps the mmdb function isSolventChain().
Returns: -1 on error, 0 for no, 1 for is "a solvent chain". We wouldn’t want to be doing rotamer searches and the like on such a chain.
Next: is-nucleotide-chain-p, Previous: is-solvent-chain-p, Up: Molecule Info Functions [Contents][Index]
Where:
is this a protein chain? [Raw function]
This is a raw interface function, you should generally not use this, but instead use (is-protein-chain? imol chain-id)
This wraps the mmdb function isAminoacidChain().
Returns: -1 on error, 0 for no, 1 for is "a protein chain". We wouldn’t want to be doing rotamer searches and the like on such a chain.
Next: n-residues, Previous: is-protein-chain-p, Up: Molecule Info Functions [Contents][Index]
Where:
is this a nucleic acid chain? [Raw function]
This is a raw interface function, you should generally not use this, but instead use (is-nucleicacid-chain? imol chain-id)
This wraps the mmdb function isNucleotideChain(). For completeness.
Returns: -1 on error, 0 for no, 1 for is "a nucleicacid chain". We wouldn’t want to be doing rotamer searches and the like on such a chain.
Next: n-atoms, Previous: is-nucleotide-chain-p, Up: Molecule Info Functions [Contents][Index]
Where imol is an integer number
return the number of residues in the molecule,
return -1 if this is a map or closed.
Next: remarks-scm, Previous: n-residues, Up: Molecule Info Functions [Contents][Index]
Where imol is an integer number
return the atoms of residues in the molecule,
return -1 if this is a map or closed.
Next: sort-chains, Previous: n-atoms, Up: Molecule Info Functions [Contents][Index]
Where imol is an integer number
return a list of the remarks of hte molecule number imol
Next: sort-residues, Previous: remarks-scm, Up: Molecule Info Functions [Contents][Index]
Where imol is an integer number
sort the chain ids of the imol-th molecule in lexographical order
Next: remarks-dialog, Previous: sort-chains, Up: Molecule Info Functions [Contents][Index]
Where imol is an integer number
sort the residues of the imol-th molecule
Next: print-header-secondary-structure-info, Previous: sort-residues, Up: Molecule Info Functions [Contents][Index]
Where imol is an integer number
a gui dialog showing remarks header info (for a model molecule).
Next: add-header-secondary-structure-info, Previous: remarks-dialog, Up: Molecule Info Functions [Contents][Index]
Where imol is an integer number
simply print secondary structure info to the terminal/console. In future, this could/should return the info.
Next: copy-molecule, Previous: print-header-secondary-structure-info, Up: Molecule Info Functions [Contents][Index]
Where imol is an integer number
add secondary structure info to the internal representation of the model
Next: add-ligand-delete-residue-copy-molecule, Previous: add-header-secondary-structure-info, Up: Molecule Info Functions [Contents][Index]
Where imol is an integer number
copy molecule imol
Returns: the new molecule number. Return -1 on failure to copy molecule (out of range, or molecule is closed)
Next: exchange-chain-ids-for-seg-ids, Previous: copy-molecule, Up: Molecule Info Functions [Contents][Index]
Where:
Copy a molecule with addition of a ligand and a deletion of current ligand.
This function is used when adding a new (modified) ligand to a structure. It creates a new molecule that is a copy of the current molecule except that the new ligand is added and the current ligand/residue is deleted.
Next: show-remarks-browswer, Previous: add-ligand-delete-residue-copy-molecule, Up: Molecule Info Functions [Contents][Index]
Where imol is an integer number
Experimental interface for Ribosome People.
Ribosome People have many chains in their pdb file, they prefer segids to chainids (chainids are only 1 character). But coot uses the concept of chain ids and not seg-ids. mmdb allow us to use more than one char in the chainid, so after we read in a pdb, let’s replace the chain ids with the segids. Will that help?
Previous: exchange-chain-ids-for-seg-ids, Up: Molecule Info Functions [Contents][Index]
show the remarks browser
Next: Graphics Utility Functions, Previous: Molecule Info Functions, Up: Scripting Functions [Contents][Index]
Next: svn-revision, Up: Library and Utility Functions [Contents][Index]
return the git revision count for for this build.
Next: molecule-name, Previous: git-revision-count, Up: Library and Utility Functions [Contents][Index]
an alias to git_revision_count() for backwards compatibility
Next: molecule-name-stub-scm, Previous: svn-revision, Up: Library and Utility Functions [Contents][Index]
Where imol is an integer number
return the name of molecule number imol
Returns: 0 if not a valid name ( -> False in scheme) e.g. "/a/b/c.pdb" for "d/e/f.mtz FWT PHWT"
Next: molecule-name-stub-py, Previous: molecule-name, Up: Library and Utility Functions [Contents][Index]
Where:
return the molecule name without file extension
Next: set-molecule-name, Previous: molecule-name-stub-scm, Up: Library and Utility Functions [Contents][Index]
Where:
return the molecule name without file extension
Next: coot-real-exit, Previous: molecule-name-stub-py, Up: Library and Utility Functions [Contents][Index]
Where:
set the molecule name of the imol-th molecule
Next: coot-no-state-real-exit, Previous: set-molecule-name, Up: Library and Utility Functions [Contents][Index]
Where retval is an integer number
exit from coot, give return value retval back to invoking process.
Next: coot-clear-backup-or-real-exit, Previous: coot-real-exit, Up: Library and Utility Functions [Contents][Index]
Where retval is an integer number
exit without writing a state file
Next: coot-save-state-and-exit, Previous: coot-no-state-real-exit, Up: Library and Utility Functions [Contents][Index]
Where retval is an integer number
exit coot doing clear-backup maybe
Next: run-clear-backups, Previous: coot-clear-backup-or-real-exit, Up: Library and Utility Functions [Contents][Index]
Where:
exit coot, write a state file
Next: first-coords-imol, Previous: coot-save-state-and-exit, Up: Library and Utility Functions [Contents][Index]
Where retval is an integer number
run clear-backups
Next: first-small-coords-imol, Previous: run-clear-backups, Up: Library and Utility Functions [Contents][Index]
What is the molecule number of first coordinates molecule?
return -1 when there is none.
Next: first-unsaved-coords-imol, Previous: first-coords-imol, Up: Library and Utility Functions [Contents][Index]
molecule number of first small (<400 atoms) molecule.
return -1 on no such molecule
Next: mmcif-sfs-to-mtz, Previous: first-small-coords-imol, Up: Library and Utility Functions [Contents][Index]
What is the molecule number of first unsaved coordinates molecule?
return -1 when there is none.
Previous: first-unsaved-coords-imol, Up: Library and Utility Functions [Contents][Index]
Where:
convert the structure factors in cif_file_name to an mtz file.
Return 1 on success. Return 0 on a file without Rfree, return -1 on complete failure to write a file.
Next: Interface Preferences, Previous: Library and Utility Functions, Up: Scripting Functions [Contents][Index]
Next: do-anti-aliasing-state, Up: Graphics Utility Functions [Contents][Index]
Where state is an integer number
set the bond lines to be antialiased
Next: set-do-GL-lighting, Previous: set-do-anti-aliasing, Up: Graphics Utility Functions [Contents][Index]
return the flag for antialiasing the bond lines
Next: do-GL-lighting-state, Previous: do-anti-aliasing-state, Up: Graphics Utility Functions [Contents][Index]
Where state is an integer number
turn the GL lighting on (state = 1) or off (state = 0)
slows down the display of simple lines
Next: use-graphics-interface-state, Previous: set-do-GL-lighting, Up: Graphics Utility Functions [Contents][Index]
return the flag for GL lighting
Next: python-at-prompt-at-startup-state, Previous: do-GL-lighting-state, Up: Graphics Utility Functions [Contents][Index]
shall we start up the Gtk and the graphics window?
if passed the command line argument
no-graphics, coot will not start up gtk itself.
An interface function for Ralf.
Next: start-graphics-interface, Previous: use-graphics-interface-state, Up: Graphics Utility Functions [Contents][Index]
is the python interpreter at the prompt?
Returns: 1 for yes, 0 for no.
Next: reset-view, Previous: python-at-prompt-at-startup-state, Up: Graphics Utility Functions [Contents][Index]
start Gtk (and graphics)
This function is useful if it was not started already (which can be achieved by using the command line argument
no-graphics).
An interface for Ralf
Next: graphics-n-molecules, Previous: start-graphics-interface, Up: Graphics Utility Functions [Contents][Index]
"Reset" the view
return 1 if we moved, else return 0.
centre on last-read molecule with zoom 100. If we are there, then go to the previous molecule, if we are there, then go to the origin.
Next: toggle-idle-spin-function, Previous: reset-view, Up: Graphics Utility Functions [Contents][Index]
return the number of molecules (coordinates molecules and map molecules combined) that are currently in coot
Returns: the number of molecules (closed molecules are not counted)
Next: toggle-idle-rock-function, Previous: graphics-n-molecules, Up: Graphics Utility Functions [Contents][Index]
Spin spin spin (or not)
Next: set-rocking-factors, Previous: toggle-idle-spin-function, Up: Graphics Utility Functions [Contents][Index]
Rock (not roll) (self-timed)
Next: set-idle-function-rotate-angle, Previous: toggle-idle-rock-function, Up: Graphics Utility Functions [Contents][Index]
Where:
Settings for the inevitable discontents who dislike the default rocking rates (defaults 1 and 1)
Next: idle-function-rotate-angle, Previous: set-rocking-factors, Up: Graphics Utility Functions [Contents][Index]
Where f is a number
how far should we rotate when (auto) spinning? Fast computer? set this to 0.1
Next: handle-read-draw-molecule, Previous: set-idle-function-rotate-angle, Up: Graphics Utility Functions [Contents][Index]
what is the idle function rotation angle?
Next: make-updating-model-molecule, Previous: idle-function-rotate-angle, Up: Graphics Utility Functions [Contents][Index]
Where filename is a string
a synonym for read-pdb. Read the coordinates from filename (can be pdb, cif or shelx format)
Next: allow-duplicate-sequence-numbers, Previous: handle-read-draw-molecule, Up: Graphics Utility Functions [Contents][Index]
Where filename is a string
make a model molecule from the give file name.
If the file updates, then the model will be updated.
Next: set-convert-to-v2-atom-names, Previous: make-updating-model-molecule, Up: Graphics Utility Functions [Contents][Index]
enable reading PDB/pdbx files with duplicate sequence numbers
Next: handle-read-draw-molecule-with-recentre, Previous: allow-duplicate-sequence-numbers, Up: Graphics Utility Functions [Contents][Index]
Where state is an integer number
shall we convert nucleotides to match the old dictionary names?
Usually (after 2006 or so) we do not want to do this (given current Coot architecture). Coot should handle the residue synonyms transparently.
default off (0).
Next: handle-read-draw-molecule-and-move-molecule-here, Previous: set-convert-to-v2-atom-names, Up: Graphics Utility Functions [Contents][Index]
Where:
read coordinates from filename with option to not recentre.
set recentre_on_read_pdb_flag to 0 if you don’t want the view to recentre on the new coordinates.
Next: read-pdb, Previous: handle-read-draw-molecule-with-recentre, Up: Graphics Utility Functions [Contents][Index]
Where filename is a string
read coordinates from filename and recentre the new molecule at the screen rotation centre.
Next: assign-hetatms, Previous: handle-read-draw-molecule-and-move-molecule-here, Up: Graphics Utility Functions [Contents][Index]
Where filename is a string
read coordinates from filename
Next: hetify-residue, Previous: read-pdb, Up: Graphics Utility Functions [Contents][Index]
Where imol is an integer number
some programs produce PDB files with ATOMs where there should be HETATMs. This is a function to assign HETATMs as per the PDB definition.
Next: residue-has-hetatms, Previous: assign-hetatms, Up: Graphics Utility Functions [Contents][Index]
Where:
if this is not a standard group, then turn the atoms to HETATMs.
Return 1 on atoms changes, 0 on not. Return -1 if residue not found.
Next: het-group-residues-scm, Previous: hetify-residue, Up: Graphics Utility Functions [Contents][Index]
Where:
residue has HETATMs?
return 1 if all atoms of the specified residue are HETATMs, else, return 0. If residue not found, return -1.
Next: het-group-residues-py, Previous: residue-has-hetatms, Up: Graphics Utility Functions [Contents][Index]
Where imol is an integer number
get the specs for hetgroups - waters are not counted as het-groups.
Next: het-group-n-atoms, Previous: het-group-residues-scm, Up: Graphics Utility Functions [Contents][Index]
Where imol is an integer number
get the specs for hetgroups - waters are not counted as het-groups.
Next: replace-fragment, Previous: het-group-residues-py, Up: Graphics Utility Functions [Contents][Index]
Where comp_id is a string
return the number of non-hydrogen atoms in the given het-group (comp-id).
Return -1 on comp-id not found in dictionary.
Next: copy-residue-range, Previous: het-group-n-atoms, Up: Graphics Utility Functions [Contents][Index]
Where:
replace the parts of molecule number imol that are duplicated in molecule number imol_frag
Next: replace-residues-from-mol-scm, Previous: replace-fragment, Up: Graphics Utility Functions [Contents][Index]
Where:
copy the given residue range from the reference chain to the target chain
resno_range_start and resno_range_end are inclusive.
Next: clear-and-update-model-molecule-from-file, Previous: copy-residue-range, Up: Graphics Utility Functions [Contents][Index]
Where:
replace the given residues from the reference molecule to the target molecule
Next: screendump-image, Previous: replace-residues-from-mol-scm, Up: Graphics Utility Functions [Contents][Index]
Where:
replace pdb. Fail if molecule_number is not a valid model molecule. Return -1 on failure. Else return molecule_number
Next: check-for-dark-blue-density, Previous: clear-and-update-model-molecule-from-file, Up: Graphics Utility Functions [Contents][Index]
Where filename is a string
dump the current screen image to a file. Format ppm
You can use this, in conjunction with spinning and view moving functions to make movies
Next: set-draw-solid-density-surface, Previous: screendump-image, Up: Graphics Utility Functions [Contents][Index]
give a warning dialog if density it too dark (blue)
Next: set-draw-map-standard-lines, Previous: check-for-dark-blue-density, Up: Graphics Utility Functions [Contents][Index]
Where:
sets the density map of the given molecule to be drawn as a (transparent) solid surface.
Next: set-solid-density-surface-opacity, Previous: set-draw-solid-density-surface, Up: Graphics Utility Functions [Contents][Index]
Where:
toggle for standard lines representation of map.
This turns off/on standard lines representation of map. transparent surface is another representation type.
If you want to just turn off a map, don’t use this, use
.
Next: set-flat-shading-for-solid-density-surface, Previous: set-draw-map-standard-lines, Up: Graphics Utility Functions [Contents][Index]
Where:
set the opacity of density surface representation of the given map.
0.0 is totally transparent, 1.0 is completely opaque and (because the objects are no longer depth sorted) considerably faster to render. 0.3 is a reasonable number.
Previous: set-solid-density-surface-opacity, Up: Graphics Utility Functions [Contents][Index]
Where state is an integer number
set the flag to do flat shading rather than smooth shading for solid density surface.
Default is 1 (on.
Next: Mouse Buttons, Previous: Graphics Utility Functions, Up: Scripting Functions [Contents][Index]
Next: scroll-by-wheel-mouse-state, Up: Interface Preferences [Contents][Index]
Where istate is an integer number
Some people (like Phil Evans) don’t want to scroll their map with the mouse-wheel.
To turn off mouse wheel recontouring call this with istate value of 0
Next: set-auto-recontour-map, Previous: set-scroll-by-wheel-mouse, Up: Interface Preferences [Contents][Index]
return the internal state of the scroll-wheel map contouring
Next: get-auto-recontour-map, Previous: scroll-by-wheel-mouse-state, Up: Interface Preferences [Contents][Index]
Where state is an integer number
turn off (0) or on (1) auto recontouring (on screen centre change) (default it on)
Next: set-default-initial-contour-level-for-map, Previous: set-auto-recontour-map, Up: Interface Preferences [Contents][Index]
return the auto-recontour state
Next: set-default-initial-contour-level-for-difference-map, Previous: get-auto-recontour-map, Up: Interface Preferences [Contents][Index]
Where n_sigma is a number
set the default inital contour for 2FoFc-style map
in sigma
Next: print-view-matrix, Previous: set-default-initial-contour-level-for-map, Up: Interface Preferences [Contents][Index]
Where n_sigma is a number
set the default inital contour for FoFc-style map
in sigma
Next: get-view-quaternion-internal, Previous: set-default-initial-contour-level-for-difference-map, Up: Interface Preferences [Contents][Index]
print the view matrix to the console, useful for molscript, perhaps
Next: set-view-quaternion, Previous: print-view-matrix, Up: Interface Preferences [Contents][Index]
Where element is an integer number
internal function to get an element of the view quaternion. The whole quaternion is returned by the scheme function view-quaternion
Next: apply-ncs-to-view-orientation, Previous: get-view-quaternion-internal, Up: Interface Preferences [Contents][Index]
Where:
Set the view quaternion.
Next: apply-ncs-to-view-orientation-and-screen-centre, Previous: set-view-quaternion, Up: Interface Preferences [Contents][Index]
Where:
Given that we are in chain current_chain, apply the NCS operator that maps current_chain on to next_ncs_chain, so that the relative view is preserved. For NCS skipping.
Next: set-fps-flag, Previous: apply-ncs-to-view-orientation, Up: Interface Preferences [Contents][Index]
Where:
as above, but shift the screen centre also.
Next: get-fps-flag, Previous: apply-ncs-to-view-orientation-and-screen-centre, Up: Interface Preferences [Contents][Index]
Where t is an integer number
set show frame-per-second flag
Next: set-show-origin-marker, Previous: set-fps-flag, Up: Interface Preferences [Contents][Index]
set the state of show frames-per-second flag
Next: show-origin-marker-state, Previous: get-fps-flag, Up: Interface Preferences [Contents][Index]
Where istate is an integer number
set a flag: is the origin marker to be shown? 1 for yes, 0 for no.
Next: hide-modelling-toolbar, Previous: set-show-origin-marker, Up: Interface Preferences [Contents][Index]
return the origin marker shown? state
Next: show-modelling-toolbar, Previous: show-origin-marker-state, Up: Interface Preferences [Contents][Index]
hide the vertical modelling toolbar in the GTK2 version
Next: hide-main-toolbar, Previous: hide-modelling-toolbar, Up: Interface Preferences [Contents][Index]
show the vertical modelling toolbar in the GTK2 version (the toolbar is shown by default)
Next: show-main-toolbar, Previous: show-modelling-toolbar, Up: Interface Preferences [Contents][Index]
hide the horizontal main toolbar in the GTK2 version
Next: show-model-toolbar-all-icons, Previous: hide-main-toolbar, Up: Interface Preferences [Contents][Index]
show the horizontal main toolbar in the GTK2 version (the toolbar is shown by default)
Next: show-model-toolbar-main-icons, Previous: show-main-toolbar, Up: Interface Preferences [Contents][Index]
show all available icons in the modelling toolbar (same as MFR dialog)
Next: reattach-modelling-toolbar, Previous: show-model-toolbar-all-icons, Up: Interface Preferences [Contents][Index]
show only a selection of icons in the modelling toolbar
Next: set-model-toolbar-docked-position, Previous: show-model-toolbar-main-icons, Up: Interface Preferences [Contents][Index]
reattach the modelling toolbar to the last attached position
Next: suck-model-fit-dialog, Previous: reattach-modelling-toolbar, Up: Interface Preferences [Contents][Index]
Where state is an integer number
to swap sides of the Model/Fit/Refine toolbar 0 (default) is right, 1 is left, 2 is top, 3 is bottom
Next: add-status-bar-text, Previous: set-model-toolbar-docked-position, Up: Interface Preferences [Contents][Index]
reparent the Model/Fit/Refine dialog so that it becomes part of the main window, next to the GL graphics context
Next: set-model-fit-refine-dialog-stays-on-top, Previous: suck-model-fit-dialog, Up: Interface Preferences [Contents][Index]
Where s is a string
Put text s into the status bar.
use this to put info for the user in the statusbar (less intrusive than popup).
Next: model-fit-refine-dialog-stays-on-top-state, Previous: add-status-bar-text, Up: Interface Preferences [Contents][Index]
Where istate is an integer number
model-fit-refine dialog stays on top
Next: accept-reject-dialog-docked-state, Previous: set-model-fit-refine-dialog-stays-on-top, Up: Interface Preferences [Contents][Index]
return the state model-fit-refine dialog stays on top
Next: set-accept-reject-dialog-docked-show, Previous: model-fit-refine-dialog-stays-on-top-state, Up: Interface Preferences [Contents][Index]
the accept/reject dialog docked state
Next: accept-reject-dialog-docked-show-state, Previous: accept-reject-dialog-docked-state, Up: Interface Preferences [Contents][Index]
Where state is an integer number
set the accept/reject dialog docked show state
Previous: set-accept-reject-dialog-docked-show, Up: Interface Preferences [Contents][Index]
what is the accept/reject dialog docked show state?
Next: Cursor Function, Previous: Interface Preferences, Up: Scripting Functions [Contents][Index]
Next: quanta-like-zoom, Up: Mouse Buttons [Contents][Index]
quanta-like buttons
Note, when you have set these, there is no way to turn them of again (other than restarting).
Next: set-control-key-for-rotate, Previous: quanta-buttons, Up: Mouse Buttons [Contents][Index]
quanta-like zoom buttons
Note, when you have set these, there is no way to turn them of again (other than restarting).
Next: control-key-for-rotate-state, Previous: quanta-like-zoom, Up: Mouse Buttons [Contents][Index]
Where state is an integer number
Alternate mode for rotation.
Prefered by some, including Dirk Kostrewa. I don’t think this mode works properly yet
Next: blob-under-pointer-to-screen-centre, Previous: set-control-key-for-rotate, Up: Mouse Buttons [Contents][Index]
return the control key rotate state
Next: select-atom-under-pointer-scm, Previous: control-key-for-rotate-state, Up: Mouse Buttons [Contents][Index]
Put the blob under the cursor to the screen centre. Check only positive blobs. Useful function if bound to a key.
The refinement map must be set. (We can’t check all maps because they are not (or may not be) on the same scale).
Returns: 1 if successfully found a blob and moved there. return 0 if no move.
Next: select-atom-under-pointer-py, Previous: blob-under-pointer-to-screen-centre, Up: Mouse Buttons [Contents][Index]
return scheme false or a list of molecule number and an atom spec
Previous: select-atom-under-pointer-scm, Up: Mouse Buttons [Contents][Index]
return Python false or a list of molecule number and an atom spec
Next: Model/Fit/Refine Functions, Previous: Mouse Buttons, Up: Scripting Functions [Contents][Index]
• normal-cursor: | ||
• fleur-cursor: | ||
• pick-cursor-maybe: | ||
• rotate-cursor: | ||
• set-pick-cursor-index: |
Next: fleur-cursor, Up: Cursor Function [Contents][Index]
normal cursor
Next: pick-cursor-maybe, Previous: normal-cursor, Up: Cursor Function [Contents][Index]
fleur cursor
Next: rotate-cursor, Previous: fleur-cursor, Up: Cursor Function [Contents][Index]
pick cursor maybe
Next: set-pick-cursor-index, Previous: pick-cursor-maybe, Up: Cursor Function [Contents][Index]
rotate cursor
Previous: rotate-cursor, Up: Cursor Function [Contents][Index]
Where icursor_index is an integer number
let the user have a different pick cursor
sometimes (the default) GDK_CROSSHAIR is hard to see, let the user set their own
Next: Backup Functions, Previous: Cursor Function, Up: Scripting Functions [Contents][Index]
Next: unset-model-fit-refine-dialog, Up: Model/Fit/Refine Functions [Contents][Index]
display the Model/Fit/Refine dialog
Next: unset-refine-params-dialog, Previous: post-model-fit-refine-dialog, Up: Model/Fit/Refine Functions [Contents][Index]
unset model/fit/refine dialog
Next: show-select-map-dialog, Previous: unset-model-fit-refine-dialog, Up: Model/Fit/Refine Functions [Contents][Index]
unset refine params dialog
Next: set-model-fit-refine-rotate-translate-zone-label, Previous: unset-refine-params-dialog, Up: Model/Fit/Refine Functions [Contents][Index]
display the Display Manager dialog
Next: set-model-fit-refine-place-atom-at-pointer-label, Previous: show-select-map-dialog, Up: Model/Fit/Refine Functions [Contents][Index]
Where txt is a string
Allow the changing of Model/Fit/Refine button label from "Rotate/Translate Zone".
Next: post-other-modelling-tools-dialog, Previous: set-model-fit-refine-rotate-translate-zone-label, Up: Model/Fit/Refine Functions [Contents][Index]
Where txt is a string
Allow the changing of Model/Fit/Refine button label from "Place Atom at Pointer".
Next: set-refinement-move-atoms-with-zero-occupancy, Previous: set-model-fit-refine-place-atom-at-pointer-label, Up: Model/Fit/Refine Functions [Contents][Index]
display the Other Modelling Tools dialog
Next: refinement-move-atoms-with-zero-occupancy-state, Previous: post-other-modelling-tools-dialog, Up: Model/Fit/Refine Functions [Contents][Index]
Where state is an integer number
shall atoms with zero occupancy be moved when refining? (default 1, yes)
Previous: set-refinement-move-atoms-with-zero-occupancy, Up: Model/Fit/Refine Functions [Contents][Index]
return the state of "shall atoms with zero occupancy be moved when refining?"
Next: Recover Session Function, Previous: Model/Fit/Refine Functions, Up: Scripting Functions [Contents][Index]
Next: turn-off-backup, Up: Backup Functions [Contents][Index]
Where imol is an integer number
make backup for molecule number imol
Next: turn-on-backup, Previous: make-backup, Up: Backup Functions [Contents][Index]
Where imol is an integer number
turn off backups for molecule number imol
Next: backup-state, Previous: turn-off-backup, Up: Backup Functions [Contents][Index]
Where imol is an integer number
turn on backups for molecule number imol
Next: apply-undo, Previous: turn-on-backup, Up: Backup Functions [Contents][Index]
Where imol is an integer number
return the backup state for molecule number imol
return 0 for backups off, 1 for backups on, -1 for unknown
Next: apply-redo, Previous: backup-state, Up: Backup Functions [Contents][Index]
apply undo - the "Undo" button callback
Next: set-have-unsaved-changes, Previous: apply-undo, Up: Backup Functions [Contents][Index]
apply redo - the "Redo" button callback
Next: have-unsaved-changes-p, Previous: apply-redo, Up: Backup Functions [Contents][Index]
Where imol is an integer number
set the molecule number imol to be marked as having unsaved changes
Next: set-undo-molecule, Previous: set-have-unsaved-changes, Up: Backup Functions [Contents][Index]
Where imol is an integer number
does molecule number imol have unsaved changes?
Returns: -1 on bad imol, 0 on no unsaved changes, 1 on has unsaved changes
Next: show-set-undo-molecule-chooser, Previous: have-unsaved-changes-p, Up: Backup Functions [Contents][Index]
Where imol is an integer number
set the molecule to which undo operations are done to molecule number imol
Next: set-unpathed-backup-file-names, Previous: set-undo-molecule, Up: Backup Functions [Contents][Index]
show the Undo Molecule chooser - i.e. choose the molecule to which the "Undo" button applies.
Next: unpathed-backup-file-names-state, Previous: show-set-undo-molecule-chooser, Up: Backup Functions [Contents][Index]
Where state is an integer number
set the state for adding paths to backup file names
by default directories names are added into the filename for backup (with / to _ mapping). call this with state=1 to turn off directory names
Next: set-decoloned-backup-file-names, Previous: set-unpathed-backup-file-names, Up: Backup Functions [Contents][Index]
return the state for adding paths to backup file names
Next: decoloned-backup-file-names-state, Previous: unpathed-backup-file-names-state, Up: Backup Functions [Contents][Index]
Where state is an integer number
set the state for adding paths to backup file names
by default directories names are added into the filename for backup (with / to _ mapping). call this with state=1 to turn off directory names
Next: backup-compress-files-state, Previous: set-decoloned-backup-file-names, Up: Backup Functions [Contents][Index]
return the state for adding paths to backup file names
Next: set-backup-compress-files, Previous: decoloned-backup-file-names-state, Up: Backup Functions [Contents][Index]
return the state for compression of backup files
Previous: backup-compress-files-state, Up: Backup Functions [Contents][Index]
Where state is an integer number
set if backup files will be compressed or not using gzip
Next: Map Functions, Previous: Backup Functions, Up: Scripting Functions [Contents][Index]
• recover-session: |
recover session
After a crash, we provide this convenient interface to restore the session. It runs through all the molecules with models and looks at the coot backup directory looking for related backup files that are more recent that the read file. (Not very good, because you need to remember which files you read in before the crash - should be improved.)
Next: Density Increment, Previous: Recover Session Function, Up: Scripting Functions [Contents][Index]
Next: map-from-mtz-by-refmac-calc-phases, Up: Map Functions [Contents][Index]
Where mtz_file_name is a string
fire up a GUI, which asks us which model molecule we want to calc phases from. On "OK" button there, we call map_from_mtz_by_refmac_calc_phases()
Next: map-from-mtz-by-calc-phases, Previous: calc-phases-generic, Up: Map Functions [Contents][Index]
Where:
Calculate SFs (using refmac optionally) from an MTZ file and generate a map. Get F and SIGF automatically (first of their type) from the mtz file.
Returns: the new molecule number, -1 on a problem.
Next: sfcalc-genmap, Previous: map-from-mtz-by-refmac-calc-phases, Up: Map Functions [Contents][Index]
Where:
Calculate SFs from an MTZ file and generate a map.
Returns: the new molecule number.
Next: set-auto-updating-sfcalc-genmap, Previous: map-from-mtz-by-calc-phases, Up: Map Functions [Contents][Index]
Where:
Calculate structure factors from the model and update the given difference map accordingly.
Next: set-scroll-wheel-map, Previous: sfcalc-genmap, Up: Map Functions [Contents][Index]
Where:
As above, calculate structure factors from the model and update the given difference map accordingly - but difference map gets updated automatically on modification of the imol_model molecule.
Next: set-scrollable-map, Previous: set-auto-updating-sfcalc-genmap, Up: Map Functions [Contents][Index]
Where imap is an integer number
set the map that is moved by changing the scroll wheel and change_contour_level().
Next: scroll-wheel-map, Previous: set-scroll-wheel-map, Up: Map Functions [Contents][Index]
Where imol is an integer number
return the molecule number to which the mouse scroll wheel is attached
set the map that has its contour level changed by the scrolling the mouse wheel to molecule number imol (same as
).
Next: save-previous-map-colour, Previous: set-scrollable-map, Up: Map Functions [Contents][Index]
the contouring of which map is altered when the scroll wheel changes?
Next: restore-previous-map-colour, Previous: scroll-wheel-map, Up: Map Functions [Contents][Index]
Where imol is an integer number
save previous colour map for molecule number imol
Next: set-active-map-drag-flag, Previous: save-previous-map-colour, Up: Map Functions [Contents][Index]
Where imol is an integer number
restore previous colour map for molecule number imol
Next: get-active-map-drag-flag, Previous: restore-previous-map-colour, Up: Map Functions [Contents][Index]
Where t is an integer number
set the state of immediate map upate on map drag.
By default, it is on (t=1). On slower computers it might be better to set t=0.
Next: set-last-map-colour, Previous: set-active-map-drag-flag, Up: Map Functions [Contents][Index]
return the state of the dragged map flag
Next: set-map-colour, Previous: get-active-map-drag-flag, Up: Map Functions [Contents][Index]
Where:
set the colour of the last (highest molecule number) map
Next: set-contour-level-absolute, Previous: set-last-map-colour, Up: Map Functions [Contents][Index]
Where:
set the colour of the imolth map
Next: set-contour-level-in-sigma, Previous: set-map-colour, Up: Map Functions [Contents][Index]
Where:
set the contour level, direct control
Next: get-contour-level-absolute, Previous: set-contour-level-absolute, Up: Map Functions [Contents][Index]
Where:
set the contour level, direct control in r.m.s.d. (if you like that sort of thing)
Next: get-contour-level-in-sigma, Previous: set-contour-level-in-sigma, Up: Map Functions [Contents][Index]
Where imol is an integer number
get the contour level
Next: set-last-map-sigma-step, Previous: get-contour-level-absolute, Up: Map Functions [Contents][Index]
Where imol is an integer number
get the contour level in rmd above 0.
Next: set-contour-by-sigma-step-by-mol, Previous: get-contour-level-in-sigma, Up: Map Functions [Contents][Index]
Where f is a number
set the sigma step of the last map to f sigma
Next: data-resolution, Previous: set-last-map-sigma-step, Up: Map Functions [Contents][Index]
Where:
set the contour level step
set the contour level step of molecule number imol to f and variable state (setting state to 0 turns off contouring by sigma level)
Next: model-resolution, Previous: set-contour-by-sigma-step-by-mol, Up: Map Functions [Contents][Index]
Where imol is an integer number
return the resolution of the data for molecule number imol. Return negative number on error, otherwise resolution in A (eg. 2.0)
Next: export-map, Previous: data-resolution, Up: Map Functions [Contents][Index]
Where imol is an integer number
return the resolution set in the header of the model/coordinates file. If this number is not available, return a number less than 0.
Next: export-map-fragment, Previous: model-resolution, Up: Map Functions [Contents][Index]
Where:
export (write to disk) the map of molecule number imol to filename.
Return 0 on failure, 1 on success.
Next: export-map-fragment-with-origin-shift, Previous: export-map, Up: Map Functions [Contents][Index]
Where:
export a fragment of the map about (x,y,z)
Next: export-map-fragment-to-plain-file, Previous: export-map-fragment, Up: Map Functions [Contents][Index]
Where:
export a fragment of the map about (x,y,z)
Next: difference-map, Previous: export-map-fragment-with-origin-shift, Up: Map Functions [Contents][Index]
Where:
tmp interface for Hamish
Next: reinterp-map, Previous: export-map-fragment-to-plain-file, Up: Map Functions [Contents][Index]
Where:
make a difference map, taking map_scale * imap2 from imap1, on the grid of imap1. Return the new molecule number. Return -1 on failure.
Next: smooth-map, Previous: difference-map, Up: Map Functions [Contents][Index]
Where:
make a new map (a copy of map_no) that is in the cell, spacegroup and gridding of the map in reference_map_no.
Return the new map molecule number - return -1 on failure
Next: average-map-scm, Previous: reinterp-map, Up: Map Functions [Contents][Index]
Where:
make a new map (a copy of map_no) that is in the cell, spacegroup and a multiple of the sampling of the input map (a sampling factor of more than 1 makes the output maps smoother)
Next: average-map-py, Previous: smooth-map, Up: Map Functions [Contents][Index]
Where map_number_and_scales is a SCM
make an average map from the map_number_and_scales (which is a list of pairs (list map-number scale-factor)) (the scale factors are typically 1.0 of course). The output map is in the same grid as the first (valid) map. Return -1 on failure to make an averaged map, otherwise return the new map molecule number.
Previous: average-map-scm, Up: Map Functions [Contents][Index]
Where map_number_and_scales is a PyObject
make an average map from the map_number_and_scales (which is a list of pairs map_number, scale_factor. The output map is in the same grid as the first (valid) map. Return -1 on failure to make an averaged map, otherwise return the new map molecule number.
Next: Density Functions, Previous: Map Functions, Up: Scripting Functions [Contents][Index]
Next: set-diff-map-iso-level-increment, Up: Density Increment [Contents][Index]
Where val is a number
set the contour scroll step (in absolute e/A3) for 2Fo-Fc-style maps to val
The is only activated when scrolling by sigma is turned off
Next: get-diff-map-iso-level-increment, Previous: set-iso-level-increment, Up: Density Increment [Contents][Index]
Where val is a number
set the contour scroll step for difference map (in absolute e/A3) to val
The is only activated when scrolling by sigma is turned off
Next: set-diff-map-iso-level-increment-from-text, Previous: set-diff-map-iso-level-increment, Up: Density Increment [Contents][Index]
return difference maps iso-map level increment
Next: set-map-sampling-rate-text, Previous: get-diff-map-iso-level-increment, Up: Density Increment [Contents][Index]
Where:
set the difference maps iso-map level increment
Next: set-map-sampling-rate, Previous: set-diff-map-iso-level-increment-from-text, Up: Density Increment [Contents][Index]
Where text is a string
sampling rate
find the molecule for which the single map dialog applies and set the contour level and redraw
Next: get-map-sampling-rate, Previous: set-map-sampling-rate-text, Up: Density Increment [Contents][Index]
Where r is a number
set the map sampling rate (default 1.5)
Set to something like 2.0 or 2.5 for more finely sampled maps. Useful for baton-building low resolution maps.
Next: change-contour-level, Previous: set-map-sampling-rate, Up: Density Increment [Contents][Index]
return the map sampling rate
Next: set-last-map-contour-level, Previous: get-map-sampling-rate, Up: Density Increment [Contents][Index]
Where is_increment is an integer number
change the contour level of the current map by a step
if is_increment=1 the contour level is increased. If is_increment=0 the map contour level is decreased.
Next: set-last-map-contour-level-by-sigma, Previous: change-contour-level, Up: Density Increment [Contents][Index]
Where level is a number
set the contour level of the map with the highest molecule number to level
Next: set-stop-scroll-diff-map, Previous: set-last-map-contour-level, Up: Density Increment [Contents][Index]
Where n_sigma is a number
set the contour level of the map with the highest molecule number to n_sigma sigma
Next: set-stop-scroll-iso-map, Previous: set-last-map-contour-level-by-sigma, Up: Density Increment [Contents][Index]
Where i is an integer number
create a lower limit to the "Fo-Fc-style" map contour level changing
(default 1 on)
Next: set-stop-scroll-iso-map-level, Previous: set-stop-scroll-diff-map, Up: Density Increment [Contents][Index]
Where i is an integer number
create a lower limit to the "2Fo-Fc-style" map contour level changing
(default 1 on)
Next: set-stop-scroll-diff-map-level, Previous: set-stop-scroll-iso-map, Up: Density Increment [Contents][Index]
Where f is a number
set the actual map level changing limit
(default 0.0)
Next: set-residue-density-fit-scale-factor, Previous: set-stop-scroll-iso-map-level, Up: Density Increment [Contents][Index]
Where f is a number
set the actual difference map level changing limit
(default 0.0)
Previous: set-stop-scroll-diff-map-level, Up: Density Increment [Contents][Index]
Where f is a number
set the scale factor for the Residue Density fit analysis
Next: Parameters from map, Previous: Density Increment, Up: Scripting Functions [Contents][Index]
Next: map-line-width-state, Up: Density Functions [Contents][Index]
Where w is an integer number
draw the lines of the chickenwire density in width w
Next: make-and-draw-map, Previous: set-map-line-width, Up: Density Functions [Contents][Index]
return the width in which density contours are drawn
Next: make-and-draw-map-with-refmac-params, Previous: map-line-width-state, Up: Density Functions [Contents][Index]
Where:
make a map from an mtz file (simple interface)
given mtz file mtz_file_name and F column f_col and phases column phi_col and optional weight column weight_col (pass use_weights=0 if weights are not to be used). Also mark the map as a difference map (is_diff_map=1) or not (is_diff_map=0) because they are handled differently inside coot.
Returns: -1 on error, else return the new molecule number
Next: make-and-draw-map-with-reso-with-refmac-params, Previous: make-and-draw-map, Up: Density Functions [Contents][Index]
Where:
as the above function, execpt set refmac parameters too
pass along the refmac column labels for storage (not used in the creation of the map)
Returns: -1 on error, else return imol
Next: make-updating-map, Previous: make-and-draw-map-with-refmac-params, Up: Density Functions [Contents][Index]
Where:
as the above function, except set expert options too.
Next: valid-labels, Previous: make-and-draw-map-with-reso-with-refmac-params, Up: Density Functions [Contents][Index]
Where:
make a map molecule from the give file name.
If the file updates, then the map will be updated.
Next: mtz-file-has-phases-p, Previous: make-updating-map, Up: Density Functions [Contents][Index]
Where:
does the mtz file have the columms that we want it to have?
Next: is-mtz-file-p, Previous: valid-labels, Up: Density Functions [Contents][Index]
Where mtz_file_name is a string
does the mtz file have phases?
Next: cns-file-has-phases-p, Previous: mtz-file-has-phases-p, Up: Density Functions [Contents][Index]
Where filename is a string
is the given filename an mtz file?
Next: auto-read-do-difference-map-too-state, Previous: is-mtz-file-p, Up: Density Functions [Contents][Index]
Where cns_file_name is a string
does the given file have cns phases?
Next: set-auto-read-column-labels, Previous: cns-file-has-phases-p, Up: Density Functions [Contents][Index]
return the flag to do a difference map (too) on auto-read MTZ
Returns: 0 means no, 1 means yes.
Next: set-map-radius, Previous: auto-read-do-difference-map-too-state, Up: Density Functions [Contents][Index]
Where:
set the expected MTZ columns for Auto-reading MTZ file.
Not every program uses the default refmac labels ("FWT"/"PHWT") for its MTZ file. Here we can tell coot to expect other labels so that coot can "Auto-open" such MTZ files.
e.g. (set-auto-read-column-labels "2FOFCWT" "PH2FOFCWT" 0)
Next: set-map-radius-em, Previous: set-auto-read-column-labels, Up: Density Functions [Contents][Index]
Where f is a number
set the extent of the box/radius of electron density contours for x-ray maps
Next: set-density-size, Previous: set-map-radius, Up: Density Functions [Contents][Index]
Where radius is a number
set the extent of the box/radius of electron density contours for EM map
Next: set-display-intro-string, Previous: set-map-radius-em, Up: Density Functions [Contents][Index]
Where f is a number
another (old) way of setting the radius of the map
Next: get-map-radius, Previous: set-density-size, Up: Density Functions [Contents][Index]
Where str is a string
Give me this nice message str when I start coot.
Next: set-esoteric-depth-cue, Previous: set-display-intro-string, Up: Density Functions [Contents][Index]
return the extent of the box/radius of electron density contours
Next: esoteric-depth-cue-state, Previous: get-map-radius, Up: Density Functions [Contents][Index]
Where istate is an integer number
not everone likes coot’s esoteric depth cueing system
Pass an argument istate=1 to turn it off
(this function is currently disabled).
Next: set-swap-difference-map-colours, Previous: set-esoteric-depth-cue, Up: Density Functions [Contents][Index]
native depth cueing system
return the state of the esoteric depth cueing flag
Next: set-map-is-difference-map, Previous: esoteric-depth-cue-state, Up: Density Functions [Contents][Index]
Where i is an integer number
not everone likes coot’s default difference map colouring.
Pass an argument i=1 to swap the difference map colouring so that red is positive and green is negative.
Next: map-is-difference-map, Previous: set-swap-difference-map-colours, Up: Density Functions [Contents][Index]
Where:
post-hoc set the map of molecule number imol to be a difference map
Returns: success status, 0 -> failure (imol does not have a map)
Next: another-level, Previous: set-map-is-difference-map, Up: Density Functions [Contents][Index]
Where imol is an integer number
map is difference map?
Next: another-level-from-map-molecule-number, Previous: map-is-difference-map, Up: Density Functions [Contents][Index]
Add another contour level for the last added map.
Currently, the map must have been generated from an MTZ file.
Returns: the molecule number of the new molecule or -1 on failure
Next: residue-density-fit-scale-factor, Previous: another-level, Up: Density Functions [Contents][Index]
Where imap is an integer number
Add another contour level for the given map.
Currently, the map must have been generated from an MTZ file.
Returns: the molecule number of the new molecule or -1 on failure
Next: density-at-point, Previous: another-level-from-map-molecule-number, Up: Density Functions [Contents][Index]
return the scale factor for the Residue Density fit analysis
Previous: residue-density-fit-scale-factor, Up: Density Functions [Contents][Index]
Where:
return the density at the given point for the given map. Return 0 for bad imol
Next: PDB Functions, Previous: Density Functions, Up: Scripting Functions [Contents][Index]
• mtz-hklin-for-map: | ||
• mtz-fp-for-map: | ||
• mtz-phi-for-map: | ||
• mtz-weight-for-map: | ||
• mtz-use-weight-for-map: | ||
• map-parameters-scm: | ||
• cell-scm: | ||
• map-parameters-py: | ||
• cell-py: |
Next: mtz-fp-for-map, Up: Parameters from map [Contents][Index]
Where imol_map is an integer number
return the mtz file that was use to generate the map
return 0 when there is no mtz file associated with that map (it was generated from a CCP4 map file say).
Next: mtz-phi-for-map, Previous: mtz-hklin-for-map, Up: Parameters from map [Contents][Index]
Where imol_map is an integer number
return the FP column in the file that was use to generate the map
return 0 when there is no mtz file associated with that map (it was generated from a CCP4 map file say).
Caller should dispose of returned pointer.
Next: mtz-weight-for-map, Previous: mtz-fp-for-map, Up: Parameters from map [Contents][Index]
Where imol_map is an integer number
return the phases column in mtz file that was use to generate the map
return 0 when there is no mtz file associated with that map (it was generated from a CCP4 map file say). Caller should dispose of returned pointer.
Next: mtz-use-weight-for-map, Previous: mtz-phi-for-map, Up: Parameters from map [Contents][Index]
Where imol_map is an integer number
return the weight column in the mtz file that was use to generate the map
return 0 when there is no mtz file associated with that map (it was generated from a CCP4 map file say) or no weights were used. Caller should dispose of returned pointer.
Next: map-parameters-scm, Previous: mtz-weight-for-map, Up: Parameters from map [Contents][Index]
Where imol_map is an integer number
return flag for whether weights were used that was use to generate the map
return 0 when no weights were used or there is no mtz file associated with that map.
Next: cell-scm, Previous: mtz-use-weight-for-map, Up: Parameters from map [Contents][Index]
Where imol is an integer number
return the parameter that made the map,
Returns: false or a string like ("xxx.mtz" "FPH" "PHWT" "" False)
Next: map-parameters-py, Previous: map-parameters-scm, Up: Parameters from map [Contents][Index]
Where imol is an integer number
return the parameter that made the map,
Returns: false or a list like (45 46 47 90 90 120), angles in degress
Next: cell-py, Previous: cell-scm, Up: Parameters from map [Contents][Index]
Where imol is an integer number
return the parameter of the molecule, something like (45 46 47 90 90 120), angles in degress
return the parameter that made the map,
Returns: False or something like ["xxx.mtz", "FPH", "PHWT", "", False]
Previous: map-parameters-py, Up: Parameters from map [Contents][Index]
Where imol is an integer number
return the parameter that made the map,
Returns: False or something like [45, 46, 47, 90, 90, 120], angles in degress
Next: Info Dialog, Previous: Parameters from map, Up: Scripting Functions [Contents][Index]
• write-pdb-file: | ||
• write-cif-file: | ||
• write-residue-range-to-pdb-file: | ||
• quick-save: |
Next: write-cif-file, Up: PDB Functions [Contents][Index]
Where:
write molecule number imol as a PDB to file file_name
Next: write-residue-range-to-pdb-file, Previous: write-pdb-file, Up: PDB Functions [Contents][Index]
Where:
write molecule number imol as a mmCIF to file file_name
Next: quick-save, Previous: write-cif-file, Up: PDB Functions [Contents][Index]
Where:
write molecule number imol’s residue range as a PDB to file file_name
Previous: write-residue-range-to-pdb-file, Up: PDB Functions [Contents][Index]
save all modified coordinates molecules to the default names and save the state too.
Next: Refmac Functions, Previous: PDB Functions, Up: Scripting Functions [Contents][Index]
• info-dialog: | ||
• info-dialog-and-text: | ||
• info-dialog-with-markup: |
Next: info-dialog-and-text, Up: Info Dialog [Contents][Index]
Where txt is a string
create a dialog with information
create a dialog with information string txt. User has to click to dismiss it, but it is not modal (nothing in coot is modal).
Next: info-dialog-with-markup, Previous: info-dialog, Up: Info Dialog [Contents][Index]
Where txt is a string
create a dialog with information and print to console
as info_dialog but print to console as well.
Previous: info-dialog-and-text, Up: Info Dialog [Contents][Index]
Where txt is a string
as above, create a dialog with information
This dialog is left-justified and can use markup such as angled bracketted tt or i
Next: Symmetry Functions, Previous: Info Dialog, Up: Scripting Functions [Contents][Index]
• set-refmac-counter: | ||
• swap-map-colours: | ||
• set-keep-map-colour-after-refmac: | ||
• keep-map-colour-after-refmac-state: |
Next: swap-map-colours, Up: Refmac Functions [Contents][Index]
Where:
set counter for runs of refmac so that this can be used to construct a unique filename for new output
Next: set-keep-map-colour-after-refmac, Previous: set-refmac-counter, Up: Refmac Functions [Contents][Index]
Where:
swap the colours of maps
swap the colour of maps imol1 and imol2. Useful to some after running refmac, so that the map to be build into is always the same colour
Next: keep-map-colour-after-refmac-state, Previous: swap-map-colours, Up: Refmac Functions [Contents][Index]
Where istate is an integer number
flag to enable above
call this with istate=1
Previous: set-keep-map-colour-after-refmac, Up: Refmac Functions [Contents][Index]
the keep-map-colour-after-refmac internal state
Returns: 1 for "yes", 0 for "no"
Next: History Functions, Previous: Refmac Functions, Up: Scripting Functions [Contents][Index]
Next: get-show-symmetry, Up: Symmetry Functions [Contents][Index]
Where f is a number
set the size of the displayed symmetry
Next: set-show-symmetry-master, Previous: set-symmetry-size, Up: Symmetry Functions [Contents][Index]
is symmetry master display control on?
Next: set-show-symmetry-molecule, Previous: get-show-symmetry, Up: Symmetry Functions [Contents][Index]
Where state is an integer number
set display symmetry, master controller
Next: symmetry-as-calphas, Previous: set-show-symmetry-master, Up: Symmetry Functions [Contents][Index]
Where:
set display symmetry for molecule number mol_no
pass with state=0 for off, state=1 for on
Next: get-symmetry-as-calphas-state, Previous: set-show-symmetry-molecule, Up: Symmetry Functions [Contents][Index]
Where:
display symmetry as CAs?
pass with state=0 for off, state=1 for on
Next: set-symmetry-molecule-rotate-colour-map, Previous: symmetry-as-calphas, Up: Symmetry Functions [Contents][Index]
Where imol is an integer number
what is state of display CAs for molecule number mol_no?
return state=0 for off, state=1 for on
Next: symmetry-molecule-rotate-colour-map-state, Previous: get-symmetry-as-calphas-state, Up: Symmetry Functions [Contents][Index]
Where:
set the colour map rotation (i.e. the hue) for the symmetry atoms of molecule number imol
Next: set-symmetry-colour-by-symop, Previous: set-symmetry-molecule-rotate-colour-map, Up: Symmetry Functions [Contents][Index]
Where imol is an integer number
should there be colour map rotation (i.e. the hue) change for the symmetry atoms of molecule number imol?
return state=0 for off, state=1 for on
Next: set-symmetry-whole-chain, Previous: symmetry-molecule-rotate-colour-map-state, Up: Symmetry Functions [Contents][Index]
Where:
set symmetry colour by symop mode
Next: set-symmetry-atom-labels-expanded, Previous: set-symmetry-colour-by-symop, Up: Symmetry Functions [Contents][Index]
Where:
set symmetry colour for the chain
Next: has-unit-cell-state, Previous: set-symmetry-whole-chain, Up: Symmetry Functions [Contents][Index]
Where state is an integer number
set use expanded symmetry atom labels
Next: undo-symmetry-view, Previous: set-symmetry-atom-labels-expanded, Up: Symmetry Functions [Contents][Index]
Where imol is an integer number
molecule number imol has a unit cell?
Returns: 1 on "yes, it has a cell", 0 for "no"
Next: first-molecule-with-symmetry-displayed, Previous: has-unit-cell-state, Up: Symmetry Functions [Contents][Index]
Undo symmetry view. Translate back to main molecule from this symmetry position.
Next: save-symmetry-coords, Previous: undo-symmetry-view, Up: Symmetry Functions [Contents][Index]
return the molecule number.
Returns: -1 if there is no molecule with symmetry displayed.
Next: new-molecule-by-symmetry, Previous: first-molecule-with-symmetry-displayed, Up: Symmetry Functions [Contents][Index]
Where:
save the symmetry coordinates of molecule number imol to filename
Allow a shift of the coordinates to the origin before symmetry expansion is apllied (this is how symmetry works in Coot internals).
Next: new-molecule-by-symmetry-with-atom-selection, Previous: save-symmetry-coords, Up: Symmetry Functions [Contents][Index]
Where:
create a new molecule (molecule number is the return value) from imol.
The rotation/translation matrix components are given in
coordinates.
Allow a shift of the coordinates to the origin before symmetry expansion is aplied.
Pass "" as the name-in and a name will be constructed for you.
Return -1 on failure.
Next: new-molecule-by-symop, Previous: new-molecule-by-symmetry, Up: Symmetry Functions [Contents][Index]
Where:
create a new molecule (molecule number is the return value) from imol, but only for atom that match the mmdb_atom_selection_string.
The rotation/translation matrix components are given in
coordinates.
Allow a shift of the coordinates to the origin before symmetry expansion is aplied.
Pass "" as the name-in and a name will be constructed for you.
Return -1 on failure.
Next: n-symops, Previous: new-molecule-by-symmetry-with-atom-selection, Up: Symmetry Functions [Contents][Index]
Where:
create a new molecule (molecule number is the return value) from imol.
Next: origin-pre-shift-scm, Previous: new-molecule-by-symop, Up: Symmetry Functions [Contents][Index]
Where imol is an integer number
return the number of symmetry operators for the given molecule
return -1 on no-symmetry for molecule or inappropriate imol number
Next: origin-pre-shift-py, Previous: n-symops, Up: Symmetry Functions [Contents][Index]
Where imol is an integer number
return the pre-shift (the shift that translates the centre of the molecule as close as possible to the origin) as a list of ints or scheme false on failure
Next: set-space-group, Previous: origin-pre-shift-scm, Up: Symmetry Functions [Contents][Index]
Where imol is an integer number
return the pre-shift (the shift that translates the centre of the molecule as close as possible to the origin) as a list of ints or Python false on failure
Next: set-unit-cell-and-space-group, Previous: origin-pre-shift-py, Up: Symmetry Functions [Contents][Index]
Where:
set the space group for a coordinates molecule
for shelx FA pdb files, there is no space group. So allow the user to set it. This can be initted with a HM symbol or a symm list for clipper.
This will only work on model molecules.
Returns: the success status of the setting (1 good, 0 fail).
Next: set-unit-cell-and-space-group-using-molecule, Previous: set-space-group, Up: Symmetry Functions [Contents][Index]
Where:
set the unit cell for a given model molecule
Angles in degress, cell lengths in Angstroms.
Returns: the success status of the setting (1 good, 0 fail).
Next: set-symmetry-shift-search-size, Previous: set-unit-cell-and-space-group, Up: Symmetry Functions [Contents][Index]
Where:
set the unit cell for a given model molecule using the cell of moecule imol_from
This will only work on model molecules.
Returns: the success status of the setting (1 good, 0 fail).
Previous: set-unit-cell-and-space-group-using-molecule, Up: Symmetry Functions [Contents][Index]
Where shift is an integer number
set the cell shift search size for symmetry searching.
When the coordinates for one (or some) symmetry operator are missing (which happens sometimes, but rarely), try changing setting this to 2 (default is 1). It slows symmetry searching, which is why it is not set to 2 by default.
Next: State Functions, Previous: Symmetry Functions, Up: Scripting Functions [Contents][Index]
• print-all-history-in-scheme: | ||
• print-all-history-in-python: | ||
• set-console-display-commands-state: | ||
• set-console-display-commands-hilights: |
Next: print-all-history-in-python, Up: History Functions [Contents][Index]
print the history in scheme format
Next: set-console-display-commands-state, Previous: print-all-history-in-scheme, Up: History Functions [Contents][Index]
print the history in python format
Next: set-console-display-commands-hilights, Previous: print-all-history-in-python, Up: History Functions [Contents][Index]
Where istate is an integer number
set a flag to show the text command equivalent of gui commands in the console as they happen.
1 for on, 0 for off.
Previous: set-console-display-commands-state, Up: History Functions [Contents][Index]
Where:
set a flag to show the text command equivalent of gui commands in the console as they happen in bold and colours.
colour_flag: pass 1 for on, 0 for off.
colour_index 0 to 7 inclusive for various different colourings.
Next: The Virtual Trackball, Previous: History Functions, Up: Scripting Functions [Contents][Index]
Next: save-state-file, Up: State Functions [Contents][Index]
save the current state to the default filename
Next: save-state-file-py, Previous: save-state, Up: State Functions [Contents][Index]
Where filename is a string
save the current state to file filename
Next: set-save-state-file-name, Previous: save-state-file, Up: State Functions [Contents][Index]
Where filename is a string
save the current state to file filename
Next: save-state-file-name-scm, Previous: save-state-file-py, Up: State Functions [Contents][Index]
Where filename is a string
set the default state file name (default 0-coot.state.scm)
Next: save-state-file-name-py, Previous: set-save-state-file-name, Up: State Functions [Contents][Index]
the save state file name
Returns: the save state file name
Next: set-run-state-file-status, Previous: save-state-file-name-scm, Up: State Functions [Contents][Index]
the save state file name
Returns: the save state file name
Next: run-state-file, Previous: save-state-file-name-py, Up: State Functions [Contents][Index]
Where istat is an integer number
set run state file status
0: never run it 1: ask to run it 2: run it, no questions
Next: run-state-file-maybe, Previous: set-run-state-file-status, Up: State Functions [Contents][Index]
run the state file (reading from default filenname)
Previous: run-state-file, Up: State Functions [Contents][Index]
run the state file depending on the state variables
Next: Clipping Functions, Previous: State Functions, Up: Scripting Functions [Contents][Index]
• vt-surface: | ||
• vt-surface-status: |
Next: vt-surface-status, Up: The Virtual Trackball [Contents][Index]
Where mode is an integer number
How should the mouse move the view?
mode=1 for "Flat", mode=2 for "Spherical Surface"
Previous: vt-surface, Up: The Virtual Trackball [Contents][Index]
return the mouse view status mode
mode=1 for "Flat", mode=2 for "Spherical Surface"
Next: Unit Cell interface, Previous: The Virtual Trackball, Up: Scripting Functions [Contents][Index]
• set-clipping-back: | ||
• set-clipping-front: |
Next: set-clipping-front, Up: Clipping Functions [Contents][Index]
Where v is a number
set clipping plane back
Previous: set-clipping-back, Up: Clipping Functions [Contents][Index]
Where v is a number
set clipping plane front
Next: Colour, Previous: Clipping Functions, Up: Scripting Functions [Contents][Index]
• get-show-unit-cell: | ||
• set-show-unit-cells-all: | ||
• set-show-unit-cell: |
Next: set-show-unit-cells-all, Up: Unit Cell interface [Contents][Index]
Where imol is an integer number
return the stage of show unit cell for molecule number imol
Next: set-show-unit-cell, Previous: get-show-unit-cell, Up: Unit Cell interface [Contents][Index]
Where istate is an integer number
set the state of show unit cell for all molecules
1 for displayed 0 for undisplayed
Previous: set-show-unit-cells-all, Up: Unit Cell interface [Contents][Index]
Where:
set the state of show unit cell for the particular molecule number imol
1 for displayed 0 for undisplayed
Next: Map colour, Previous: Unit Cell interface, Up: Scripting Functions [Contents][Index]
Next: set-colour-map-rotation-on-read-pdb-flag, Up: Colour [Contents][Index]
Where f is a number
set the hue change step on reading a new molecule
Next: set-colour-map-rotation-on-read-pdb-c-only-flag, Previous: set-colour-map-rotation-on-read-pdb, Up: Colour [Contents][Index]
Where i is an integer number
shall the hue change step be used?
Next: set-colour-by-chain, Previous: set-colour-map-rotation-on-read-pdb-flag, Up: Colour [Contents][Index]
Where i is an integer number
shall the colour map rotation apply only to C atoms?
Next: set-colour-by-chain-goodsell-mode, Previous: set-colour-map-rotation-on-read-pdb-c-only-flag, Up: Colour [Contents][Index]
Where imol is an integer number
colour molecule number imol by chain type
Next: set-colour-by-molecule, Previous: set-colour-by-chain, Up: Colour [Contents][Index]
Where imol is an integer number
colour molecule number imol by chain type, goodsell-like colour scheme
Next: set-symmetry-colour, Previous: set-colour-by-chain-goodsell-mode, Up: Colour [Contents][Index]
Where imol is an integer number
colour molecule number imol by molecule
Previous: set-colour-by-molecule, Up: Colour [Contents][Index]
Where:
set the symmetry colour base
Next: Anisotropic Atoms Interface, Previous: Colour, Up: Scripting Functions [Contents][Index]
• set-colour-map-rotation-for-map: | ||
• set-molecule-bonds-colour-map-rotation: | ||
• get-molecule-bonds-colour-map-rotation: |
Next: set-molecule-bonds-colour-map-rotation, Up: Map colour [Contents][Index]
Where f is a number
set the colour map rotation (hue change) for maps
default: for maps is 14 degrees.
Next: get-molecule-bonds-colour-map-rotation, Previous: set-colour-map-rotation-for-map, Up: Map colour [Contents][Index]
Where:
set the colour map rotation for molecule number imol
theta is in degrees
Previous: set-molecule-bonds-colour-map-rotation, Up: Map colour [Contents][Index]
Where imol is an integer number
Get the colour map rotation for molecule number imol.
Next: Display Functions, Previous: Map colour, Up: Scripting Functions [Contents][Index]
• get-limit-aniso: | ||
• get-show-limit-aniso: | ||
• get-show-aniso: | ||
• set-limit-aniso: | ||
• set-show-aniso: | ||
• set-aniso-probability: | ||
• get-aniso-probability: |
Next: get-show-limit-aniso, Up: Anisotropic Atoms Interface [Contents][Index]
get the aniso radius limit
Next: get-show-aniso, Previous: get-limit-aniso, Up: Anisotropic Atoms Interface [Contents][Index]
get show the aniso limit
Next: set-limit-aniso, Previous: get-show-limit-aniso, Up: Anisotropic Atoms Interface [Contents][Index]
return show-aniso-atoms state
Next: set-show-aniso, Previous: get-show-aniso, Up: Anisotropic Atoms Interface [Contents][Index]
Where state is an integer number
set the aniso atom limit
Next: set-aniso-probability, Previous: set-limit-aniso, Up: Anisotropic Atoms Interface [Contents][Index]
Where state is an integer number
set show aniso atoms
Next: get-aniso-probability, Previous: set-show-aniso, Up: Anisotropic Atoms Interface [Contents][Index]
Where f is a number
set aniso probability
Previous: set-aniso-probability, Up: Anisotropic Atoms Interface [Contents][Index]
get aniso probability
Next: Smooth Scrolling, Previous: Anisotropic Atoms Interface, Up: Scripting Functions [Contents][Index]
Next: set-graphics-window-position, Up: Display Functions [Contents][Index]
Where:
set the window size
Next: store-graphics-window-position, Previous: set-graphics-window-size, Up: Display Functions [Contents][Index]
Where:
set the graphics window position
Next: graphics-window-size-and-position-to-preferences, Previous: set-graphics-window-position, Up: Display Functions [Contents][Index]
Where:
store the graphics window position
Next: graphics-draw, Previous: store-graphics-window-position, Up: Display Functions [Contents][Index]
store the graphics window position and size to zenops-graphics-window-size-and-postion.scm in the preferences directory.
Next: zalman-stereo-mode, Previous: graphics-window-size-and-position-to-preferences, Up: Display Functions [Contents][Index]
draw a frame
Next: hardware-stereo-mode, Previous: graphics-draw, Up: Display Functions [Contents][Index]
try to turn on Zalman stereo mode
Next: stereo-mode-state, Previous: zalman-stereo-mode, Up: Display Functions [Contents][Index]
try to turn on stereo mode
Next: mono-mode, Previous: hardware-stereo-mode, Up: Display Functions [Contents][Index]
what is the stero state?
Returns: 1 for in hardware stereo, 2 for side by side stereo, else return 0.
Next: side-by-side-stereo-mode, Previous: stereo-mode-state, Up: Display Functions [Contents][Index]
try to turn on mono mode
Next: set-hardware-stereo-angle-factor, Previous: mono-mode, Up: Display Functions [Contents][Index]
Where use_wall_eye_mode is an integer number
turn on side bye side stereo mode
Next: hardware-stereo-angle-factor-state, Previous: side-by-side-stereo-mode, Up: Display Functions [Contents][Index]
Where f is a number
how much should the eyes be separated in stereo mode?
Next: set-model-fit-refine-dialog-position, Previous: set-hardware-stereo-angle-factor, Up: Display Functions [Contents][Index]
return the hardware stereo angle factor
Next: set-display-control-dialog-position, Previous: hardware-stereo-angle-factor-state, Up: Display Functions [Contents][Index]
Where:
set position of Model/Fit/Refine dialog
Next: set-go-to-atom-window-position, Previous: set-model-fit-refine-dialog-position, Up: Display Functions [Contents][Index]
Where:
set position of Display Control dialog
Next: set-delete-dialog-position, Previous: set-display-control-dialog-position, Up: Display Functions [Contents][Index]
Where:
set position of Go To Atom dialog
Next: set-rotate-translate-dialog-position, Previous: set-go-to-atom-window-position, Up: Display Functions [Contents][Index]
Where:
set position of Delete dialog
Next: set-accept-reject-dialog-position, Previous: set-delete-dialog-position, Up: Display Functions [Contents][Index]
Where:
set position of the Rotate/Translate Residue Range dialog
Next: set-ramachandran-plot-dialog-position, Previous: set-rotate-translate-dialog-position, Up: Display Functions [Contents][Index]
Where:
set position of the Accept/Reject dialog
Next: set-edit-chi-angles-dialog-position, Previous: set-accept-reject-dialog-position, Up: Display Functions [Contents][Index]
Where:
set position of the Ramachadran Plot dialog
Next: set-rotamer-selection-dialog-position, Previous: set-ramachandran-plot-dialog-position, Up: Display Functions [Contents][Index]
Where:
set edit chi angles dialog position
Previous: set-edit-chi-angles-dialog-position, Up: Display Functions [Contents][Index]
Where:
set rotamer selection dialog position
Next: Font Parameters, Previous: Display Functions, Up: Scripting Functions [Contents][Index]
• set-smooth-scroll-flag: | ||
• get-smooth-scroll: | ||
• set-smooth-scroll-steps: | ||
• set-smooth-scroll-limit: |
Next: get-smooth-scroll, Up: Smooth Scrolling [Contents][Index]
Where v is an integer number
set smooth scrolling
Next: set-smooth-scroll-steps, Previous: set-smooth-scroll-flag, Up: Smooth Scrolling [Contents][Index]
return the smooth scrolling state
Next: set-smooth-scroll-limit, Previous: get-smooth-scroll, Up: Smooth Scrolling [Contents][Index]
Where i is an integer number
set the number of steps in the smooth scroll
Set more steps (e.g. 50) for more smoothness (default 10).
Previous: set-smooth-scroll-steps, Up: Smooth Scrolling [Contents][Index]
Where lim is a number
do not scroll for distances greater this limit
Next: Rotation Centre, Previous: Smooth Scrolling, Up: Scripting Functions [Contents][Index]
• set-font-size: | ||
• get-font-size: | ||
• set-font-colour: | ||
• set-use-stroke-characters: |
Next: get-font-size, Up: Font Parameters [Contents][Index]
Where i is an integer number
set the font size
Next: set-font-colour, Previous: set-font-size, Up: Font Parameters [Contents][Index]
return the font size
Returns: 1 (small) 2 (medium, default) 3 (large)
Next: set-use-stroke-characters, Previous: get-font-size, Up: Font Parameters [Contents][Index]
Where:
set the colour of the atom label font - the arguments are in the range 0->1
Previous: set-font-colour, Up: Font Parameters [Contents][Index]
Where state is an integer number
set use stroke characters
Next: Atom Selection Utilities, Previous: Font Parameters, Up: Scripting Functions [Contents][Index]
• set-rotation-centre-size: | ||
• recentre-on-read-pdb: | ||
• set-recentre-on-read-pdb: | ||
• set-rotation-centre: | ||
• go-to-ligand: | ||
• set-go-to-ligand-n-atoms-limit: | ||
• set-reorienting-next-residue-mode: |
Next: recentre-on-read-pdb, Up: Rotation Centre [Contents][Index]
Where f is a number
set rotoation centre marker size
Next: set-recentre-on-read-pdb, Previous: set-rotation-centre-size, Up: Rotation Centre [Contents][Index]
return the recentre-on-pdb state
Next: set-rotation-centre, Previous: recentre-on-read-pdb, Up: Rotation Centre [Contents][Index]
Where int is a short
set the recentre-on-pdb state
Next: go-to-ligand, Previous: set-recentre-on-read-pdb, Up: Rotation Centre [Contents][Index]
Where:
set the rotation centre
Next: set-go-to-ligand-n-atoms-limit, Previous: set-rotation-centre, Up: Rotation Centre [Contents][Index]
centre on the ligand of the "active molecule", if we are already there, centre on the next hetgroup (etc)
Next: set-reorienting-next-residue-mode, Previous: go-to-ligand, Up: Rotation Centre [Contents][Index]
Where n_atom_min is an integer number
go to the ligand that has more than n_atom_min atoms
Previous: set-go-to-ligand-n-atoms-limit, Up: Rotation Centre [Contents][Index]
Where state is an integer number
rotate the view so that the next main-chain atoms are oriented in the same direction as the previous - hence side-chain always seems to be "up" - set this mode to 1 for reorientation-mode - and 0 for off (standard translation)
Next: Skeletonization Interface, Previous: Rotation Centre, Up: Scripting Functions [Contents][Index]
Next: average-temperature-factor, Up: Atom Selection Utilities [Contents][Index]
Where imol is an integer number
return the median temperature factor for imol
Next: standard-deviation-temperature-factor, Previous: median-temperature-factor, Up: Atom Selection Utilities [Contents][Index]
Where imol is an integer number
return the average temperature factor for the atoms in imol
Next: clear-pending-picks, Previous: average-temperature-factor, Up: Atom Selection Utilities [Contents][Index]
Where imol is an integer number
return the standard deviation of the atom temperature factors for imol
Next: set-default-temperature-factor-for-new-atoms, Previous: standard-deviation-temperature-factor, Up: Atom Selection Utilities [Contents][Index]
clear pending picks (stop coot thinking that the user is about to pick an atom).
Next: default-new-atoms-b-factor, Previous: clear-pending-picks, Up: Atom Selection Utilities [Contents][Index]
Where new_b is a number
set the default temperature factor for newly created atoms (initial default 20)
Next: set-reset-b-factor-moved-atoms, Previous: set-default-temperature-factor-for-new-atoms, Up: Atom Selection Utilities [Contents][Index]
return the default temperature factor for newly created atoms
Next: get-reset-b-factor-moved-atoms-state, Previous: default-new-atoms-b-factor, Up: Atom Selection Utilities [Contents][Index]
Where state is an integer number
reset temperature factor for all moved atoms to the default for new atoms (usually 30)
Next: set-atom-attribute, Previous: set-reset-b-factor-moved-atoms, Up: Atom Selection Utilities [Contents][Index]
return the state if temperature factors shoudl be reset for moved atoms
Next: set-atom-string-attribute, Previous: get-reset-b-factor-moved-atoms-state, Up: Atom Selection Utilities [Contents][Index]
Where:
set a numberical attibute to the atom with the given specifier.
Attributes can be "x", "y","z", "B", "occ" and the attribute val is a floating point number
Next: set-atom-attributes, Previous: set-atom-attribute, Up: Atom Selection Utilities [Contents][Index]
Where:
set a string attibute to the atom with the given specifier.
Attributes can be "atom-name", "alt-conf", "element" or "segid".
Next: set-residue-name, Previous: set-atom-string-attribute, Up: Atom Selection Utilities [Contents][Index]
Where attribute_expression_list is a SCM
set lots of atom attributes at once by-passing the rebonding and redrawing of the above 2 functions
Previous: set-atom-attributes, Up: Atom Selection Utilities [Contents][Index]
Where:
set the residue name of the specified residue
Next: Save Coordinates, Previous: Atom Selection Utilities, Up: Scripting Functions [Contents][Index]
• skeletonize-map: | ||
• unskeletonize-map: | ||
• set-max-skeleton-search-depth: | ||
• set-skeleton-box-size: |
Next: unskeletonize-map, Up: Skeletonization Interface [Contents][Index]
Where:
skeletonize molecule number imol
the prune_flag should almost always be 0.
NOTE:: The arguments to have been reversed for coot 0.8.3 and later (now the molecule number comes first).
Next: set-max-skeleton-search-depth, Previous: skeletonize-map, Up: Skeletonization Interface [Contents][Index]
Where imol is an integer number
undisplay the skeleton on molecule number imol
Next: set-skeleton-box-size, Previous: unskeletonize-map, Up: Skeletonization Interface [Contents][Index]
Where v is an integer number
set the skeleton search depth, used in baton building
For high resolution maps, you need to search deeper down the skeleton tree. This limit needs to be increased to 20 or so for high res maps (it is 10 by default)
Previous: set-max-skeleton-search-depth, Up: Skeletonization Interface [Contents][Index]
Where f is a number
the box size (in Angstroms) for which the skeleton is displayed
Next: Read Phases File Functions, Previous: Skeletonization Interface, Up: Scripting Functions [Contents][Index]
• save-coordinates: | ||
• set-save-coordinates-in-original-directory: |
Where:
save coordinates of molecule number imol in filename
Returns: status 1 is good (success), 0 is fail.
Previous: save-coordinates, Up: Save Coordinates [Contents][Index]
Where i is an integer number
set save coordinates in the starting directory
Next: Graphics Move, Previous: Save Coordinates, Up: Scripting Functions [Contents][Index]
Next: read-phs-and-make-map-using-cell-symm-from-previous-mol, Up: Read Phases File Functions [Contents][Index]
Where pdb_filename is a string
read phs file use coords to get cell and symm to make map
uses pending data to make the map.
Next: read-phs-and-make-map-using-cell-symm-from-mol, Previous: read-phs-and-coords-and-make-map, Up: Read Phases File Functions [Contents][Index]
Where phs_filename is a string
read a phs file, the cell and symm information is from previously read (most recently read) coordinates file
For use with phs data filename provided on the command line
Next: read-phs-and-make-map-using-cell-symm, Previous: read-phs-and-make-map-using-cell-symm-from-previous-mol, Up: Read Phases File Functions [Contents][Index]
Where:
read phs file and use a previously read molecule to provide the cell and symmetry information
Returns: the new molecule number, return -1 if problem creating the map (e.g. not phs data, file not found etc).
Next: read-phs-and-make-map-with-reso-limits, Previous: read-phs-and-make-map-using-cell-symm-from-mol, Up: Read Phases File Functions [Contents][Index]
Where:
read phs file use coords to use cell and symm to make map
in degrees
Previous: read-phs-and-make-map-using-cell-symm, Up: Read Phases File Functions [Contents][Index]
Where:
read a phs file and use the cell and symm in molecule number imol and use the resolution limits reso_lim_high (in Angstroems).
Next: Go To Atom Widget Functions, Previous: Read Phases File Functions, Up: Scripting Functions [Contents][Index]
• undo-last-move: | ||
• translate-molecule-by: | ||
• transform-molecule-by: | ||
• transform-zone: |
Next: translate-molecule-by, Up: Graphics Move [Contents][Index]
undo last move
Next: transform-molecule-by, Previous: undo-last-move, Up: Graphics Move [Contents][Index]
Where:
translate molecule number imol by (x,y,z) in Angstroms
Next: transform-zone, Previous: translate-molecule-by, Up: Graphics Move [Contents][Index]
Where:
transform molecule number imol by the given rotation matrix, then translate by (x,y,z) in Angstroms
Previous: transform-molecule-by, Up: Graphics Move [Contents][Index]
Where:
transform fragment of molecule number imol by the given rotation matrix, then translate by (x,y,z) in Angstroms
Next: Map and Molecule Control, Previous: Graphics Move, Up: Scripting Functions [Contents][Index]
Next: go-to-atom-molecule-number, Up: Go To Atom Widget Functions [Contents][Index]
Post the Go To Atom Window.
Next: go-to-atom-chain-id, Previous: post-go-to-atom-window, Up: Go To Atom Widget Functions [Contents][Index]
the go-to-atom molecule number
Next: go-to-atom-atom-name, Previous: go-to-atom-molecule-number, Up: Go To Atom Widget Functions [Contents][Index]
the go-to-atom chain-id
Next: go-to-atom-residue-number, Previous: go-to-atom-chain-id, Up: Go To Atom Widget Functions [Contents][Index]
the go-to-atom atom name
Next: go-to-atom-ins-code, Previous: go-to-atom-atom-name, Up: Go To Atom Widget Functions [Contents][Index]
the go-to-atom residue number
Next: go-to-atom-alt-conf, Previous: go-to-atom-residue-number, Up: Go To Atom Widget Functions [Contents][Index]
the go-to-atom insertion code
Next: set-go-to-atom-chain-residue-atom-name, Previous: go-to-atom-ins-code, Up: Go To Atom Widget Functions [Contents][Index]
the go-to-atom alt conf
Next: set-go-to-atom-chain-residue-atom-name-full, Previous: go-to-atom-alt-conf, Up: Go To Atom Widget Functions [Contents][Index]
Where:
set the go to atom specification
It seems important for swig that the char * arguments are const char *, not const gchar * (or else we get wrong type of argument error on (say) "A"
Returns: the success status of the go to. 0 for fail, 1 for success.
Next: set-go-to-atom-chain-residue-atom-name-no-redraw, Previous: set-go-to-atom-chain-residue-atom-name, Up: Go To Atom Widget Functions [Contents][Index]
Where:
set the go to (full) atom specification
It seems important for swig that the char * arguments are const char *, not const gchar * (or else we get wrong type of argument error on (say) "A"
Returns: the success status of the go to. 0 for fail, 1 for success.
Next: update-go-to-atom-from-current-position, Previous: set-go-to-atom-chain-residue-atom-name-full, Up: Go To Atom Widget Functions [Contents][Index]
Where:
set go to atom but don’t redraw
Next: atom-spec-to-atom-index, Previous: set-go-to-atom-chain-residue-atom-name-no-redraw, Up: Go To Atom Widget Functions [Contents][Index]
update the Go To Atom widget entries to atom closest to screen centre.
Next: full-atom-spec-to-atom-index, Previous: update-go-to-atom-from-current-position, Up: Go To Atom Widget Functions [Contents][Index]
Where:
what is the atom index of the given atom?
Next: update-go-to-atom-window-on-changed-mol, Previous: atom-spec-to-atom-index, Up: Go To Atom Widget Functions [Contents][Index]
Where:
what is the atom index of the given atom?
Next: update-go-to-atom-window-on-new-mol, Previous: full-atom-spec-to-atom-index, Up: Go To Atom Widget Functions [Contents][Index]
Where imol is an integer number
update the Go To Atom window
Next: set-go-to-atom-molecule, Previous: update-go-to-atom-window-on-changed-mol, Up: Go To Atom Widget Functions [Contents][Index]
update the Go To Atom window. This updates the option menu for the molecules.
Previous: update-go-to-atom-window-on-new-mol, Up: Go To Atom Widget Functions [Contents][Index]
Where imol is an integer number
set the molecule for the Go To Atom
For dynarama callback sake. The widget/class knows which molecule that it was generated from, so in order to go to the molecule from dynarama, we first need to the the molecule - because
does not mention the molecule (see "Next/Previous Residue" for reasons for that). This function simply calls the graphics_info_t function of the same name.
Also used in scripting, where go-to-atom-chain-residue-atom-name does not mention the molecule number.
20090914-PE set-go-to-atom-molecule can be used in a script and it should change the go-to-atom-molecule in the Go To Atom dialog (if it is being displayed). This does mean, of course that using the ramachandran plot to centre on atoms will change the Go To Atom dialog. Maybe that is surprising (maybe not).
Next: Align and Mutate, Previous: Go To Atom Widget Functions, Up: Scripting Functions [Contents][Index]
Next: set-map-displayed, Up: Map and Molecule Control [Contents][Index]
display the Display Constrol window
Next: set-mol-displayed, Previous: post-display-control-window, Up: Map and Molecule Control [Contents][Index]
Where:
make the map displayed/undisplayed, 0 for off, 1 for on
Next: set-display-only-model-mol, Previous: set-map-displayed, Up: Map and Molecule Control [Contents][Index]
Where:
make the coordinates molecule displayed/undisplayed, 0 for off, 1 for on
Next: set-mol-active, Previous: set-mol-displayed, Up: Map and Molecule Control [Contents][Index]
Where imol is an integer number
from all the model molecules, display only imol
This stops flashing/delayed animations with many molecules
Next: display-maps-scm, Previous: set-display-only-model-mol, Up: Map and Molecule Control [Contents][Index]
Where:
make the coordinates molecule active/inactve (clickable), 0 for off, 1 for on
Next: mol-is-displayed, Previous: set-mol-active, Up: Map and Molecule Control [Contents][Index]
Where maps_list is a SCM
maps_list is a list of integers (map molecule numbers).
This interface is uses so that we don’t get flashing when a map is turned off (using set_mol_displayed).
Next: mol-is-active, Previous: display-maps-scm, Up: Map and Molecule Control [Contents][Index]
Where imol is an integer number
return the display state of molecule number imol
Returns: 1 for on, 0 for off
Next: map-is-displayed, Previous: mol-is-displayed, Up: Map and Molecule Control [Contents][Index]
Where imol is an integer number
return the active state of molecule number imol
Returns: 1 for on, 0 for off
Next: set-all-maps-displayed, Previous: mol-is-active, Up: Map and Molecule Control [Contents][Index]
Where imol is an integer number
return the display state of molecule number imol
Returns: 1 for on, 0 for off
Next: set-all-models-displayed-and-active, Previous: map-is-displayed, Up: Map and Molecule Control [Contents][Index]
Where on_or_off is an integer number
if on_or_off is 0 turn off all maps displayed, for other values of on_or_off turn on all maps
Next: set-only-last-model-molecule-displayed, Previous: set-all-maps-displayed, Up: Map and Molecule Control [Contents][Index]
Where on_or_off is an integer number
if on_or_off is 0 turn off all models displayed and active, for other values of on_or_off turn on all models.
Next: display-only-active, Previous: set-all-models-displayed-and-active, Up: Map and Molecule Control [Contents][Index]
only display the last model molecule
Next: space-group-scm, Previous: set-only-last-model-molecule-displayed, Up: Map and Molecule Control [Contents][Index]
display only the active mol and the refinement map
Next: show-spacegroup, Previous: display-only-active, Up: Map and Molecule Control [Contents][Index]
Where imol is an integer number
return the spacegroup as a string, return scheme false if unable to do so.
Next: symmetry-operators-scm, Previous: space-group-scm, Up: Map and Molecule Control [Contents][Index]
Where imol is an integer number
return the spacegroup of molecule number imol . Deprecated.
Returns: "No Spacegroup" when the spacegroup of a molecule has not been set.
Next: symmetry-operators-py, Previous: show-spacegroup, Up: Map and Molecule Control [Contents][Index]
Where imol is an integer number
return a list of symmetry operators as strings - or scheme false if that is not possible.
Previous: symmetry-operators-scm, Up: Map and Molecule Control [Contents][Index]
Where imol is an integer number
return a list of symmetry operators as strings - or Python False if that is not possible.
Next: Renumber Residue Range, Previous: Map and Molecule Control, Up: Scripting Functions [Contents][Index]
• align-and-mutate: | ||
• set-alignment-gap-and-space-penalty: | ||
• nearest-residue-by-sequence-scm: | ||
• nearest-residue-by-sequence-py: |
Next: set-alignment-gap-and-space-penalty, Up: Align and Mutate [Contents][Index]
Where:
align and mutate the given chain to the given sequence
Next: nearest-residue-by-sequence-scm, Previous: align-and-mutate, Up: Align and Mutate [Contents][Index]
Where:
set the penalty for affine gap and space when aligning, defaults -3.0 and -0.4
Next: nearest-residue-by-sequence-py, Previous: set-alignment-gap-and-space-penalty, Up: Align and Mutate [Contents][Index]
Where:
return the residue spec of the nearest residue by sequence numbering.
Returns: scheme false if not possible
Previous: nearest-residue-by-sequence-scm, Up: Align and Mutate [Contents][Index]
Where:
return the residue spec of the nearest residue by sequence numbering. Return Python False if not possible
Next: Scripting Interface, Previous: Align and Mutate, Up: Scripting Functions [Contents][Index]
• renumber-residue-range: | ||
• change-residue-number: |
Next: change-residue-number, Up: Renumber Residue Range [Contents][Index]
Where:
renumber the given residue range by offset residues
Previous: renumber-residue-range, Up: Renumber Residue Range [Contents][Index]
Where:
change chain id, residue number or insertion code for given residue
Next: Monomer, Previous: Renumber Residue Range, Up: Scripting Functions [Contents][Index]
• probe-available-p: | ||
• post-scripting-window: | ||
• post-scheme-scripting-window: | ||
• post-python-scripting-window: |
Next: post-scripting-window, Up: Scripting Interface [Contents][Index]
Can we run probe (was the executable variable set properly?) (predicate).
Returns: 1 for yes, 2 for no
Next: post-scheme-scripting-window, Previous: probe-available-p, Up: Scripting Interface [Contents][Index]
do nothing - compatibility function
Next: post-python-scripting-window, Previous: post-scripting-window, Up: Scripting Interface [Contents][Index]
pop-up a scripting window for scheming
Previous: post-scheme-scripting-window, Up: Scripting Interface [Contents][Index]
pop-up a scripting window for pythoning
Next: Regularization and Refinement, Previous: Scripting Interface, Up: Scripting Functions [Contents][Index]
Next: run-guile-script, Up: Monomer [Contents][Index]
Where filename is a string
run script file
Next: run-python-script, Previous: run-script, Up: Monomer [Contents][Index]
Where filename is a string
guile run script file
Next: import-python-module, Previous: run-guile-script, Up: Monomer [Contents][Index]
Where filename is a string
run python script file
Next: matching-compound-names-from-dictionary-scm, Previous: run-python-script, Up: Monomer [Contents][Index]
Where:
import python module
Next: comp-id-to-name-scm, Previous: import-python-module, Up: Monomer [Contents][Index]
Where:
return a list of compoundIDs in the dictionary of which the given string is a substring of the compound name
Next: auto-load-dictionary, Previous: matching-compound-names-from-dictionary-scm, Up: Monomer [Contents][Index]
Where comp_id is a string
return the monomer name
return scheme false if not found
Next: reload-dictionary, Previous: comp-id-to-name-scm, Up: Monomer [Contents][Index]
Where comp_id is a string
try to auto-load the dictionary for comp_id from the refmac monomer library.
return 0 on failure. return 1 on successful auto-load. return 2 on already-read.
Next: add-non-auto-load-residue-name, Previous: auto-load-dictionary, Up: Monomer [Contents][Index]
Where comp_id is a string
as above, but dictionary is cleared and re-read if it already exists
Next: remove-non-auto-load-residue-name, Previous: reload-dictionary, Up: Monomer [Contents][Index]
Where s is a string
add residue name to the list of residue names that don’t get auto-loaded from the Refmac dictionary.
Next: matching-compound-names-from-dictionary-py, Previous: add-non-auto-load-residue-name, Up: Monomer [Contents][Index]
Where s is a string
remove residue name from the list of residue names that don’t get auto-loaded from the Refmac dictionary.
Next: comp-id-to-name-py, Previous: remove-non-auto-load-residue-name, Up: Monomer [Contents][Index]
Where:
return a list of compoundIDs in the dictionary which the given string is a substring of the compound name
Previous: matching-compound-names-from-dictionary-py, Up: Monomer [Contents][Index]
Where comp_id is a string
return the monomer name
return python false if not found
Next: Simplex Refinement Interface, Previous: Monomer, Up: Scripting Functions [Contents][Index]
add a restraint on peptides to make them planar
This adds a 5 atom restraint that includes both CA atoms of the peptide. Use this rather than editting the mon_lib_list.cif file.
Next: make-tight-planar-peptide-restraints, Previous: add-planar-peptide-restraints, Up: Regularization and Refinement [Contents][Index]
remove restraints on peptides to make them planar.
Next: set-use-trans-peptide-restraints, Previous: remove-planar-peptide-restraints, Up: Regularization and Refinement [Contents][Index]
make the planar peptide restraints tight
Useful when refining models with cryo-EM maps
Next: add-omega-torsion-restriants, Previous: make-tight-planar-peptide-restraints, Up: Regularization and Refinement [Contents][Index]
Where on_off_state is an integer number
add a restraint on peptides to keep trans peptides trans
i.e. omega in trans-peptides is restraints to 180 degrees.
Next: remove-omega-torsion-restriants, Previous: set-use-trans-peptide-restraints, Up: Regularization and Refinement [Contents][Index]
add restraints on the omega angle of the peptides
(that is the torsion round the peptide bond). Omega angles that are closer to 0 than to 180 will be refined as cis peptides (and of course if omega is greater than 90 then the peptide will be refined as a trans peptide (this is the normal case).
Next: set-auto-h-bond-restraints, Previous: add-omega-torsion-restriants, Up: Regularization and Refinement [Contents][Index]
remove omega restraints on CIS and TRANS linked residues.
Next: set-refinement-immediate-replacement, Previous: remove-omega-torsion-restriants, Up: Regularization and Refinement [Contents][Index]
Where state is an integer number
add or remove auto H-bond restraints
Next: refinement-immediate-replacement-state, Previous: set-auto-h-bond-restraints, Up: Regularization and Refinement [Contents][Index]
Where istate is an integer number
set immediate replacement mode for refinement and regularization. You need this (call with istate=1) if you are scripting refinement/regularization
Next: set-residue-selection-flash-frames-number, Previous: set-refinement-immediate-replacement, Up: Regularization and Refinement [Contents][Index]
query the state of the immediate replacement mode
Next: accept-moving-atoms, Previous: refinement-immediate-replacement-state, Up: Regularization and Refinement [Contents][Index]
Where i is an integer number
set the number of frames for which the selected residue range flashes
On fast computers, this can be set to higher than the default for more aesthetic appeal.
Next: accept-regularizement, Previous: set-residue-selection-flash-frames-number, Up: Regularization and Refinement [Contents][Index]
accept the new positions of the regularized or refined residues
If you are scripting refinement and/or regularization, this is the function that you need to call after refine-zone or regularize-zone.
Next: refinement-already-ongoing-p, Previous: accept-moving-atoms, Up: Regularization and Refinement [Contents][Index]
a hideous alias for the above
Next: refine-residues-scm, Previous: accept-regularizement, Up: Regularization and Refinement [Contents][Index]
If there is a refinement on-going already, we don’t want to start a new one.
The is the means to ask if that is the case. This needs a scheme wrapper to provide refinement-already-ongoing? The question is translated to "are the intermediate atoms being displayed?" so that might be a more accurate function name than the current one.
Returns: 1 for yes, 0 for no.
Next: refine-residues-py, Previous: refinement-already-ongoing-p, Up: Regularization and Refinement [Contents][Index]
Where:
refine residues, r is a list of residue specs.
1 - an information string (in case of error)
2 - the progress variable (from GSL)
3 - refinement results for each particular geometry type (bonds, angles etc.)
Returns: refinement results, which consists of
Next: shiftfield-b-factor-refinement, Previous: refine-residues-scm, Up: Regularization and Refinement [Contents][Index]
Where:
refine the residues in the given residue spec list
Returns: the refinement summary statistics
Next: shiftfield-xyz-factor-refinement, Previous: refine-residues-py, Up: Regularization and Refinement [Contents][Index]
Where imol is an integer number
shiftfield B-factor refinement
Next: set-refine-with-torsion-restraints, Previous: shiftfield-b-factor-refinement, Up: Regularization and Refinement [Contents][Index]
Where imol is an integer number
shiftfield xyz refinement
Next: refine-with-torsion-restraints-state, Previous: shiftfield-xyz-factor-refinement, Up: Regularization and Refinement [Contents][Index]
Where istate is an integer number
turn on (or off) torsion restraints
Pass with istate=1 for on, istate=0 for off.
Next: set-matrix, Previous: set-refine-with-torsion-restraints, Up: Regularization and Refinement [Contents][Index]
return the state of above
Next: matrix-state, Previous: refine-with-torsion-restraints-state, Up: Regularization and Refinement [Contents][Index]
Where f is a number
set the relative weight of the geometric terms to the map terms
The default is 60.
The higher the number the more weight that is given to the map terms but the resulting chi squared values are higher). This will be needed for maps generated from data not on (or close to) the absolute scale or maps that have been scaled (for example so that the sigma level has been scaled to 1.0).
Next: get-map-weight, Previous: set-matrix, Up: Regularization and Refinement [Contents][Index]
return the relative weight of the geometric terms to the map terms.
Next: set-refine-auto-range-step, Previous: matrix-state, Up: Regularization and Refinement [Contents][Index]
return the relative weight of the geometric terms to the map terms.
A more sensible name for the
function)
Next: set-refine-max-residues, Previous: get-map-weight, Up: Regularization and Refinement [Contents][Index]
Where i is an integer number
change the +/- step for autoranging (default is 1)
Auto-ranging alow you to select a range from one button press, this allows you to set the number of residues either side of the clicked residue that becomes the selected zone
Next: refine-zone-atom-index-define, Previous: set-refine-auto-range-step, Up: Regularization and Refinement [Contents][Index]
Where n is an integer number
set the heuristic fencepost for the maximum number of residues in the refinement/regularization residue range
Default is 20
Next: refine-zone, Previous: set-refine-max-residues, Up: Regularization and Refinement [Contents][Index]
Where:
refine a zone based on atom indexing
Next: repeat-refine-zone, Previous: refine-zone-atom-index-define, Up: Regularization and Refinement [Contents][Index]
Where:
refine a zone
presumes that imol_Refinement_Map has been set
Next: refine-auto-range, Previous: refine-zone, Up: Regularization and Refinement [Contents][Index]
repeat the previous (user-selected) refine zone
Next: regularize-zone, Previous: repeat-refine-zone, Up: Regularization and Refinement [Contents][Index]
Where:
refine a zone using auto-range
presumes that imol_Refinement_Map has been set
Next: set-dragged-refinement-steps-per-frame, Previous: refine-auto-range, Up: Regularization and Refinement [Contents][Index]
Where:
regularize a zone
Returns: a status, whether the regularisation was done or not. 0 for no, 1 for yes.
Next: dragged-refinement-steps-per-frame, Previous: regularize-zone, Up: Regularization and Refinement [Contents][Index]
Where v is an integer number
set the number of refinement steps applied to the intermediate atoms each frame of graphics.
smaller numbers make the movement of the intermediate atoms slower, smoother, more elegant.
Default: 80.
Next: set-refinement-refine-per-frame, Previous: set-dragged-refinement-steps-per-frame, Up: Regularization and Refinement [Contents][Index]
return the number of steps per frame in dragged refinement
Next: refinement-refine-per-frame-state, Previous: dragged-refinement-steps-per-frame, Up: Regularization and Refinement [Contents][Index]
Where istate is an integer number
allow refinement of intermediate atoms after dragging, before displaying (default: 0, off).
An attempt to do something like xfit does, at the request of Frank von Delft.
Pass with istate=1 to enable this option.
Next: set-refinement-drag-elasticity, Previous: set-refinement-refine-per-frame, Up: Regularization and Refinement [Contents][Index]
query the state of the above option
Next: set-refine-ramachandran-angles, Previous: refinement-refine-per-frame-state, Up: Regularization and Refinement [Contents][Index]
Where e is a number
the elasticity of the dragged atom in refinement mode.
Default 0.33
Bigger numbers mean bigger movement of the other atoms.
Next: set-refine-ramachandran-restraints-type, Previous: set-refinement-drag-elasticity, Up: Regularization and Refinement [Contents][Index]
Where state is an integer number
turn on Ramachandran angles refinement in refinement and regularization
name consistent with
!?
Next: set-refine-ramachandran-restraints-weight, Previous: set-refine-ramachandran-angles, Up: Regularization and Refinement [Contents][Index]
Where type is an integer number
change the target function type
Next: set-fix-chiral-volumes-before-refinement, Previous: set-refine-ramachandran-restraints-type, Up: Regularization and Refinement [Contents][Index]
Where w is a number
change the target function weight
a big number means bad things
Next: check-chiral-volumes, Previous: set-refine-ramachandran-restraints-weight, Up: Regularization and Refinement [Contents][Index]
Where istate is an integer number
correct the sign of chiral volumes before commencing refinement?
Do we want to fix chiral volumes (by moving the chiral atom to the other side of the chiral plane if necessary). Default yes (1). Note: doesn’t work currently.
Next: set-show-chiral-volume-errors-dialog, Previous: set-fix-chiral-volumes-before-refinement, Up: Regularization and Refinement [Contents][Index]
Where imol is an integer number
query the state of the above option
Next: set-secondary-structure-restraints-type, Previous: check-chiral-volumes, Up: Regularization and Refinement [Contents][Index]
Where istate is an integer number
For experienced Cooters who don’t like Coot nannying about chiral volumes during refinement.
Next: secondary-structure-restraints-type, Previous: set-show-chiral-volume-errors-dialog, Up: Regularization and Refinement [Contents][Index]
Where itype is an integer number
set the type of secondary structure restraints
0 no sec str restraints
1 alpha helix restraints
2 beta strand restraints
Next: imol-refinement-map, Previous: set-secondary-structure-restraints-type, Up: Regularization and Refinement [Contents][Index]
return the secondary structure restraints type
Next: set-imol-refinement-map, Previous: secondary-structure-restraints-type, Up: Regularization and Refinement [Contents][Index]
the molecule number of the map used for refinement
Returns: the map number, if it has been set or there is only one map, return -1 on no map set (ambiguous) or no maps.
Next: does-residue-exist-p, Previous: imol-refinement-map, Up: Regularization and Refinement [Contents][Index]
Where imol is an integer number
set the molecule number of the map to be used for refinement/fitting.
Returns: imol on success, -1 on failure
Next: delete-restraints, Previous: set-imol-refinement-map, Up: Regularization and Refinement [Contents][Index]
Where:
Does the residue exist? (Raw function)
Returns: 0 on not-exist, 1 on does exist.
Next: add-extra-bond-restraint, Previous: does-residue-exist-p, Up: Regularization and Refinement [Contents][Index]
Where comp_id is a string
delete the restraints for the given comp_id (i.e. residue name)
Returns: success status (0 is failed, 1 is success)
Next: add-extra-geman-mcclure-restraint, Previous: delete-restraints, Up: Regularization and Refinement [Contents][Index]
Where:
add a user-define bond restraint
this extra restraint is used when the given atoms are selected in refinement or regularization.
Returns: the index of the new restraint.
Returns: -1 when the atoms were not found and no extra bond restraint was stored.
Next: delete-all-extra-restraints, Previous: add-extra-bond-restraint, Up: Regularization and Refinement [Contents][Index]
Where:
add a user-define GM distance restraint
this extra restraint is used when the given atoms are selected in refinement or regularization.
Returns: the index of the new restraint.
Returns: -1 when the atoms were not found and no extra bond restraint was stored.
Next: delete-extra-restraints-for-residue, Previous: add-extra-geman-mcclure-restraint, Up: Regularization and Refinement [Contents][Index]
Where imol is an integer number
clear out all the extra/user-defined restraints for molecule number imol
Next: set-extra-restraints-prosmart-sigma-limits, Previous: delete-all-extra-restraints, Up: Regularization and Refinement [Contents][Index]
Where:
clear out all the extra/user-defined restraints for this residue in molecule number imol
Next: generate-local-self-restraints, Previous: delete-extra-restraints-for-residue, Up: Regularization and Refinement [Contents][Index]
Where:
often we don’t want to see all prosmart restraints, just the (big) violations
Next: generate-self-restraints, Previous: set-extra-restraints-prosmart-sigma-limits, Up: Regularization and Refinement [Contents][Index]
Where:
generate external distance local self restraints
Next: generate-local-self-restraints-by-residues-scm, Previous: generate-local-self-restraints, Up: Regularization and Refinement [Contents][Index]
Where:
generate external distance all-molecule self restraints
Next: write-interpolated-extra-restraints, Previous: generate-self-restraints, Up: Regularization and Refinement [Contents][Index]
Where:
generate external distance self restraints for selected residues
Next: write-interpolated-models-and-extra-restraints, Previous: generate-local-self-restraints-by-residues-scm, Up: Regularization and Refinement [Contents][Index]
Where:
proSMART interpolated restraints for model morphing
Next: set-use-only-extra-torsion-restraints-for-torsions, Previous: write-interpolated-extra-restraints, Up: Regularization and Refinement [Contents][Index]
Where:
proSMART interpolated restraints for model morphing and write interpolated model
interpolation_mode is currently dummy - in due course I will addd torion angle interpolation.
Next: use-only-extra-torsion-restraints-for-torsions-state, Previous: write-interpolated-models-and-extra-restraints, Up: Regularization and Refinement [Contents][Index]
Where state is an integer number
set use only extra torsion restraints for torsions
Next: show-restraints-editor, Previous: set-use-only-extra-torsion-restraints-for-torsions, Up: Regularization and Refinement [Contents][Index]
return only-use-extra-torsion-restraints-for-torsions state
Next: show-restraints-editor-by-index, Previous: use-only-extra-torsion-restraints-for-torsions-state, Up: Regularization and Refinement [Contents][Index]
Where monomer_type is a string
show restraints editor
Next: write-restraints-cif-dictionary, Previous: show-restraints-editor, Up: Regularization and Refinement [Contents][Index]
Where menu_item_index is an integer number
show restraints editor using residue type index
Previous: show-restraints-editor-by-index, Up: Regularization and Refinement [Contents][Index]
Where:
write cif restraints for monomer
Next: Nomenclature Errors, Previous: Regularization and Refinement, Up: Scripting Functions [Contents][Index]
• fit-residue-range-to-map-by-simplex: | ||
• score-residue-range-fit-to-map: |
Where:
refine residue range using simplex optimization
Previous: fit-residue-range-to-map-by-simplex, Up: Simplex Refinement Interface [Contents][Index]
Where:
simply score the residue range fit to map
Next: Atom Info Interface, Previous: Simplex Refinement Interface, Up: Scripting Functions [Contents][Index]
• fix-nomenclature-errors: | ||
• set-nomenclature-errors-on-read: |
Next: set-nomenclature-errors-on-read, Up: Nomenclature Errors [Contents][Index]
Where imol is an integer number
fix nomenclature errors in molecule number imol
Returns: the number of resides altered.
Previous: fix-nomenclature-errors, Up: Nomenclature Errors [Contents][Index]
Where mode is a string
set way nomenclature errors should be handled on reading coordinates.
mode should be "auto-correct", "ignore", "prompt". The default is "prompt"
Next: Residue Info, Previous: Nomenclature Errors, Up: Scripting Functions [Contents][Index]
• output-atom-info-as-text: |
Up: Atom Info Interface [Contents][Index]
Where:
output to the terminal the Atom Info for the give atom specs
Next: Residue Environment Functions, Previous: Atom Info Interface, Up: Scripting Functions [Contents][Index]
• residue-info-dialog: |
Up: Residue Info [Contents][Index]
Where:
show residue info dialog for given residue
Next: Pointer Position Function, Previous: Residue Info, Up: Scripting Functions [Contents][Index]
Where state is an integer number
show environment distances. If state is 0, distances are turned off, otherwise distances are turned on.
Next: set-show-environment-distances-h-bonds, Previous: set-show-environment-distances, Up: Residue Environment Functions [Contents][Index]
Where state is an integer number
show bumps environment distances. If state is 0, bump distances are turned off, otherwise bump distances are turned on.
Next: show-environment-distances-state, Previous: set-show-environment-distances-bumps, Up: Residue Environment Functions [Contents][Index]
Where state is an integer number
show H-bond environment distances. If state is 0, bump distances are turned off, otherwise H-bond distances are turned on.
Next: set-environment-distances-distance-limits, Previous: set-show-environment-distances-h-bonds, Up: Residue Environment Functions [Contents][Index]
show the state of display of the environment distances
Next: set-show-environment-distances-as-solid, Previous: show-environment-distances-state, Up: Residue Environment Functions [Contents][Index]
Where:
min and max distances for the environment distances
Next: set-environment-distances-label-atom, Previous: set-environment-distances-distance-limits, Up: Residue Environment Functions [Contents][Index]
Where state is an integer number
show the environment distances with solid modelling
Next: label-neighbours, Previous: set-show-environment-distances-as-solid, Up: Residue Environment Functions [Contents][Index]
Where state is an integer number
Label the atom on Environment Distances start/change.
Next: label-atoms-in-residue, Previous: set-environment-distances-label-atom, Up: Residue Environment Functions [Contents][Index]
Label the atoms in the residues around the central residue.
Next: add-geometry-distance, Previous: label-neighbours, Up: Residue Environment Functions [Contents][Index]
Label the atoms in the central residue.
Previous: label-atoms-in-residue, Up: Residue Environment Functions [Contents][Index]
Where:
Add a geometry distance between points in a given molecule.
Returns: the distance between the points
Next: Pointer Functions, Previous: Residue Environment Functions, Up: Scripting Functions [Contents][Index]
• get-pointer-position-frac-py: |
return the [x,y] position of the pointer in fractional coordinates.
the origin is top-left. may return false if pointer is not available
Next: Zoom Functions, Previous: Pointer Position Function, Up: Scripting Functions [Contents][Index]
• set-show-pointer-distances: | ||
• show-pointer-distances-state: |
Next: show-pointer-distances-state, Up: Pointer Functions [Contents][Index]
Where istate is an integer number
turn on (or off) the pointer distance by passing 1 (or 0).
Previous: set-show-pointer-distances, Up: Pointer Functions [Contents][Index]
show the state of display of the pointer distances
Next: CNS Data Functions, Previous: Pointer Functions, Up: Scripting Functions [Contents][Index]
• scale-zoom: | ||
• zoom-factor: | ||
• set-smooth-scroll-do-zoom: | ||
• smooth-scroll-do-zoom: |
Next: zoom-factor, Up: Zoom Functions [Contents][Index]
Where f is a number
scale the view by f
external (scripting) interface (with redraw)
Next: set-smooth-scroll-do-zoom, Previous: scale-zoom, Up: Zoom Functions [Contents][Index]
return the current zoom factor
Next: smooth-scroll-do-zoom, Previous: zoom-factor, Up: Zoom Functions [Contents][Index]
Where i is an integer number
set smooth scroll with zoom
Previous: set-smooth-scroll-do-zoom, Up: Zoom Functions [Contents][Index]
return the state of the above system
Next: mmCIF Functions, Previous: Zoom Functions, Up: Scripting Functions [Contents][Index]
• handle-cns-data-file: | ||
• handle-cns-data-file-with-cell: |
Next: handle-cns-data-file-with-cell, Up: CNS Data Functions [Contents][Index]
Where:
read CNS data (currently only a placeholder)
Previous: handle-cns-data-file, Up: CNS Data Functions [Contents][Index]
Where:
read CNS data (currently only a placeholder)
a, b,c are in Angstroems. alpha, beta, gamma are in degrees. spg is the space group info, either ;-delimited symmetry operators or the space group name
Next: SHELXL Functions, Previous: CNS Data Functions, Up: Scripting Functions [Contents][Index]
• open-cif-dictionary-file-selector-dialog: | ||
• non-standard-residue-names-scm: | ||
• non-standard-residue-names-py: |
Next: non-standard-residue-names-scm, Up: mmCIF Functions [Contents][Index]
open the cif dictionary file selector dialog
Next: non-standard-residue-names-py, Previous: open-cif-dictionary-file-selector-dialog, Up: mmCIF Functions [Contents][Index]
Where imol is an integer number
non-standard residue/monomer names (note HOH is not non-standard).
Previous: non-standard-residue-names-scm, Up: mmCIF Functions [Contents][Index]
Where imol is an integer number
non-standard residue/monomer names (note HOH is not non-standard).
Next: Validation Functions, Previous: mmCIF Functions, Up: Scripting Functions [Contents][Index]
• read-shelx-ins-file: | ||
• write-shelx-ins-file: |
Next: write-shelx-ins-file, Up: SHELXL Functions [Contents][Index]
Where:
read a SHELXL .ins file
Previous: read-shelx-ins-file, Up: SHELXL Functions [Contents][Index]
Where:
write a SHELXL .ins file for molecule number imol
Next: Ramachandran Plot Functions, Previous: SHELXL Functions, Up: Scripting Functions [Contents][Index]
• difference-map-peaks: | ||
• gln-asn-b-factor-outliers: | ||
• map-peaks-py: | ||
• map-peaks-scm: | ||
• set-torsion-scm: | ||
• multi-residue-torsion-scm: | ||
• set-torsion-py: | ||
• multi-residue-torsion-py: |
Next: gln-asn-b-factor-outliers, Up: Validation Functions [Contents][Index]
Where:
generate a list of difference map peaks
peaks within max_closeness (2.0 A typically) of a larger peak are not listed.
Next: map-peaks-py, Previous: difference-map-peaks, Up: Validation Functions [Contents][Index]
Where imol is an integer number
Make a gui for GLN adn ASN B-factor outiers, compairing the O and N temperatur factors difference to the distribution of temperature factors from the other atoms.
Next: map-peaks-scm, Previous: gln-asn-b-factor-outliers, Up: Validation Functions [Contents][Index]
Where:
return a list of map peaks of molecule number imol_map above n_sigma. There will be cluster filtering of the map peaks. Return a list of 3d cartestian coordinates or Python False if imol_map is not suitable for peak picking.
Next: set-torsion-scm, Previous: map-peaks-py, Up: Validation Functions [Contents][Index]
Where:
return a list of map peaks of molecule number imol_map above n_sigma. There will be cluster filtering of the map peaks. Return a list of 3d cartestian coordinates or scheme false if imol_map is not suitable for peak picking.
Next: multi-residue-torsion-scm, Previous: map-peaks-scm, Up: Validation Functions [Contents][Index]
Where:
set the given torsion the given residue. tors is in degrees. Return the resulting torsion (also in degrees).
Next: set-torsion-py, Previous: set-torsion-scm, Up: Validation Functions [Contents][Index]
Where:
create a multi-residue torsion dialog (user manipulation of torsions)
Next: multi-residue-torsion-py, Previous: multi-residue-torsion-scm, Up: Validation Functions [Contents][Index]
Where:
set the given torsion the given residue. tors is in degrees. Return the resulting torsion (also in degrees).
Previous: set-torsion-py, Up: Validation Functions [Contents][Index]
Where:
create a multi-residue torsion dialog (user manipulation of torsions)
Next: Sequence View Interface, Previous: Validation Functions, Up: Scripting Functions [Contents][Index]
Next: set-kleywegt-plot-n-diffs, Up: Ramachandran Plot Functions [Contents][Index]
Where imol is an integer number
Ramachandran plot for molecule number imol.
Next: set-ramachandran-plot-contour-levels, Previous: do-ramachandran-plot, Up: Ramachandran Plot Functions [Contents][Index]
Where n_diffs is an integer number
set the number of biggest difference arrows on the Kleywegt plot.
Next: set-ramachandran-plot-background-block-size, Previous: set-kleywegt-plot-n-diffs, Up: Ramachandran Plot Functions [Contents][Index]
Where:
set the contour levels for the ramachandran plot, default values are 0.02 (prefered) 0.002 (allowed)
Next: set-ramachandran-psi-axis-mode, Previous: set-ramachandran-plot-contour-levels, Up: Ramachandran Plot Functions [Contents][Index]
Where blocksize is a number
set the ramachandran plot background block size.
Smaller is smoother but slower. Should be divisible exactly into
Next: ramachandran-plot-differences, Previous: set-ramachandran-plot-background-block-size, Up: Ramachandran Plot Functions [Contents][Index]
Where mode is an integer number
set the psi axis for the ramachandran plot. Default (0) from -180 to 180. Alternative (1) from -120 to 240.
Next: ramachandran-plot-differences-by-chain, Previous: set-ramachandran-psi-axis-mode, Up: Ramachandran Plot Functions [Contents][Index]
Where:
2 molecule ramachandran plot (NCS differences) a.k.a. A Kleywegt Plot.
Previous: ramachandran-plot-differences, Up: Ramachandran Plot Functions [Contents][Index]
Where:
A chain-specific Kleywegt Plot.
Next: Atom Labelling, Previous: Ramachandran Plot Functions, Up: Scripting Functions [Contents][Index]
• do-sequence-view: |
Up: Sequence View Interface [Contents][Index]
Where imol is an integer number
display the sequence view dialog for molecule number imol
Next: Screen Rotation, Previous: Sequence View Interface, Up: Scripting Functions [Contents][Index]
• set-brief-atom-labels: | ||
• brief-atom-labels-state: | ||
• set-seg-ids-in-atom-labels: |
Next: brief-atom-labels-state, Up: Atom Labelling [Contents][Index]
Where istat is an integer number
use brief atom names for on-screen labels
call with istat=1 to use brief labels, istat=0 for normal labels
Next: set-seg-ids-in-atom-labels, Previous: set-brief-atom-labels, Up: Atom Labelling [Contents][Index]
the brief atom label state
Previous: brief-atom-labels-state, Up: Atom Labelling [Contents][Index]
Where istat is an integer number
set if brief atom labels should have seg-ids also
Next: Screen Translation, Previous: Atom Labelling, Up: Scripting Functions [Contents][Index]
• rotate-y-scene: | ||
• rotate-x-scene: | ||
• rotate-z-scene: | ||
• spin-zoom-trans: |
Next: rotate-x-scene, Up: Screen Rotation [Contents][Index]
Where:
rotate view round y axis stepsize degrees for nstep such steps
Next: rotate-z-scene, Previous: rotate-y-scene, Up: Screen Rotation [Contents][Index]
Where:
rotate view round x axis stepsize degrees for nstep such steps
Next: spin-zoom-trans, Previous: rotate-x-scene, Up: Screen Rotation [Contents][Index]
Where:
rotate view round z axis stepsize degrees for nstep such steps
Previous: rotate-z-scene, Up: Screen Rotation [Contents][Index]
Where:
Bells and whistles rotation.
spin, zoom and translate.
where axis is either x,y or z, stepsize is in degrees, zoom_by and x_rel etc are how much zoom, x,y,z should have changed by after nstep steps.
Next: Views Interface, Previous: Screen Rotation, Up: Scripting Functions [Contents][Index]
• translate-scene-x: | ||
• translate-scene-y: | ||
• translate-scene-z: |
Next: translate-scene-y, Up: Screen Translation [Contents][Index]
Where nsteps is an integer number
translate rotation centre relative to screen axes for nsteps
Next: translate-scene-z, Previous: translate-scene-x, Up: Screen Translation [Contents][Index]
Where nsteps is an integer number
translate rotation centre relative to screen axes for nsteps
Previous: translate-scene-y, Up: Screen Translation [Contents][Index]
Where nsteps is an integer number
translate rotation centre relative to screen axes for nsteps
Next: Background Colour, Previous: Screen Translation, Up: Scripting Functions [Contents][Index]
• add-view-here: | ||
• add-view-raw: | ||
• remove-named-view: | ||
• remove-view: | ||
• add-view-description: | ||
• add-action-view: | ||
• insert-action-view-after-view: | ||
• save-views: | ||
• view-name: | ||
• view-name-py: | ||
• clear-all-views: |
Next: add-view-raw, Up: Views Interface [Contents][Index]
Where view_name is a string
return the view number
Next: remove-named-view, Previous: add-view-here, Up: Views Interface [Contents][Index]
Where:
return the view number
Next: remove-view, Previous: add-view-raw, Up: Views Interface [Contents][Index]
Where view_name is a string
the view with the given name
Next: add-view-description, Previous: remove-named-view, Up: Views Interface [Contents][Index]
Where view_number is an integer number
the given view number
Next: add-action-view, Previous: remove-view, Up: Views Interface [Contents][Index]
Where:
Add a view description/annotation to the give view number.
Next: insert-action-view-after-view, Previous: add-view-description, Up: Views Interface [Contents][Index]
Where:
add a view (not add to an existing view) that does something (e.g. displays or undisplays a molecule) rather than move the graphics.
Returns: the view number for this (new) view.
Next: save-views, Previous: add-action-view, Up: Views Interface [Contents][Index]
Where:
add an action view after the view of the given view number
Returns: the view number for this (new) view.
Next: view-name, Previous: insert-action-view-after-view, Up: Views Interface [Contents][Index]
Where view_file_name is a string
save views to view_file_name
Next: view-name-py, Previous: save-views, Up: Views Interface [Contents][Index]
Where view_number is an integer number
return the name of the given view, if view_number does not specify a view return scheme value False
Next: clear-all-views, Previous: view-name, Up: Views Interface [Contents][Index]
Where view_number is an integer number
return the name of the given view, if view_number does not specify a view return Python value False
Previous: view-name-py, Up: Views Interface [Contents][Index]
Clear the view list.
Next: Ligand Fitting Functions, Previous: Views Interface, Up: Scripting Functions [Contents][Index]
• set-background-colour: | ||
• redraw-background: | ||
• background-is-black-p: |
Next: redraw-background, Up: Background Colour [Contents][Index]
Where:
set the background colour
red, green and blue are numbers between 0.0 and 1.0
Next: background-is-black-p, Previous: set-background-colour, Up: Background Colour [Contents][Index]
re draw the background colour when switching between mono and stereo
Previous: redraw-background, Up: Background Colour [Contents][Index]
is the background black (or nearly black)?
Returns: 1 if the background is black (or nearly black), else return 0.
Next: Water Fitting Functions, Previous: Background Colour, Up: Scripting Functions [Contents][Index]
Next: set-ligand-cluster-sigma-level, Up: Ligand Fitting Functions [Contents][Index]
Where f is a number
set the fraction of atoms which must be in positive density after a ligand fit
Next: set-ligand-flexible-ligand-n-samples, Previous: set-ligand-acceptable-fit-fraction, Up: Ligand Fitting Functions [Contents][Index]
Where f is a number
set the default sigma level that the map is searched to find potential ligand sites
Next: set-find-ligand-n-top-ligands, Previous: set-ligand-cluster-sigma-level, Up: Ligand Fitting Functions [Contents][Index]
Where i is an integer number
set the number of conformation samples
big ligands require more samples. Default 10.
Next: set-find-ligand-multi-solutions-per-cluster, Previous: set-ligand-flexible-ligand-n-samples, Up: Ligand Fitting Functions [Contents][Index]
Where n is an integer number
search the top n sites for ligands.
Default 10.
Next: set-find-ligand-mask-waters, Previous: set-find-ligand-n-top-ligands, Up: Ligand Fitting Functions [Contents][Index]
Where:
allow multiple ligand solutions per cluster.
The first limit is the fraction of the top scored positions that go on to correlation scoring (closer to 1 means less and faster - default 0.7).
The second limit is the fraction of the top correlation score that is considered interesting. Limits the number of solutions displayed to user. Default 0.9.
There is currently no chi-angle set redundancy filtering - I suspect that there should be.
Nino-mode.
Next: set-ligand-search-protein-molecule, Previous: set-find-ligand-multi-solutions-per-cluster, Up: Ligand Fitting Functions [Contents][Index]
Where istate is an integer number
how shall we treat the waters during ligand fitting?
pass with istate=1 for waters to mask the map in the same way that protein atoms do.
Next: set-ligand-search-map-molecule, Previous: set-find-ligand-mask-waters, Up: Ligand Fitting Functions [Contents][Index]
Where imol is an integer number
set the protein molecule for ligand searching
Next: add-ligand-search-ligand-molecule, Previous: set-ligand-search-protein-molecule, Up: Ligand Fitting Functions [Contents][Index]
Where imol_map is an integer number
set the map molecule for ligand searching
Next: add-ligand-search-wiggly-ligand-molecule, Previous: set-ligand-search-map-molecule, Up: Ligand Fitting Functions [Contents][Index]
Where imol_ligand is an integer number
add a rigid ligand molecule to the list of ligands to search for in ligand searching
Next: set-find-ligand-here-cluster, Previous: add-ligand-search-ligand-molecule, Up: Ligand Fitting Functions [Contents][Index]
Where imol_ligand is an integer number
add a flexible ligand molecule to the list of ligands to search for in ligand searching
Next: ligand-expert, Previous: add-ligand-search-wiggly-ligand-molecule, Up: Ligand Fitting Functions [Contents][Index]
Where state is an integer number
Allow the user a scripting means to find ligand at the rotation centre.
Next: do-find-ligands-dialog, Previous: set-find-ligand-here-cluster, Up: Ligand Fitting Functions [Contents][Index]
this sets the flag to have expert option ligand entries in the Ligand Searching dialog
Next: overlap-ligands, Previous: ligand-expert, Up: Ligand Fitting Functions [Contents][Index]
display the find ligands dialog
if maps, coords and ligands are available, that is.
Next: match-ligand-atom-names, Previous: do-find-ligands-dialog, Up: Ligand Fitting Functions [Contents][Index]
Where:
Overlap residue with "template"-based matching.
Overlap the first residue in imol_ligand onto the residue specified by the reference parameters. Use graph matching, not atom names.
Returns: success status, False = failed to find residue in either imol_ligand or imo_ref. If success, return the RT operator.
Next: match-ligand-atom-names-to-comp-id, Previous: overlap-ligands, Up: Ligand Fitting Functions [Contents][Index]
Where:
Match ligand atom names.
By using graph matching, make the names of the atoms of the given ligand/residue match those of the reference residue/ligand as closely as possible - where there would be an atom name clash, invent a new atom name.
Next: flip-ligand, Previous: match-ligand-atom-names, Up: Ligand Fitting Functions [Contents][Index]
Where:
Match ligand atom names to a reference ligand type (comp_id)
By using graph matching, make the names of the atoms of the given ligand/residue match those of the reference ligand from the geometry store as closely as possible. Where there would be an atom name clash, invent a new atom name.
This doesn’t create a new dictionary for the selected ligand - and that’s a big problem (see match_residue_and_dictionary).
Previous: match-ligand-atom-names-to-comp-id, Up: Ligand Fitting Functions [Contents][Index]
Where:
flip the ligand (usually active residue) around its eigen vectors to the next flip number. Immediate replacement (like flip peptide).
Next: Bond Representation, Previous: Ligand Fitting Functions, Up: Scripting Functions [Contents][Index]
Next: renumber-waters, Up: Water Fitting Functions [Contents][Index]
create a dialog for water fitting
Next: execute-find-waters-real, Previous: wrapped-create-find-waters-dialog, Up: Water Fitting Functions [Contents][Index]
Where imol is an integer number
Renumber the waters of molecule number imol with consecutive numbering.
Next: move-waters-to-around-protein, Previous: renumber-waters, Up: Water Fitting Functions [Contents][Index]
Where:
find waters
Next: move-hetgroups-to-around-protein, Previous: execute-find-waters-real, Up: Water Fitting Functions [Contents][Index]
Where imol is an integer number
move waters of molecule number imol so that they are around the protein.
Returns: the number of moved waters.
Next: max-water-distance, Previous: move-waters-to-around-protein, Up: Water Fitting Functions [Contents][Index]
Where imol is an integer number
move all hetgroups (including waters) of molecule number imol so that they are around the protein.
Next: set-water-check-spherical-variance-limit, Previous: move-hetgroups-to-around-protein, Up: Water Fitting Functions [Contents][Index]
Where imol is an integer number
return the maximum minimum distance of any water atom to any protein atom - used in validation of move_waters_to_around_protein() funtion.
Next: set-ligand-water-to-protein-distance-limits, Previous: max-water-distance, Up: Water Fitting Functions [Contents][Index]
Where f is a number
set the limit of interesting variance, above which waters are listed (otherwise ignored)
default 0.12.
Next: set-ligand-water-n-cycles, Previous: set-water-check-spherical-variance-limit, Up: Water Fitting Functions [Contents][Index]
Where:
set ligand to protein distance limits
f1 is the minimum distance, f2 is the maximum distance
Next: execute-find-blobs, Previous: set-ligand-water-to-protein-distance-limits, Up: Water Fitting Functions [Contents][Index]
Where i is an integer number
set the number of cycles of water searching
Next: split-water, Previous: set-ligand-water-n-cycles, Up: Water Fitting Functions [Contents][Index]
Where:
find blobs
Previous: execute-find-blobs, Up: Water Fitting Functions [Contents][Index]
Where:
split the given water and fit to map.
If refinement map is not defined, don’t do anything.
If there is more than one atom in the specified resiue, don’t do anything.
If the given atom does not have an alt conf of "", don’t do anything.
Next: Dots Representation, Previous: Water Fitting Functions, Up: Scripting Functions [Contents][Index]
Next: set-bond-thickness, Up: Bond Representation [Contents][Index]
Where t is an integer number
set the default thickness for bonds (e.g. in ~/.coot)
Next: set-bond-thickness-intermediate-atoms, Previous: set-default-bond-thickness, Up: Bond Representation [Contents][Index]
Where:
set the thickness of the bonds in molecule number imol to t pixels
Next: set-use-variable-bond-thickness, Previous: set-bond-thickness, Up: Bond Representation [Contents][Index]
Where t is a number
set the thickness of the bonds of the intermediate atoms to t pixels
Next: set-bond-colour-rotation-for-molecule, Previous: set-bond-thickness-intermediate-atoms, Up: Bond Representation [Contents][Index]
Where state is an integer number
allow lines that are further away to be thinner
Next: set-draw-stick-mode-atoms-default, Previous: set-use-variable-bond-thickness, Up: Bond Representation [Contents][Index]
Where:
set bond colour for molecule
Next: get-bond-colour-rotation-for-molecule, Previous: set-bond-colour-rotation-for-molecule, Up: Bond Representation [Contents][Index]
Where state is an integer number
set default for the drawing of atoms in stick mode (default is on (1))
Next: set-default-representation-type, Previous: set-draw-stick-mode-atoms-default, Up: Bond Representation [Contents][Index]
Where imol is an integer number
get the bond colour for molecule.
Return -1 on err (bad molecule number)
Next: get-default-bond-thickness, Previous: get-bond-colour-rotation-for-molecule, Up: Bond Representation [Contents][Index]
Where type is an integer number
set the default representation type (default 1).
Next: set-draw-zero-occ-markers, Previous: set-default-representation-type, Up: Bond Representation [Contents][Index]
get the default thickness for bonds
Next: set-draw-cis-peptide-markups, Previous: get-default-bond-thickness, Up: Bond Representation [Contents][Index]
Where status is an integer number
set status of drawing zero occupancy markers.
default status is 1.
Next: set-draw-hydrogens, Previous: set-draw-zero-occ-markers, Up: Bond Representation [Contents][Index]
Where status is an integer number
set status of drawing cis-peptide markups
default status is 1.
Next: draw-hydrogens-state, Previous: set-draw-cis-peptide-markups, Up: Bond Representation [Contents][Index]
Where:
set the hydrogen drawing state. istat = 0 is hydrogens off, istat = 1: show hydrogens
Next: set-draw-stick-mode-atoms, Previous: set-draw-hydrogens, Up: Bond Representation [Contents][Index]
Where imol is an integer number
the state of draw hydrogens for molecule number imol.
return -1 on bad imol.
Next: set-draw-missing-residues-loops, Previous: draw-hydrogens-state, Up: Bond Representation [Contents][Index]
Where:
draw little coloured balls on atoms
turn off with state = 0
turn on with state = 1
Next: graphics-to-ca-representation, Previous: set-draw-stick-mode-atoms, Up: Bond Representation [Contents][Index]
Where state is an integer number
set the state for drawing missing resiude loops
For taking screenshots, we often don’t want to see them.
Next: graphics-to-ca-plus-ligands-representation, Previous: set-draw-missing-residues-loops, Up: Bond Representation [Contents][Index]
Where imol is an integer number
draw molecule number imol as CAs
Next: graphics-to-ca-plus-ligands-and-sidechains-representation, Previous: graphics-to-ca-representation, Up: Bond Representation [Contents][Index]
Where imol is an integer number
draw molecule number imol as CA + ligands
Next: graphics-to-bonds-no-waters-representation, Previous: graphics-to-ca-plus-ligands-representation, Up: Bond Representation [Contents][Index]
Where imol is an integer number
draw molecule number imol as CA + ligands + sidechains
Next: graphics-to-bonds-representation, Previous: graphics-to-ca-plus-ligands-and-sidechains-representation, Up: Bond Representation [Contents][Index]
Where imol is an integer number
draw molecule number imol with no waters
Next: graphics-to-ca-plus-ligands-sec-struct-representation, Previous: graphics-to-bonds-no-waters-representation, Up: Bond Representation [Contents][Index]
Where mol is an integer number
draw molecule number imol with normal bonds
Next: graphics-to-sec-struct-bonds-representation, Previous: graphics-to-bonds-representation, Up: Bond Representation [Contents][Index]
Where imol is an integer number
draw molecule number imol with CA bonds in secondary structure representation and ligands
Next: graphics-to-rainbow-representation, Previous: graphics-to-ca-plus-ligands-sec-struct-representation, Up: Bond Representation [Contents][Index]
Where imol is an integer number
draw molecule number imol with bonds in secondary structure representation
Next: graphics-to-b-factor-representation, Previous: graphics-to-sec-struct-bonds-representation, Up: Bond Representation [Contents][Index]
Where imol is an integer number
draw molecule number imol in Jones’ Rainbow
Next: graphics-to-b-factor-cas-representation, Previous: graphics-to-rainbow-representation, Up: Bond Representation [Contents][Index]
Where imol is an integer number
draw molecule number imol coloured by B-factor
Next: graphics-to-occupancy-representation, Previous: graphics-to-b-factor-representation, Up: Bond Representation [Contents][Index]
Where imol is an integer number
draw molecule number imol coloured by B-factor, CA + ligands
Next: graphics-to-user-defined-atom-colours-representation, Previous: graphics-to-b-factor-cas-representation, Up: Bond Representation [Contents][Index]
Where imol is an integer number
draw molecule number imol coloured by occupancy
Next: graphics-to-user-defined-atom-colours-all-atoms-representation, Previous: graphics-to-occupancy-representation, Up: Bond Representation [Contents][Index]
Where imol is an integer number
draw molecule number imol in CA+Ligands mode coloured by user-defined atom colours
Next: graphics-molecule-bond-type, Previous: graphics-to-user-defined-atom-colours-representation, Up: Bond Representation [Contents][Index]
Where imol is an integer number
draw molecule number imol all atoms coloured by user-defined atom colours
Next: set-b-factor-bonds-scale-factor, Previous: graphics-to-user-defined-atom-colours-all-atoms-representation, Up: Bond Representation [Contents][Index]
Where imol is an integer number
what is the bond drawing state of molecule number imol
Next: change-model-molecule-representation-mode, Previous: graphics-molecule-bond-type, Up: Bond Representation [Contents][Index]
Where:
scale the colours for colour by b factor representation
Next: set-use-grey-carbons-for-molecule, Previous: set-b-factor-bonds-scale-factor, Up: Bond Representation [Contents][Index]
Where up_or_down is an integer number
change the representation of the model molecule closest to the centre of the screen
Next: set-grey-carbon-colour, Previous: change-model-molecule-representation-mode, Up: Bond Representation [Contents][Index]
Where:
make the carbon atoms for molecule imol be grey
Next: make-ball-and-stick, Previous: set-use-grey-carbons-for-molecule, Up: Bond Representation [Contents][Index]
Where:
set the colour for the carbon atoms
can be not grey if you desire, r, g, b in the range 0 to 1.
Next: clear-ball-and-stick, Previous: set-grey-carbon-colour, Up: Bond Representation [Contents][Index]
Where:
make a ball and stick representation of imol given atom selection
e.g. (make-ball-and-stick 0 "/1" 0.15 0.25 1)
Next: additional-representation-by-string, Previous: make-ball-and-stick, Up: Bond Representation [Contents][Index]
Where imol is an integer number
clear ball and stick representation of molecule number imol
Next: additional-representation-by-attributes, Previous: clear-ball-and-stick, Up: Bond Representation [Contents][Index]
Where:
return the index of the additional representation. Return -1 on error
Previous: additional-representation-by-string, Up: Bond Representation [Contents][Index]
Where:
return the index of the additional representation.
Returns: -1 on error.
Next: Pep-flip Interface, Previous: Bond Representation, Up: Scripting Functions [Contents][Index]
• dots: | ||
• set-dots-colour: | ||
• unset-dots-colour: | ||
• clear-dots: | ||
• clear-dots-by-name: | ||
• n-dots-sets: |
Next: set-dots-colour, Up: Dots Representation [Contents][Index]
Where:
display dotted surface
return a generic objects handle (which can be used to remove later)
Next: unset-dots-colour, Previous: dots, Up: Dots Representation [Contents][Index]
Where:
set the colour of the surface dots of the imol-th molecule to be the given single colour
r,g,b are values between 0.0 and 1.0
Next: clear-dots, Previous: set-dots-colour, Up: Dots Representation [Contents][Index]
Where imol is an integer number
no longer set the dots of molecule imol to a single colour
i.e. go back to element-based colours.
Next: clear-dots-by-name, Previous: unset-dots-colour, Up: Dots Representation [Contents][Index]
Where:
clear dots in imol with dots_handle
Next: n-dots-sets, Previous: clear-dots, Up: Dots Representation [Contents][Index]
Where:
clear the first dots object for imol with given name
Previous: clear-dots-by-name, Up: Dots Representation [Contents][Index]
Where imol is an integer number
return the number of dots sets for molecule number imol
Next: Rigid Body Refinement Interface, Previous: Dots Representation, Up: Scripting Functions [Contents][Index]
• pepflip: |
Up: Pep-flip Interface [Contents][Index]
Where:
pepflip the given residue
Next: Add Terminal Residue Functions, Previous: Pep-flip Interface, Up: Scripting Functions [Contents][Index]
• rigid-body-refine-zone: | ||
• rigid-body-refine-by-residue-ranges-scm: | ||
• rigid-body-refine-by-residue-ranges-py: | ||
• set-rigid-body-fit-acceptable-fit-fraction: |
Next: rigid-body-refine-by-residue-ranges-scm, Up: Rigid Body Refinement Interface [Contents][Index]
Where:
setup rigid body refine zone
where we set the atom selection holders according to the arguments and then call execute_rigid_body_refine()
Next: rigid-body-refine-by-residue-ranges-py, Previous: rigid-body-refine-zone, Up: Rigid Body Refinement Interface [Contents][Index]
Where:
rigid body refine using residue ranges. residue_ranges is a list of residue ranges. A residue range is (list chain-id resno-start resno-end).
Next: set-rigid-body-fit-acceptable-fit-fraction, Previous: rigid-body-refine-by-residue-ranges-scm, Up: Rigid Body Refinement Interface [Contents][Index]
Where:
rigid body refine using residue ranges. residue_ranges is a list of residue ranges. A residue range is [chain_id, resno_start, resno_end].
Previous: rigid-body-refine-by-residue-ranges-py, Up: Rigid Body Refinement Interface [Contents][Index]
Where f is a number
set rigid body fraction of atoms in positive density
Next: Delete Residues, Previous: Rigid Body Refinement Interface, Up: Scripting Functions [Contents][Index]
Next: add-terminal-residue, Up: Add Terminal Residue Functions [Contents][Index]
Where i is an integer number
set immediate addition of terminal residue
call with i=1 for immediate addtion
Next: add-nucleotide, Previous: set-add-terminal-residue-immediate-addition, Up: Add Terminal Residue Functions [Contents][Index]
Where:
Add a terminal residue.
residue type can be "auto" and immediate_add is recommended to be 1.
Returns: 0 on failure, 1 on success
Next: add-terminal-residue-using-phi-psi, Previous: add-terminal-residue, Up: Add Terminal Residue Functions [Contents][Index]
Where:
Add a terminal nucleotide.
No fitting is done
Next: set-add-terminal-residue-default-residue-type, Previous: add-nucleotide, Up: Add Terminal Residue Functions [Contents][Index]
Where:
Add a terminal residue using given phi and psi angles.
Returns: the success status, 0 on failure, 1 on success
Next: set-add-terminal-residue-do-post-refine, Previous: add-terminal-residue-using-phi-psi, Up: Add Terminal Residue Functions [Contents][Index]
Where type is a string
set the residue type of an added terminal residue.
Next: add-terminal-residue-do-post-refine-state, Previous: set-add-terminal-residue-default-residue-type, Up: Add Terminal Residue Functions [Contents][Index]
Where istat is an integer number
set a flag to run refine zone on terminal residues after an addition.
Previous: set-add-terminal-residue-do-post-refine, Up: Add Terminal Residue Functions [Contents][Index]
what is the value of the previous flag?
Next: Mainchain Building Functions, Previous: Add Terminal Residue Functions, Up: Scripting Functions [Contents][Index]
Next: delete-residue, Up: Delete Residues [Contents][Index]
Where:
delete residue range
Next: delete-residue-with-full-spec, Previous: delete-residue-range, Up: Delete Residues [Contents][Index]
Where:
delete residue
Next: delete-residues-scm, Previous: delete-residue, Up: Delete Residues [Contents][Index]
Where:
delete residue with altconf
Next: delete-residues-py, Previous: delete-residue-with-full-spec, Up: Delete Residues [Contents][Index]
Where:
delete residues in the residue spec list
Next: delete-residue-hydrogens, Previous: delete-residues-scm, Up: Delete Residues [Contents][Index]
Where:
delete residues in the residue spec list
Next: delete-atom, Previous: delete-residues-py, Up: Delete Residues [Contents][Index]
Where:
delete hydrogen atoms in residue
Next: delete-residue-sidechain, Previous: delete-residue-hydrogens, Up: Delete Residues [Contents][Index]
Where:
delete atom in residue
Next: delete-hydrogen-atoms, Previous: delete-atom, Up: Delete Residues [Contents][Index]
Where:
delete all atoms in residue that are not main chain or CB
Next: delete-hydrogens, Previous: delete-residue-sidechain, Up: Delete Residues [Contents][Index]
Where imol is an integer number
delete all hydrogens in molecule,
Returns: number of hydrogens deleted.
Next: delete-waters, Previous: delete-hydrogen-atoms, Up: Delete Residues [Contents][Index]
Where imol is an integer number
delete all hydrogens in molecule,
Returns: number of hydrogens deleted.
Next: delete-chain, Previous: delete-hydrogens, Up: Delete Residues [Contents][Index]
Where imol is an integer number
delete all waters in molecule,
Returns: number of waters deleted.
Next: delete-sidechains-for-chain, Previous: delete-waters, Up: Delete Residues [Contents][Index]
Where:
delete the chain
Previous: delete-chain, Up: Delete Residues [Contents][Index]
Where:
delete the side chains in the chain
Next: Close Molecule Functions, Previous: Delete Residues, Up: Scripting Functions [Contents][Index]
• db-mainchain: | ||
• db-mainchains-fragment: |
Next: db-mainchains-fragment, Up: Mainchain Building Functions [Contents][Index]
Where:
CA -> mainchain conversion.
direction is either "forwards" or "backwards"
See also the function below.
return the new molecule number
Previous: db-mainchain, Up: Mainchain Building Functions [Contents][Index]
Where:
CA-Zone to Mainchain for a fragment based on the given residue.
Both directions are built. This is the modern interface.
Next: Rotamer Functions, Previous: Mainchain Building Functions, Up: Scripting Functions [Contents][Index]
• close-molecule: |
Where imol is an integer number
close the molecule
Next: 180 Flip Side chain, Previous: Close Molecule Functions, Up: Scripting Functions [Contents][Index]
Next: set-rotamer-lowest-probability, Up: Rotamer Functions [Contents][Index]
Where mode is an integer number
set the mode of rotamer search, options are (ROTAMERSEARCHAUTOMATIC), (ROTAMERSEARCHLOWRES) (aka. "backrub rotamers"), (ROTAMERSEARCHHIGHRES) (with rigid body fitting)
Next: set-rotamer-check-clashes, Previous: set-rotamer-search-mode, Up: Rotamer Functions [Contents][Index]
Where f is a number
For Dunbrack rotamers, set the lowest probability to be considered. Set as a percentage i.e. 1.00 is quite low. For Richardson Rotamers, this has no effect.
Next: auto-fit-best-rotamer, Previous: set-rotamer-lowest-probability, Up: Rotamer Functions [Contents][Index]
Where i is an integer number
set a flag: 0 is off, 1 is on
Next: set-auto-fit-best-rotamer-clash-flag, Previous: set-rotamer-check-clashes, Up: Rotamer Functions [Contents][Index]
Where:
auto fit by rotamer search.
return the score, for some not very good reason. clash_flag determines if we use clashes with other residues in the score for this rotamer (or not). It would be cool to call this from a script that went residue by residue along a (newly-built) chain (now available).
Next: n-rotamers, Previous: auto-fit-best-rotamer, Up: Rotamer Functions [Contents][Index]
Where i is an integer number
set the clash flag for rotamer search
And this functions for [pre-setting] the variables for auto_fit_best_rotamer called interactively (using a graphics_info_t function). 0 off, 1 on.
Next: set-residue-to-rotamer-number, Previous: set-auto-fit-best-rotamer-clash-flag, Up: Rotamer Functions [Contents][Index]
Where:
return the number of rotamers for this residue - return -1 on no residue found.
Next: set-residue-to-rotamer-name, Previous: n-rotamers, Up: Rotamer Functions [Contents][Index]
Where:
set the residue specified to the rotamer number specifed.
Next: fill-partial-residues, Previous: set-residue-to-rotamer-number, Up: Rotamer Functions [Contents][Index]
Where:
set the residue specified to the rotamer name specified.
(rotamer names are the Richardson rotamer names.)
return value is 0 if atoms were not moved (e.g. because rotamer-name was not know)
Next: simple-fill-partial-residues, Previous: set-residue-to-rotamer-name, Up: Rotamer Functions [Contents][Index]
Where imol is an integer number
fill all the residues of molecule number imol that have missing atoms.
To be used to remove the effects of chainsaw.
Next: rotamer-graphs, Previous: fill-partial-residues, Up: Rotamer Functions [Contents][Index]
Where imol is an integer number
Fill amino acid residues.
do backrub rotamer search for residues, but don’t do refinement
Next: rotamer-graphs-py, Previous: simple-fill-partial-residues, Up: Rotamer Functions [Contents][Index]
Where imol is an integer number
Activate rotamer graph analysis for molecule number imol.
Return rotamer info - function used in testing.
Previous: rotamer-graphs, Up: Rotamer Functions [Contents][Index]
Where imol is an integer number
Activate rotamer graph analysis for molecule number imol.
Return rotamer info - function used in testing.
Next: Mutate Functions, Previous: Rotamer Functions, Up: Scripting Functions [Contents][Index]
• do-180-degree-side-chain-flip: |
Up: 180 Flip Side chain [Contents][Index]
Where:
rotate 180 degrees round the last chi angle
Next: Alternative Conformation, Previous: 180 Flip Side chain, Up: Scripting Functions [Contents][Index]
Next: mutate-active-residue, Up: Mutate Functions [Contents][Index]
Where state is an integer number
Mutate then fit to map.
that we have a map define is checked first
Next: mutate, Previous: setup-mutate-auto-fit, Up: Mutate Functions [Contents][Index]
display a dialog that allows the choice of residue type to which to mutate
Next: mutate-base, Previous: mutate-active-residue, Up: Mutate Functions [Contents][Index]
Where:
mutate a given residue
target_res_type is a three-letter-code.
Return 1 on a good mutate.
Next: set-mutate-auto-fit-do-post-refine, Previous: mutate, Up: Mutate Functions [Contents][Index]
Where:
mutate a base. return success status, 1 for a good mutate.
Next: mutate-auto-fit-do-post-refine-state, Previous: mutate-base, Up: Mutate Functions [Contents][Index]
Where istate is an integer number
Do you want Coot to automatically run a refinement after every mutate and autofit?
1 for yes, 0 for no.
Next: set-rotamer-auto-fit-do-post-refine, Previous: set-mutate-auto-fit-do-post-refine, Up: Mutate Functions [Contents][Index]
what is the value of the previous flag?
Next: rotamer-auto-fit-do-post-refine-state, Previous: mutate-auto-fit-do-post-refine-state, Up: Mutate Functions [Contents][Index]
Where istate is an integer number
Do you want Coot to automatically run a refinement after every rotamer autofit?
1 for yes, 0 for no.
Next: mutate-single-residue-by-serial-number, Previous: set-rotamer-auto-fit-do-post-refine, Up: Mutate Functions [Contents][Index]
what is the value of the previous flag?
Next: set-residue-type-chooser-stub-state, Previous: rotamer-auto-fit-do-post-refine-state, Up: Mutate Functions [Contents][Index]
Where:
an alternate interface to mutation of a singe residue.
ires-ser is the serial number of the residue, not the seqnum There 2 functions don’t make backups, but
does - CHECKME Hence
is for use as a "one-by-one" type and the following 2 by wrappers that muate either a residue range or a whole chain
Note that the target_res_type is a char, not a string (or a char *). So from the scheme interface you’d use (for example) hash backslash A for ALA.
Returns: 1 on success, 0 on failure
Previous: mutate-single-residue-by-serial-number, Up: Mutate Functions [Contents][Index]
Where istat is an integer number
set a flag saying that the residue chosen by mutate or auto-fit mutate should only be added as a stub (mainchain + CB)
Next: Pointer Atom Functions, Previous: Mutate Functions, Up: Scripting Functions [Contents][Index]
• add-alt-conf-scm: | ||
• add-alt-conf-py: |
Next: add-alt-conf-py, Up: Alternative Conformation [Contents][Index]
Where:
add an alternative conformer to a residue. Add it in conformation rotamer number rotamer_number.
Return the new alt_conf chain_id on sucess, scheme false on fail
Previous: add-alt-conf-scm, Up: Alternative Conformation [Contents][Index]
Where:
add an alternative conformer to a residue. Add it in conformation rotamer number rotamer_number.
Return the new alt_conf chain_id on sucess, python False on fail
Next: Baton Build Interface Functions, Previous: Alternative Conformation, Up: Scripting Functions [Contents][Index]
• create-pointer-atom-molecule-maybe: | ||
• pointer-atom-molecule: |
Next: pointer-atom-molecule, Up: Pointer Atom Functions [Contents][Index]
Return the current pointer atom molecule, create a pointer atom molecule if necessary (i.e. when the user has not set it).
Previous: create-pointer-atom-molecule-maybe, Up: Pointer Atom Functions [Contents][Index]
Return the current pointer atom molecule.
Next: Crosshairs Interface, Previous: Pointer Atom Functions, Up: Scripting Functions [Contents][Index]
Next: try-set-draw-baton, Up: Baton Build Interface Functions [Contents][Index]
Where i is an integer number
toggle so that mouse movement moves the baton not rotates the view.
Next: accept-baton-position, Previous: set-baton-mode, Up: Baton Build Interface Functions [Contents][Index]
Where i is an integer number
draw the baton or not
Next: baton-tip-try-another, Previous: try-set-draw-baton, Up: Baton Build Interface Functions [Contents][Index]
accept the baton tip position - a prime candidate for a key binding
Next: baton-tip-previous, Previous: accept-baton-position, Up: Baton Build Interface Functions [Contents][Index]
move the baton tip position - another prime candidate for a key binding
Next: shorten-baton, Previous: baton-tip-try-another, Up: Baton Build Interface Functions [Contents][Index]
move the baton tip to the previous position
Next: lengthen-baton, Previous: baton-tip-previous, Up: Baton Build Interface Functions [Contents][Index]
shorten the baton length
Next: baton-build-delete-last-residue, Previous: shorten-baton, Up: Baton Build Interface Functions [Contents][Index]
lengthen the baton
Next: set-baton-build-params, Previous: lengthen-baton, Up: Baton Build Interface Functions [Contents][Index]
delete the most recently build CA position
Previous: baton-build-delete-last-residue, Up: Baton Build Interface Functions [Contents][Index]
Where:
set the parameters for the start of a new baton-built fragment. direction can either be "forwards" or "backwards"
Next: Edit Chi Angles, Previous: Baton Build Interface Functions, Up: Scripting Functions [Contents][Index]
• set-draw-crosshairs: |
Up: Crosshairs Interface [Contents][Index]
Where i is an integer number
draw the distance crosshairs, 0 for off, 1 for on.
Next: Masks, Previous: Crosshairs Interface, Up: Scripting Functions [Contents][Index]
• set-find-hydrogen-torsions: | ||
• edit-chi-angles: | ||
• setup-torsion-general: |
Next: edit-chi-angles, Up: Edit Chi Angles [Contents][Index]
Where state is an integer number
show torsions that rotate hydrogens in the torsion angle manipulation dialog. Note that this may be needed if, in the dictionary cif file torsion which have as a 4th atom both a hydrogen and a heavier atom bonding to the 3rd atom, but list the 4th atom as a hydrogen (not a heavier atom).
Next: setup-torsion-general, Previous: set-find-hydrogen-torsions, Up: Edit Chi Angles [Contents][Index]
Where:
display the edit chi angles gui for the given residue
return a status of 0 if it failed to fined the residue, return a value of 1 if it worked.
Previous: edit-chi-angles, Up: Edit Chi Angles [Contents][Index]
Where state is an integer number
beloved torsion general at last makes an entrance onto the Coot scene...
Next: check Waters Interface, Previous: Edit Chi Angles, Up: Scripting Functions [Contents][Index]
• mask-map-by-molecule: | ||
• mask-map-by-atom-selection: | ||
• make-masked-maps-split-by-chain: | ||
• set-map-mask-atom-radius: | ||
• map-mask-atom-radius: |
Next: mask-map-by-atom-selection, Up: Masks [Contents][Index]
Where:
generate a new map that has been masked by some coordinates
(mask-map-by-molecule map-no mol-no invert?) creates and displays a masked map, cuts down density where the coordinates are (invert is 0). If invert? is 1, cut the density down where there are no atoms atoms.
Next: make-masked-maps-split-by-chain, Previous: mask-map-by-molecule, Up: Masks [Contents][Index]
Where:
mask map by atom selection
Next: set-map-mask-atom-radius, Previous: mask-map-by-atom-selection, Up: Masks [Contents][Index]
Where:
make chain masked maps
needs to return a list of values
Next: map-mask-atom-radius, Previous: make-masked-maps-split-by-chain, Up: Masks [Contents][Index]
Where rad is a number
set the atom radius for map masking
Previous: set-map-mask-atom-radius, Up: Masks [Contents][Index]
get the atom radius for map masking
Next: Least-Squares matching, Previous: Masks, Up: Scripting Functions [Contents][Index]
• delete-checked-waters-baddies: | ||
• highly-coordinated-waters-scm: | ||
• highly-coordinated-waters-py: |
Next: highly-coordinated-waters-scm, Up: check Waters Interface [Contents][Index]
Where:
Delete waters that are fail to meet the given criteria.
Next: highly-coordinated-waters-py, Previous: delete-checked-waters-baddies, Up: check Waters Interface [Contents][Index]
Where:
return an improper list first is list of metals, second is list of waters that are coordinated with at least coordination_number of other atoms at distances less than or equal to dist_max. Return scheme false on not able to make a list, otherwise a list of atoms and neighbours. Can return scheme false if imol is not a valid molecule.
Previous: highly-coordinated-waters-scm, Up: check Waters Interface [Contents][Index]
Where:
return a list first of waters, second metals that are coordinated with at least coordination_number of other atoms at distances less than or equal to dist_max. Return Python false on not able to make a list, otherwise a list of atoms and neighours. can return Python False if imol is not a valid molecule.
Next: Trim, Previous: check Waters Interface, Up: Scripting Functions [Contents][Index]
• apply-lsq-matches: |
Up: Least-Squares matching [Contents][Index]
Where:
apply the LSQ matches
Returns: an rtop pair (proper list) on good match, else false
Next: External Ray-Tracing, Previous: Least-Squares matching, Up: Scripting Functions [Contents][Index]
• trim-molecule-by-map: |
Where:
cut off (delete or give zero occupancy) atoms in the given molecule if they are below the given map (absolute) level.
Next: Superposition (SSM), Previous: Trim, Up: Scripting Functions [Contents][Index]
Next: set-raster3d-bond-thickness, Up: External Ray-Tracing [Contents][Index]
Where rd3_filename is a string
create a r3d file for the current view
Next: set-raster3d-atom-radius, Previous: raster3d, Up: External Ray-Tracing [Contents][Index]
Where f is a number
set the bond thickness for the Raster3D representation
Next: set-raster3d-density-thickness, Previous: set-raster3d-bond-thickness, Up: External Ray-Tracing [Contents][Index]
Where f is a number
set the atom radius for the Raster3D representation
Next: set-renderer-show-atoms, Previous: set-raster3d-atom-radius, Up: External Ray-Tracing [Contents][Index]
Where f is a number
set the density line thickness for the Raster3D representation
Next: set-raster3d-bone-thickness, Previous: set-raster3d-density-thickness, Up: External Ray-Tracing [Contents][Index]
Where istate is an integer number
set the flag to show atoms for the Raster3D representation
Next: set-raster3d-shadows-enabled, Previous: set-renderer-show-atoms, Up: External Ray-Tracing [Contents][Index]
Where f is a number
set the bone (skeleton) thickness for the Raster3D representation
Next: set-raster3d-water-sphere, Previous: set-raster3d-bone-thickness, Up: External Ray-Tracing [Contents][Index]
Where state is an integer number
turn off shadows for raster3d output - give argument 0 to turn off
Next: set-raster3d-font-size, Previous: set-raster3d-shadows-enabled, Up: External Ray-Tracing [Contents][Index]
Where istate is an integer number
set the flag to show waters as spheres for the Raster3D representation. 1 show as spheres, 0 the usual stars.
Next: raster-screen-shot, Previous: set-raster3d-water-sphere, Up: External Ray-Tracing [Contents][Index]
Where size_in is a string
set the font size (as a string) for raster3d
Previous: set-raster3d-font-size, Up: External Ray-Tracing [Contents][Index]
run raster3d and display the resulting image.
Next: NCS, Previous: External Ray-Tracing, Up: Scripting Functions [Contents][Index]
• superpose: | ||
• superpose-with-chain-selection: | ||
• superpose-with-atom-selection: |
Next: superpose-with-chain-selection, Up: Superposition (SSM) [Contents][Index]
Where:
simple interface to superposition.
Superpose all residues of imol2 onto imol1. imol1 is reference, we can either move imol2 or copy it to generate a new molecule depending on the vaule of move_imol2_flag (1 for copy 0 for move).
Next: superpose-with-atom-selection, Previous: superpose, Up: Superposition (SSM) [Contents][Index]
Where:
chain-based interface to superposition.
Superpose the given chains of imol2 onto imol1. imol1 is reference, we can either move imol2 or copy it to generate a new molecule depending on the vaule of move_imol2_flag (1 for move 0 for copy).
Previous: superpose-with-chain-selection, Up: Superposition (SSM) [Contents][Index]
Where:
detailed interface to superposition.
Superpose the given atom selection (specified by the mmdb atom selection strings) of imol2 onto imol1. imol1 is reference, we can either move imol2 or copy it to generate a new molecule depending on the vaule of move_imol2_flag (1 for move 0 for copy).
Returns: the index of the superposed molecule - which could either be a new molecule (if move_imol2_flag was 1) or the imol2 or -1 (signifying failure to do the SMM superposition).
Next: Helices and Strands, Previous: Superposition (SSM), Up: Scripting Functions [Contents][Index]
Next: draw-ncs-ghosts-state, Up: NCS [Contents][Index]
Where:
set drawing state of NCS ghosts for molecule number imol
Next: set-ncs-ghost-bond-thickness, Previous: set-draw-ncs-ghosts, Up: NCS [Contents][Index]
Where imol is an integer number
return the drawing state of NCS ghosts for molecule number imol. Return -1 on imol is a bad molecule or no ghosts.
Next: ncs-update-ghosts, Previous: draw-ncs-ghosts-state, Up: NCS [Contents][Index]
Where:
set bond thickness of NCS ghosts for molecule number imol
Next: make-dynamically-transformed-ncs-maps, Previous: set-ncs-ghost-bond-thickness, Up: NCS [Contents][Index]
Where imol is an integer number
update ghosts for molecule number imol
Next: add-ncs-matrix, Previous: ncs-update-ghosts, Up: NCS [Contents][Index]
Where:
make NCS map
Next: add-strict-ncs-matrix, Previous: make-dynamically-transformed-ncs-maps, Up: NCS [Contents][Index]
Where:
Add NCS matrix.
Next: show-strict-ncs-state, Previous: add-ncs-matrix, Up: NCS [Contents][Index]
Where:
add an NCS matrix for strict NCS molecule representation
for CNS strict NCS usage: expand like normal symmetry does
Next: set-show-strict-ncs, Previous: add-strict-ncs-matrix, Up: NCS [Contents][Index]
Where imol is an integer number
return the state of NCS ghost molecules for molecule number imol
Next: set-ncs-homology-level, Previous: show-strict-ncs-state, Up: NCS [Contents][Index]
Where:
set display state of NCS ghost molecules for molecule number imol
Next: copy-chain, Previous: set-show-strict-ncs, Up: NCS [Contents][Index]
Where flev is a number
At what level of homology should we say that we can’t see homology for NCS calculation? (default 0.8)
Next: copy-from-ncs-master-to-others, Previous: set-ncs-homology-level, Up: NCS [Contents][Index]
Where:
Copy single NCS chain.
Next: copy-residue-range-from-ncs-master-to-others, Previous: copy-chain, Up: NCS [Contents][Index]
Where:
Copy chain from master to all related NCS chains.
Next: ncs-master-chains-scm, Previous: copy-from-ncs-master-to-others, Up: NCS [Contents][Index]
Where:
Copy residue range to all related NCS chains.
If the target residues do not exist in the peer chains, then create them.
Next: copy-from-ncs-master-to-chains-scm, Previous: copy-residue-range-from-ncs-master-to-others, Up: NCS [Contents][Index]
Where imol is an integer number
Copy residue range to selected NCS chains.
If the target residues do not exist in the peer chains, then create them.
return a list of NCS masters or scheme false
Next: ncs-control-change-ncs-master-to-chain, Previous: ncs-master-chains-scm, Up: NCS [Contents][Index]
Where:
Copy chain from master to a list of NCS chains.
Next: ncs-control-change-ncs-master-to-chain-id, Previous: copy-from-ncs-master-to-chains-scm, Up: NCS [Contents][Index]
Where:
change the NCS master chain (by number)
Next: ncs-control-display-chain, Previous: ncs-control-change-ncs-master-to-chain, Up: NCS [Contents][Index]
Where:
change the NCS master chain (by chain_id)
Next: ncs-chain-ids-scm, Previous: ncs-control-change-ncs-master-to-chain-id, Up: NCS [Contents][Index]
Where:
display the NCS master chain
Next: ncs-chain-ids-py, Previous: ncs-control-display-chain, Up: NCS [Contents][Index]
Where imol is an integer number
Return the ncs chains id for the given molecule.
return something like: ’(("A" "B")) or ’(("A" "C" "E") ("B" "D" "F")). The master chain goes in first.
If imol does not have NCS ghosts, return scheme false.
Next: ncs-ghosts-scm, Previous: ncs-chain-ids-scm, Up: NCS [Contents][Index]
Where imol is an integer number
Return the ncs chains id for the given molecule.
return something like: [["A", "B"]] or [["A", "C", "E"], ["B", "D", "F"]]. The master chain goes in first.
If imol does not have NCS ghosts, return python False.
Next: ncs-ghosts-py, Previous: ncs-chain-ids-py, Up: NCS [Contents][Index]
Where imol is an integer number
get the NCS ghost description
Returns: false on bad imol or a list of ghosts on good imol. Can include NCS rtops if they are available, else the rtops are False
Previous: ncs-ghosts-scm, Up: NCS [Contents][Index]
Where imol is an integer number
Get the NCS ghosts description.
Returns: False on bad imol or a list of ghosts on good imol. Can include NCS rtops if they are available, else the rtops are False
Next: Nucleotides, Previous: NCS, Up: Scripting Functions [Contents][Index]
• place-helix-here: | ||
• place-strand-here: | ||
• place-strand-here-dialog: | ||
• find-helices: | ||
• find-strands: | ||
• find-secondary-structure: | ||
• find-secondary-structure-local: |
Next: place-strand-here, Up: Helices and Strands [Contents][Index]
add a helix
Add a helix somewhere close to this point in the map, try to fit the orientation. Add to a molecule called "Helix", create it if needed. Create another moecule called "Reverse Helix" if the helix orientation isn’t completely unequivocal.
Returns: the index of the new molecule.
Next: place-strand-here-dialog, Previous: place-helix-here, Up: Helices and Strands [Contents][Index]
Where:
add a strands
Add a strand close to this point in the map, try to fit the orientation. Add to a molecule called "Strand", create it if needed. n_residues is the estimated number of residues in the strand.
n_sample_strands is the number of strands from the database tested to fit into this strand density. 8 is a suggested number. 20 for a more rigourous search, but it will be slower.
Returns: the index of the new molecule.
Next: find-helices, Previous: place-strand-here, Up: Helices and Strands [Contents][Index]
show the strand placement gui.
Choose the python version in there, if needed. Call scripting function, display it in place, don’t return a widget.
Next: find-strands, Previous: place-strand-here-dialog, Up: Helices and Strands [Contents][Index]
autobuild helices
Find secondary structure in the current map. Add to a molecule called "Helices", create it if needed.
Returns: the index of the new molecule.
Next: find-secondary-structure, Previous: find-helices, Up: Helices and Strands [Contents][Index]
autobuild strands
Find secondary structure in the current map. Add to a molecule called "Strands", create it if needed.
Returns: the index of the new molecule.
Next: find-secondary-structure-local, Previous: find-strands, Up: Helices and Strands [Contents][Index]
Where:
autobuild secondary structure
Find secondary structure in the current map. Add to a molecule called "SecStruc", create it if needed.
Returns: the index of the new molecule.
Previous: find-secondary-structure, Up: Helices and Strands [Contents][Index]
Where:
autobuild secondary structure
Find secondary structure local to current view in the current map. Add to a molecule called "SecStruc", create it if needed.
Returns: the index of the new molecule.
Next: New Molecule by Section Interface, Previous: Helices and Strands, Up: Scripting Functions [Contents][Index]
• find-nucleic-acids-local: |
Up: Nucleotides [Contents][Index]
Where radius is a number
autobuild nucleic acid chains
Find secondary structure local to current view in the current map. Add to a molecule called "NuclAcid", create it if needed.
Returns: the index of the new molecule.
Next: RNA/DNA, Previous: Nucleotides, Up: Scripting Functions [Contents][Index]
• new-molecule-by-residue-type-selection: | ||
• new-molecule-by-atom-selection: | ||
• new-molecule-by-sphere-selection: | ||
• new-molecule-by-residue-specs-py: | ||
• new-molecule-by-residue-specs-scm: |
Where:
create a new molecule that consists of only the residue of type residue_type in molecule number imol
Returns: the new molecule number, -1 means an error.
Next: new-molecule-by-sphere-selection, Previous: new-molecule-by-residue-type-selection, Up: New Molecule by Section Interface [Contents][Index]
Where:
create a new molecule that consists of only the atoms specified by the mmdb atoms selection string in molecule number imol
Returns: the new molecule number, -1 means an error.
Next: new-molecule-by-residue-specs-py, Previous: new-molecule-by-atom-selection, Up: New Molecule by Section Interface [Contents][Index]
Where:
create a new molecule that consists of only the atoms within the given radius (r) of the given position.
Returns: the new molecule number, -1 means an error.
Next: new-molecule-by-residue-specs-scm, Previous: new-molecule-by-sphere-selection, Up: New Molecule by Section Interface [Contents][Index]
Where:
create a new molecule that consists of only the atoms of the specified list of residues
Returns: the new molecule number, -1 means an error.
Previous: new-molecule-by-residue-specs-py, Up: New Molecule by Section Interface [Contents][Index]
Where:
create a new molecule that consists of only the atoms of the specified list of residues
Returns: the new molecule number, -1 means an error.
Next: Sequence (Assignment), Previous: New Molecule by Section Interface, Up: Scripting Functions [Contents][Index]
• ideal-nucleic-acid: | ||
• pucker-info-scm: | ||
• pucker-info-py: | ||
• watson-crick-pair: | ||
• watson-crick-pair-for-residue-range: |
Next: pucker-info-scm, Up: RNA/DNA [Contents][Index]
Where:
create a molecule of idea nucleotides
use the given sequence (single letter code)
RNA_or_DNA is either "RNA" or "DNA"
form is either "A" or "B"
Returns: the new molecule number or -1 if a problem
Next: pucker-info-py, Previous: ideal-nucleic-acid, Up: RNA/DNA [Contents][Index]
Where:
get the pucker info for the specified residue
(where plane-distortion is for the other 4 atoms in the plane (I think)).
and if there is no following residue, then the phosphate distance cannot be calculated, so the (inner) list is null (not filled).
Returns: scheme false if residue not found, otherwise (list (list phosphate-distance puckered-atom out-of-plane-distance plane-distortion) chain-id resno ins-code)
Next: watson-crick-pair, Previous: pucker-info-scm, Up: RNA/DNA [Contents][Index]
Where:
return False if residue not found, otherwise [[phosphate_distance, puckered_atom, out_of_plane_distance, plane_distortion], chain_id, resno, ins_code]
(where plane_distortion is for the other 4 atoms in the plane (I think)).
and if there is no following residue, then the phosphate distance cannot be calculated, so the (inner) list is null (not filled).
Next: watson-crick-pair-for-residue-range, Previous: pucker-info-py, Up: RNA/DNA [Contents][Index]
Where:
Return a molecule that contains a residue that is the WC pair partner of the clicked/picked/selected residue.
Previous: watson-crick-pair, Up: RNA/DNA [Contents][Index]
Where:
add base pairs for the given residue range, modify molecule imol by creating a new chain
Next: Surface Interface, Previous: RNA/DNA, Up: Scripting Functions [Contents][Index]
Next: print-sequence-chain-general, Up: Sequence (Assignment) [Contents][Index]
Where:
Print the sequence to the console of the given molecule.
Next: assign-fasta-sequence, Previous: print-sequence-chain, Up: Sequence (Assignment) [Contents][Index]
Where:
optionally write the sequence to the file for the given molecule, optionally in PIR format
Next: assign-pir-sequence, Previous: print-sequence-chain-general, Up: Sequence (Assignment) [Contents][Index]
Where:
Assign a FASTA sequence to a given chain in the molecule.
Next: assign-sequence-from-file, Previous: assign-fasta-sequence, Up: Sequence (Assignment) [Contents][Index]
Where:
Assign a PIR sequence to a given chain in the molecule. If the chain of the molecule already had a chain assigned to it, then this will overwrite that old assignment with the new one.
Next: assign-sequence-from-string, Previous: assign-pir-sequence, Up: Sequence (Assignment) [Contents][Index]
Where:
Assign a sequence to a given molecule from (whatever) sequence file.
Next: delete-all-sequences-from-molecule, Previous: assign-sequence-from-file, Up: Sequence (Assignment) [Contents][Index]
Where:
Assign a sequence to a given molecule from a simple string.
Next: delete-sequence-by-chain-id, Previous: assign-sequence-from-string, Up: Sequence (Assignment) [Contents][Index]
Where imol is an integer number
Delete all the sequences from a given molecule.
Next: sequence-info, Previous: delete-all-sequences-from-molecule, Up: Sequence (Assignment) [Contents][Index]
Where:
Delete the sequence for a given chain_id from a given molecule.
Next: alignment-mismatches-scm, Previous: delete-sequence-by-chain-id, Up: Sequence (Assignment) [Contents][Index]
Where imol is an integer number
return the sequence info that has been assigned to molecule number imol. return as a list of dotted pairs (list (cons chain-id seq)). To be used in constructing the cootaneer gui. Return Scheme False when no sequence has been assigned to imol.
Next: sequence-info-py, Previous: sequence-info, Up: Sequence (Assignment) [Contents][Index]
Where imol is an integer number
do a internal alignment of all the assigned sequences, return a list of mismatches that need to be made to model number imol to match the input sequence.
Return a list of mutations deletions insetions. Return scheme false on failure to align (e.g. not assigned sequence) and the empty list on no alignment mismatches.
Next: alignment-mismatches-py, Previous: alignment-mismatches-scm, Up: Sequence (Assignment) [Contents][Index]
Where imol is an integer number
return the sequence info that has been assigned to molecule number imol. return as a list of dotted pairs [[chain-id, seq]]. To be used in constructing the cootaneer gui. Return False when no sequence has been assigned.
Previous: sequence-info-py, Up: Sequence (Assignment) [Contents][Index]
Where imol is an integer number
do a internal alignment of all the assigned sequences, return a list of mismatches that need to be made to model number imol to match the input sequence.
Return a list of mutations deletions insetions. Return False on failure to align (e.g. not assigned sequence) and the empty list on no alignment mismatches.
Next: FFFearing, Previous: Sequence (Assignment), Up: Scripting Functions [Contents][Index]
• do-surface: | ||
• do-clipped-surface-scm: | ||
• do-clipped-surface-py: | ||
• set-transparent-electrostatic-surface: | ||
• get-electrostatic-surface-opacity: |
Next: do-clipped-surface-scm, Up: Surface Interface [Contents][Index]
Where:
draw surface of molecule number imol
if state = 1 draw the surface (normal representation goes away)
if state = 0 don’t draw surface
Next: do-clipped-surface-py, Previous: do-surface, Up: Surface Interface [Contents][Index]
Where:
draw the surface of the imolth molecule clipped to the residues given by residue_specs.
residue_specs must not contain spec for waters (you wouldn’t want to surface over waters anyway).
Next: set-transparent-electrostatic-surface, Previous: do-clipped-surface-scm, Up: Surface Interface [Contents][Index]
Where:
draw the surface of the imolth molecule clipped to the residues given by residue_specs
Next: get-electrostatic-surface-opacity, Previous: do-clipped-surface-py, Up: Surface Interface [Contents][Index]
Where:
simple on/off screendoor transparency at the moment, an opacity > 0.0 will turn on screendoor transparency (stippling).
Previous: set-transparent-electrostatic-surface, Up: Surface Interface [Contents][Index]
Where imol is an integer number
return 1.0 for non transparent and 0.5 if screendoor transparency has been turned on.
Next: Remote Control, Previous: Surface Interface, Up: Scripting Functions [Contents][Index]
• fffear-search: | ||
• set-fffear-angular-resolution: | ||
• fffear-angular-resolution: |
Next: set-fffear-angular-resolution, Up: FFFearing [Contents][Index]
Where:
fffear search model in molecule number imol_model in map number imol_map
Next: fffear-angular-resolution, Previous: fffear-search, Up: FFFearing [Contents][Index]
Where f is a number
set and return the fffear angular resolution in degrees
Previous: set-fffear-angular-resolution, Up: FFFearing [Contents][Index]
return the fffear angular resolution in degrees
Next: Display Lists for Maps, Previous: FFFearing, Up: Scripting Functions [Contents][Index]
• make-socket-listener-maybe: | ||
• set-socket-string-waiting: | ||
• set-socket-python-string-waiting: |
Next: set-socket-string-waiting, Up: Remote Control [Contents][Index]
try to make socket listener
Next: set-socket-python-string-waiting, Previous: make-socket-listener-maybe, Up: Remote Control [Contents][Index]
Where s is a string
feed the main thread a scheme script to evaluate
Previous: set-socket-string-waiting, Up: Remote Control [Contents][Index]
Where s is a string
feed the main thread a python script to evaluate
Next: Browser Interface, Previous: Remote Control, Up: Scripting Functions [Contents][Index]
• set-display-lists-for-maps: | ||
• display-lists-for-maps-state: |
Next: display-lists-for-maps-state, Up: Display Lists for Maps [Contents][Index]
Where i is an integer number
Should display lists be used for maps? It may speed things up if these are turned on (or off) - depends on graphics card and drivers. Pass 1 for on, 0 for off.
Previous: set-display-lists-for-maps, Up: Display Lists for Maps [Contents][Index]
return the state of display_lists_for_maps.
Next: Molprobity Interface, Previous: Display Lists for Maps, Up: Scripting Functions [Contents][Index]
• browser-url: | ||
• set-browser-interface: | ||
• handle-online-coot-search-request: |
Next: set-browser-interface, Up: Browser Interface [Contents][Index]
Where url is a string
try to open given url in Web browser
Next: handle-online-coot-search-request, Previous: browser-url, Up: Browser Interface [Contents][Index]
Where browser is a string
set command to open the web browser,
examples are "open" or "mozilla"
Previous: set-browser-interface, Up: Browser Interface [Contents][Index]
Where entry_text is a string
the search interface
find words, construct a url and open it.
Next: Map Sharpening Interface, Previous: Browser Interface, Up: Scripting Functions [Contents][Index]
Where dots_file is a string
pass a filename that contains molprobity’s probe output in XtalView format
Next: set-do-probe-dots-on-rotamers-and-chis, Previous: handle-read-draw-probe-dots, Up: Molprobity Interface [Contents][Index]
Where:
pass a filename that contains molprobity’s probe output in unformatted format
Next: do-probe-dots-on-rotamers-and-chis-state, Previous: handle-read-draw-probe-dots-unformatted, Up: Molprobity Interface [Contents][Index]
Where state is an integer number
shall we run molprobity for on edit chi angles intermediate atoms?
Next: set-do-probe-dots-post-refine, Previous: set-do-probe-dots-on-rotamers-and-chis, Up: Molprobity Interface [Contents][Index]
return the state of if run molprobity for on edit chi angles intermediate atoms?
Next: do-probe-dots-post-refine-state, Previous: do-probe-dots-on-rotamers-and-chis-state, Up: Molprobity Interface [Contents][Index]
Where state is an integer number
shall we run molprobity after a refinement has happened?
Next: unmangle-hydrogen-name, Previous: set-do-probe-dots-post-refine, Up: Molprobity Interface [Contents][Index]
show the state of shall we run molprobity after a refinement has happened?
Next: set-interactive-probe-dots-molprobity-radius, Previous: do-probe-dots-post-refine-state, Up: Molprobity Interface [Contents][Index]
Where pdb_hydrogen_name is a string
make an attempt to convert pdb hydrogen name to the name used in Coot (and the refmac dictionary, perhaps).
Next: interactive-probe-dots-molprobity-radius, Previous: unmangle-hydrogen-name, Up: Molprobity Interface [Contents][Index]
Where r is a number
set the radius over which we can run interactive probe, bigger is better but slower.
default is 6.0
Next: user-mods-scm, Previous: set-interactive-probe-dots-molprobity-radius, Up: Molprobity Interface [Contents][Index]
return the radius over which we can run interactive probe.
Next: user-mods-py, Previous: interactive-probe-dots-molprobity-radius, Up: Molprobity Interface [Contents][Index]
Where file_name is a string
return the parsed user mod fields from the PDB file file_name (output by reduce most likely)
Previous: user-mods-scm, Up: Molprobity Interface [Contents][Index]
Where file_name is a string
return the parsed user mod fields from the PDB file file_name (output by reduce most likely)
Next: Intermediate Atom Manipulation Interface, Previous: Molprobity Interface, Up: Scripting Functions [Contents][Index]
• sharpen: | ||
• set-map-sharpening-scale-limit: |
Next: set-map-sharpening-scale-limit, Up: Map Sharpening Interface [Contents][Index]
Where:
Sharpen map imol by b_factor (note (of course) that positive numbers blur the map).
Previous: sharpen, Up: Map Sharpening Interface [Contents][Index]
Where f is a number
set the limit of the b-factor map sharpening slider (default 30)
Next: Marking Fixed Atom Interface, Previous: Map Sharpening Interface, Up: Scripting Functions [Contents][Index]
• add-target-position-restraint-for-intermediate-atom-py: |
Where:
add a target position for an intermediate atom and refine
Next: Partial Charges, Previous: Intermediate Atom Manipulation Interface, Up: Scripting Functions [Contents][Index]
• clear-all-fixed-atoms: |
Where imol is an integer number
clear all fixed atoms
Next: EM interface, Previous: Marking Fixed Atom Interface, Up: Scripting Functions [Contents][Index]
• show-partial-charge-info: |
Up: Partial Charges [Contents][Index]
Where:
show the partial charges for the residue of the given specs (charges are read from the dictionary)
Next: CCP4mg Interface, Previous: Partial Charges, Up: Scripting Functions [Contents][Index]
• scale-cell: |
Up: EM interface [Contents][Index]
Where:
Scale the cell, for use with EM maps, where the cell needs to be adjusted. Use like: (scale-cell 2 1.012 1.012 1.012). Return error status, 1 means it worked, 0 means it did not work.
Next: Dipoles, Previous: EM interface, Up: Scripting Functions [Contents][Index]
• ccp4i-projects-scm: | ||
• ccp4i-projects-py: | ||
• set-add-ccp4i-projects-to-file-dialogs: | ||
• write-ccp4mg-picture-description: | ||
• get-atom-colour-from-mol-no: |
Next: ccp4i-projects-py, Up: CCP4mg Interface [Contents][Index]
return a list of pairs of strings, the project names and the directory. Include aliases.
Next: set-add-ccp4i-projects-to-file-dialogs, Previous: ccp4i-projects-scm, Up: CCP4mg Interface [Contents][Index]
return a list of pairs of strings, the project names and the directory. Include aliases.
Next: write-ccp4mg-picture-description, Previous: ccp4i-projects-py, Up: CCP4mg Interface [Contents][Index]
Where state is an integer number
allow the user to not add ccp4i directories to the file choosers
use state=0 to turn it off
Next: get-atom-colour-from-mol-no, Previous: set-add-ccp4i-projects-to-file-dialogs, Up: CCP4mg Interface [Contents][Index]
Where filename is a string
write a ccp4mg picture description file
Previous: write-ccp4mg-picture-description, Up: CCP4mg Interface [Contents][Index]
Where:
get element colour for imol as Python formatted list char
Next: Aux functions, Previous: CCP4mg Interface, Up: Scripting Functions [Contents][Index]
• add-dipole-for-residues-scm: | ||
• add-dipole-scm: | ||
• add-dipole-py: | ||
• add-dipole-for-residues-py: |
Next: add-dipole-scm, Up: Dipoles [Contents][Index]
Where:
generate a dipole from all atoms in the given residues. Return the dipole description
Next: add-dipole-py, Previous: add-dipole-for-residues-scm, Up: Dipoles [Contents][Index]
Where:
return the dipole number
Next: add-dipole-for-residues-py, Previous: add-dipole-scm, Up: Dipoles [Contents][Index]
Where:
generate a dipole from all atoms in the given residues.
Previous: add-dipole-py, Up: Dipoles [Contents][Index]
Where:
add a dipole given a set of residues. Return a dipole description.
Next: SMILES, Previous: Dipoles, Up: Scripting Functions [Contents][Index]
• laplacian: |
Up: Aux functions [Contents][Index]
Where imol is an integer number
Create the "Laplacian" (-ve second derivative) of the given map.
Next: PHENIX Support, Previous: Aux functions, Up: Scripting Functions [Contents][Index]
• do-smiles-gui: |
display the SMILES string dialog
Next: Graphics Text, Previous: SMILES, Up: Scripting Functions [Contents][Index]
• set-button-label-for-external-refinement: |
Up: PHENIX Support [Contents][Index]
Where button_label is a string
set the button label of the external Refinement program
Next: PISA Interaction, Previous: PHENIX Support, Up: Scripting Functions [Contents][Index]
• place-text: | ||
• remove-text: | ||
• text-index-near-position: |
Next: remove-text, Up: Graphics Text [Contents][Index]
Where:
Put text at x,y,z.
size variable is currently ignored.
Returns: a text handle
Next: text-index-near-position, Previous: place-text, Up: Graphics Text [Contents][Index]
Where text_handle is an integer number
Remove "3d" text item.
Previous: remove-text, Up: Graphics Text [Contents][Index]
Where:
return the closest text that is with r A of the given position. If no text item is close, then return -1
Next: Jiggle Fit, Previous: Graphics Text, Up: Scripting Functions [Contents][Index]
• pisa-interaction: |
Up: PISA Interaction [Contents][Index]
Where:
return the molecule number of the interacting residues. Return -1 if no new model was created. Old, not very useful.
Next: SBase interface, Previous: PISA Interaction, Up: Scripting Functions [Contents][Index]
Next: fit-molecule-to-map-by-random-jiggle, Up: Jiggle Fit [Contents][Index]
Where:
jiggle fit to the current refinment map. return < -100 if not possible, else return the new best fit for this residue.
Next: fit-molecule-to-map-by-random-jiggle-and-blur, Previous: fit-to-map-by-random-jiggle, Up: Jiggle Fit [Contents][Index]
Where:
jiggle fit the molecule to the current refinment map. return < -100 if not possible, else return the new best fit for this molecule.
Next: fit-chain-to-map-by-random-jiggle, Previous: fit-molecule-to-map-by-random-jiggle, Up: Jiggle Fit [Contents][Index]
Where:
jiggle fit the molecule to the current refinment map. return < -100 if not possible, else return the new best fit for this molecule - create a map that is blurred by the given factor for fitting
Next: fit-chain-to-map-by-random-jiggle-and-blur, Previous: fit-molecule-to-map-by-random-jiggle-and-blur, Up: Jiggle Fit [Contents][Index]
Where:
jiggle fit the chain to the current refinment map. return < -100 if not possible, else return the new best fit for this chain.
Previous: fit-chain-to-map-by-random-jiggle, Up: Jiggle Fit [Contents][Index]
Where:
jiggle fit the chain to the current refinment map
Use a map that is blurred by the give factor for fitting.
Returns: < -100 if not possible, else return the new best fit for this chain.
Next: FLE-View, Previous: Jiggle Fit, Up: Scripting Functions [Contents][Index]
• matching-compound-names-from-sbase-scm: | ||
• matching-compound-names-from-sbase-py: | ||
• get-ccp4srs-monomer-and-dictionary: | ||
• get-sbase-monomer: |
Next: matching-compound-names-from-sbase-py, Up: SBase interface [Contents][Index]
Where compound_name_fragment is a string
return a list of compoundIDs of in SBase of which the given string is a substring of the compound name
Next: get-ccp4srs-monomer-and-dictionary, Previous: matching-compound-names-from-sbase-scm, Up: SBase interface [Contents][Index]
Where compound_name_fragment is a string
return a list of compoundIDs of in SBase of which the given string is a substring of the compound name
Next: get-sbase-monomer, Previous: matching-compound-names-from-sbase-py, Up: SBase interface [Contents][Index]
Where comp_id is a string
return the new molecule number of the monomer.
The monomer will have chainid "A" and residue number 1.
Return -1 on failure to get monomer.
Previous: get-ccp4srs-monomer-and-dictionary, Up: SBase interface [Contents][Index]
Where comp_id is a string
same as above but using old name for back-compatibility
Next: LSQ-improve, Previous: SBase interface, Up: Scripting Functions [Contents][Index]
• fle-view-set-water-dist-max: | ||
• fle-view-set-h-bond-dist-max: |
Next: fle-view-set-h-bond-dist-max, Up: FLE-View [Contents][Index]
Where dist_max is a number
set the maximum considered distance to water
default 3.25 A.
Previous: fle-view-set-water-dist-max, Up: FLE-View [Contents][Index]
Where h_bond_dist_max is a number
set the maximum considered hydrogen bond distance
default 3.9 A.
Next: single-model view, Previous: FLE-View, Up: Scripting Functions [Contents][Index]
• lsq-improve: |
Up: LSQ-improve [Contents][Index]
Where:
an slightly-modified implementation of the "lsq_improve" algorithm of Kleywegt and Jones (1997).
Note that if a residue selection is specified in the residue selection(s), then the first residue of the given range must exist in the molecule (if not, then mmdb will not select any atoms from that molecule).
Kleywegt and Jones set n_res to 4 and dist_crit to 6.0.
Next: graphics 2D ligand view, Previous: LSQ-improve, Up: Scripting Functions [Contents][Index]
• single-model-view-model-number: | ||
• single-model-view-this-model-number: | ||
• single-model-view-next-model-number: | ||
• single-model-view-prev-model-number: |
Next: single-model-view-this-model-number, Up: single-model view [Contents][Index]
Where:
put molecule number imol to display only model number imodel
Next: single-model-view-next-model-number, Previous: single-model-view-model-number, Up: single-model view [Contents][Index]
Where imol is an integer number
the current model number being displayed
return 0 on non-multimodel-molecule.
Next: single-model-view-prev-model-number, Previous: single-model-view-this-model-number, Up: single-model view [Contents][Index]
Where imol is an integer number
change the representation to the next model number to be displayed
return 0 on non-multimodel-molecule.
Previous: single-model-view-next-model-number, Up: single-model view [Contents][Index]
Where imol is an integer number
change the representation to the previous model number to be displayed
return 0 on non-multimodel-molecule.
Previous: single-model view, Up: Scripting Functions [Contents][Index]
• set-show-graphics-ligand-view: |
Up: graphics 2D ligand view [Contents][Index]
Where state is an integer number
set the graphics ligand view state
(default is 1 (on)).
Next: More Refinement Scripting Functions, Previous: Scripting Functions, Up: Top [Contents][Index]
Next: Extra Map Functions, Up: More Scripting Functions [Contents][Index]
• get-symmetry: | ||
• clashes-with-symmetry: |
Next: clashes-with-symmetry, Up: More Symmetry Functions [Contents][Index]
Where imol is an integer number
return the symmetry of the imolth molecule
Return as a list of strings the symmetry operators of the given molecule. If imol is a not a valid molecule, return an empty list.
Previous: get-symmetry, Up: More Symmetry Functions [Contents][Index]
Where:
return 1 if this residue clashes with the symmetry-related atoms of the same molecule.
0 means that it did not clash, -1 means that the residue or molecule could not be found or that there was no cell and symmetry.
Next: Multi-Residue Torsion, Previous: More Symmetry Functions, Up: More Scripting Functions [Contents][Index]
Where filename is a string
read MTZ file filename and from it try to make maps
Useful for reading the output of refmac. The default labels (FWT/PHWT and DELFWT/PHDELFWT) can be changed using ...[something]
Returns: a list of molecule numbers for the new maps
Next: sharpen-blur-map, Previous: auto-read-make-and-draw-maps, Up: Extra Map Functions [Contents][Index]
Where filename is a string
set the flag to do a difference map (too) on auto-read MTZ
Next: sharpen-blur-map-with-resampling, Previous: auto-read-make-and-draw-maps-from-mtz, Up: Extra Map Functions [Contents][Index]
Where:
make a sharpened or blurred map
blurred maps are generated by using a positive value of b_factor.
Returns: the index of the map created by applying a b-factor to the given map. Return -1 on failure.
Next: multi-sharpen-blur-map-scm, Previous: sharpen-blur-map, Up: Extra Map Functions [Contents][Index]
Where:
make a sharpened or blurred map with resampling
resampling factor might typically be 1.3
blurred maps are generated by using a positive value of b_factor.
Returns: the index of the map created by applying a b-factor to the given map. Return -1 on failure.
Next: multi-sharpen-blur-map-py, Previous: sharpen-blur-map-with-resampling, Up: Extra Map Functions [Contents][Index]
Where:
make many sharpened or blurred maps
blurred maps are generated by using a positive value of b_factor.
Next: flip-hand, Previous: multi-sharpen-blur-map-scm, Up: Extra Map Functions [Contents][Index]
Where:
make many sharpened or blurred maps
blurred maps are generated by using a positive value of b_factor.
Next: go-to-map-molecule-centre, Previous: multi-sharpen-blur-map-py, Up: Extra Map Functions [Contents][Index]
Where imol_map is an integer number
Flip the hand of the map.
in case it was accidentally generated on the wrong one.
Returns: the molecule number of the flipped map.
Next: b-factor-from-map, Previous: flip-hand, Up: Extra Map Functions [Contents][Index]
Where imol_map is an integer number
Go to the centre of the molecule - for Cryo-EM Molecules.
and recontour at a sensible value.
Next: map-colour-components, Previous: go-to-map-molecule-centre, Up: Extra Map Functions [Contents][Index]
Where imol_map is an integer number
b-factor from map
calculate structure factors and use the amplitudes to estimate the B-factor of the data using a wilson plot using a low resolution limit of 4.5A.
Returns: -1 when given a bad map or there were no data beyond 4.5A
Next: map-colour-components-py, Previous: b-factor-from-map, Up: Extra Map Functions [Contents][Index]
Where imol is an integer number
return the colour triple of the imolth map
(e.g.: (list 0.4 0.6 0.8). If invalid imol return scheme false.
Next: handle-read-ccp4-map, Previous: map-colour-components, Up: Extra Map Functions [Contents][Index]
Where imol is an integer number
return the colour triple of the imolth map
e.g.: [0.4, 0.6, 0.8]. If invalid imol return Py_False.
Previous: map-colour-components-py, Up: Extra Map Functions [Contents][Index]
Where:
read a CCP4 map or a CNS map (despite the name).
Next: Merge Fragments, Previous: Extra Map Functions, Up: More Scripting Functions [Contents][Index]
• multi-residue-torsion-fit-scm: | ||
• multi-residue-torsion-fit-py: |
Next: multi-residue-torsion-fit-py, Up: Multi-Residue Torsion [Contents][Index]
Where:
fit residues
(note: fit to the current-refinement map)
Previous: multi-residue-torsion-fit-scm, Up: Multi-Residue Torsion [Contents][Index]
Where:
fit residues
(note: fit to the current-refinement map)
Next: Execute Refmac, Previous: Multi-Residue Torsion, Up: More Scripting Functions [Contents][Index]
• merge-fragments: |
Up: Merge Fragments [Contents][Index]
Where imol is an integer number
each fragment is presumed to be in its own chain.
Next: Dictionary Functions, Previous: Merge Fragments, Up: More Scripting Functions [Contents][Index]
• execute-refmac-real: | ||
• refmac-name: |
Next: refmac-name, Up: Execute Refmac [Contents][Index]
Where:
if swap_map_colours_post_refmac_flag is not 1 thenn imol_refmac_map is ignored.
Previous: execute-refmac-real, Up: Execute Refmac [Contents][Index]
Where imol is an integer number
the name for refmac
Returns: a stub name used in the construction of filename for refmac output
Next: Restraints Interface, Previous: Execute Refmac, Up: More Scripting Functions [Contents][Index]
• dictionaries-read: |
Up: Dictionary Functions [Contents][Index]
return a list of all the dictionaries read
Next: Atom Information functions, Previous: Dictionary Functions, Up: More Scripting Functions [Contents][Index]
• set-monomer-restraints: |
Up: Restraints Interface [Contents][Index]
Where:
set the monomer restraints of the given monomer_type
Returns: scheme false or true for success or failure to set the restrains for monomer_type
Next: Using S-expression molecules, Previous: Restraints Interface, Up: More Scripting Functions [Contents][Index]
Next: residue-name, Up: Atom Information functions [Contents][Index]
Where:
return the rename from a residue serial number
Returns: blank ("") on failure.
Next: serial-number-from-residue-specs, Previous: resname-from-serial-number, Up: Atom Information functions [Contents][Index]
Where:
return the residue name of the specified residue
Next: residue-info, Previous: residue-name, Up: Atom Information functions [Contents][Index]
Where:
return the serial number of the specified residue
Returns: -1 on failure to find the residue
Next: chain-fragments-scm, Previous: serial-number-from-residue-specs, Up: Atom Information functions [Contents][Index]
Where:
Return a list of atom info for each atom in the specified residue.
output is like this: (list (list (list atom-name alt-conf) (list occ temp-fact element) (list x y z)))
occ can be a single number or a list of seven numbers of which the first is the isotropic B.
Next: add-molecule, Previous: residue-info, Up: Atom Information functions [Contents][Index]
Where:
chain fragments
Next: clear-and-update-molecule, Previous: chain-fragments-scm, Up: Atom Information functions [Contents][Index]
Where:
generate a molecule from an s-expression
return a molecule number, -1 on error
Next: active-residue, Previous: add-molecule, Up: Atom Information functions [Contents][Index]
Where:
update a molecule from a s-expression
And going the other way, given an s-expression, update molecule_number by the given molecule. Clear what’s currently there first though.
Next: closest-atom-simple-scm, Previous: clear-and-update-molecule, Up: Atom Information functions [Contents][Index]
return specs of the atom close to screen centre
Return a list of (list imol chain-id resno ins-code atom-name alt-conf) for atom that is closest to the screen centre in any displayed molecule. If there are multiple models with the same coordinates at the screen centre, return the attributes of the atom in the highest number molecule number.
return scheme false if no active residue
Next: closest-atom, Previous: active-residue, Up: Atom Information functions [Contents][Index]
return the specs of the closest displayed atom
Return a list of (list imol chain-id resno ins-code atom-name alt-conf (list x y z)) for atom that is closest to the screen centre in the given molecule (unlike active-residue, potential CA substition is not performed). If there is no atom, or if imol is not a valid model molecule, return scheme false.
Next: closest-atom-raw-scm, Previous: closest-atom-simple-scm, Up: Atom Information functions [Contents][Index]
Where imol is an integer number
return the specs of the closest atom in imolth molecule
Return a list of (list imol chain-id resno ins-code atom-name alt-conf (list x y z)) for atom that is closest to the screen centre in the given molecule (unlike active-residue, no account is taken of the displayed state of the molecule). If there is no atom, or if imol is not a valid model molecule, return scheme false.
Next: residues-near-residue, Previous: closest-atom, Up: Atom Information functions [Contents][Index]
return the specs of the closest atom to the centre of the screen
Return a list of (list imol chain-id resno ins-code atom-name alt-conf (list x y z)) for atom that is closest to the screen for displayed molecules. If there is no atom, return scheme false. Don’t choose the CA of the residue if there is a CA in the residue of the closest atom. 201602015-PE: I add this now, but I have a feeling that I’ve done this before.
Next: residues-near-residues-scm, Previous: closest-atom-raw-scm, Up: Atom Information functions [Contents][Index]
Where:
return residues near residue
Return residue specs for residues that have atoms that are closer than radius Angstroems to any atom in the residue specified by res_in.
Next: residues-near-position-scm, Previous: residues-near-residue, Up: Atom Information functions [Contents][Index]
Where:
return residues near the given residues
Return residue specs for residues that have atoms that are closer than radius Angstroems to any atom in the residue specified by res_in.
Next: label-closest-atoms-in-neighbour-residues-scm, Previous: residues-near-residues-scm, Up: Atom Information functions [Contents][Index]
Where:
residues near residue
Return a list of pairs of (imol, residue_spec). pos is a list of 3 numbers. (get imol from active-atom)
Returns: residues within radius of pos (x,y,z) position
Next: hydrogenate-region, Previous: residues-near-position-scm, Up: Atom Information functions [Contents][Index]
Where:
label the closest atoms in the residues that neighbour residue_spec
Next: add-hydrogens-from-file, Previous: label-closest-atoms-in-neighbour-residues-scm, Up: Atom Information functions [Contents][Index]
Where radius is a number
find the active residue, find the near residues (within radius) create a new molecule, run reduce on that, import hydrogens from the result and apply them to the molecule of the active residue.
Next: atom-info-string-py, Previous: hydrogenate-region, Up: Atom Information functions [Contents][Index]
Where:
Add hydrogens to imol from the given pdb file.
Next: molecule-to-pdb-string-py, Previous: add-hydrogens-from-file, Up: Atom Information functions [Contents][Index]
Where:
output atom info in a python list for use in scripting:
in this format [occ, temp_factor, element, x, y, z]. Return empty list if atom not found.
Next: residue-info-py, Previous: atom-info-string-py, Up: Atom Information functions [Contents][Index]
Where imol is an integer number
Return the molecule as a PDB string.
Previous: molecule-to-pdb-string-py, Up: Atom Information functions [Contents][Index]
Where:
Return a list of atom info for each atom in the specified residue:
output is like this: [ [[atom-name,alt-conf] [occ,temp_fact,element] [x,y,z]]]
Next: Refinement with specs, Previous: Atom Information functions, Up: More Scripting Functions [Contents][Index]
Next: closest-atom-simple-py, Up: Using S-expression molecules [Contents][Index]
Return a list of [imol, chain-id, resno, ins-code, atom-name, alt-conf] for atom that is closest to the screen centre. If there are multiple models with the same coordinates at the screen centre, return the attributes of the atom in the highest number molecule number.
return False if no active residue
Next: closest-atom-py, Previous: active-residue-py, Up: Using S-expression molecules [Contents][Index]
return the spec of the closest displayed atom
Return a list of [imol, chain-id, resno, ins-code, atom-name, alt-conf, [x, y, z]] for atom that is closest to the screen centre in the given molecule (unlike active-residue, potential CA substition is not performed). If there is no atom, or if imol is not a valid model molecule, return False.
Next: closest-atom-raw-py, Previous: closest-atom-simple-py, Up: Using S-expression molecules [Contents][Index]
Where imol is an integer number
return closest atom in imolth molecule
Return a list of [imol, chain-id, resno, ins-code, atom-name, alt-conf, [x, y, z]] for atom that is closest to the screen centre in the given molecule (unlike active-residue, no account is taken of the displayed state of the molecule). If there is no atom, or if imol is not a valid model molecule, return False.
Next: residues-near-position-py, Previous: closest-atom-py, Up: Using S-expression molecules [Contents][Index]
return the specs of the closest atom to the centre of the screen
Return a list of (list imol chain-id resno ins-code atom-name alt-conf (list x y z)) for atom that is closest to the screen for displayed molecules. If there is no atom, return scheme false. Don’t choose the CA of the residue if there is a CA in the residue of the closest atom
Next: label-closest-atoms-in-neighbour-residues-py, Previous: closest-atom-raw-py, Up: Using S-expression molecules [Contents][Index]
Where:
Return residue specs for residues that have atoms that are closer than radius Angstroems to the given position.
Next: get-bonds-representation, Previous: residues-near-position-py, Up: Using S-expression molecules [Contents][Index]
Where:
label the closest atoms in the residues that neighbour residue_spec
Next: get-dictionary-radii, Previous: label-closest-atoms-in-neighbour-residues-py, Up: Using S-expression molecules [Contents][Index]
Where imol is an integer number
return a Python object for the bonds
Next: get-environment-distances-representation-py, Previous: get-bonds-representation, Up: Using S-expression molecules [Contents][Index]
return a Python object for the radii of the atoms in the dictionary
Next: get-intermediate-atoms-bonds-representation, Previous: get-dictionary-radii, Up: Using S-expression molecules [Contents][Index]
Where:
return a Python object for the representation of bump and hydrogen bonds of
Next: get-continue-updating-refinement-atoms-state, Previous: get-environment-distances-representation-py, Up: Using S-expression molecules [Contents][Index]
return a Python object for the intermediate atoms bonds
Previous: get-intermediate-atoms-bonds-representation, Up: Using S-expression molecules [Contents][Index]
return the continue-updating-refinement-atoms state
Next: Water Chain Functions, Previous: Using S-expression molecules, Up: More Scripting Functions [Contents][Index]
• all-residues-with-serial-numbers-scm: | ||
• regularize-residues: | ||
• mtz-file-name: | ||
• refine-zone-with-full-residue-spec-scm: |
Next: regularize-residues, Up: Refinement with specs [Contents][Index]
Where imol is an integer number
a utility to return the specs of all the residues, each spec prefixed by the serial number
Next: mtz-file-name, Previous: all-residues-with-serial-numbers-scm, Up: Refinement with specs [Contents][Index]
Where:
regularize the given residues
Next: refine-zone-with-full-residue-spec-scm, Previous: regularize-residues, Up: Refinement with specs [Contents][Index]
Where imol is an integer number
presumes that imol_Refinement_Map has been set
Previous: mtz-file-name, Up: Refinement with specs [Contents][Index]
Where:
Refine the given residue range.
Next: Glyco Tools, Previous: Refinement with specs, Up: More Scripting Functions [Contents][Index]
• water-chain-from-shelx-ins-scm: | ||
• water-chain-scm: | ||
• water-chain-py: |
Next: water-chain-scm, Up: Water Chain Functions [Contents][Index]
Where imol is an integer number
return the chain id of the water chain from a shelx molecule. Raw interface
Returns: scheme false if no chain or bad imol
Next: water-chain-py, Previous: water-chain-from-shelx-ins-scm, Up: Water Chain Functions [Contents][Index]
Where imol is an integer number
return the chain id of the water chain. Raw interface
Previous: water-chain-scm, Up: Water Chain Functions [Contents][Index]
Where imol is an integer number
return the chain id of the water chain. Raw interface
Next: Spin Search Functions, Previous: Water Chain Functions, Up: More Scripting Functions [Contents][Index]
• print-glyco-tree: |
Up: Glyco Tools [Contents][Index]
Where:
print the glycosylation tree that contains the specified residue
Next: Rotamer Scoring, Previous: Glyco Tools, Up: More Scripting Functions [Contents][Index]
• spin-search: | ||
• spin-N-scm: | ||
• CG-spin-search-scm: | ||
• spin-search-py: | ||
• spin-N-py: | ||
• CG-spin-search-py: |
Next: spin-N-scm, Up: Spin Search Functions [Contents][Index]
Where:
for the given residue, spin the atoms in moving_atom_list around the bond defined by direction_atoms_list looking for the best fit to density of imol_map map of the first atom in moving_atom_list. Works (only) with atoms in altconf ""
Next: CG-spin-search-scm, Previous: spin-search, Up: Spin Search Functions [Contents][Index]
Where:
Spin N and CB (and the rest of the side chain if extant)
Sometime on N-terminal addition, then N ends up pointing the wrong way. The allows us to (more or less) interchange the positions of the CB and the N. angle is in degrees.
Next: spin-search-py, Previous: spin-N-scm, Up: Spin Search Functions [Contents][Index]
Where:
Spin search the density based on possible positions of CG of a side-chain.
c.f. EM-Ringer
Next: spin-N-py, Previous: CG-spin-search-scm, Up: Spin Search Functions [Contents][Index]
Where:
for the given residue, spin the atoms in moving_atom_list...
around the bond defined by direction_atoms_list looking for the best fit to density of imom_map map of the first atom in moving_atom_list. Works (only) with atoms in altconf ""
Next: CG-spin-search-py, Previous: spin-search-py, Up: Spin Search Functions [Contents][Index]
Where:
Spin N and CB (and the rest of the side chain if extant)
Sometime on N-terminal addition, then N ends up pointing the wrong way. The allows us to (more or less) interchange the positions of the CB and the N. angle is in degrees.
Previous: spin-N-py, Up: Spin Search Functions [Contents][Index]
Where:
Spin search the density based on possible positions of CG of a side-chain.
Next: protein-db, Previous: Spin Search Functions, Up: More Scripting Functions [Contents][Index]
• score-rotamers-scm: |
Up: Rotamer Scoring [Contents][Index]
Where:
return the scores of the rotamers for this residue.
Next: Coot's Hole implementation, Previous: Rotamer Scoring, Up: More Scripting Functions [Contents][Index]
• protein-db-loops: |
Up: protein-db [Contents][Index]
Where:
Cowtan’s protein_db loops.
Next: Drag and Drop Functions, Previous: protein-db, Up: More Scripting Functions [Contents][Index]
• hole: | ||
• make-link: |
Next: make-link, Up: Coot's Hole implementation [Contents][Index]
Where:
starting piont and end point, colour map multiplier and shall the probe radius graph be shown (dummy value currently).
if export_dots_file_name string length is zero, then don’t try to export the surface dots.
Previous: hole, Up: Coot's Hole implementation [Contents][Index]
Where:
make a link between the specified atoms
Next: Map Contouring Functions, Previous: Coot's Hole implementation, Up: More Scripting Functions [Contents][Index]
• handle-drag-and-drop-string: |
Up: Drag and Drop Functions [Contents][Index]
Where uri is a const std::string &
handle the string that get when a file or URL is dropped.
Next: Map to Model Correlation, Previous: Drag and Drop Functions, Up: More Scripting Functions [Contents][Index]
• map-contours: |
Where:
return two lists: a list of vertices and a list of indices for connection
Next: Get Sequence, Previous: Map Contouring Functions, Up: More Scripting Functions [Contents][Index]
Next: map-to-model-correlation-scm, Up: Map to Model Correlation [Contents][Index]
Where r is a number
The atom radius is not passed as a parameter to correlation.
Next: map-to-model-correlation, Previous: set-map-correlation-atom-radius, Up: Map to Model Correlation [Contents][Index]
Where:
atom-mask-mode is as follows:
Next: map-to-model-correlation-stats, Previous: map-to-model-correlation-scm, Up: Map to Model Correlation [Contents][Index]
Where:
atom-mask-mode is as follows:
Next: map-to-model-correlation-per-residue, Previous: map-to-model-correlation, Up: Map to Model Correlation [Contents][Index]
Where:
map to model density correlation stats
atom-mask-mode is as follows:
Next: map-to-model-correlation-stats-per-residue, Previous: map-to-model-correlation-stats, Up: Map to Model Correlation [Contents][Index]
Where:
map to model density correlation, reported per residue
atom-mask-mode is as follows:
Next: map-to-model-correlation-per-residue-scm, Previous: map-to-model-correlation-per-residue, Up: Map to Model Correlation [Contents][Index]
Where:
map to model density statistics, reported per residue
Next: map-to-model-correlation-stats-per-residue-scm, Previous: map-to-model-correlation-stats-per-residue, Up: Map to Model Correlation [Contents][Index]
Where:
map to model correlation
Next: qq-plot-map-and-model-scm, Previous: map-to-model-correlation-per-residue-scm, Up: Map to Model Correlation [Contents][Index]
Where:
map to model stats
Next: density-score-residue, Previous: map-to-model-correlation-stats-per-residue-scm, Up: Map to Model Correlation [Contents][Index]
Where:
QQ plot of the model density correlation, reported per residue.
atom-mask-mode is as follows:
Next: map-mean-scm, Previous: qq-plot-map-and-model-scm, Up: Map to Model Correlation [Contents][Index]
Where:
simple density score for given residue (over-ridden by scripting function)
Next: map-statistics-scm, Previous: density-score-residue, Up: Map to Model Correlation [Contents][Index]
Where imol is an integer number
return sigma for the given map. Return scheme False if not a valid map molecule number.
Next: map-mean-py, Previous: map-mean-scm, Up: Map to Model Correlation [Contents][Index]
Where imol is an integer number
return either scheme false on non-a-map or list (mean, standard-deviation, skew, kurtosis)
Previous: map-statistics-scm, Up: Map to Model Correlation [Contents][Index]
Where imol is an integer number
return sigma for the given map. Return Python False if not a valid map molecule number.
Previous: Map to Model Correlation, Up: More Scripting Functions [Contents][Index]
• get-sequence-as-fasta-for-chain: | ||
• write-sequence: |
Next: write-sequence, Up: Get Sequence [Contents][Index]
Where:
get the sequence for chain_id in imol
Previous: get-sequence-as-fasta-for-chain, Up: Get Sequence [Contents][Index]
Where:
write the sequence for imol as fasta
Next: Scheme Scripting Functions, Previous: More Scripting Functions, Up: Top [Contents][Index]
• More Refinement Functions: |
Next: use-unimodal-ring-torsion-restraints-for-residue, Up: More Refinement Functions [Contents][Index]
Where res_name is a const std::string &
use unimodal ring torsion restraints (e.g. for carbohydrate pyranose)
Next: set-refinement-geman-mcclure-alpha, Previous: use-unimodal-ring-torsion-restraints, Up: More Refinement Functions [Contents][Index]
Where:
use unimodal ring torsion restraints (e.g. for carbohydrate pyranose)
Next: get-refinement-geman-mcclure-alpha, Previous: use-unimodal-ring-torsion-restraints-for-residue, Up: More Refinement Functions [Contents][Index]
Where alpha is a number
set the Geman-McClure distance alpha value (weight)
Next: set-refinement-lennard-jones-epsilon, Previous: set-refinement-geman-mcclure-alpha, Up: More Refinement Functions [Contents][Index]
get the Geman-McClure distance alpha value (weight)
Next: set-log-cosh-target-distance-scale-factor, Previous: get-refinement-geman-mcclure-alpha, Up: More Refinement Functions [Contents][Index]
Where epsilon is a number
set the Lennard Jones epsilon parameter
Next: crankshaft-peptide-rotation-optimization-scm, Previous: set-refinement-lennard-jones-epsilon, Up: More Refinement Functions [Contents][Index]
Where sf is a number
set the log cosh scale factor for target position restraints
Next: crankshaft-peptide-rotation-optimization-py, Previous: set-log-cosh-target-distance-scale-factor, Up: More Refinement Functions [Contents][Index]
Where:
Apply crankshaft peptide rotation optimization to the specified residue.
Previous: crankshaft-peptide-rotation-optimization-scm, Up: More Refinement Functions [Contents][Index]
Where:
Apply crankshaft peptide rotation optimization to the specified residue.
Next: Concept Index, Previous: More Refinement Scripting Functions, Up: Top [Contents][Index]
• shelx: | ||
• run-mogul: | ||
• remote-control: | ||
• tips: | ||
• refmac: | ||
• refmac-problems: | ||
• redefine-functions: | ||
• tips-gui: | ||
• raster3d-from-scheme: | ||
• quat-convert: | ||
• gui-prosmart: | ||
• mutate-from-scheme: | ||
• parse-pisa-xml: | ||
• add-linked-cho: | ||
• ncs: | ||
• acedrg-link: | ||
• ligand-check: | ||
• what-check: | ||
• user-define-restraints: | ||
• jligand-gui: | ||
• gui-ligand-sliders: | ||
• snarf-coot-docs: | ||
• mutate-in-scheme: | ||
• entry+do-button: | ||
• dictionary-generators: | ||
• extra-top-level: | ||
• coot-lsq: | ||
• get-ebi: | ||
• coot-gui: | ||
• hello: | ||
• coot-crash-catcher: | ||
• coot-utils: | ||
• contact-score-isolated-ligand: | ||
• libcheck: | ||
• cns2coot: | ||
• clear-backup: | ||
• generic-objects: | ||
• exercise-scm-mol: | ||
• check-for-updates: | ||
• brute-lsqman: | ||
• fitting: | ||
• group-settings: | ||
• background-demo: | ||
• americanisms: | ||
• filter: | ||
• a-rapper-gui: | ||
• fascinating-things: | ||
• get-recent-pdbe: | ||
• 3d-generator-import: | ||
• coot: | ||
• jligand: |
Next: run-mogul, Up: Scheme Scripting Functions [Contents][Index]
hkl-file-in can be null ’() or (list astring).
ie. create a interesting-things GUI for split (and other things?) in a shelx .lst file.
Next: remote-control, Previous: shelx, Up: Scheme Scripting Functions [Contents][Index]
prefix-str can be blank
return: a string that is the mogul-out file-name a symbol: something went wrong
return a string that is the mogul results file name that gets parsed to make results (return #f on failure) mode is ’all or ’bonds-and-angles
Next: tips, Previous: run-mogul, Up: Scheme Scripting Functions [Contents][Index]
a place-holder for the coot listener socket
Open a coot listener socket, return nothing much, but do set! %coot-listener-socket.
Hmmm... why make a side-effect like that? Why not return %coot-listener-socket so that the caller can set it? There may be a reason...
And the reason is that I can then call coot-listener-idle-function-proc without having to use a c++ variable.
yet another go to make a coot port reader work. This time, we use a gtk-timer to read stuff from the socket.
The gtk-timer function must return 1 to be called again. When we want to close the socket reader, simply make the function return 0.
based on coot-listener-idle-function-proc
Do this thing when idle
currently set to listen to the %coot-listener-socket
the function to run from the main thread to evaluate a string:
Next: refmac, Previous: remote-control, Up: Scheme Scripting Functions [Contents][Index]
a list of tips for Coot
Function to turn off coot tips at start
Next: refmac-problems, Previous: tips, Up: Scheme Scripting Functions [Contents][Index]
This is the default refmac version, it is presumed to be in the path. It can be overridden using a re-definition either at the scripting interface or in one’s ~/.coot file. E.g.: (define refmac-exec "/y/programs/xtal/refmac-latest/bin/refmac5-3-dec-2004")
Set this to a list of parameter strings:
If refmac-extra-params is a list of strings, it is used in preference to the "refmac-extra-params" file (should it exist). e.g. (set! refmac-extra-params (list "WEIGHT 0.2" "NCYC 10" "REFI BREF ISO" "REFI METH CGMAT" "REFI TYPE REST RESO 20 1.64"))
Return #t if the list of strings params-list contains a string beginning with "WEIGHT". If not return #f
If refmac-extra-params is defined (as a list of strings), then return that, else read the file "refmac-extra-params".
Return a list a list of strings.
this is not run as a sub-thread, no useful return value.
Next: redefine-functions, Previous: refmac, Up: Scheme Scripting Functions [Contents][Index]
The gui for the refmac problems
Next: tips-gui, Previous: refmac-problems, Up: Scheme Scripting Functions [Contents][Index]
scm aliases.
fix typo of set-find-hydrogen-torsions (backward compatibility in case anyone was using that)
(define residue->sdf-file residue-to-sdf-file)
I changed the function name - save those (just a few) with scripts that I’ve handed out
Next: raster3d-from-scheme, Previous: redefine-functions, Up: Scheme Scripting Functions [Contents][Index]
given a number and a gtk text widget text, put tip number n into the widget.
increment the tip number when the user sees a tip
decrement the tip number when the user sees a tip
run the tips gui.
Next: quat-convert, Previous: tips-gui, Up: Scheme Scripting Functions [Contents][Index]
run raster3d
Run either raster3d or povray
Next: gui-prosmart, Previous: raster3d-from-scheme, Up: Scheme Scripting Functions [Contents][Index]
convert a view matrix to a view quaternion to set Coot view internals.
Set the view matrix
Next: mutate-from-scheme, Previous: quat-convert, Up: Scheme Scripting Functions [Contents][Index]
target is my molecule, ref is the homologous (high-res) model
Next: parse-pisa-xml, Previous: gui-prosmart, Up: Scheme Scripting Functions [Contents][Index]
this should negate the need for Bill’s patch here.
args not including the output filename
Run provray using current displayed image and write .pov file to default filename
Next: add-linked-cho, Previous: mutate-from-scheme, Up: Scheme Scripting Functions [Contents][Index]
(define *pisa-command* "/home/paule/ccp4/ccp4-6.1.2/bin/pisa")
it calls parse-pisa-assemblies which does the work
a interface-molecule record contains information about pvalue and residues.
—————————————————- pisa assemblies: —————————————————-
pisa_results name status total_asm asm_set ser_no assembly id size mmsize diss_energy asa bas entropy diss_area int_energy n_uc n_diss symNumber molecule chain_id rxx rxy rxz tx ryx ryy ryz ty rzx rzy rzz tz rxx-f rxy-f rxz-f tx-f ryx-f ryy-f ryz-f ty-f rzx-f rzy-f rzz-f tz-f
20100213 prep-for-pisa needs to make directory, config file, write the pdb file and thre return value should be #f if there was a problem or some value where we can check that pisa -analyse ran (probably a directory). It is not clear right now where the output is going. config files has PISA_WORK_ROOT coot-pisa but things seems to be written to DATA_ROOT /home/emsley/ccp4/ccp4-6.1.3/share/pisa which seems like a bug (or something like it) in pisa. Needs rechecking.
needs fleshing out (see notes for prep-for-pisa).
pdb_entry pdb_code status n_interfaces interface id type n_occ int_area int_solv_en pvalue stab_en css overlap x-rel fixed h-bonds n_bonds bond chain-1 res-1 seqnum-1 inscode-1 atname-1 chain-2 res-2 seqnum-2 inscode-2 atname-2 dist salt-bridges n-bonds bond chain-1 res-1 seqnum-1 inscode-1 atname-1 chain-2 res-2 seqnum-2 inscode-2 atname-2 dist ss-bonds n-bonds bond chain-1 res-1 seqnum-1 inscode-1 atname-1 chain-2 res-2 seqnum-2 inscode-2 atname-2 dist cov-bonds n-bonds bond chain-1 res-1 seqnum-1 inscode-1 atname-1 chain-2 res-2 seqnum-2 inscode-2 atname-2 dist molecule id chain_id class symop symop_no cell_i cell_j cell_k rxx rxy rxz tx ryx ryy ryz ty rzx rzy rzz tz int_natoms int_nres int_area int_solv_en pvalue residues residue ser_no name seq_num ins_code bonds asa bsa solv_en
Next: ncs, Previous: parse-pisa-xml, Up: Scheme Scripting Functions [Contents][Index]
return the new molecule number
complex mammal bianntennary mammal
complex plant plant bianntennary
now users can set this
Next: acedrg-link, Previous: add-linked-cho, Up: Scheme Scripting Functions [Contents][Index]
Skip the residue in the next chain (typically of a molecule with NCS) with the same residue number. If on the last chain, then wrap to beginning. If it can’t find anything then don’t move (and put a message in the status bar)
We can only see one peer at a time with this (each time we do a clear-ncs-ghost-matrices).
chain-id-list is (list "A" "B" "C" "D")), i.e. the reference/target/master chain-id first and then the peers. This allows us to add many peers at the same time (unlike above function).
Update NCS ghosts based on local environment (residues within 6A of (and including) the active residue).
Typically one would bind this function to a key.
Return the first master chain id (usually there is only one of course) or #f.
This was designed to create an NCS copy of a ligand (or range of residues) in the active site of one chain to the as yet unoccupied active site of another, i.e. it makes a NCS ligand "D"1 that is a NCS copy of ligand "C"1 using an NCS operator that maps protein chain "A" onto chain "B".
Next: ligand-check, Previous: ncs, Up: Scheme Scripting Functions [Contents][Index]
return the new file name
Next: what-check, Previous: acedrg-link, Up: Scheme Scripting Functions [Contents][Index]
test: (using-active-atom (get-metrics-for-ligand aa-imol aa-chain-id aa-res-no aa-ins-code "rnasa-1.8-all_refmac1.mtz" "FGMP18" "SIGFGMP18" "FreeR_flag" "coot-refmac"))
refmac-dir: the dir where input/output refmac files should be written.
return (list correlation mogul bumps difference-map-stats b-factor-info) where: mogul is an improper pair (mogul-z-worst . mogul-out-file-name) or an error status difference-map-stats: the output of map-to-model-correlation-stats-scm (list correlation var_x var_y n sum_x sum_y D D2 (based on mean/sd of the map at the ligand) map_mean map_mean_at_ligand map_sd map_sd_at_ligand SCM_UNDEFINED) and b-factor-info list of (median-ratio median-ligand median-env ks-test-result)
only look at ligands in maps with resolution worse than this: (to look at everything, set it to 0.1)
remove residues that are waters from env-residues
Next: user-define-restraints, Previous: ligand-check, Up: Scheme Scripting Functions [Contents][Index]
" 53" -> "53", " " -> ""
consider for coot-utils
consider for coot-utils
make this internal
where line is something like " 53 HIS ( 53 ) A12" ignore xxxxI Cyy xxxx is 4char resno, I insertion code, C chain id, yy is model number
return a residue spec, or #f
A problemed-res-list is improper pair where the car is a pair of string, one describing the problem, and the other being the "fix it" button label. The cdr is a list of residue specs.
A problemed-flip-list-list is a list of those things.
action is either ’gui (then we get a gui) or ’apply-actions, then the model modifications are automatically applied.
Next: jligand-gui, Previous: what-check, Up: Scheme Scripting Functions [Contents][Index]
spec-1 and spec-2 are 7-element atom-specs
Example of a stack restraint: "exte stac plan 1 firs resi 99 chai A atoms substitute-open-brace CB CG CD1 CD2 CE1 CE2 CZ OH substitute-close-brace plan 2 firs resi 61 chai B atoms substitute-open-brace CB CG CD1 CD2 CE1 CE2 CZ substitute-close-brace dist 3.4 sddi 0.2 sdan 6.0 type 1"
Next: gui-ligand-sliders, Previous: user-define-restraints, Up: Scheme Scripting Functions [Contents][Index]
This happens when user clicks on the "Launch JLigand" button. It starts a jligand and puts it in the background.
This happens when user clicks on the "Select Residues for JLigand" (or some such) button. It expects the user to click on atoms of the two residues involved in the link.
Next: snarf-coot-docs, Previous: jligand-gui, Up: Scheme Scripting Functions [Contents][Index]
return 3 values
Next: mutate-in-scheme, Previous: gui-ligand-sliders, Up: Scheme Scripting Functions [Contents][Index]
remove any trailing /s
return the file component of file-name "x/y" -> "y" "x" -> "x"
prepend the files with the directory dir
(note that the args are reversed to "natural" order (which is the reverse of glob args)
return a list of file names that match pattern pat in directory dir.
"a.b.res" -> "a.b" file-name-sans-extension
Return #t or #f:
Where cmd is e.g. "refmac" args is (list "HKLIN" "thing.mtz") log-file-name is "refmac.log" data-list is (list "HEAD" "END")
Return the exist status e.g. 0 or 1.
Return the strings screen output of cmd or #f if command was not found
Return a list if str is a string, else return ’()
The following functions from PLEAC (guile version thereof of course).
or define a utility function for this
Next: entry+do-button, Previous: snarf-coot-docs, Up: Scheme Scripting Functions [Contents][Index]
Mutate chain-id of molecule number imol given sequence. This presumes a protein sequence.
The number of residues in chain-id must match the length of sequence.
An internal function of mutate. This presumes a protein sequence.
The stop-res-no is inclusive, so usage e.g. (mutate-residue-range 0 "A" 1 2 "AC")
This presumes a protein sequence (not nucleic acid).
mutate and auto fit a residue range.
This presumes a protein sequence (not nucleic acid).
The sequence is a string of one letter codes
mutate and autofit whole chain
This presumes a protein sequence (not nucleic acid).
a short-hand for mutate-and-auto-fit
return a char, return #\A for unknown residue-type
a wrapper for mutate-single-residue-by-seqno (which uses slightly inconvenient single letter code)
Here residue-type is the 3-letter code
Delete (back to the CB stub) the side change in the range resno-start to resno-end
Next: dictionary-generators, Previous: mutate-in-scheme, Up: Scheme Scripting Functions [Contents][Index]
test that function:
test that function:
Next: extra-top-level, Previous: entry+do-button, Up: Scheme Scripting Functions [Contents][Index]
return a molecule number. Return -1 on fail.
Next: coot-lsq, Previous: dictionary-generators, Up: Scheme Scripting Functions [Contents][Index]
This is what to do when the button is pressed. It can be any guile or coot function.
define a simple window and put a button in it
Next: get-ebi, Previous: extra-top-level, Up: Scheme Scripting Functions [Contents][Index]
Internal type conversion for LSQ fitting. Return a number according to the symbol match-type-in
Create matchers, 7 elements: (list ref-start-resno ref-end-resno ref-chain-id imol-ref mov-start-resno mov-end-resno mov-chain-id imol-mov match-type)
The scripting interface to LSQ matching. Pass molecule numbers for the reference (imol-ref) and moving (imol-moving) molecules and a match list. The match list format is described in the manual.
Simple interface to LSQ fitting. More often than not this is what you will want, I imagine, e.g. (simple-lsq-match 940 950 "A" 0 940 950 "A" 1 ’main)
Next: coot-gui, Previous: coot-lsq, Up: Scheme Scripting Functions [Contents][Index]
return 0 on success
check the directory and get url url-string.
get url-string for data type ’pdb or ’sfs
Return a molecule number on success or not a number (#f) or -1 on error.
Return a list of molecules (i.e. the model molecule and the 2 maps).
or, if it didn’t work then return #f
Next: hello, Previous: get-ebi, Up: Scheme Scripting Functions [Contents][Index]
Fire up the coot scripting gui. This function is called from the main C++ code of coot. Not much use if you don’t have a gui to type functions in to start with.
The callback from pressing the Go button in the smiles widget, an interface to run libcheck.
smiles GUI
Generic single entry widget
Pass the hint labels of the entries and a function that gets called when user hits "Go". The handle-go-function accepts one argument that is the entry text when the go button is pressed.
handle-go-function takes 3 arguments, the third of which is the state of the check button.
if check-button-label not a string, then we don’t display (or create, even) the check-button. If it *is* a string, create a check button and add the callback handle-check-button-function which takes as an argument the active-state of the the checkbutton.
generic double entry widget, now with a check button
OLD:
pass a the hint labels of the entries and a function (handle-go-function) that gets called when user hits "Go" (which takes two string aguments and the active-state of the check button (either #t of #f).
if check-button-label not a string, then we don’t display (or create, even) the check-button. If it *is* a string, create a check button and add the callback handle-check-button-function which takes as an argument the active-state of the the checkbutton.
A demo gui to move about to molecules.
old coot test
We can either go to a place (in which case the element is a list of button label (string) and 3 numbers that represent the x y z coordinates) or an atom (in which case the element is a list of a button label (string) followed by the molecule-number chain-id residue-number ins-code atom-name altconf)
e.g. (interesting-things-gui "Bad things by Analysis X" (list (list "Bad Chiral" 0 "A" 23 "" "CA" "A") (list "Bad Density Fit" 0 "B" 65 "" "CA" "") (list "Interesting blob" 45.6 46.7 87.5)))
In this case, each baddie can have a function at the end which is called when the fix button is clicked.
Fill an option menu with the "right type" of molecules. If filter-function returns #t then add it. Typical value of filter-function is valid-model-molecule?
Helper function for molecule chooser. Not really for users.
Return a list of models, corresponding to the menu items of the option menu.
The returned list will not contain references to map or closed molecules.
Helper function for molecule chooser. Not really for users.
return the molecule number of the active item in the option menu, or return #f if there was a problem (e.g. closed molecule)
Here we return the active item in an option menu of generic items
Typically option-menu-fill-function is fill-option-menu-with-coordinates-mol-options
Fire up a coordinates/model molecule chooser dialog, with a given label and on OK we call the call-back-fuction with an argument of the chosen molecule number.
chooser-label is a directive to the user such as "Choose a Molecule"
callback-function is a function that takes a molecule number as an argument.
Fire up a map molecule chooser dialog, with a given label and on OK we call the call-back-fuction with an argument of the chosen molecule number.
chooser-label is a directive to the user such as "Choose a Molecule"
callback-function is a function that takes a molecule number as an argument.
if always-dismiss-on-ok-clicked? is false then the dialog is not dismissed if callback-function returns #f.
as above, plus we also have a check-button and an additional argument in the callback If check-button-label is false, then don’t create a check-button.
Create a window.
Return a pair of widgets, a molecule chooser and an entry. callback-function is a function that takes a molecule number and a file-name
chooser-filter is typically valid-map-molecule? or valid-model-molecule?
If a menu with label menu-label is not found in the coot main menubar, then create it and return it. If it does exist, simply return it.
Given that we have a menu (e.g. one called "Extensions") provide a cleaner interface to adding something to it:
activate-function is a thunk.
Make an interesting things GUI for residues with missing atoms
button-list is a list of pairs (improper list) the first item of which is the button label text the second item is a lambda function, what to do when the button is pressed.
Generic interesting things gui: user passes a function that takes 4 args: the chain-id, resno, inscode and residue-serial-number (should it be needed) and returns either #f or something interesting (e.g. a label/value). It is the residue-test-func of the residue-matching-criteria function.
A gui that makes a generic number chooser the go function is a lambda function that takes the value of the active menu item - as a number.
pack a hint text and a molecule chooser option menu into the given vbox.
return the option-menu and model molecule list:
Return an entry, the widget is inserted into the hbox passed to this function.
Cootaneer gui
The gui for saving views
If check-button-label is #f, don’t make one, otherwise create with with the given label and "on" state.
geometry is an improper list of ints buttons is a list of: (list (list button-1-label button-1-action button-2-label button-2-action)) The button-1-action function takes as an argument the imol The button-2-action function takes as an argument the imol
A gui showing views:
nudge screen centre box. Useful when Ctrl left-mouse has been taken over by another function.
A gui to make a difference map (from arbitrarily gridded maps (that’s it’s advantage))
A GUI to display all the CIS peptides and navigate to them.
Associate the contents of a PIR file with a molecule. Select file from a GUI.
Make a box-of-buttons GUI for the various modifications that need to be made to match the model sequence to the assigned sequence(s).
Call this when the associated sequence(s) have been read in already.
Wrapper in that we test if there have been sequence(s) assigned to imol before we look for the sequence mismatches
Use clustalw to do the alignment. Then mutate using that alignement.
(Notice that we are not dealing with insertion codes).
USER MODS gui
simple rename residue GUI
close-button
interface to the difference-map based pepflip finder
return a list, or #f (e.g. if not in same chain and molecule)
by default, rename loop residues to UNK. If scheme true, then leave them as the residue names found in the database.
Next: coot-crash-catcher, Previous: coot-gui, Up: Scheme Scripting Functions [Contents][Index]
Primarily for Indian Names.
Say we are given str: (list "M." "D." "Albert" "Dorkins"). We want to return ""Albert" not "M.") We reject names that are one character long and names that are 2 characters long that end in ".". So, "M." is rejected, but "Ma" is not.
An excercise for the committed is to also reject run-together dotted initials such as "D.K.". I was sufficiently committed.
Next: coot-utils, Previous: hello, Up: Scheme Scripting Functions [Contents][Index]
Basic scheme function, filter the objects in list ls by function fn. e.g. (filter even? (list 0 1 2 3) -> ’(0 2)
simple scheme functions to concat the strings in ls (ls must contain only strings)
The following functions from PLEAC (guile version thereof of course).
or define a utility function for this
return a list of file names that match pattern pat in directory dir.
Return the strings screen output of cmd (reversed) or #f if command was not found
Return #t or #f:
Return a list if str is a string, else return ’()
code from thi <ttn at mingle.glug.org>
run command and put the output into a string and return
it. (c.f. run-command/strings
)
return #f or list of strings
gui
Next: contact-score-isolated-ligand, Previous: coot-crash-catcher, Up: Scheme Scripting Functions [Contents][Index]
3D annotations - a bit of a hack currently
used in Extensions -> Representation -> Ball & Stick
rigid body refine using residue ranges. Takes 2 arguments, the
first is the molecule number, the second is a list of
residue-ranges. A residue range is
(list chain-id resno-start resno-end)
.
add terminal residue is the normal thing we do with an aligned sequence, but also we can try ton find the residue type of a residue in the middle of the chain that is modelled as an ALA, say.
not tail-recursive
make the directory and return the directory name. If you cant make it directly in this directory try to make it in $HOME. Return #f if complete failure. e.g. coot-ccp4 or coot-backup
schemify function
out-file-name has been written, in-file-name needs to be read.
do something based on the active residue (presumably)
Return a boolean
Return a list of molecule numbers (closed and open) The elements of the returned list need to be tested against is-valid-model-molecule?
c.f. graphics_info_t::undisplay_all_model_molecules_except(int imol)
is isn’t quite because one of the options is "all"
first n fields of ls. if length ls is less than n, return ls. if ls is not a list, return ls. If n is negative, return ls.
Test for prefix-dir (1) being a string (2) existing (3) being a directory (4) modifiable by user (ie. u+rwx). prefix-dir must be a string.
Return #t or #f.
return an absolute file-name for file-name or #f
return the directory component of file-name, leave "/" on, if it’s there. Note "x", "", "/" -> ""
return the file component of file-name "x/y" -> "y" "x" -> "x"
return #f on no-such-file
Convert a residue-spec to an mmdb atom selection string.
residue-info atom
residue-info atom
residue-info atom
residue-info atom
residue-info atom needs other parameters to make a spec for an atom
residue spec (e.g. from residue-near-residue)
for sorting residue specs
Return a list of molecules that are maps
Return a list of molecules that are maps
Return #t (#f) if imol is (isn’t) a shelx molecule.
Set the virtual trackball behaviour.
trackball type is a symbol: either ’flat or ’spherical-surface.
Is ls a list of strings? Return #t or #f
(coot-replace-string "one two three" " " "_") -> "one_two_three"
string concat with spaces, ls must be a list of strings.
The screen centre.
return the rotation centre as a 3 membered list of numbers
Make list of integers, a to b: eg (number-list 2 5) -> (2 3 4 5)
ls must be a list of strings, atom must be a string.
return either #t or #f.
range: works like the eponymous python function e.g. (range 3) -> ’(0, 1, 2) e.g. (range 1 3) -> ’(1, 2)
code from thi <ttn at mingle.glug.org>
run command and put the output into a string and return
it. (c.f. run-command/strings
)
run cmd putting output to file-name and reading commands data from the list of strings data-list.
Is the command f in the path? return #t or #f.
Thank you for this, rixed at happyleptic.org
Return #t or #f
Where cmd is e.g. "refmac" args is (list "HKLIN" "thing.mtz") log-file-name is "refmac.log" data-list is (list "HEAD" "END")
Return the exist status e.g. 0 or 1.
run commands from an input file.
Return the strings screen output of cmd or #f if command was not found
Crude test to see of 2 floats are the same (more or less). Used in a greg test after setting the atom position.
if passed a string, return a string with no spaces, else return #f.
" 53" -> "53", " " -> ""
Append strings with tag-str between them
"a.b.res" -> "a.b" file-name-sans-extension
What is the extension of file-name?
"a.pdb" -> "pdb" "" -> ""
e.g. "a.pdb" -> "a-tmp.pdb"
Same function as strip-extension, different name, as per scsh, in fact.
/a/b.t -> b.t d/e.ext -> e.ext file-name-sans-path
does s start with a "/" ? return #t or #f
simple scheme functions to concat the strings in ls (ls must contain only strings)
return a string that contains the date/time e.g. "2006-01-02_2216.03"
return a list that has only every-nth members;
e.g. (every-nth '(0 1 2 3 4 5 6 7 8) 2)
-> ’(0 2 3 6 8)
(every-nth '(0 1 2 3 4 5 6 7 8) 3)
-> ’(0 3 6)
n must be positive
now useful in testing
residue-atoms must be a list
Return an atom info or #f (if atom not found).
multi-read-pdb reads all the files matching
glob-pattern
in
directory dir
. Typical usage of this might be:
(multi-read-pdb "a*.pdb" ".")
read-pdb-all reads all the "*.pdb" files in the current directory.
Return a list if str is a string, else return ’()
In a laughable attempt to minimise system dependence.
Similarly attempting to minimise system dependence.
the first elements are directories, the last is the file name c.f. os.path.join
remove any trailing /s
return #t or #f depending on if file-name (which must be a string) is a directory.
return the dir-name on success.
return #f if dir-name is a file or we can’t do the mkdir.
The following functions from PLEAC (guile version thereof of course).
Return: a list of files in the given directory
return a list of file names that match pattern pat in directory dir.
prepend the files with the directory dir
(note that the args are reversed to "natural" order (which is the reverse of glob args)
return the view matrix (useful for molscript, perhaps).
return the view quaternion
Return the view number
Convert a view matrix to a view quaternion to set Coot view internals.
Set the view matrix using matrix->quaternion.
Useful for using a view matrix from another program, perhaps.
Return the molecule centre as a list of 3 numbers.
Note: mol-cen could contain values less than -9999.
Move the centre of molecule number imol to the current screen centre
This is a short name for the above.
this is an americanism
Return a nine-membered list of numbers.
e.g. (translation ’x 2) -> ’(2 0 0) Return: "scheme false" on error
Rotate degrees about screen axis, where axis is either ’x, ’y or ’z.
Support for old toggle functions. (consider instead the raw functions use the direct set_displayed functions).
toggle the display of imol
toggle the active state (clickability) of imol
return a scheme representation of molecule imol, or #f if we can’t do it (imol is a map, say).
reorder chains
transform a coordinates molecule by a coot-rtop (which is a SCM expression of a clipper::RTop), i.e. a list of a 9-element list and a 3 element list. e.g. (list (list 1 0 0 0 1 0 0 0 1) (list 4.5 0.4 1.2)).
(transform-map imol mat trans about-pt radius space-group cell)
where space-group is a HM-symbol and cell is a list of 6 parameters, where the cell angles are in degrees.
or (transform-map imol trans about-pt radius)
for a simple translation
or (transform-map imol trans radius)
when using the default
rotation-centre as the about-pt
return the NCS master of the first molecule that has NCS.
return "" on fail to find an ncs chain
Remember, that now the about-pt is the "to" point, i.e. the maps are brought from somewhere else and generated about the about-pt.
Make the imol-th map brighter.
Make all maps brighter
Make all maps darker.
Return a list of chain ids for given molecule number imol. return empty list on error
convert from interface name to schemish name
Return #t or #f.
schemey interface to eponymous scripting interface function. Return scheme true or false
schemey interface to eponymous scripting interface function. Return scheme true or false.
Return #t or #f
schemey interface to shelx molecule test
Return #t or #f.
Return #t or #f.
Does residue resno with insertion code ins-code of chain chain-id and in molecule number imol exist?
Return #t or #f.
Does the residue contain hetatoms? Return #t or #f.
Return as a list the occupancy temperature-factor element x y z coordinates of the given atom. (the x,y,z are in Cartesian Angstroms).
on error (e.g. atom not found) return #f
return a guess at the map to be refined (usually called after imol-refinement-map returns -1)
Ian Tickle says (as far as I can understand) that the target rmsd should be 0.25 or thereabouts. You can over-ride it now.
Set the refinement weight (matrix) by iterating the refinement and varying the weight until the chi squares (not including the non-bonded terms) reach 1.0 =/- 10%. It uses sphere refinement. The refinement map must be set. At the end show the new weight in the status bar. Seems to take about 5 rounds.
Print the sequence of molecule number imol
This is not really a util, perhaps it should be somewhere else?
simple utility function to return the contents of a file as a string.
Associate the contents of a PIR file with a molecule.
comma key hook
dot key hook
a list of (code key name thunk) e.g. ’(103 "g" "Goto Blob" (blob-under-pointer-to-screen-centre))
Add a key binding
with a given name, key (e.g. "x" or "S") and the function to run (a thunk) when that key is pressed.
general key press hook, not for public use.
Function requested by Mark White.
read XtalView (and maybe other) .vu files and convert them into generic objects.
Pass the filename and an object name e.g. (read-vu-file "axes.vu" "axes")
Returns: nothing interesting.
Return a list of residues, each of which has a return value at the start, ie. (list return-value chain-id res-no ins-code)
Return a list of all the residues in the chain
Return a list of all residues that have alt confs: where a residue is specified thusly: (list chain-id resno ins-code)
Return a list of all the altconfs in the residue. Typically this will return (list "") or (list "A" "B")
extraction function
extraction function
extraction function
extraction function
extraction function
simple extraction function
simple extraction function
simple extraction function
Return #f if no atom can be found given the spec else return a list consisting of the atom name and alt-conf specifier.
Choose an atom that is called " CA ". Failing that choose the first atom.
Typically one might want to use this on a water, but it deletes the nearest CA currently... Needs a re-think. Should active-atom just return the nearest atom and not be clever about returning a CA.
change chain ids with residue range for the PTY
A bit of fun
A function for Overlaying ligands. The transformation is applied to all the atoms of the molecule that contains the moving ligand.
Resets alt confs and occupancies of atoms in residue that have orphan alt-loc attributes.
Resets alt confs and occupancies of atoms in residue that have orphan alt-loc attributes. Use the active-residue.
multiple maps of varying colour from a given map.
simple enumeration
hilight-colour is specified in degrees (round the colour wheel - starting at yellow (e.g. 230 is purple))
To paraphrase: The distance of the plane of the base to the following phosphate is highly correlated to the pucker of the ribose.
An analysis of the structures in RNADB2005 shows that a critical distance of 3.3A provides a partition function to separate C2’ from C3’ endo puckering. Not all ribose follow this rule. There may be some errors in the models comprising RNADB2005. So we check the distance of the following phosphate to the plane of the ribose and record the riboses that are inconsitent. We also report puckers that are not C2’ or C3’. The puckers are determined by the most out-of-plane atom of the ribose (the rms deviation of the 4 atoms in the plane is calculated, but not used to determine the puckering atom).
if you don’t have mogul, set this to #f
Generate restraints from the residue at the centre of the screen using PRODRG. Delete hydrogens from the residue because PRODRG has anomalous hydrogens.
Here we construct the url that contains the latest (pre) release info adding in "pre-release" if this binary is a pre-release. args ends up as something like: ("-s" "xxx/phone-home.scm" "pre-release" "binary" "Linux-1386-fedora-10-python-gtk2" "command-line" "/home/xx/coot/bin/coot")
Get the binary (i.e. the action that happens when the download button is pressed). This is run in a thread, so it can’t do any graphics stuff.
return #t if tar file was successfully downloaded and untared and #f if not.
(used in downloading new version)
e.g. input: "coot-0.6.2-pre-1-revision-2765\n" output: "coot-0.6.2-pre-1-revision-2765"
In the first case the sequence is assigned to the closest match (model sequence to target sequence), subsequently only chains without a sequence associated with them are candidates for matching. The protein sequence has to have at least 95% sequence identity with the target sequence in "default.seq"
not really for public manipulation.
keep a copy of the old directories around in a directory named after expiration time.
This should almost all be c++ code so that Bernie doesn’t have to redo it. This is temporary then.
return a string "DB00xxxx.mol" or some such - this is the file name of the mdl mol file from drugbank. Or #f/undefined on fail. Test result with string?.
If you are debugging this function, you probably want to be looking at handle-rev-string or drugbox->drugitem.
to determine if we have pygtk
Next: libcheck, Previous: coot-utils, Up: Scheme Scripting Functions [Contents][Index]
This will hydrogenate the active residue, not imol
Next: cns2coot, Previous: contact-score-isolated-ligand, Up: Scheme Scripting Functions [Contents][Index]
this is override-able by the user in their .coot file (for example).
Return -2 on code is not a string
Return -3 on libcheck failure
Return imol on success
Return handle-read-draw-molecule
error code on failure to
read resultant pdb file
Actually, it would be nice to know if this code represented a full description - or a minimal one... perhaps we can parse the log file and call a pop-up that will tell us.
dict-cif-libin should be a string. If it is "" then it is ignored. If it is not "" then it is used to create input to libcheck (not a command line argument) so that bespoke dictionary libraries can produce coords using "Get Monomer".
Next: clear-backup, Previous: libcheck, Up: Scheme Scripting Functions [Contents][Index]
Read in cns coeff-data (given filenames) and a pdb molecule filename to make maps.
Next: generic-objects, Previous: cns2coot, Up: Scheme Scripting Functions [Contents][Index]
Return #t or #f depending on if the GUI dialog was shown (it isn’t show if there are no files to delete).
Return a status, #f or #t, did the GUI run?
Note that clear-backup-gui returns either #t or #f too.
If this function returns #f, then coot_real_exit() just exits with coot_real_exit(). Otherwise we wait for the GUI.
Next: exercise-scm-mol, Previous: clear-backup, Up: Scheme Scripting Functions [Contents][Index]
map to scheme names:
map to scheme names:
return a new generic object number for the given object obj-name. If there is no such object with name obj-name, then create a new one. (Maybe you want the generic object to be cleaned if it exists before returning, this function does not do that).
display a GUI for generic objects
return status.
return status.
return status.
run molprobity (well reduce and probe) to make generic objects (and display the generic objects gui)
Write the connectivity for the non-standard (non-water) residues in the given molecule for which we have the dictionary.
Don’t return anything interesting.
gets set the first time we run interactive-probe. Takes values unset (initial value) ’yes and ’no)
run "probe" interactively, which in the current implementation, means that this function can run during a edit-chi angles manipulation, or after a real space refine zone.
Thus function presumes that there are 2 pdb files in the current directory, one of which is the reference pdb file and the other is a pdb file containing the tmp/moving atom set.
The function takes arguments for the centre of the probe dots and the radius of the probe dots sphere. The chain id and residue number are also needed to pass as arguments to probe.
Update the generic objects probe dots from residues within radius of the screen centre.
Return nothing interesting.
Next: check-for-updates, Previous: generic-objects, Up: Scheme Scripting Functions [Contents][Index]
Next: brute-lsqman, Previous: exercise-scm-mol, Up: Scheme Scripting Functions [Contents][Index]
Is this true?
Needs testing.
show the dialog
version-string is something like: "coot-0.6-pre-1-revision-2060"
Test for prefix-dir 1) existing 2) being a directory 3) modifiable by user (ie. u+rwx)
Return #t or #f.
Next: fitting, Previous: check-for-updates, Up: Scheme Scripting Functions [Contents][Index]
brute-lsqman - run lsqman on chains A of two pdb-files and read in the result to coot. Charlie Bond 2003. Can keep a count of the number of successful runs if necessary
Next: group-settings, Previous: brute-lsqman, Up: Scheme Scripting Functions [Contents][Index]
Note that residue with alt confs do not undergo auto-fit-rotamer. This is because that autofit-rotamer then refine will tend to put both rotamers into the same place. Not good. It seems a reasonable expectation that residues with an alternate conformation are already resonably well-fitted. So residues with alternate conformations undergo only real space refinement.
This is simple-minded and outdated now we have the interruptible version (below).
These 2 variables are used by multi-refine function(s), called by idle functions to refine just one residue.
chain-specifier can be a string, where it is the chain of interest. or ’all-chains, where all chains are chosen.
func is a refinement function that takes 2 args, one a residue spec, the other the imol-refinement-map. e.g. fit-protein-fit-function
For each residue in chain chain-id of molecule number imol, do a rotamer fit and real space refinement of each residue. Don’t update the graphics while this is happening (which makes it faster than fit-protein, but much less interesting to look at).
For each residue in the solvent chains of molecule number imol, do a rigid body fit of the water to the density.
Step through the residues of molecule number imol and at each step do a residue range refinement (unlike fit-protein for example, which does real-space refinement for every residue).
The step is set internally to 2.
refine each residue with ramachandran restraints
The GUI that you see after ligand finding.
test-func is a function given one argument (a molecule number) that returns either #f if the condition is not satisfied or something else if it is. And that "something else" can be a list like (list label x y z) or (list "Bad Chiral" 0 "A" 23 "" "CA" "A")
It is used in the create a button label and "what to do when the button is pressed".
This totally ignores insertion codes. A clever algorithm would need a re-write, I think. Well, we’d have at this end a function that took a chain-id res-no-1 ins-code-1 res-no-2 ins-code-2
And refine-zone would need to be re-written too, of course. So let’s save that for a rainy day (days... (weeks)).
refine active residue
refine active residue triple
For just one (this) residue, side-residue-offset is 0.
Pepflip the active residue - needs a key binding.
Auto-fit rotamer on active residues
atom-sel-type is either ’all ’main-chain or ’ca
Next: background-demo, Previous: fitting, Up: Scheme Scripting Functions [Contents][Index]
The rapper installation dir. This is just a guess, that it is installed in the users home directory.
Next: americanisms, Previous: group-settings, Up: Scheme Scripting Functions [Contents][Index]
flash the background different colours in some uninteresting way.
Next: filter, Previous: background-demo, Up: Scheme Scripting Functions [Contents][Index]
an americanism
an americanism
an americanism
an americanism
an americanism
an americanism
an americanism
an americanism
an americanism
an americanism
Next: a-rapper-gui, Previous: americanisms, Up: Scheme Scripting Functions [Contents][Index]
Basic scheme function, filter the objects in list ls by function fn. e.g. (filter even? (list 0 1 2 3) -> ’(0 2)
Next: fascinating-things, Previous: filter, Up: Scheme Scripting Functions [Contents][Index]
something that the user sets:
loop-building-tool is either ’rapper or ’ARP/wARP
Next: get-recent-pdbe, Previous: a-rapper-gui, Up: Scheme Scripting Functions [Contents][Index]
(list cluster-name-string cluster-center-go-button-label-string ccgb-x ccgb-y ccgb-z ; now a list of specific items (list (list specific-button-label-string button-red button-green button-blue specific-x specific-y specific-z) (list specific-button-label-string button-red button-green button-blue specific-x specific-y specific-z)))))
Next: 3d-generator-import, Previous: fascinating-things, Up: Scheme Scripting Functions [Contents][Index]
(coot-thread-dispatcher image-name thunk)
If check-button-label is #f, don’t make one, otherwise create with with the given label and "on" state.
Get image-name (caller doesn’t care how) and when it is in place run thunk func.
This is a generally useful function, so it has been promoted outside of dig-table.
return refmac-result or #f
Use progress bars
include-get-sfs-flag is either ’no-sfs or ’include-sfs
Sameer Velankar says to get this file for the latest releases "http://www.ebi.ac.uk/pdbe-apps/jsonizer/latest/released/" (note the end "/").
Next: coot, Previous: get-recent-pdbe, Up: Scheme Scripting Functions [Contents][Index]
if there is a prodrg-xyzin set the current-time to its mtime, else #f
This function can be overwritten by your favourite 3d conformer and restraints generator.
Run libcheck to convert from SMILES string
not needed?
return #f (if fail) or a list of: the molecule number of the selected residue, the prodrg output mol file-name, the prodrg output pdb file-name
import from SBASE, callback using sbase_import_function
Next: jligand, Previous: 3d-generator-import, Up: Scheme Scripting Functions [Contents][Index]
This is full pathname of molprobity’s probe program
This is full pathname of molprobity’s reduce program
This has be be here (in a general place) because tips-gui (where it used to be is conditionally loaded). (default to tips-gui displayed is true).
Note the position of coot-gui is important. It seem that if there are too many files in front of it (even blank ones!) coot barfs when it gets to coot-gui.scm.
20060203 I have now enabled coot in scripting mode (no graphics (–no-graphics command line option)). In that case, we need to not load up scheme files which load up gtk (currently coot-gui and tips-gui).
Previous: coot, Up: Scheme Scripting Functions [Contents][Index]
JLigand sends Coot a file that contains filenames for the link and new dictionary/restraints.
jligand internal parameter
this could be in utils
every fraction of a second look to see if *from-jligand-secret-link-file-name* has been updated. If so, then run the handle-read-from-jligand-file function.
Next: Function Index, Previous: Scheme Scripting Functions, Up: Top [Contents][Index]
Jump to: | .
A B C D E F G H I L M N O P R S T U V W Y Z |
---|
Jump to: | .
A B C D E F G H I L M N O P R S T U V W Y Z |
---|
Previous: Concept Index, Up: Top [Contents][Index]
Jump to: | %
*
3
A B C D E F G H I J K L M N O P Q R S T U V W Z |
---|
Jump to: | %
*
3
A B C D E F G H I J K L M N O P Q R S T U V W Z |
---|
The official CCP4 graphics program (which contains parts of Coot (and Coot contains parts of CCP4MG)), CCP4MG is under the direct control of Liz Potterton and Stuart McNicholas.
although it does have a local refinement algorithm it is no substitute for refmac (a wrapper for refmac is available).
that’s the job of the CCP4 Program Suite.
it’s Free Software after all and I could give you a hand.
I can get by with a one button Macintosh - but it’s not ideal.
as it is known in Clipper.
coot has several influences and dependencies, but these will not be discussed here in the User Manual.
COOT_BACKUP_DIR is used in preference if set
The map-reading problem (documented in Section Maps in General) is already known.
now there’s a hostage to fortune.
to do so, please send me the output of the following:
$ gdb `which coot-real` corefile and then at the
(gdb) prompt type: where
, where
corefile is the core dump file, core or
core.4536 or some such.
See also more on zooming
Mouse movement in “Spherical Surface” mode generates a component of (often undesirable) screen z-rotation, particularly noticeable when the mouse is at the edge of the screen.
(vt-surface 0)
to turn it back to “Spherical”
mode.
this is off by default because I find it annoying.
Put your mouse over a widget for a couple of seconds, if that widget has a tooltip, it will pop-up in a yellow box (or a grey box for some reason if you are using Macintosh).
that works for me, at least.
Povray support is only semi-working, there is a problem with the orientation of the image.
to a limited extent.
the substantial majority of the time you will want your the buttons to be both either depressed or undepressed, rarely one but not the other.
British modelling, of course
which causes the evaluation of the command.
such as the Coot state file (Section Coot State).
in that particular directory.
funny that
this might be initially surprising since this could chew up a lot of disk space. However, disk space is cheap compared to losing you molecule.
The coordinates are written in pdb format - that’s OK, isn’t it?.
unless you tell it not to, of course -
use (e.g.) (turn-off-backup 0)
to turn off the backup
(for molecule 0 in this case).
or system manager.
It works like the “Forwards” buttons in a web browser - which is not available immediately after viewing a new page.
for example, if coot crashes.
if no space group has been assigned it
returns ``No spacegroup for this molecule''
I find a clipping level of about 3.5 to 4 comfortable for viewing electron density maps - it is a little “thinner” than the default startup thickness.
Inspired by PyMol? Yep… sure was!
and C again to toggle them off.
compared to some other one.
prompted by changing the contour level.
i.e. the terminal in which you started Coot.
Hue Saturation Value (Intensity).
they
can be redisplayed using (set-draw-hydrogens mol-no 1)
.
the reference chain is, by default, the first chain of that type in the coordinates file. The reference (master) chain can be changed using the NCS Ghosts Control dialog.
that also only makes sense in the region of the reference chain.
OCA is “goose” in Spanish (and Italian)
the default is the Weizmann Institute - which for reasons I won’t go into here is currently much faster than the EBI server.
which (currently) only a fraction are.
using thermal ellipsoids
in the case of isotropic atoms, ellipsoids are spherical, of course.
symmetry labels are in pale blue/purple and also provide the symmetry operator number and the translations along the a, b and c axes.
contacts involving two hydrogens or at least one carbon atom are yellow, denoting ’bump’. Hydrogen contacts display cut-off are based on the user-defined maximum distance, but shortened by 0.5Å per hydrogen atom.
Use Angle
for an angle, of
course.
e.g. this molecule was a map or a closed molecule.
the same one as in the CCP4 program SUPERPOSE
given a half-decent window manager
Diamond, R. (1971). A Real-Space Refinement Procedure for Proteins. Acta Crystallographica A27, 436-452.
but the resulting \chi^2 values are higher.
And a few extras, such as phosphate
unless you are using Buccaneer, of course
if you want to move only one residue, then click the same atom twice.
like Refinement and Regularization
like Regularization and Refinement.
T. J. Oldfield & R. E. Hubbard (1994). “Analysis of C\alpha Geometry in Protein Structures” Proteins-Structure Function and Genetics 18(4) 324 – 337.
which is quite likely at first since coot has no knowledge of where the chain has been and cannot score according to geometric criteria.
“b” again toggles the mode off.
high-resolution map interpretation is planned.
i.e. one less than the starting residue in the forward direction (defaults to 1).
R. M. Esnouf “Polyalanine Reconstruction from C\alpha Positions Using the Program CALPHA Can Aid Initial Phasing of Data by Molecular Replacement Procedures” Acta Cryst. , D53, 666-672 (1997).
T.A. Jones & S. Thirup “Using known substructures in protein model building and crystallography” EMBO J. 5, 819–822 (1986).
and high resolution
i.e. there are severely misplaced atoms
as for Rotate/Translate Zone (Section Rotate/Translate Zone).
since version 0.4
SC Lovell, JM Word, JS Richardson and DC Richardson (2000) "The Penultimate Rotamer Library" Proteins: Structure Function and Genetics 40: 389-408. You can get the paper from http://kinemage.biochem.duke.edu/databases/rotamer.php
"The Backrub Motion: How Protein Backbone Shrugs When a Sidechain Dances" Structure, Volume 14, Issue 2, Pages 265-274 I. Davis, W. Bryan Arendall III, D. Richardson, J. Richardson
for example, in preparation of a model for molecular replacement
atoms of residues that are too close to each other
that’s “zero”.
Note that selecting a residue type that matches the residue in the graphics will also result in a mutation
i.e. the current residue type matches the residue type to which you wish to mutate the residue
e.g. after using Ca -> Mainchain.
i.e. the residue atoms will remain untouched
this is a wrapper round LIBCHECK, so you must have CCP4 suite to installed for this function to work
rather than running LIBCHECK again
you can search for many different ligand types.
usually if this still fails after two repetitions then it never seems to work.
The map is selected using “Refine/Regularize Control”
e.g. (add-OXT-to-residue 0 428 "" "A")
including sulfate or phosphate ions (in such a case, it is probably useful to do a “Rigid Body Fit Zone” on that new residue).
For example, after a ligand search has been performed.
i.e. Coot is idle and ignores all input.
This is not an ideal feature, of course and will be addressed in future.... Digressive Musing: If only computers were fast enough to run Refmac interactively…
such that Coot would subsequently expect an atom selection “pick” in the graphics window.
the current single function doesn’t always perform very well in tests
R.W.W. Hooft, G. Vriend, C. Sander, E.E. Abola, Errors in protein structures. Nature (1996) 381, 272-272.
e.g. it’s a directory or a coordinate filename.
like I don’t on my Mac.
actually, it’s a box.
in a coot difference map you will get to see the negative level contoured at the inverted level of the positive level, what I mean is that you don’t want to see the “positive” level going less than 0.
takes you right back to the good old Frodo days, no?
Jan Dohnalek, for instance.
a value of 2.5 is often sufficient.
If you’re living in Sweden... or Captain Kirk, that is.
you may think it strange that a box has a radius, this is an idiosyncrasy of Coot.
or set their occupancy to zero
the not-GLY-or-PRO is the most familiar Ramachandran plot.
prolines have a grey outline rather than a black one, triangles are glycines.
but that’s partly the idea, I suppose.
and therefore most interesting
or the water should be more properly modelled as anistrotropic or a split partial site
and remember to check the difference map button in the “Run Refmac” dialog