options

Bindings for basic::options namespace

pyrosetta.rosetta.basic.options.add_anonymous_option(options: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.OptionKey) → None

Add a base-class OptionKey to an OptionCollection by trying to perform a dynamic

cast to each of the available option types until the correct derived class is found.

C++: basic::options::add_anonymous_option(class utility::options::OptionCollection &, const class utility::options::OptionKey &) –> void

pyrosetta.rosetta.basic.options.get_boolean_option(id: str) → bool

C++: basic::options::get_boolean_option(const std::string &) –> bool

pyrosetta.rosetta.basic.options.get_boolean_vector_option(id: str) → pyrosetta.rosetta.utility.vector1_bool

C++: basic::options::get_boolean_vector_option(const std::string &) –> class utility::vector1<bool, class std::allocator<bool> >

pyrosetta.rosetta.basic.options.get_file_option(id: str) → str

C++: basic::options::get_file_option(const std::string &) –> std::string

pyrosetta.rosetta.basic.options.get_file_vector_option(id: str) → pyrosetta.rosetta.utility.vector1_std_string

C++: basic::options::get_file_vector_option(const std::string &) –> class utility::vector1<std::string, class std::allocator<std::string > >

pyrosetta.rosetta.basic.options.get_integer_option(id: str) → int

C++: basic::options::get_integer_option(const std::string &) –> int

pyrosetta.rosetta.basic.options.get_integer_vector_option(id: str) → pyrosetta.rosetta.utility.vector1_int

C++: basic::options::get_integer_vector_option(const std::string &) –> class utility::vector1<int, class std::allocator<int> >

pyrosetta.rosetta.basic.options.get_path_option(id: str) → str

C++: basic::options::get_path_option(const std::string &) –> std::string

pyrosetta.rosetta.basic.options.get_path_vector_option(id: str) → pyrosetta.rosetta.utility.vector1_std_string

C++: basic::options::get_path_vector_option(const std::string &) –> class utility::vector1<std::string, class std::allocator<std::string > >

pyrosetta.rosetta.basic.options.get_real_option(id: str) → float

C++: basic::options::get_real_option(const std::string &) –> double

pyrosetta.rosetta.basic.options.get_real_vector_option(id: str) → pyrosetta.rosetta.utility.vector1_double

C++: basic::options::get_real_vector_option(const std::string &) –> class utility::vector1<double, class std::allocator<double> >

pyrosetta.rosetta.basic.options.get_string_option(id: str) → str

C++: basic::options::get_string_option(const std::string &) –> std::string

pyrosetta.rosetta.basic.options.get_string_vector_option(id: str) → pyrosetta.rosetta.utility.vector1_std_string

C++: basic::options::get_string_vector_option(const std::string &) –> class utility::vector1<std::string, class std::allocator<std::string > >

pyrosetta.rosetta.basic.options.initialize() → pyrosetta.rosetta.utility.options.OptionCollection

Initialize the options

C++: basic::options::initialize() –> class utility::options::OptionCollection &

pyrosetta.rosetta.basic.options.int2afteroption(*args, **kwargs)

Overloaded function.

1. int2afteroption(str: str, opt_default: int, inum: int, opt_default2: int, inum2: int) -> None

C++: basic::options::int2afteroption(const std::string &, const int, int &, const int, int &) –> void

2. int2afteroption(key: utility::options::OptionKey, opt_default: int, inum: int, opt_default2: int, inum2: int) -> None

C++: basic::options::int2afteroption(const class utility::options::OptionKey &, const int, int &, const int, int &) –> void

pyrosetta.rosetta.basic.options.intafteroption(*args, **kwargs)

Overloaded function.

1. intafteroption(str: str) -> int

C++: basic::options::intafteroption(const std::string &) –> int

2. intafteroption(str: str, opt_default: int) -> int

C++: basic::options::intafteroption(const std::string &, const int) –> int

3. intafteroption(str: str, opt_default: int, inum: int) -> None

C++: basic::options::intafteroption(const std::string &, const int, int &) –> void

4. intafteroption(key: utility::options::OptionKey, opt_default: int, inum: int) -> None

