Rosetta Core  2014.35
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
core::pack::task Namespace Reference

Namespaces

 operation
 
 residue_selector
 
 rna
 

Classes

class  ALLAA
 ALLAA is deprecated; allows repacking and designing to any canonical residue (default state of PackerTask) More...
 
class  ALLAAwc
 allows repacking and designing to any canonical residue (default state of PackerTask) More...
 
class  ALLAAxc
 ALLAAxc allows repacking and designing to any canonical noncysteine residue. More...
 
class  APOLA
 APOLA is deprecated, it calls APOLAR to allow nonpolar residues and packing. More...
 
class  APOLAR
 APOLAR allows nonpolar residues and packing. More...
 
class  AUTO
 AUTO suggests that a packer can/should reconsider the design setting at a/each residue. More...
 
class  EMPTY
 EMPTY disallows all canonical and noncanonical residues. More...
 
class  EX
 EX handles the various extrachi options. More...
 
class  EX_CUTOFF
 EX_CUTOFF allows setting of the extrachi_cutoff (for determining burial for extra rotamers) More...
 
class  FIX_HIS_TAUTOMER
 FIX_HIS_TAUTOMER: when a histidine is present when the PackerTask is initialized, this flag will fix its tautomer (whether its hydrogen is on ND1 or NE2. Does nothing if not histidine at initialization (meaning if it mutates to histidine later this flag will have no effect). More...
 
class  IGEdgeReweightContainer
 class that interfaces to containers holding IGedge weights between individual residues of the task More...
 
class  IGEdgeReweighter
 helper class for IGEdgeReweightContainer More...
 
class  NATAA
 NATAA allows repacking but no sequence changes (all rotamers are of the original residue) More...
 
class  NATRO
 NATRO disables packing and designing at a position, the residue will be totally unchanged. More...
 
class  NC
 NC handles explicit allowance of noncanonical residue types. More...
 
class  NO_ADDUCTS
 NO_ADDUCTS will disable adducts, assuming they exist This command exists because if adducts exist, then they are enabled by default for all residues. More...
 
class  NOTAA
 NOTAA disallows residues specified in a following string, and allows packing. More...
 
class  PackerTask
 Task class that gives instructions to the packer. More...
 
class  PackerTask_
 the PackerTask controls what rotameric (including sequence) changes the packer is allowed to make More...
 
class  PIKAA
 PIKAA allows residues specifed in a following string and packing. More...
 
class  PIKNA
 PIKNA allows nucleic acid residues specifed in a following string. More...
 
class  PIKRNA
 PIKRNA allows nucleic acid residues specifed in a following string. More...
 
class  POLAR
 POLAR allows polar residues and packing. More...
 
class  RESET
 RESET restores the list of allowd residue types to the CAAs. More...
 
class  ResfileCommand
 abstract/interface class for Resfile reader command objects More...
 
class  ResfileContents
 
class  ResfileReaderException
 
class  ResidueLevelTask
 
class  ResidueLevelTask_
 Residue-level task class; contained within PackerTask. More...
 
class  SCAN
 SCAN suggests to some packing routines that if there are multiple type choices for this residue, then each of them should be considered explicitly in one way or another. More...
 
class  TARGET
 TARGET flags the position as "targeted", and can optionally specify a "targeted" type. More...
 
class  TaskFactory
 Factory class for the creation and initialization of PackerTask objects. More...
 
class  USE_INPUT_SC
 USE_INPUT_SC turns on inclusion of the current rotamer for the packer. More...
 

Typedefs

typedef
utility::pointer::owning_ptr
< IGEdgeReweighter
IGEdgeReweighterOP
 
typedef
utility::pointer::owning_ptr
< IGEdgeReweighter const > 
IGEdgeReweighterCOP
 
typedef
utility::pointer::owning_ptr
< IGEdgeReweightContainer
IGEdgeReweightContainerOP
 
typedef
utility::pointer::owning_ptr
< IGEdgeReweightContainer
const > 
IGEdgeReweightContainerCOP
 
typedef
utility::pointer::owning_ptr
< PackerTask
PackerTaskOP
 
typedef
utility::pointer::owning_ptr
< PackerTask const > 
PackerTaskCOP
 
typedef
utility::pointer::owning_ptr
< PackerTask_
PackerTask_OP
 
typedef
utility::pointer::owning_ptr
< PackerTask_ const > 
PackerTask_COP
 
typedef
utility::pointer::owning_ptr
< ResfileCommand
ResfileCommandOP
 
typedef
utility::pointer::owning_ptr
< ResfileCommand const > 
ResfileCommandCOP
 
typedef
utility::pointer::owning_ptr
< ResfileContents
ResfileContentsOP
 
typedef
utility::pointer::owning_ptr
< ResfileContents const > 
ResfileContentsCOP
 
typedef boost::shared_ptr
< TaskFactory
TaskFactorySP
 
typedef
utility::pointer::owning_ptr
< TaskFactory
TaskFactoryOP
 
typedef
utility::pointer::owning_ptr
< TaskFactory const > 
TaskFactoryCOP
 

Enumerations

enum  PackerTaskSymmetryStatus { NO_SYMMETRIZATION_REQUEST, REQUEST_SYMMETRIZE_BY_UNION, REQUEST_SYMMETRIZE_BY_INTERSECTION, ALREADY_SYMMETRIZED }
 
enum  ExtraRotSample {
  NO_EXTRA_CHI_SAMPLES = 0, EX_ONE_STDDEV, EX_ONE_HALF_STEP_STDDEV, EX_TWO_FULL_STEP_STDDEVS,
  EX_TWO_HALF_STEP_STDDEVS, EX_FOUR_HALF_STEP_STDDEVS, EX_THREE_THIRD_STEP_STDDEVS, EX_SIX_QUARTER_STEP_STDDEVS,
  ExtraRotSampleCardinality
}
 levels of extra rotamer sampling, i.e., step size and number of steps. More...
 

Functions

std::ostream & operator<< (std::ostream &os, PackerTask const &task)
 output highlights of the internal data of PackerTask_: for each residue whether it is to be packed, designed and which amino acids are allowed. More...
 
std::map< std::string,
ResfileCommandOP
create_command_map ()
 utility for resfile reader, commands MUST be entered into this hard-coded map More...
 
bool comment_begin (utility::vector1< std::string > const &tokens, Size which_token)
 utility function for resfile reader (checks for a leading # signaling a comment) More...
 
void parse_resfile (pose::Pose const &pose, PackerTask &the_task)
 changes the state of the given PackerTask according to the commands in the resfile at read in from the -pack:resfile option system. More...
 
void parse_resfile (pose::Pose const &pose, PackerTask &the_task, std::string filename)
 changes the state of the given PackerTask according to the commands in the resfile at filename More...
 
void parse_resfile_string (pose::Pose const &pose, PackerTask &the_task, std::string const &resfile_string) throw (ResfileReaderException)
 changes the state of the given PackerTask according to the commands in the resfile. More...
 
std::string get_token (const Size which_token, const utility::vector1< std::string > &tokens, const bool make_upper_case=true)
 utility function to increment next token to be parsed More...
 
utility::vector1< std::string > tokenize_line (std::istream &inputstream)
 utility function for resfile reader More...
 
void onError (std::string message)
 
ExtraRotSample rot_sample_from_name (std::string const &name)
 
bool is_rot_sample_name (std::string const &name)
 

Variables

static basic::Tracer tr ("core.pack.task.IGEdgeReweightContainer")
 
basic::Tracer T ("core.pack.task", basic::t_info)
 
static basic::Tracer TR ("core.pack.task.ResfileReader")
 
const int EXTRACHI_CUTOFF_LIMIT = 18
 

Typedef Documentation

Enumeration Type Documentation

levels of extra rotamer sampling, i.e., step size and number of steps.

Enumerator
NO_EXTRA_CHI_SAMPLES 
EX_ONE_STDDEV 
EX_ONE_HALF_STEP_STDDEV 
EX_TWO_FULL_STEP_STDDEVS 
EX_TWO_HALF_STEP_STDDEVS 
EX_FOUR_HALF_STEP_STDDEVS 
EX_THREE_THIRD_STEP_STDDEVS 
EX_SIX_QUARTER_STEP_STDDEVS 
ExtraRotSampleCardinality 
Enumerator
NO_SYMMETRIZATION_REQUEST 
REQUEST_SYMMETRIZE_BY_UNION 
REQUEST_SYMMETRIZE_BY_INTERSECTION 
ALREADY_SYMMETRIZED 

Function Documentation

bool core::pack::task::comment_begin ( utility::vector1< std::string > const &  tokens,
Size  which_token 
)

utility function for resfile reader (checks for a leading # signaling a comment)

References get_token().

Referenced by core::pack::task::ResfileContents::parse_body_line(), core::pack::task::ResfileContents::parse_header_line(), and core::pack::task::ResfileContents::ResfileContents().

std::map< std::string, ResfileCommandOP > core::pack::task::create_command_map ( )
std::string core::pack::task::get_token ( const Size  which_token,
const utility::vector1< std::string > &  tokens,
bool  make_upper_case 
)

utility function to increment next token to be parsed

utility function to increment next token to be parsed

The PDB specification is case insensitive everywhere except for the chain identifiers. By default get_tokens makes everything upper case. To handle this special case, get_tokens optionally allows it to not convert it to upper case.

References onError().

Referenced by comment_begin(), core::pack::task::NATRO::initialize_from_tokens(), core::pack::task::NATAA::initialize_from_tokens(), core::pack::task::ALLAA::initialize_from_tokens(), core::pack::task::ALLAAxc::initialize_from_tokens(), core::pack::task::ALLAAwc::initialize_from_tokens(), core::pack::task::PIKAA::initialize_from_tokens(), core::pack::task::PIKNA::initialize_from_tokens(), core::pack::task::NOTAA::initialize_from_tokens(), core::pack::task::EMPTY::initialize_from_tokens(), core::pack::task::RESET::initialize_from_tokens(), core::pack::task::POLAR::initialize_from_tokens(), core::pack::task::APOLAR::initialize_from_tokens(), core::pack::task::APOLA::initialize_from_tokens(), core::pack::task::EX::initialize_from_tokens(), core::pack::task::NC::initialize_from_tokens(), core::pack::task::EX_CUTOFF::initialize_from_tokens(), core::pack::task::USE_INPUT_SC::initialize_from_tokens(), core::pack::task::AUTO::initialize_from_tokens(), core::pack::task::SCAN::initialize_from_tokens(), core::pack::task::TARGET::initialize_from_tokens(), core::pack::task::NO_ADDUCTS::initialize_from_tokens(), core::pack::task::ResfileContents::locate_command(), core::pack::task::ResfileContents::parse_header_line(), and core::pack::task::ResfileContents::parse_resid().

bool core::pack::task::is_rot_sample_name ( std::string const &  name)
void core::pack::task::onError ( std::string  message)
std::ostream& core::pack::task::operator<< ( std::ostream &  os,
PackerTask const &  task 
)

output highlights of the internal data of PackerTask_: for each residue whether it is to be packed, designed and which amino acids are allowed.

output operator

References core::pack::task::PackerTask::show().

void core::pack::task::parse_resfile ( pose::Pose const &  pose,
PackerTask &  the_task 
)

changes the state of the given PackerTask according to the commands in the resfile at read in from the -pack:resfile option system.

resfile parser applies a resfile filename to a PackerTask each line of the resfile is broken into whitespace-delimited tokens whenever it reads a comment token, it ignores the rest of the line commands read before a "start" token are stored for application later as defaults lines after the start token alter specific ResidueLevelTasks in the PackerTask currently the reader assumes residue ID = PDB ID at the end, any residues not explicitly specified have the default actions performed on them

References core::io::serialization::at(), basic::options::option, and basic::options::OptionKeys::packing::resfile.

Referenced by core::pack::task::operation::ReadResfile::apply().

void core::pack::task::parse_resfile ( pose::Pose const &  pose,
PackerTask &  the_task,
std::string  filename 
)

changes the state of the given PackerTask according to the commands in the resfile at filename

References file, basic::options::OptionKeys::run::interactive, basic::options::option, parse_resfile_string(), resfile, utility::slurp(), TR, user, utility_exit, and utility_exit_with_message.

void core::pack::task::parse_resfile_string ( pose::Pose const &  pose,
PackerTask &  the_task,
std::string const &  resfile_string 
)
throw (ResfileReaderException
)
ExtraRotSample core::pack::task::rot_sample_from_name ( std::string const &  name)
utility::vector1< std::string > core::pack::task::tokenize_line ( std::istream &  inputstream)

utility function for resfile reader

Referenced by core::pack::task::ResfileContents::ResfileContents().

Variable Documentation

const int core::pack::task::EXTRACHI_CUTOFF_LIMIT = 18
basic::Tracer core::pack::task::T("core.pack.task", basic::t_info)
basic::Tracer core::pack::task::tr("core.pack.task.IGEdgeReweightContainer")
static
basic::Tracer core::pack::task::TR("core.pack.task.ResfileReader")
static