ConstraintsGenerator Class Reference

Inheritance diagram for ConstraintsGenerator:

Collaboration diagram for ConstraintsGenerator:

Public Member Functions
def	__init__ (self, generator)
def	event (self)
def	terminate (self)

Public Attributes
	generator
	The generator: alignment.Constraints.
	consts
	Generated constraints (key is constraint checksum)

Detailed Description

basf2 python module to generate a file with a single set of constraints

(Needed especially for time-dependent constraints)

Definition at line 19 of file constraints_generator.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			generator
	)

Constructor

Parameters
----------
generator : alignment.Constraints
  Set of constraints to be generated (defines also filename)

Definition at line 26 of file constraints_generator.py.

    def __init__(self, generator):
        """
        Constructor
 
        Parameters
        ----------
        generator : alignment.Constraints
          Set of constraints to be generated (defines also filename)
 
        """
 
        super().__init__()
        
        self.generator = generator
        
        self.consts = dict()
        super().set_name(super().name() + ":" + generator.filename)
 

Member Function Documentation

event()

def event

(

self

)

 Event: attempt to add constraints
At each event, attempt to generate the constraints and add them
to the dict (same cheksum - using only labels - means it gets overriden!)
Thus is only works if the time-dependence is set (otherwise you always get the same labels and
only the last constraint coefficients will be stored)

Definition at line 44 of file constraints_generator.py.

terminate()

def terminate

(

self

)

 Terminate: write-down collect constraint data to file

Definition at line 55 of file constraints_generator.py.

---

The documentation for this class was generated from the following file:

• alignment/scripts/alignment/constraints_generator.py