C++: basic::options::intafteroption(const class utility::options::OptionKey &, const int, int &) –> void

pyrosetta.rosetta.basic.options.optional_positive_intafteroption(*args, **kwargs)

Overloaded function.

1. optional_positive_intafteroption(str: str, opt_default: int, inum: int) -> None

C++: basic::options::optional_positive_intafteroption(const std::string &, const int, int &) –> void

2. optional_positive_intafteroption(key: utility::options::OptionKey, opt_default: int, inum: int) -> None

C++: basic::options::optional_positive_intafteroption(const class utility::options::OptionKey &, const int, int &) –> void

pyrosetta.rosetta.basic.options.pre_tracer_process() → pyrosetta.rosetta.utility.options.OptionCollection

Process complex option inter-dependencies, prior to Tracer initializations

C++: basic::options::pre_tracer_process() –> class utility::options::OptionCollection &

pyrosetta.rosetta.basic.options.process() → pyrosetta.rosetta.utility.options.OptionCollection

Process complex option inter-dependencies (after tracer system is initialized)

C++: basic::options::process() –> class utility::options::OptionCollection &

pyrosetta.rosetta.basic.options.read_subset_of_global_option_collection(opt_keys: pyrosetta.rosetta.std.list_utility_keys_VariantKey_utility_options_OptionKey_t) → pyrosetta.rosetta.utility.options.OptionCollection

Create an OptionCollection that knows about only the subset of option keys

listed in the input OptionsKeys list. Load this new OptionCollection with the values and the defaults that are stored in the global option collection.

C++: basic::options::read_subset_of_global_option_collection(const class std::list<class utility::keys::VariantKey<class utility::options::OptionKey>, class std::allocator<class utility::keys::VariantKey<class utility::options::OptionKey> > > &) –> class std::shared_ptr<class utility::options::OptionCollection>

pyrosetta.rosetta.basic.options.real2afteroption(*args, **kwargs)

Overloaded function.

1. real2afteroption(str: str, default1: float, rnum1: float, default2: float, rnum2: float) -> None

C++: basic::options::real2afteroption(const std::string &, const double, double &, const double, double &) –> void

2. real2afteroption(key: utility::options::OptionKey, default1: float, rnum1: float, default2: float, rnum2: float) -> None

C++: basic::options::real2afteroption(const class utility::options::OptionKey &, const double, double &, const double, double &) –> void

pyrosetta.rosetta.basic.options.real3afteroption(*args, **kwargs)

Overloaded function.

1. real3afteroption(str: str, default1: float, rnum1: float, default2: float, rnum2: float, default3: float, rnum3: float) -> None

C++: basic::options::real3afteroption(const std::string &, const double, double &, const double, double &, const double, double &) –> void

2. real3afteroption(key: utility::options::OptionKey, default1: float, rnum1: float, default2: float, rnum2: float, default3: float, rnum3: float) -> None

C++: basic::options::real3afteroption(const class utility::options::OptionKey &, const double, double &, const double, double &, const double, double &) –> void

pyrosetta.rosetta.basic.options.realafteroption(*args, **kwargs)

Overloaded function.

1. realafteroption(str: str) -> float

C++: basic::options::realafteroption(const std::string &) –> double

2. realafteroption(str: str, opt_default: float) -> float

C++: basic::options::realafteroption(const std::string &, const double) –> double

3. realafteroption(str: str, opt_default: float, rnum: float) -> None

C++: basic::options::realafteroption(const std::string &, const double, double &) –> void

4. realafteroption(key: utility::options::OptionKey, opt_default: float, rnum: float) -> None

C++: basic::options::realafteroption(const class utility::options::OptionKey &, const double, double &) –> void

pyrosetta.rosetta.basic.options.replace_option_namespace_colons_with_underscores(key: pyrosetta.rosetta.utility.options.OptionKey) → str

C++: basic::options::replace_option_namespace_colons_with_underscores(const class utility::options::OptionKey &) –> std::string

pyrosetta.rosetta.basic.options.set_boolean_option(id: str, : bool) → None

C++: basic::options::set_boolean_option(const std::string &, bool) –> void

