rosetta.core.io.pdb
index
(built-in)

Bindings for core::io::pdb namespace

 
Classes
       
builtins.object
Field
RecordType
rosetta.utility.SingletonBase_core_io_pdb_RecordCollection_t(builtins.object)
RecordCollection

 
class Field(builtins.object)
     Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(rosetta.core.io.pdb.Field) -> NoneType
 
2. __init__(self : rosetta.core.io.pdb.Field, start_in : int, end_in : int) -> NoneType
 
3. __init__(self : rosetta.core.io.pdb.Field,  : rosetta.core.io.pdb.Field) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__str__(...) from builtins.PyCapsule
__str__(rosetta.core.io.pdb.Field) -> str
assign(...) from builtins.PyCapsule
assign(self : rosetta.core.io.pdb.Field,  : rosetta.core.io.pdb.Field) -> rosetta.core.io.pdb.Field
set_value_from_pdb_line(...) from builtins.PyCapsule
set_value_from_pdb_line(self : rosetta.core.io.pdb.Field, source : str) -> NoneType
 
Read field value from given .pdb line and set.

Data descriptors defined here:
end
start
value

 
class RecordCollection(rosetta.utility.SingletonBase_core_io_pdb_RecordCollection_t)
    This class is a singleton and manages the definitions of PDB Records, which should only be read from the
database one time.
 
 
Method resolution order:
RecordCollection
rosetta.utility.SingletonBase_core_io_pdb_RecordCollection_t
builtins.object

Methods defined here:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
is_valid_record_type(...) from builtins.PyCapsule
is_valid_record_type(type : str) -> bool
 
Is the given string a valid 6-letter PDB record type?

Methods inherited from rosetta.utility.SingletonBase_core_io_pdb_RecordCollection_t:
get_instance(...) from builtins.PyCapsule
get_instance() -> core::io::pdb::RecordCollection

 
class RecordType(builtins.object)
    Enumerators for all of the record types used in PDB files, according to:
http://www.wwpdb.org/documentation/file-format-content/format33/v3.3.html
 
  Methods defined here:
__eq__(...) from builtins.PyCapsule
__eq__(rosetta.core.io.pdb.RecordType, rosetta.core.io.pdb.RecordType) -> bool
__hash__(...) from builtins.PyCapsule
__hash__(rosetta.core.io.pdb.RecordType) -> int
__init__(...) from builtins.PyCapsule
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(rosetta.core.io.pdb.RecordType, int) -> NoneType
 
2. __init__(rosetta.core.io.pdb.RecordType, int) -> NoneType
__int__(...) from builtins.PyCapsule
__int__(rosetta.core.io.pdb.RecordType) -> int
__ne__(...) from builtins.PyCapsule
__ne__(rosetta.core.io.pdb.RecordType, rosetta.core.io.pdb.RecordType) -> bool
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__repr__(...) from builtins.PyCapsule
__repr__(rosetta.core.io.pdb.RecordType) -> str

