Example module. More...

Detailed Description

Example module.

This module contains simple classes that span many parts of IMP functionality, so it can be used to see how to write a new class, export it to Python, document it, and provide tests and examples.

The overview section of the module page can contain any MarkDown or doxygen markup as well as references to IMP classes such as IMP::Model.

imp_example_app

This is an example application (command line tool).

Info

Author(s): Daniel Russel

Maintainer: benmwebb

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:

See main IMP papers list.

Classes
class	ExampleComplexRestraint
	Restrain the diameter of a set of points. More...

class	ExampleConstraint
	A trivial constraint that just increments a counter. More...

class	ExampleDecorator
	A simple decorator which adds a name to a particle. More...

class	ExampleObject
	An example simple object which is reference counted. More...

class	ExamplePairScore
	Apply a harmonic to the distance between two particles. More...

class	ExampleRestraint
	Restrain a particle to be in the x,y plane. More...

class	ExampleSingletonModifier
	An example singleton modifier. More...

class	ExampleSubsetFilterTable

class	ExampleTemplateClassD
	A line segment templated on the dimension. More...

class	ExampleUnaryFunction
	A simple unary function. More...

class	PythonExampleConstraint
	An example Constraint written in Python. More...

class	PythonExamplePairScore
	An example PairScore written in Python. More...

class	PythonExampleRestraint
	An example restraint written in Python. More...

class	PythonExampleSingletonModifier
	An example SingletonModifier written in Python. More...

class	PythonExampleUnaryFunction
	An example UnaryFunction written in Python. More...

Typedefs
typedef IMP::Vector < ExampleDecorator >	ExampleDecorators

typedef Vector< Pointer < ExampleObject > >	ExampleObjects

typedef Vector< WeakPointer < ExampleObject > >	ExampleObjectsTemp

typedef IMP::Vector < IMP::Pointer < ExamplePairScore > >	ExamplePairScores

typedef IMP::Vector < IMP::WeakPointer < ExamplePairScore > >	ExamplePairScoresTemp

typedef ExampleTemplateClassD< 3 >	ExampleTemplateClass3D

typedef Vector < ExampleTemplateClassD< 3 > >	ExampleTemplateClass3Ds

Functions
Restraint *	create_chain_restraint (Model *m, const ParticleIndexes &ps, double length_factor, double k, std::string name)

Restraint *	create_excluded_volume (Model *m, const ParticleIndexes &ps, double k, std::string name)

unsigned int	get_number_of_incidences (const ParticlesTemp &psa, const ParticlesTemp &psb, double point_distance)

template<class ParticlesList , class BoundingVolume >
void	randomize_particles (const ParticlesList &ps, const BoundingVolume &bv)

template<class RigidBody , class BoundingVolume >
void	randomize_rigid_body (RigidBody rbi, const BoundingVolume &bv)

Standard module functions
All `IMP` modules have a set of standard functions to help get information about the module and about files associated with the module.
std::string	get_module_version ()
	Return the version of this module, as a string. More...

std::string	get_module_name ()

std::string	get_data_path (std::string file_name)
	Return the full path to one of this module's data files. More...

std::string	get_example_path (std::string file_name)
	Return the full path to one of this module's example files. More...

Typedef Documentation

typedef IMP::Vector<IMP::Pointer< ExamplePairScore > > IMP::example::ExamplePairScores

A vector of reference-counting object pointers.

Definition at line 50 of file ExamplePairScore.h.

typedef IMP::Vector<IMP::WeakPointer< ExamplePairScore > > IMP::example::ExamplePairScoresTemp

A vector of weak (non reference-counting) pointers to specified objects.

See Also: ExamplePairScore

Definition at line 50 of file ExamplePairScore.h.

Function Documentation

Restraint* IMP::example::create_chain_restraint	(	Model *	m,
		const ParticleIndexes &	ps,
		double	length_factor,
		double	k,
		std::string	name
	)

Restrain the passed particles to be connected in a chain. The distance between consecutive particles is length_factor*the sum of the radii.

Note, this assumes that all such chains will be disjoint and so you can use the container::ExclusiveConsecutivePairFilter if you want to filter out all pairs of particles connected by such chain restraints.

The restraint is not added to the model.

Definition at line 31 of file creating_restraints.h.

Here is the call graph for this function:

Restraint* IMP::example::create_excluded_volume	(	Model *	m,
		const ParticleIndexes &	ps,
		double	k,
		std::string	name
	)

Create an excluded-volume style ClosePairContainer based score.

Definition at line 50 of file creating_restraints.h.

Here is the call graph for this function:

std::string IMP::example::get_data_path ( std::string file_name )

Return the full path to one of this module's data files.

To read the data file "data_library" that was placed in the data directory of this module, do something like

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

This will ensure that the code works both when IMP is installed or if used via the setup_environment.sh script.

Note: Each module has its own data directory, so be sure to use this function from the correct module.

std::string IMP::example::get_example_path ( std::string file_name )

Return the full path to one of this module's example files.

To read the example file "example_protein.pdb" that was placed in the examples directory of this module, do something like

std::ifstream in(IMP::example::get_example_path("example_protein.pdb"));

This will ensure that the code works both when IMP is installed or if used via the setup_environment.sh script.

Note: Each module has its own example directory, so be sure to use this function from the correct module.

std::string IMP::example::get_module_version ( )

Return the version of this module, as a string.

Note: This function is only available in Python.

Definition at line 5 of file EMageFit/__init__.py.

unsigned int IMP::example::get_number_of_incidences	(	const ParticlesTemp &	psa,
		const ParticlesTemp &	psb,
		double	point_distance
	)

Return the number of times particles from one set are close to those from another set.

Note: This method uses the distance between the centers of the particles and does not use their radii.

Definition at line 23 of file counting.h.

Here is the call graph for this function:

template<class ParticlesList , class BoundingVolume >

void IMP::example::randomize_particles	(	const ParticlesList &	ps,
		const BoundingVolume &	bv
	)

Randomize the positions of a set of particles within a bounding volume. Rigid bodies have their orientation randomized too.

Definition at line 32 of file randomizing.h.

Here is the call graph for this function:

Detailed Description

imp_example_app

Info

Classes

Typedefs

Functions

Standard module functions

Typedef Documentation

Function Documentation