Get session - Revision history

Pyadmin: 5 revisions

2014-03-28T01:46:59Z

5 revisions

Speleo3: field_data

2012-09-21T13:48:22Z

field_data

Speleo3: map object example

2012-09-21T13:44:07Z

map object example

TakanoriNakane: Description of top-level structure

2012-02-22T14:49:55Z

Description of top-level structure

New page

Returns a dictionary representation the currently loaded PyMOL session.The session file (.pse) is a compressed version of its output.

By using this API, user scripts can access many interesting properties which are otherwise inaccessible. Examples include [[Pymol2glmol]] and [[get_raw_distances]] scripts.

WARNING: This API is undocumented API, intended for internal use. Use it only when it is necessary.

= Usage =
<source lang="python">
# get the session as a dictionary
print cmd.get_session()
</source>

= Return value =

The returned dictionary has following key-value pairs.

:main: An array encoding window size. For example, [640, 480]

:color_ext:

:settings: An array of PyMOL's global settings. They are dumped by SettingAsPyList in layer1/Setting.c. Further details will not be discussed because scripts can access these values from [[get|cmd.get]] API.

:colors: If you have defined color names by [[Set Color]], they are described here. Default color names (red, blue, etc...) will not appear. This dict can also be obtained by [[Get Color Indices|cmd.get_color_indices()]]. To get RGB definition of a color, get its pallet ID by cmd.get_color_index and convert it to RGB tuple by cmd.get_color_tuple.

:view: Same as [[Get View|cmd.get_view()]]

:version: Version number of PyMOL

:view_dict:

:names: This is the most complex but interesting part. Produced by ExecutiveGetNamedEntries, this array describes internal C-objects of the current session. Each element is an array of five elements.

(documentation in progress... Please feel free to expand)

[[Category:Commands]]

@@ Line 53: / Line 53: @@
 cmd.map_new('mymap', 'gaussian', 0.5)
 mymap = cmd.get_session('mymap', 1)['names'][0]
-values = numpy.reshape(mymap[5][2][0][14][2][6],
+values = numpy.reshape(field_data[6], field_data[4])
 </syntaxhighlight>

← Older revision	Revision as of 01:46, 28 March 2014
(No difference)

@@ Line 5: / Line 5: @@
 WARNING: This API is undocumented API, intended for internal use. Use it only when it is necessary.
-= Usage =
+== Usage ==
 <source lang="python">
-# get the session as a dictionary
+dict cmd.get_session(names='', partial=0)
 </source>
-= Return value =
+== Return value ==
 The returned dictionary has following key-value pairs.
-:main: An array encoding window size. For example, [640, 480]
+* '''main''': An array encoding window size. For example, [640, 480]
-:settings: An array of PyMOL's global settings. They are dumped by SettingAsPyList in layer1/Setting.c. Further details will not be discussed because scripts can access these values from [[get|cmd.get]] API.
+(documentation in progress... Please feel free to expand)
-:colors: If you have defined color names by [[Set Color]], they are described here. Default color names (red, blue, etc...) will not appear. This dict can also be obtained by [[Get Color Indices|cmd.get_color_indices()]]. To get RGB definition of a color, get its pallet ID by cmd.get_color_index and convert it to RGB tuple by cmd.get_color_tuple.
+== Examples ==
-:view: Same as [[Get View|cmd.get_view()]]
+=== Object array ===
-:version: Version number of PyMOL
+<syntaxhighlight lang="python">
-:view_dict:
+=== Internals of a map object ===
-:names: This is the most complex but interesting part. Produced by ExecutiveGetNamedEntries, this array describes internal C-objects of the current session. Each element is an array of five elements.
+The map data as a numpy array:
-(documentation in progress... Please feel free to expand)
+cmd.map_new('mymap', 'gaussian', 0.5)
 [[Category:Commands]]