51Degrees Pipeline Python  4.2

51Degrees Pipeline for Python
  • pipeline-python
  • fiftyone_pipeline_core
  • fiftyone_pipeline_core
  • evidence_keyfilter
  • EvidenceKeyFilter

pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.evidence_keyfilter.EvidenceKeyFilter Class Reference

Detailed Description

An EvidenceKeyFilter is attached to a FlowElement and is used to check if a specific evidence key is needed by it.

This allows for keys that are not used by any FLowElement in a pipeline to be discarded, and on a FlowElement level allows for caching of data / memoization based on the evidence a FlowElement requires.

Inheritance diagram for pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.evidence_keyfilter.EvidenceKeyFilter:

[legend]

Public Member Functions

def  filter_evidence (self, evidence_key_object)
Filter evidence from a dictionary of evidence keys/values. More...
def  filter_evidence_key (self, key)
See if a property key should be in the filtered evidence. More...

Member Function Documentation

◆ filter_evidence()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.evidence_keyfilter.EvidenceKeyFilter.filter_evidence (   self,
  evidence_key_object  
)

Filter evidence from a dictionary of evidence keys/values.

Runs filterEvidenceKey on each key in the dictionary

@type evidence_key_object: dict

Parameters
evidence_key_object - Evidence dictionary contents

@rtype: dict

Returns
: EReturns filtered evidence dictionary contents

◆ filter_evidence_key()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.evidence_keyfilter.EvidenceKeyFilter.filter_evidence_key (   self,
  key  
)

See if a property key should be in the filtered evidence.

@type key: string

Parameters
key - property name

@rtype: bool

Returns
: Returns is this be filtered out or not?