ConstraintsGenerator Class Reference

Inheritance diagram for ConstraintsGenerator:

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

Public Attributes
	generator = generator
	The generator: alignment.Constraints.
	consts = dict()
	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__()

__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()

event

(

self

)

 Event: attempt to add constraints
At each event, attempt to generate the constraints and add them
to the dict (same checksum - using only labels - means it gets overridden!)
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.

    def event(self):
        """ Event: attempt to add constraints
        At each event, attempt to generate the constraints and add them
        to the dict (same checksum - using only labels - means it gets overridden!)
        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)
        """
        consts = self.generator.generate()
        for const in consts:
            self.consts[const.get_checksum()] = const.data
 

terminate()

terminate

(

self

)

 Terminate: write-down collect constraint data to file

Definition at line 55 of file constraints_generator.py.

    def terminate(self):
        """ Terminate: write-down collect constraint data to file
        """
        if len(self.consts):
            with open(self.generator.filename, 'w') as f:
                for checksum, data in self.consts.items():
                    f.write('Constraint 0.\n')
                    for label, coef in data:
                        f.write('{} {}\n'.format(label, coef))
                print("Finished file: ", self.generator.filename)
        print("Done: ", self.generator.filename)
 
 

Member Data Documentation

consts

consts = dict()

Generated constraints (key is constraint checksum)

Definition at line 41 of file constraints_generator.py.

generator

generator = generator

The generator: alignment.Constraints.

Definition at line 39 of file constraints_generator.py.

---

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

• alignment/scripts/alignment/constraints_generator.py