DataSample Class Reference

Inheritance diagram for DataSample:

Collaboration diagram for DataSample:

Public Member Functions
def	__init__ (self, *location, processing, experiment, beam_energy="4S", general_skim="all", **kwargs)
def	__repr__ (self)
def	as_dict (self)
def	encodeable_name (self)
def	printable_name (self)
def	__str__ (self)

Static Public Member Functions
def	resolve_path (location)

Public Attributes
	location
	processing
	experiment
	beam_energy
	general_skim

Detailed Description

Definition at line 85 of file testfiles.py.

Member Function Documentation

as_dict()

def as_dict

(

self

)

Sample serialised as a dictionary.

Reimplemented from Sample.

Definition at line 118 of file testfiles.py.

encodeable_name()

def encodeable_name

(

self

)

Identifying string which is safe to be included as a filename component or as a
key in the skim stats JSON file.

As a rough naming convention, data samples should start with 'Data-', MC sample
with 'MC-', and custom samples with 'Custom-'.

Reimplemented from Sample.

Definition at line 128 of file testfiles.py.

printable_name()

def printable_name

(

self

)

Human-readable name for displaying in printed tables.

Reimplemented from Sample.

Definition at line 140 of file testfiles.py.

resolve_path()

def resolve_path (   location )

staticinherited

Replace ``'${SampleDirectory}'`` with ``Sample.SampleDirectory``, and resolve
the path.

Parameters:
    location (str, pathlib.Path): Filename to be resolved.

Returns:
    pathlib.Path: Resolved path.

Definition at line 59 of file testfiles.py.

---

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

• skim/scripts/skim/utils/testfiles.py