Package rosetta :: Package protocols :: Package rosetta_scripts :: Module _protocols_rosetta_scripts_
[hide private]
[frames] | no frames]

Module _protocols_rosetta_scripts_

Classes [hide private]
  AdditionalOutputWrapper
protocols/rosetta_scripts/AdditionalOutputWrapper.hh:43
  AdditionalOutputWrapperAP
  AdditionalOutputWrapperCAP
  AdditionalOutputWrapperCreator
protocols/rosetta_scripts/AdditionalOutputWrapperCreator.hh:22
  AdditionalOutputWrapperCreatorAP
  AdditionalOutputWrapperCreatorCAP
  MultipleOutputWrapper
protocols/rosetta_scripts/MultipleOutputWrapper.hh:41
  MultipleOutputWrapperAP
  MultipleOutputWrapperCAP
  MultipleOutputWrapperCreator
protocols/rosetta_scripts/MultipleOutputWrapperCreator.hh:22
  MultipleOutputWrapperCreatorAP
  MultipleOutputWrapperCreatorCAP
  MultiplePoseMover
protocols/rosetta_scripts/MultiplePoseMover.hh:46
  MultiplePoseMoverAP
  MultiplePoseMoverCAP
  MultiplePoseMoverCreator
protocols/rosetta_scripts/MultiplePoseMoverCreator.hh:22
  MultiplePoseMoverCreatorAP
  MultiplePoseMoverCreatorCAP
  ParsedProtocol
protocols/rosetta_scripts/ParsedProtocol.hh:46
  ParsedProtocolAP
  ParsedProtocolCAP
  ParsedProtocolCreator
protocols/rosetta_scripts/ParsedProtocolCreator.hh:22
  ParsedProtocolCreatorAP
  ParsedProtocolCreatorCAP
  PosePropertyReporter
protocols/rosetta_scripts/PosePropertyReporter.hh:36
  PosePropertyReporterAP
  PosePropertyReporterCAP
  PosePropertyReporterCreator
Abstract base class for a PosePropertyReporter factory; the Creator class is responsible for creating a particular PosePropertyReporter class.
  PosePropertyReporterCreatorAP
  PosePropertyReporterCreatorCAP
  PosePropertyReporterFactory
protocols/rosetta_scripts/PosePropertyReporterFactory.hh:66
  PosePropertyReporterFactoryAP
  PosePropertyReporterFactoryCAP
  PoseSelector
protocols/rosetta_scripts/PoseSelector.hh:42
  PoseSelectorAP
  PoseSelectorCAP
  PoseSelectorCreator
Abstract base class for a PoseSelector factory; the Creator class is responsible for creating a particular PoseSelector class.
  PoseSelectorCreatorAP
  PoseSelectorCreatorCAP
  PoseSelectorFactory
protocols/rosetta_scripts/PoseSelectorFactory.hh:57
  PoseSelectorFactoryAP
  PoseSelectorFactoryCAP
  PoseSelectorFlags
protocols/rosetta_scripts/PoseSelector.hh:37
  RosettaScriptsParser
Reading the xml file and generating the mover
  RosettaScriptsParserAP
  RosettaScriptsParserCAP
  SavePoseMover
mover that can be used to save or restore a pose at an arbitrary point during a rosetta scripts protocol.
  SavePoseMoverAP
  SavePoseMoverCAP
  SavePoseMoverCreator
protocols/rosetta_scripts/SavePoseMoverCreator.hh:24
  SavePoseMoverCreatorAP
  SavePoseMoverCreatorCAP
  SingletonBase_T_core_chemical_ChemicalManager_T
SingletonBase is meant to serve as a base class for singleton classes in Rosetta handling the initialization of the singleton in a thread-safe way.
  SingletonBase_T_core_chemical_ChemicalManager_TAP
  SingletonBase_T_core_chemical_ChemicalManager_TCAP
  SingletonBase_T_protocols_rosetta_scripts_PoseSelectorFactory_T
