python.sugar.iovtype.IOVType Class Reference

Inheritance diagram for python.sugar.iovtype.IOVType:

Collaboration diagram for python.sugar.iovtype.IOVType:

Public Member Functions
def	__reduce__ (self)
def	empty (cls, since=None, until=None)
def	runs (self)
def	run (self)
def	contains_point (self, iovkey)
def	intersect (self, iov)
def	intersects (self, iov)
def	length (self)
def	connected_to (self, rhs)
def	merge (self, rhs)
def	trimmed (self)
def	is_time_based (self)
def	intersect_run (self, run_number)

Public Attributes
	until

Private Member Functions
def	_contents (self)

Private Attributes
	_contents

Static Private Attributes
tuple	__slots__ = ()
bool	_is_empty = False

Detailed Description

A type which encapsulates an IoV

Definition at line 23 of file iovtype.py.

Member Function Documentation

__reduce__()

def python.sugar.iovtype.IOVType.__reduce__

(

self

)

Make IOVType pickleable

Definition at line 31 of file iovtype.py.

    def __reduce__(self):
        """
        Make IOVType pickleable
        """
        # Take all but the first base class, which is unpicklable
        bases = type(self).__bases__[1:] 
        name = type(self).__name__
        args = name, self._fields[2:], bases, tuple(self), self._is_empty
        return restore_iov_type, args
        

_contents()

def python.sugar.iovtype.IOVType._contents (   self )

private

Definition at line 84 of file iovtype.py.

    def _contents(self):
        return self[2+self._has_insertion_time:]
    

connected_to()

def python.sugar.iovtype.IOVType.connected_to	(		self,
			rhs
	)

Definition at line 80 of file iovtype.py.

    def connected_to(self, rhs):
        return self.until == rhs.since and self._contents == rhs._contents
    

contains_point()

def python.sugar.iovtype.IOVType.contains_point	(		self,
			iovkey
	)

Definition at line 62 of file iovtype.py.

    def contains_point(self, iovkey):
        return self.since <= iovkey < self.until
    

empty()

def python.sugar.iovtype.IOVType.empty	(		cls,
			since = None,
			until = None
	)

Definition at line 42 of file iovtype.py.

    def empty(cls, since=None, until=None):
        empty_fields = [since, until] + [None] * (len(cls._fields)-2)
        return cls._emptycls(*empty_fields)
    

intersect()

def python.sugar.iovtype.IOVType.intersect	(		self,
			iov
	)

Definition at line 65 of file iovtype.py.

    def intersect(self, iov):
        if not self.intersects(iov):
            return None
        since, until = max(self.since, iov.since), min(self.until, iov.until)
        if since == until:
            return None
        return self._replace(since=since, until=until)
    

intersect_run()

def python.sugar.iovtype.IOVType.intersect_run	(		self,
			run_number
	)

Definition at line 106 of file iovtype.py.

    def intersect_run(self, run_number):
        runpart = run_number << 32
        sincelo, sincehi = RunLumi(runpart | 1), RunLumi(runpart | 0xFFFFFFFF)
        since, until = max(self.since, sincelo), min(self.until, sincehi)
        if since >= until:
            return None
        return self._replace(since=since, until=until)
 

intersects()

def python.sugar.iovtype.IOVType.intersects	(		self,
			iov
	)

Definition at line 73 of file iovtype.py.

    def intersects(self, iov):
        return self.since < iov.until and self.until >= iov.since
        

is_time_based()

def python.sugar.iovtype.IOVType.is_time_based

(

self

)

Definition at line 103 of file iovtype.py.

    def is_time_based(self):
        return self.since.is_time
 

length()

def python.sugar.iovtype.IOVType.length

(

self

)

Definition at line 77 of file iovtype.py.

    def length(self):
        return self.until - self.since if self.until != IOVMAX else 0
        

merge()

def python.sugar.iovtype.IOVType.merge	(		self,
			rhs
	)

Assuming this and `rhs` are `connected_to` each other, then extend.

Definition at line 87 of file iovtype.py.

    def merge(self, rhs):
        """
        Assuming this and `rhs` are `connected_to` each other, then extend.
        """
        return self._replace(until=rhs.until)
    

run()

def python.sugar.iovtype.IOVType.run

(

self

)

Returns the run the IoV started in

Definition at line 56 of file iovtype.py.

    def run(self):
        """
        Returns the run the IoV started in
        """
        return self.since.run
    

runs()

def python.sugar.iovtype.IOVType.runs

(

self

)

Return a generator of runs

Definition at line 47 of file iovtype.py.

    def runs(self):
        """
        Return a generator of runs
        """
        if self.until == IOVMAX:
            return [self.since.run]
        return range(self.since.run, self.until.run+1)
 

trimmed()

def python.sugar.iovtype.IOVType.trimmed

(

self

)

If this IoV starts on lumiblock 0, instead make it start from 1.

Definition at line 94 of file iovtype.py.

    def trimmed(self):
        """
        If this IoV starts on lumiblock 0, instead make it start from 1.
        """
        if self.since.lumi == 0:
            return self._replace(since=self.since+1)
        return self
        

Member Data Documentation

__slots__

tuple python.sugar.iovtype.IOVType.__slots__ = ()

staticprivate

Definition at line 27 of file iovtype.py.

_contents

python.sugar.iovtype.IOVType._contents

private

Definition at line 81 of file iovtype.py.

_is_empty

bool python.sugar.iovtype.IOVType._is_empty = False

staticprivate

Definition at line 28 of file iovtype.py.

until

python.sugar.iovtype.IOVType.until

Definition at line 51 of file iovtype.py.

---

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

• iovtype.py