python.D3PDObject Namespace Reference

Classes
class	D3PDObject
class	DeferArg

Functions
	_make_name (name, prefix, name_prefix, parent_prefix, default_prefix)
	_testLOD (lod, reqlev, args, hookargs)
	make_Void_D3PDObject (default_prefix='', default_object_name='', default_name=None, allow_args=[])
	make_SG_D3PDObject (default_typeName, default_sgkey, default_prefix, default_object_name=None, default_allowMissing=False, default_getterClass=D3PD.SGObjGetterTool, allow_args=[])
	make_SGDataVector_D3PDObject (default_typeName, default_sgkey, default_prefix, default_object_name=None, default_allowMissing=False, default_getterFilter=None, default_label=None, default_getterClass=\ D3PD.SGDataVectorGetterTool, allow_args=[], **other_defaults)

Variables
	D3PD = CompFactory.D3PD

Function Documentation

_make_name()

python.D3PDObject._make_name ( name, prefix, name_prefix, parent_prefix, default_prefix )

protected

Helper to form the name for object filler tools.

Definition at line 19 of file D3PDObject.py.

def _make_name (name, prefix, name_prefix, parent_prefix, default_prefix):
    """Helper to form the name for object filler tools."""
    if name is None:
        pref = prefix + name_prefix
        if len (pref) == 0: pref = default_prefix
        if len (pref) == 0:
            pref = 'Unnamed_'
        name = parent_prefix + pref + 'Filler'
    return name
 
 

_testLOD()

python.D3PDObject._testLOD ( lod, reqlev, args, hookargs )

protected

Helper to perform LOD test.

lod: The level-of-detail to test.  Either an integer or a callable.
reqlev: Requested level of detail for this object.  An integer.
args: Arguments to be passed to the block.
hookargs: Arguments passed to the D3PD object, to be passed
          on to LOD functions.

Definition at line 30 of file D3PDObject.py.

def _testLOD (lod, reqlev, args, hookargs):
    """Helper to perform LOD test.
 
    lod: The level-of-detail to test.  Either an integer or a callable.
    reqlev: Requested level of detail for this object.  An integer.
    args: Arguments to be passed to the block.
    hookargs: Arguments passed to the D3PD object, to be passed
              on to LOD functions.
"""
    # Decide whether to include this block.
    # If the block's LOD is callable, call it.
    # Otherwise, just compare.
    if callable (lod):
        # Allow for an optional third hookargs argument.
        try:
            doblock = lod (reqlev, args, hookargs)
        except TypeError as exc:
            if (len(exc.args) > 0 and
                (exc.args[0].find ('takes exactly 2 arguments') >= 0 or
                 exc.args[0].find ('takes 2 positional') >= 0)):
                doblock = lod (reqlev, args)
            else:
                raise
    else:
        doblock = (lod <= reqlev)
 
    return doblock
 
 

make_SG_D3PDObject()

python.D3PDObject.make_SG_D3PDObject	(		default_typeName,
			default_sgkey,
			default_prefix,
			default_object_name = None,
			default_allowMissing = False,
			default_getterClass = D3PD.SGObjGetterTool,
			allow_args = [] )

Helper to make a D3PDObject for the common case where the default
input source is a single object from StoreGate.

    Arguments:
      default_typeName: The default name of the type being
                        fetched from StoreGate.
      default_sgkey: The default value for the StoreGate key.
      default_prefix: The default prefix to put in front of variables.
      default_object_name: The name of the D3PDObject which is created,
                           like 'EventInfoD3PDObject'
      default_allowMissing: The default value for the AllowMissing
        property (defaults to False).
      default_getterClass: Default value to use for the getter class,
        when we create the getter.  Defaults to SGObjGetterTool.
      allow_args: Additional arguments that may be passed in when
                  instantiating the D3PDObject, but which are not
                  to be passed to the maker function.  This can be
                  used to allow for additional arguments to hook
                  or level-of-detail functions.

    Typical usage would be something like this:

       METD3PDObject = \
          make_SG_D3PDObject ('MissingET',
                              D3PDMakerFlags.MissingETSGKey,
                              'met_', 'METD3PDObject')

