IMP::misc Namespace Reference

---

Detailed Description

This module contains miscellaneous and experimental functionality.

Author:

Daniel Russel

Version:

1.0

Overview:

This module contains miscellaneous functionality that is not expected to be used by many IMP users. As a result, the code contained in it may be poorly tested, liable to change or experimental in nature.

In particular, other modules should not depend on IMP.misc (e.g. don't create a class in another module that derives from one in IMP.misc). If you find yourself relying on such functionality, discuss moving it to a specialized module or something like IMP.core or IMP.atom.

Examples

Examples can be found on the IMP.misc examples page.

License:

LGPL. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Data Structures
class	CommonEndpointPairFilter
	Return true for any pair of bonds sharing an endpoint. More...
class	LogPairScore
	Track the pairs of particles passed. More...
class	LowestRefinedPairScore
	Refine both particles with the refiner and score on the lowest pair. More...
class	StateAdaptor
	Allow OptimizerStates to be used as ScoreStates. More...
class	WormLikeChain
	Worm-like-chain energy for polymer chains. More...
Typedefs
typedef boost::adjacency_list < boost::vecS, boost::vecS, boost::undirectedS, boost::property < boost::vertex_name_t, Particle * >, boost::property < boost::edge_name_t, Object * > >	InteractionGraph
Functions
std::string	get_data_path (std::string file_name)
	Return the path to installed data for this module.
std::string	get_example_path (std::string file_name)
	Return the path to installed example data for this module.
InteractionGraph	get_interaction_graph (Model *m)
std::string	get_module_name ()
const VersionInfo &	get_module_version_info ()
void	show_attribute_usage (Model *m, std::ostream &out=std::cout)
	Print statistics about the attributes used in Particles.

---

Function Documentation

std::string IMP::misc::get_data_path

(

std::string

file_name

)

Return the path to installed data for this module.

Each module has its own data directory, so be sure to use the version of this function in the correct module. To read the data file "data_library" that was placed in the data directory of module "mymodule", do something like

    std::ifstream in(IMP::mymodule::get_data_path("data_library"));

This will ensure that the code works when IMP is installed or used via the tools/imppy.sh script.

std::string IMP::misc::get_example_path

(

std::string

file_name

)

Return the path to installed example data for this module.

Each module has its own example directory, so be sure to use the version of this function in the correct module. For example to read the file example_protein.pdb located in the examples directory of the IMP::atom module, do

    IMP::atom::read_pdb(IMP::atom::get_example_path("example_protein.pdb", model));

This will ensure that the code works when IMP is installed or used via the tools/imppy.sh script.

void IMP::misc::show_attribute_usage	(	Model *	m,
		std::ostream &	out = std::cout
	)

Print statistics about the attributes used in Particles.

For each type of attribute, the function prints the names of all the attributes and a list of how many particles has each pattern of attributes. Since the attributes are currently stored in arrays, a pattern is printed as a "-" if the particle doesn't have that attribute and a "X" if it does.