Data and other attributes defined here:
ANISOU = RecordType.ANISOU
ATOM = RecordType.ATOM
AUTHOR = RecordType.AUTHOR
CAVEAT = RecordType.CAVEAT
CISPEP = RecordType.CISPEP
COMPND = RecordType.COMPND
CONECT = RecordType.CONECT
CRYST1 = RecordType.CRYST1
DBREF = RecordType.DBREF
DBREF1 = RecordType.DBREF1
DBREF2 = RecordType.DBREF2
END = RecordType.END
ENDMDL = RecordType.ENDMDL
EXPDTA = RecordType.EXPDTA
FORMUL = RecordType.FORMUL
HEADER = RecordType.HEADER
HELIX = RecordType.HELIX
HET = RecordType.HET
HETATM = RecordType.HETATM
HETNAM = RecordType.HETNAM
HETSYN = RecordType.HETSYN
JRNL = RecordType.JRNL
KEYWDS = RecordType.KEYWDS
LINK = RecordType.LINK
MASTER = RecordType.MASTER
MDLTYP = RecordType.MDLTYP
MODEL = RecordType.MODEL
MODRES = RecordType.MODRES
MTRIX1 = RecordType.MTRIX1
MTRIX2 = RecordType.MTRIX2
MTRIX3 = RecordType.MTRIX3
NUMMD = RecordType.NUMMD
N_RECORD_TYPES = RecordType.N_RECORD_TYPES
OBSLTE = RecordType.OBSLTE
ORIGX1 = RecordType.ORIGX1
ORIGX2 = RecordType.ORIGX2
ORIGX3 = RecordType.ORIGX3
REMARK = RecordType.REMARK
REVDAT = RecordType.REVDAT
SCALE1 = RecordType.SCALE1
SCALE2 = RecordType.SCALE2
SCALE3 = RecordType.SCALE3
SEQADV = RecordType.SEQADV
SEQRES = RecordType.SEQRES
SHEET = RecordType.SHEET
SITE = RecordType.SITE
SOURCE = RecordType.SOURCE
SPLIT = RecordType.SPLIT
SPRSDE = RecordType.SPRSDE
SSBOND = RecordType.SSBOND
TER = RecordType.TER
TITLE = RecordType.TITLE
UNKNOW = RecordType.N_RECORD_TYPES

 
Functions
       
build_pose_from_pdb_as_is(...) method of builtins.PyCapsule instance
build_pose_from_pdb_as_is(*args, **kwargs)
Overloaded function.
 
1. build_pose_from_pdb_as_is(pose : rosetta.core.pose.Pose, filename : str) -> NoneType
 
Builds a pose into  <pose>, without repacking or optimizing
 hydrogens; using the full-atom ResidueTypeSet
 
2. build_pose_from_pdb_as_is(pose : rosetta.core.pose.Pose, filename : str, pdr_options : rosetta.core.io.StructFileReaderOptions) -> NoneType
 
Builds a pose into  <pose>, without repacking or optimizing
 hydrogens; using the full-atom ResidueTypeSet and a set of options.
 
3. build_pose_from_pdb_as_is(pose : rosetta.core.pose.Pose, residue_set : rosetta.core.chemical.ResidueTypeSet, filename : str) -> NoneType
 
4. build_pose_from_pdb_as_is(pose : rosetta.core.pose.Pose, residue_set : rosetta.core.chemical.ResidueTypeSet, filename : str, pdr_options : rosetta.core.io.StructFileReaderOptions) -> NoneType
create_pdb_contents_from_sfr(...) method of builtins.PyCapsule instance
create_pdb_contents_from_sfr(*args, **kwargs)
Overloaded function.
 
1. create_pdb_contents_from_sfr(sfr : core::io::StructFileRep) -> str
 
Create a full .pdb as a string given a StructFileRep object.
 
2. create_pdb_contents_from_sfr(sfr : core::io::StructFileRep, options : rosetta.core.io.StructFileRepOptions) -> str
 
Create a full .pdb as a string given a StructFileRep object.
create_sfr_from_pdb_file_contents(...) method of builtins.PyCapsule instance
create_sfr_from_pdb_file_contents(*args, **kwargs)
Overloaded function.
 
1. create_sfr_from_pdb_file_contents(pdb_contents : str, options : rosetta.core.io.StructFileReaderOptions) -> rosetta.core.io.StructFileRep
 
Create a representation of structural file data from .pdb file contents with options.
 
2. create_sfr_from_pdb_file_contents(pdb_contents : str) -> rosetta.core.io.StructFileRep
 
Create a representation of structural file data from .pdb file contents.
dump_pdb(...) method of builtins.PyCapsule instance
dump_pdb(*args, **kwargs)
Overloaded function.
 
1. dump_pdb(pose : rosetta.core.pose.Pose, extra_data : str, add_score_data : bool, add_extra_score_data : bool, out : utility::io::ozstream) -> NoneType
 