Definition at line 646 of file D3PDObject.py.

                        allow_args = []):
    """Helper to make a D3PDObject for the common case where the default
input source is a single object from StoreGate.
 
        Arguments:
          default_typeName: The default name of the type being
                            fetched from StoreGate.
          default_sgkey: The default value for the StoreGate key.
          default_prefix: The default prefix to put in front of variables.
          default_object_name: The name of the D3PDObject which is created,
                               like 'EventInfoD3PDObject'
          default_allowMissing: The default value for the AllowMissing
            property (defaults to False).
          default_getterClass: Default value to use for the getter class,
            when we create the getter.  Defaults to SGObjGetterTool.
          allow_args: Additional arguments that may be passed in when
                      instantiating the D3PDObject, but which are not
                      to be passed to the maker function.  This can be
                      used to allow for additional arguments to hook
                      or level-of-detail functions.
 
        Typical usage would be something like this:
 
           METD3PDObject = \
              make_SG_D3PDObject ('MissingET',
                                  D3PDMakerFlags.MissingETSGKey,
                                  'met_', 'METD3PDObject')
        
"""
    def make_obj (name, prefix, object_name,
                  getter = None,
                  sgkey = None,
                  allowMissing = default_allowMissing,
                  typeName = default_typeName,
                  getterClass = default_getterClass):
        if sgkey is None: sgkey = default_sgkey
        if not getter:
            getter = getterClass (name + '_Getter',
                                  TypeName = typeName,
                                  SGKey = sgkey)
        from D3PDMakerConfig.D3PDMakerFlags import D3PDMakerFlags
        return D3PD.ObjFillerTool (name,
                                   Prefix = prefix,
                                   Getter = getter,
                                   ObjectName = object_name,
                                   AllowMissing=allowMissing,
                                   SaveMetadata = \
                                     D3PDMakerFlags.SaveObjectMetadata)
 
    if default_object_name is None:
        default_object_name = default_typeName
        default_object_name = default_object_name.split('::')[-1]
 
    return D3PDObject (make_obj, default_prefix, default_object_name,
                       sgkey = default_sgkey,
                       typeName = default_typeName,
                       allow_args = allow_args)
 
 
 

make_SGDataVector_D3PDObject()

python.D3PDObject.make_SGDataVector_D3PDObject	(		default_typeName,
			default_sgkey,
			default_prefix,
			default_object_name = None,
			default_allowMissing = False,
			default_getterFilter = None,
			default_label = None,
			default_getterClass = \                                     D3PD.SGDataVectorGetterTool,
			allow_args = [],
		**	other_defaults )

Helper to make a D3PDObject for the common case where the default
input source is a DataVector container from StoreGate.

    Arguments:
      default_typeName: The default name of the type being
                        fetched from StoreGate.
      default_sgkey: The default value for the StoreGate key.
      default_prefix: The default prefix to put in front of variables.
      default_object_name: The name of the D3PDObject which is created,
                           like 'EventInfoD3PDObject'
      default_allowMissing: The default value for the AllowMissing
        property (defaults to False).
      default_label: The default value to use for the collection label
        (default to the prefix).
      default_getterFilter: A collection getter filter to wrap
        around the primary getter (defaults to no filter).
        If this is a string, then it is interpreted as the
        StoreGate key of a SelectedParticles object to use
        to do the filtering.
      default_getterClass: Default value to use for the getter class,
        when we create the getter.  Defaults to SGDataVectorGetterTool,
        which is appropriate for iterating over a DataVector.
      allow_args: Additional arguments that may be passed in when
                  instantiating the D3PDObject, but which are not
                  to be passed to the maker function.  This can be
                  used to allow for additional arguments to hook
                  or level-of-detail functions.

    Typical usage would be something like this:

       JetD3PDObject = \
          make_SGDataVector_D3PDObject ('JetCollection',
                                        D3PDMakerFlags.JetSGKey,
                                        'jet_', 'JetD3PDObject')

    In addition, each object has automatically defined a
    ContainerFlagFillerTool block named `SelectionFlags'.
    This means that you can pass in an argument like

      SelectionFlags_FlagNames [ 'selected@MyContainerType/mine:Objects in mine' ]

    This will create a flag variable `selected' which will be true if
    the object contained in the SG container MyContainerType/mine.
    The string after the colon is used for documentation.