SingletonBase is meant to serve as a base class for singleton classes in Rosetta handling the initialization of the singleton in a thread-safe way.
  SingletonBase_T_protocols_rosetta_scripts_PoseSelectorFactory_TAP
  SingletonBase_T_protocols_rosetta_scripts_PoseSelectorFactory_TCAP
  __CPP_AdditionalOutputWrapperCreator__
  __CPP_AdditionalOutputWrapper__
  __CPP_MultipleOutputWrapperCreator__
  __CPP_MultipleOutputWrapper__
  __CPP_MultiplePoseMoverCreator__
  __CPP_MultiplePoseMover__
  __CPP_ParsedProtocolCreator__
  __CPP_ParsedProtocol__
  __CPP_PosePropertyReporterCreator__
  __CPP_PoseSelectorCreator__
  __CPP_RosettaScriptsParser__
  __CPP_SavePoseMoverCreator__
  __CPP_SavePoseMover__
Functions [hide private]
 
add_movemaps_to_datamap(...)
add_movemaps_to_datamap( (Tag)in_tag, (Pose)pose, (DataMap)data [, (bool)initialize_mm_as_true=False]) -> None : Parses in_tag, adding any MoveMaps specified in branches with names to the datamap for use after.
 
find_nearest_disulfide(...)
find_nearest_disulfide( (Pose)pose, (int)res) -> int : finds the nearest disulife to given residue on pose by searching both up and down stream to the given postion
 
find_nearest_res(...)
find_nearest_res( (Pose)source, (Pose)target, (int)res, (int)target_res, (float)dist [, (int)chain=0]) -> None : find nearest residue and also return the distance
 
get_score_function_name(...)
get_score_function_name( (Tag)tag) -> str : Look up the name of assigned score function to the 'scorefxn=' option.
 
get_task_operations(...)
get_task_operations( (Tag)tag, (DataMap)data) -> object : protocols/rosetta_scripts/util.hh:48
 
has_branch(...)
has_branch( (Tag)in_tag, (str)branch_name) -> bool : Does the tag have a branch of the given name
 
parse_bogus_res_tag(...)
parse_bogus_res_tag( (Tag)tag, (str)prefix) -> None : Access res_num/pdb_num tag with prefix.
 
parse_filter(...)
parse_filter( (str)filter_name, (object)d) -> Filter : protocols/rosetta_scripts/util.hh:137
 
parse_movemap(...)
parse_movemap( (Tag)in_tag, (Pose)pose, (MoveMap)mm [, (bool)reset_movemap=True]) -> None : modifies an existing movemap according to tag the movemap defaults to move all bb, chi, and jumps.
 
parse_mover(...)
parse_mover( (str)mover_name, (object)d) -> Mover : protocols/rosetta_scripts/util.hh:140
 
parse_score_function(...)
parse_score_function( (Tag)tag, (DataMap)data [, (str)dflt_key='talaris2013']) -> ScoreFunction : Look up the score function defined in the <SCOREFXNS/> through the option 'scorefxn='.
 
parse_task_operations(...)
parse_task_operations( (str)task_list, (DataMap)data) -> TaskFactory : protocols/rosetta_scripts/util.hh:59
 
parse_xyz_vector(...)
parse_xyz_vector( (Tag)xyz_vector_tag) -> xyzVector_Real : protocols/rosetta_scripts/util.hh:143
 
residue_packer_states(...)
residue_packer_states( (Pose)pose, (__CPP_TaskFactory__)tf, (bool)designable, (bool)packable) -> vector1_Size : returns a vector containing all the residues with a given packer state according to the TF
 
saved_reference_pose(...)
saved_reference_pose( (Tag)in_tag, (DataMap)data_map [, (str)tag_str='reference_name']) -> Pose : convenience function to access pointers to poses that will be stored in the data map at an arbitrary point during an RS protocol Will look for tag in in_tag variable
Variables [hide private]
  PSF_NEED_FULL_POSE_SET = rosetta.protocols.rosetta_scripts._pr...
  PSF_NONE = rosetta.protocols.rosetta_scripts._protocols_rosett...
  __package__ = None
Function Details [hide private]

add_movemaps_to_datamap(...)

 

add_movemaps_to_datamap( (Tag)in_tag, (Pose)pose, (DataMap)data [, (bool)initialize_mm_as_true=False]) -> None :
    Parses in_tag, adding any MoveMaps specified in branches with names to the datamap for use after.
    Skips any mm names that are already loaded.
    This should allow multiple MoveMaps to be specified and loaded in a mover.
    

    C++ signature :
        void add_movemaps_to_datamap(boost::shared_ptr<utility::tag::Tag const>,core::pose::Pose,basic::datacache::DataMap {lvalue} [,bool=False])

find_nearest_disulfide(...)

 