Writes a pose to a given stream in PDB file format, optionally
 appending a given string and optionally extracting scores from the pose.
 
 
 This came out of the 2016 Chemical XRW.  It's an attempt to preserve
 some stuff that jd2 was doing before, while centralizing all PDB generation in
 one place.
 
 
 The pose to turn into a PDB.
 
 
 Additional data to append to the PDB file data.
 
 
 Grab additional score data from the pose?
 
 
 Grab still more score data from the pose?
 
 
 The output stream that the PDB file data will be written to.
 
 
 (Optional)  String for the filename.  Will be included in the score data table if provided.
 
 
 Vikram K. Mulligan (vmullig.edu).
 
2. dump_pdb(pose : rosetta.core.pose.Pose, extra_data : str, add_score_data : bool, add_extra_score_data : bool, out : utility::io::ozstream, filename : str) -> NoneType
 
Writes a pose to a given stream in PDB file format, optionally
 appending a given string and optionally extracting scores from the pose.
 
 
 This came out of the 2016 Chemical XRW.  It's an attempt to preserve
 some stuff that jd2 was doing before, while centralizing all PDB generation in
 one place.
 
 
 The pose to turn into a PDB.
 
 
 Additional data to append to the PDB file data.
 
 
 Grab additional score data from the pose?
 
 
 Grab still more score data from the pose?
 
 
 The output stream that the PDB file data will be written to.
 
 
 (Optional)  String for the filename.  Will be included in the score data table if provided.
 
 
 Vikram K. Mulligan (vmullig.edu).
 
3. dump_pdb(pose : rosetta.core.pose.Pose, extra_data : str, add_score_data : bool, add_extra_score_data : bool, out : utility::io::ozstream, filename : str, options : rosetta.core.io.StructFileRepOptions) -> NoneType
 
Writes a pose to a given stream in PDB file format, optionally
 appending a given string and optionally extracting scores from the pose.
 
 
 This came out of the 2016 Chemical XRW.  It's an attempt to preserve
 some stuff that jd2 was doing before, while centralizing all PDB generation in
 one place.
 
 
 The pose to turn into a PDB.
 
 
 Additional data to append to the PDB file data.
 
 
 Grab additional score data from the pose?
 
 
 Grab still more score data from the pose?
 
 
 The output stream that the PDB file data will be written to.
 
 
 (Optional)  String for the filename.  Will be included in the score data table if provided.
 
 
 Vikram K. Mulligan (vmullig.edu).
 
4. dump_pdb(pose : rosetta.core.pose.Pose, extra_data : str, add_score_data : bool, add_extra_score_data : bool, out : str) -> NoneType
 
Writes a pose to a given string in PDB file format, optionally
 appending a given string and optionally extracting scores from the pose.
 
 
 This came out of the 2016 Chemical XRW.  It's an attempt to preserve
 some stuff that jd2 was doing before, while centralizing all PDB generation in
 one place.
 
 
 The pose to turn into a PDB.
 
 
 Additional data to append to the PDB file data.
 
 
 Grab additional score data from the pose?
 
 
 Grab still more score data from the pose?
 
 
 The output string that the PDB file data will be written to.
 
 
 (Optional)  String for the filename.  Will be included in the score data table if provided.
 
 
 Vikram K. Mulligan (vmullig.edu).
 
5. dump_pdb(pose : rosetta.core.pose.Pose, extra_data : str, add_score_data : bool, add_extra_score_data : bool, out : str, filename : str) -> NoneType
 
Writes a pose to a given string in PDB file format, optionally
 appending a given string and optionally extracting scores from the pose.
 
 
 This came out of the 2016 Chemical XRW.  It's an attempt to preserve
 some stuff that jd2 was doing before, while centralizing all PDB generation in
 one place.
 
 
 The pose to turn into a PDB.
 
 
 Additional data to append to the PDB file data.
 
 
 Grab additional score data from the pose?
 
 
 Grab still more score data from the pose?
 
 
 The output string that the PDB file data will be written to.
 
 
 (Optional)  String for the filename.  Will be included in the score data table if provided.
 
 
 Vikram K. Mulligan (vmullig.edu).
 
6. dump_pdb(pose : rosetta.core.pose.Pose, extra_data : str, add_score_data : bool, add_extra_score_data : bool, out : str, filename : str, options : rosetta.core.io.StructFileRepOptions) -> NoneType
 
