IMP::example Namespace Reference

---

Detailed Description

This module provides example showing how to implement various types of objects and functionality in IMP.

Author:

Daniel Russel

Version:

1.0

Overview:

The overview section of the module page can contain any doxygen markup as well as references to IMP classes such as IMP::Model. See the doxygen web site for a full description of what can be done in doxygen.

Remember to escape characters to keep python happy.

Examples

Examples can be found on the IMP.example 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.

Publications:

• Daniel Russel, Keren Lasker, Ben Webb, Dina Schneidman, Javier Velazquez-Muriel, Andrej Sali, “Integrative assembly modeling using IMP”, submitted, 2010. This paper provides an overview of the key concepts in IMP and how to apply them to biological problems.
• Frank Alber, Friedrich Foerster, Dmitry Korkin, Maya Topf, Andrej Sali, “Integrating diverse data for structure determination of macromolecular assemblies”, Annual Review of Biochemistry, 2008. This paper provides a review of the integrative structure determination methodology and various data sources that can be used.
• Some Person, Someone Else, “A silly title of no paper”, Dev Null, 2051.
• IMP

Data Structures
class	ExampleComplexRestraint
	Restrain the diameter of a set of points. More...
class	ExampleDecorator
	A simple decorator which adds a name to a particle. More...
class	ExampleRefCounted
	An example simple object which is reference counted. More...
class	ExampleRestraint
	Apply a PairScore to a list of particle pairs. More...
class	ExampleSingletonModifier
	An example singleton modifer. More...
class	ExampleTemplateClass
	A line segment templated on the dimension. More...
class	ExampleUnaryFunction
	A simple unary function. More...
Typedefs
typedef Decorators < ExampleDecorator, Particles >	ExampleDecorators
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.
std::string	get_module_name ()
const VersionInfo &	get_module_version_info ()

---

Typedef Documentation

typedef Decorators<ExampleDecorator, Particles> IMP::example::ExampleDecorators

Define a collection of them. Also look at example.i

---

Function Documentation

std::string IMP::example::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::example::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.