HedTypeCounts

class HedTypeCounts(name, type_tag)[source]

Manager for summaries of tag counts for columnar files.

Methods

HedTypeCounts.__init__(name, type_tag)

HedTypeCounts.add_descriptions(type_defs)

Update this summary based on the type variable map.

HedTypeCounts.get_summary()

Return the information in the manager as a dictionary.

HedTypeCounts.update(counts)

Update count information based on counts in another HedTypeCounts.

HedTypeCounts.update_summary(type_sum[, ...])

Update this summary based on the type variable map.

Attributes

HedTypeCounts.__init__(name, type_tag)[source]
HedTypeCounts.add_descriptions(type_defs)[source]

Update this summary based on the type variable map.

Parameters:

type_defs (HedTypeDefs) – Contains the information about the value of a type.

HedTypeCounts.get_summary()[source]

Return the information in the manager as a dictionary.

Returns:

Dict with keys ‘name’, ‘type_tag’, ‘files’, ‘total_events’, and ‘details’.

Return type:

dict

HedTypeCounts.update(counts)[source]

Update count information based on counts in another HedTypeCounts.

Parameters:

counts (HedTypeCounts) – Information to use in the update.

HedTypeCounts.update_summary(type_sum, total_events=0, file_id=None)[source]

Update this summary based on the type variable map.

Parameters:
  • type_sum (dict) – Contains the information about the value of a type.

  • total_events (int) – Total number of events processed.

  • file_id (str) – Unique identifier for the associated file.