find_nearest_disulfide( (Pose)pose, (int)res) -> int :
    finds the nearest disulife to given residue on pose by searching both up and down stream to the given postion
    

    C++ signature :
        unsigned long find_nearest_disulfide(core::pose::Pose,unsigned long)

find_nearest_res(...)

 

find_nearest_res( (Pose)source, (Pose)target, (int)res, (int)target_res, (float)dist [, (int)chain=0]) -> None :
    find nearest residue and also return the distance
    

    C++ signature :
        void find_nearest_res(core::pose::Pose,core::pose::Pose,unsigned long,unsigned long {lvalue},double {lvalue} [,unsigned long=0])

find_nearest_res( (Pose)source, (Pose)target, (int)res [, (int)chain=0]) -> int :
    find source residue that is nearest to res on source. If distance is greater than 2.0A, return 0. chain=0, search all chains, chain=1,2,3 etc. search only that chain
    

    C++ signature :
        unsigned long find_nearest_res(core::pose::Pose,core::pose::Pose,unsigned long [,unsigned long=0])

get_score_function_name(...)

 

get_score_function_name( (Tag)tag) -> str :
    Look up the name of assigned score function to the 'scorefxn='
    option. Use this to prevent hard coding default score functions into
    protocols.
    

    C++ signature :
        std::string get_score_function_name(boost::shared_ptr<utility::tag::Tag const>)

get_score_function_name( (Tag)tag, (str)option_name) -> str :
    Look up the name of assigned score function to the given
    option. Use this to prevent hard coding default score functions into
    protocols.
    

    C++ signature :
        std::string get_score_function_name(boost::shared_ptr<utility::tag::Tag const>,std::string)

get_task_operations(...)

 

get_task_operations( (Tag)tag, (DataMap)data) -> object :
    protocols/rosetta_scripts/util.hh:48

    C++ signature :
        utility::vector1<boost::shared_ptr<core::pack::task::operation::TaskOperation>, std::allocator<boost::shared_ptr<core::pack::task::operation::TaskOperation> > > get_task_operations(boost::shared_ptr<utility::tag::Tag const>,basic::datacache::DataMap)

has_branch(...)

 

has_branch( (Tag)in_tag, (str)branch_name) -> bool :
    Does the tag have a branch of the given name
    

    C++ signature :
        bool has_branch(boost::shared_ptr<utility::tag::Tag const>,std::string)

parse_bogus_res_tag(...)

 

parse_bogus_res_tag( (Tag)tag, (str)prefix) -> None :
    Access res_num/pdb_num tag with prefix.
    This is to allow parsing at apply time (pdb_num) instead of at parse_my_tag.
    This allows one to use SavePoseMovers within a protocol with the correct residue from pdb_num.
    This function is to prevent unused variable crash.
    

    C++ signature :
        void parse_bogus_res_tag(boost::shared_ptr<utility::tag::Tag const>,std::string)

parse_filter(...)

 

parse_filter( (str)filter_name, (object)d) -> Filter :
    protocols/rosetta_scripts/util.hh:137

    C++ signature :
        boost::shared_ptr<protocols::filters::Filter> parse_filter(std::string,std::map<std::string const, boost::shared_ptr<protocols::filters::Filter>, std::less<std::string const>, std::allocator<std::pair<std::string const, boost::shared_ptr<protocols::filters::Filter> > > >)

parse_movemap(...)

 

parse_movemap( (Tag)in_tag, (Pose)pose, (MoveMap)mm [, (bool)reset_movemap=True]) -> None :
    modifies an existing movemap according to tag
    the movemap defaults to move all bb, chi, and jumps.
    Still resets movemap if MoveMap branch not found!
    

    C++ signature :
        void parse_movemap(boost::shared_ptr<utility::tag::Tag const>,core::pose::Pose,boost::shared_ptr<core::kinematics::MoveMap> [,bool=True])

parse_movemap( (Tag)in_tag, (Pose)pose, (MoveMap)mm, (DataMap) [, (bool)reset_movemap=True]) -> None :
    variant of parse_movemap that takes in a datamap and searches it for already existing movemaps
    Still resets movemap if MoveMap branch not found!
    

    C++ signature :
        void parse_movemap(boost::shared_ptr<utility::tag::Tag const>,core::pose::Pose,boost::shared_ptr<core::kinematics::MoveMap> {lvalue},basic::datacache::DataMap {lvalue} [,bool=True])

parse_mover(...)

 