pyrosetta.rosetta.basic.options.set_boolean_vector_option(id: str, : pyrosetta.rosetta.utility.vector1_bool) → None

C++: basic::options::set_boolean_vector_option(const std::string &, const class utility::vector1<bool, class std::allocator<bool> > &) –> void

pyrosetta.rosetta.basic.options.set_file_option(id: str, : str) → None

C++: basic::options::set_file_option(const std::string &, const std::string &) –> void

pyrosetta.rosetta.basic.options.set_file_vector_option(id: str, : pyrosetta.rosetta.utility.vector1_std_string) → None

C++: basic::options::set_file_vector_option(const std::string &, const class utility::vector1<std::string, class std::allocator<std::string > > &) –> void

pyrosetta.rosetta.basic.options.set_integer_option(id: str, : int) → None

C++: basic::options::set_integer_option(const std::string &, int) –> void

pyrosetta.rosetta.basic.options.set_integer_vector_option(id: str, : pyrosetta.rosetta.utility.vector1_int) → None

C++: basic::options::set_integer_vector_option(const std::string &, const class utility::vector1<int, class std::allocator<int> > &) –> void

pyrosetta.rosetta.basic.options.set_path_option(id: str, : str) → None

C++: basic::options::set_path_option(const std::string &, const std::string &) –> void

pyrosetta.rosetta.basic.options.set_path_vector_option(id: str, : pyrosetta.rosetta.utility.vector1_std_string) → None

C++: basic::options::set_path_vector_option(const std::string &, const class utility::vector1<std::string, class std::allocator<std::string > > &) –> void

pyrosetta.rosetta.basic.options.set_real_option(id: str, : float) → None

C++: basic::options::set_real_option(const std::string &, double) –> void

pyrosetta.rosetta.basic.options.set_real_vector_option(id: str, : pyrosetta.rosetta.utility.vector1_double) → None

C++: basic::options::set_real_vector_option(const std::string &, const class utility::vector1<double, class std::allocator<double> > &) –> void

pyrosetta.rosetta.basic.options.set_string_option(id: str, : str) → None

C++: basic::options::set_string_option(const std::string &, const std::string &) –> void

pyrosetta.rosetta.basic.options.set_string_vector_option(id: str, : pyrosetta.rosetta.utility.vector1_std_string) → None

C++: basic::options::set_string_vector_option(const std::string &, const class utility::vector1<std::string, class std::allocator<std::string > > &) –> void

pyrosetta.rosetta.basic.options.start_file() → str

convenience functions

C++: basic::options::start_file() –> std::string

pyrosetta.rosetta.basic.options.start_files() → pyrosetta.rosetta.utility.vector1_std_string

C++: basic::options::start_files() –> class utility::vector1<std::string, class std::allocator<std::string > >

pyrosetta.rosetta.basic.options.stringafteroption(*args, **kwargs)

Overloaded function.

1. stringafteroption(str: str) -> str

C++: basic::options::stringafteroption(const std::string &) –> std::string

2. stringafteroption(str: str, opt_default: str) -> str

C++: basic::options::stringafteroption(const std::string &, const std::string &) –> std::string

3. stringafteroption(str: str, opt_default: str, cval: str) -> None

C++: basic::options::stringafteroption(const std::string &, const std::string &, std::string &) –> void

4. stringafteroption(key: utility::options::OptionKey, opt_default: str, cval: str) -> None

C++: basic::options::stringafteroption(const class utility::options::OptionKey &, const std::string &, std::string &) –> void

5. stringafteroption(str: str, opt_default: str, cval: str) -> None

C++: basic::options::stringafteroption(const std::string &, const char, char &) –> void

6. stringafteroption(key: utility::options::OptionKey, opt_default: str, cval: str) -> None

C++: basic::options::stringafteroption(const class utility::options::OptionKey &, const char, char &) –> void

pyrosetta.rosetta.basic.options.truefalseoption(*args, **kwargs)

Overloaded function.

1. truefalseoption(str: str) -> bool

C++: basic::options::truefalseoption(const std::string &) –> bool

2. truefalseoption(key: utility::options::OptionKey) -> bool

C++: basic::options::truefalseoption(const class utility::options::OptionKey &) –> bool