OpenFF QCSubmit documentation

openff-qcsubmit

ResultFilter

pydantic model openff.qcsubmit.results.filters.ResultFilter

The base class for a filter which will retain selection of QC records based on a specific criterion.

Show JSON schema

{
   "title": "ResultFilter",
   "description": "The base class for a filter which will retain selection of QC records based on\na specific criterion.",
   "type": "object",
   "properties": {}
}

apply(result_collection)

Apply this filter to a results collection, returning a new collection containing only the retained entries.

Parameters

result_collection (openff.qcsubmit.results.filters.T) – The collection to apply the filter to.

Returns

The collection containing only the retained entries.

Return type

openff.qcsubmit.results.filters.T

See also

openff.qcsubmit.results.BasicResultCollection.filter()