parse_mover( (str)mover_name, (object)d) -> Mover :
    protocols/rosetta_scripts/util.hh:140

    C++ signature :
        boost::shared_ptr<protocols::moves::Mover> parse_mover(std::string,std::map<std::string const, boost::shared_ptr<protocols::moves::Mover>, std::less<std::string const>, std::allocator<std::pair<std::string const, boost::shared_ptr<protocols::moves::Mover> > > >)

parse_score_function(...)

 

parse_score_function( (Tag)tag, (DataMap)data [, (str)dflt_key='talaris2013']) -> ScoreFunction :
    Look up the score function defined in the <SCOREFXNS/>
    through the option 'scorefxn='. Default to 'talaris2013' by default.
    

    C++ signature :
        boost::shared_ptr<core::scoring::ScoreFunction> parse_score_function(boost::shared_ptr<utility::tag::Tag const>,basic::datacache::DataMap [,std::string='talaris2013'])

parse_score_function( (Tag)tag, (str)option_name, (DataMap)data [, (str)dflt_key='talaris2013']) -> ScoreFunction :
    Look up the score function defined in the <SCOREFXNS/>
    through the given option. Default to 'talaris2013' by default.
    

    C++ signature :
        boost::shared_ptr<core::scoring::ScoreFunction> parse_score_function(boost::shared_ptr<utility::tag::Tag const>,std::string,basic::datacache::DataMap [,std::string='talaris2013'])

parse_task_operations(...)

 

parse_task_operations( (str)task_list, (DataMap)data) -> TaskFactory :
    protocols/rosetta_scripts/util.hh:59

    C++ signature :
        boost::shared_ptr<core::pack::task::TaskFactory> parse_task_operations(std::string,basic::datacache::DataMap)

parse_task_operations( (Tag)tag, (DataMap)data, (__CPP_TaskFactory__)task_factory) -> TaskFactory :
    allows the transfer of whole taskfactories on the datamap. This way a "base" taskfactory can be created, transferred on the datamap, and
    individual mover's specific taskoperations can be added on top
    

    C++ signature :
        boost::shared_ptr<core::pack::task::TaskFactory> parse_task_operations(boost::shared_ptr<utility::tag::Tag const>,basic::datacache::DataMap {lvalue},boost::shared_ptr<core::pack::task::TaskFactory> {lvalue})

parse_task_operations( (Tag)tag, (DataMap)data) -> TaskFactory :
    protocols/rosetta_scripts/util.hh:51

    C++ signature :
        boost::shared_ptr<core::pack::task::TaskFactory> parse_task_operations(boost::shared_ptr<utility::tag::Tag const>,basic::datacache::DataMap)

parse_xyz_vector(...)

 

parse_xyz_vector( (Tag)xyz_vector_tag) -> xyzVector_Real :
    protocols/rosetta_scripts/util.hh:143

    C++ signature :
        numeric::xyzVector<double> parse_xyz_vector(boost::shared_ptr<utility::tag::Tag const>)

residue_packer_states(...)

 

residue_packer_states( (Pose)pose, (__CPP_TaskFactory__)tf, (bool)designable, (bool)packable) -> vector1_Size :
    returns a vector containing all the residues with a given packer state according to the TF
    

    C++ signature :
        utility::vector1<unsigned long, std::allocator<unsigned long> > residue_packer_states(core::pose::Pose,boost::shared_ptr<core::pack::task::TaskFactory const>,bool,bool)

saved_reference_pose(...)

 

saved_reference_pose( (Tag)in_tag, (DataMap)data_map [, (str)tag_str='reference_name']) -> Pose :
    convenience function to access pointers to poses that will be stored
    in the data map at an arbitrary point during an RS protocol
    Will look for tag in in_tag variable
    

    C++ signature :
        boost::shared_ptr<core::pose::Pose> saved_reference_pose(boost::shared_ptr<utility::tag::Tag const>,basic::datacache::DataMap {lvalue} [,std::string='reference_name'])


Variables Details [hide private]

PSF_NEED_FULL_POSE_SET

Value:
rosetta.protocols.rosetta_scripts._protocols_rosetta_scripts_.PoseSele\
ctorFlags.PSF_NEED_FULL_POSE_SET

PSF_NONE

Value:
rosetta.protocols.rosetta_scripts._protocols_rosetta_scripts_.PoseSele\
ctorFlags.PSF_NONE