Writes a pose to a given string in PDB file format, optionally
 appending a given string and optionally extracting scores from the pose.
 
 
 This came out of the 2016 Chemical XRW.  It's an attempt to preserve
 some stuff that jd2 was doing before, while centralizing all PDB generation in
 one place.
 
 
 The pose to turn into a PDB.
 
 
 Additional data to append to the PDB file data.
 
 
 Grab additional score data from the pose?
 
 
 Grab still more score data from the pose?
 
 
 The output string that the PDB file data will be written to.
 
 
 (Optional)  String for the filename.  Will be included in the score data table if provided.
 
 
 Vikram K. Mulligan (vmullig.edu).
 
7. dump_pdb(pose : rosetta.core.pose.Pose, file_name : str) -> bool
 
Writes <pose> to a PDB file, returning false if an error occurs.
 
8. dump_pdb(pose : rosetta.core.pose.Pose, file_name : str, tag : str) -> bool
 
Writes <pose> to a PDB file, returning false if an error occurs.
 
9. dump_pdb(pose : rosetta.core.pose.Pose, file_name : str, tag : str, write_fold_tree : bool) -> bool
 
Writes <pose> to a PDB file, returning false if an error occurs.
 
10. dump_pdb(pose : rosetta.core.pose.Pose, file_name : str, tag : str, write_fold_tree : bool, options : rosetta.core.io.StructFileRepOptions) -> bool
 
Writes  <pose>  to a PDB file, returns false if an error occurs
store_base_residue_type_name_in_sfr(...) method of builtins.PyCapsule instance
store_base_residue_type_name_in_sfr(hetID : str, text_field : str, sfr : rosetta.core.io.StructFileRep) -> NoneType
 
Parse .pdb HETNAM text field to extract full resID and convert into SFR data.

 
Data
        ANISOU = RecordType.ANISOU
ATOM = RecordType.ATOM
AUTHOR = RecordType.AUTHOR
CAVEAT = RecordType.CAVEAT
CISPEP = RecordType.CISPEP
COMPND = RecordType.COMPND
CONECT = RecordType.CONECT
CRYST1 = RecordType.CRYST1
DBREF = RecordType.DBREF
DBREF1 = RecordType.DBREF1
DBREF2 = RecordType.DBREF2
END = RecordType.END
ENDMDL = RecordType.ENDMDL
EXPDTA = RecordType.EXPDTA
FORMUL = RecordType.FORMUL
HEADER = RecordType.HEADER
HELIX = RecordType.HELIX
HET = RecordType.HET
HETATM = RecordType.HETATM
HETNAM = RecordType.HETNAM
HETSYN = RecordType.HETSYN
JRNL = RecordType.JRNL
KEYWDS = RecordType.KEYWDS
LINK = RecordType.LINK
MASTER = RecordType.MASTER
MDLTYP = RecordType.MDLTYP
MODEL = RecordType.MODEL
MODRES = RecordType.MODRES
MTRIX1 = RecordType.MTRIX1
MTRIX2 = RecordType.MTRIX2
MTRIX3 = RecordType.MTRIX3
NUMMD = RecordType.NUMMD
N_RECORD_TYPES = RecordType.N_RECORD_TYPES
OBSLTE = RecordType.OBSLTE
ORIGX1 = RecordType.ORIGX1
ORIGX2 = RecordType.ORIGX2
ORIGX3 = RecordType.ORIGX3
REMARK = RecordType.REMARK
REVDAT = RecordType.REVDAT
SCALE1 = RecordType.SCALE1
SCALE2 = RecordType.SCALE2
SCALE3 = RecordType.SCALE3
SEQADV = RecordType.SEQADV
SEQRES = RecordType.SEQRES
SHEET = RecordType.SHEET
SITE = RecordType.SITE
SOURCE = RecordType.SOURCE
SPLIT = RecordType.SPLIT
SPRSDE = RecordType.SPRSDE
SSBOND = RecordType.SSBOND
TER = RecordType.TER
TITLE = RecordType.TITLE
UNKNOW = RecordType.N_RECORD_TYPES