schrodinger.analysis.visanalysis.volumedataio module¶
This file contains the implementation of several functions that can be used to read/write VolumeData objects to various file-types.
-
schrodinger.analysis.visanalysis.volumedataio.LoadVisFile(filename)¶ This function retrieves a VolumeData object from a Schrodinger .vis file.
- Parameters
filename (
string) – A Schrodinger .vis file containing a valid mmvol object- Returns
The VolumeData extracted from the contents of the .vis file
- Return type
VolumeData
-
schrodinger.analysis.visanalysis.volumedataio.SaveVisFile(volumeData, filename)¶ This function saves a VolumeData object to a Schrodinger .vis file.
- Parameters
volumeData (
volumeData) – The VolumeData to be serialisedfilename (
string) – Where to store the .vis file
-
schrodinger.analysis.visanalysis.volumedataio.SaveCCP4File(volumeData, filename)¶ This function saves a VolumeData object to a CCP4 file.
- Parameters
volumeData (
VolumeData) – The VolumeData to be serialisedfilename (
string) – Where to store the .CCP4 file
-
schrodinger.analysis.visanalysis.volumedataio.LoadCNSFile(filename)¶ This function loads a VolumeData object from a CNS file.
- Parameters
filename (
string) – The .cns formatted file- Returns
The VolumeData object extracted from the .cns file.
- Return type
VolumeData