Definition at line 712 of file D3PDObject.py.

                                  **other_defaults):
    """Helper to make a D3PDObject for the common case where the default
input source is a DataVector container from StoreGate.
 
        Arguments:
          default_typeName: The default name of the type being
                            fetched from StoreGate.
          default_sgkey: The default value for the StoreGate key.
          default_prefix: The default prefix to put in front of variables.
          default_object_name: The name of the D3PDObject which is created,
                               like 'EventInfoD3PDObject'
          default_allowMissing: The default value for the AllowMissing
            property (defaults to False).
          default_label: The default value to use for the collection label
            (default to the prefix).
          default_getterFilter: A collection getter filter to wrap
            around the primary getter (defaults to no filter).
            If this is a string, then it is interpreted as the
            StoreGate key of a SelectedParticles object to use
            to do the filtering.
          default_getterClass: Default value to use for the getter class,
            when we create the getter.  Defaults to SGDataVectorGetterTool,
            which is appropriate for iterating over a DataVector.
          allow_args: Additional arguments that may be passed in when
                      instantiating the D3PDObject, but which are not
                      to be passed to the maker function.  This can be
                      used to allow for additional arguments to hook
                      or level-of-detail functions.
 
        Typical usage would be something like this:
 
           JetD3PDObject = \
              make_SGDataVector_D3PDObject ('JetCollection',
                                            D3PDMakerFlags.JetSGKey,
                                            'jet_', 'JetD3PDObject')
 
        In addition, each object has automatically defined a
        ContainerFlagFillerTool block named `SelectionFlags'.
        This means that you can pass in an argument like
 
          SelectionFlags_FlagNames [ 'selected@MyContainerType/mine:Objects in mine' ]
 
        This will create a flag variable `selected' which will be true if
        the object contained in the SG container MyContainerType/mine.
        The string after the colon is used for documentation.
"""
    def make_obj (name, prefix, object_name,
                  getter = None,
                  sgkey = None,
                  label = default_label,
                  allowMissing = default_allowMissing,
                  getterFilter = default_getterFilter,
                  typeName = default_typeName,
                  getterClass = default_getterClass,
                  **kw):
        if sgkey is None: sgkey = default_sgkey
        if label is None: label = prefix
        if not getter:
            getter = getterClass (name + '_Getter',
                                  TypeName = typeName,
                                  SGKey = sgkey,
                                  Label = label)
        if getterFilter:
            if isinstance(getterFilter, str):
                selgetter = D3PD.SGObjGetterTool \
                            (name + '_SelectionGetter',
                             TypeName = 'SelectedParticles',
                             SGKey = getterFilter)
                getter = D3PD.SelectedParticlesFilterTool \
                         (name + '_GetterFilter',
                          Getter = getter,
                          SelectionGetter = selgetter)
            else:
                getter = getterFilter (name + '_GetterFilter',
                                       Getter = getter)
        defs = other_defaults.copy()
        defs.update (kw)
        from D3PDMakerConfig.D3PDMakerFlags import D3PDMakerFlags
        return D3PD.VectorFillerTool (name,
                                      Prefix = prefix,
                                      Getter = getter,
                                      ObjectName = object_name,
                                      AllowMissing=allowMissing,
                                      SaveMetadata = \
                                      D3PDMakerFlags.SaveObjectMetadata,
                                      **defs)
 
    if default_object_name is None:
        default_object_name = default_typeName
        if default_object_name.endswith ('Collection'):
            default_object_name = default_object_name[:-10]
        if default_object_name.endswith ('Container'):
            default_object_name = default_object_name[:-9]
        default_object_name = default_object_name.split('::')[-1]
 
    ret = D3PDObject (make_obj, default_prefix, default_object_name,
                      sgkey = default_sgkey,
                      typeName = default_typeName,
                      allow_args = allow_args)
 
    # Automatically add SelectionFlags to each object.
    # It won't actually create any variables unless the Flags property is set.
    ret.defineBlock (0, 'SelectionFlags',
                     D3PD.ContainerFlagFillerTool)
 
    return ret
 

make_Void_D3PDObject()

python.D3PDObject.make_Void_D3PDObject	(		default_prefix = '',
			default_object_name = '',
			default_name = None,
			allow_args = [] )

Helper to make a D3PDObject for the case where no explicit
input object is being used.    

    Arguments:
      default_prefix: The default prefix to put in front of variables.
      default_object_name: The name of the D3PDObject which is created,
                           like 'EventInfoD3PDObject'
      default_name: If specified, the default tool name to use
                    for these objects.
      allow_args: Additional arguments that may be passed in when
                  instantiating the D3PDObject, but which are not
                  to be passed to the maker function.  This can be
                  used to allow for additional arguments to hook
                  or level-of-detail functions.

    Typical usage would be something like this:

       METD3PDObject = \
          make_Void_D3PDObject ('trig_', 'METD3PDObject')

Definition at line 608 of file D3PDObject.py.

                          allow_args = []):
    """Helper to make a D3PDObject for the case where no explicit
input object is being used.    
 
        Arguments:
          default_prefix: The default prefix to put in front of variables.
          default_object_name: The name of the D3PDObject which is created,
                               like 'EventInfoD3PDObject'
          default_name: If specified, the default tool name to use
                        for these objects.
          allow_args: Additional arguments that may be passed in when
                      instantiating the D3PDObject, but which are not
                      to be passed to the maker function.  This can be
                      used to allow for additional arguments to hook
                      or level-of-detail functions.
 
        Typical usage would be something like this:
 
           METD3PDObject = \
              make_Void_D3PDObject ('trig_', 'METD3PDObject')
        
"""
    def make_obj (name, prefix, object_name):
        from D3PDMakerConfig.D3PDMakerFlags import D3PDMakerFlags
        return D3PD.VoidObjFillerTool (name,
                                       Prefix = prefix,
                                       ObjectName = object_name,
                                       SaveMetadata = \
                                       D3PDMakerFlags.SaveObjectMetadata)
    return D3PDObject (make_obj, default_prefix, default_object_name,
                       default_name = default_name,
                       allow_args = allow_args)
 
 
 

Variable Documentation

D3PD

python.D3PDObject.D3PD = CompFactory.D3PD

Definition at line 16 of file D3PDObject.py.