openpathsampling.volume.PeriodicCVDefinedVolume

class openpathsampling.volume.PeriodicCVDefinedVolume(collectivevariable, lambda_min=0.0, lambda_max=1.0, period_min=None, period_max=None)

As with CVDefinedVolume, but for a periodic order parameter.

Defines a Volume containing all states where collectivevariable, a periodic function wrapping into the range [period_min, period_max], is in the given range [lambda_min, lambda_max].

period_min

minimum of the periodic domain

Type:

float (optional)

period_max

maximum of the periodic domain

Type:

float (optional)

__init__(collectivevariable, lambda_min=0.0, lambda_max=1.0, period_min=None, period_max=None)

Methods

__init__(collectivevariable[, lambda_min, ...])
args()	Return a list of args of the __init__ function of a class
base()	Return the most parent class actually derived from StorableObject
count_weaks()	Return number of objects subclassed from StorableObject still in memory
descendants()	Return a list of all subclassed objects
do_wrap(value)	Wraps value into the periodic domain.
fix_name()	Set the objects name to be immutable.
from_dict(dct)	Reconstruct an object from a dictionary representaiton
get_uuid()
idx(store)	Return the index which is used for the object in the given store.
named(name)	Name an unnamed object.
objects()	Returns a dictionary of all storable objects
range_and(amin, amax, bmin, bmax)
range_or(amin, amax, bmin, bmax)
range_sub(amin, amax, bmin, bmax)
reverse_uuid()
ruuid(uid)
set_observer(active)	(De-)Activate observing creation of storable objects
to_dict()	Convert object into a dictionary representation

Attributes

ACTIVE_LONG
CREATION_COUNT
INSTANCE_UUID
base_cls	Return the base class
base_cls_name	Return the name of the base class
cls	Return the class name as a string
default_name	Return the default name.
is_named	True if this object has a custom name.
name	Return the current name of the object.
observe_objects