CMILESResultFilter

pydantic model openff.qcsubmit.results.filters.CMILESResultFilter[source]

The base class for a filter which will retain selection of QC records based solely on the CMILES ( / InChI key) associated with the record itself, and not the actual record.

If the filter needs to access information from the QC record itself the SinglepointRecordFilter class should be used instead as it more efficiently retrieves the records and associated molecule objects from the QCFractal instances.

Show JSON schema

{
   "title": "CMILESResultFilter",
   "description": "The base class for a filter which will retain selection of QC records based\nsolely on the CMILES ( / InChI key) associated with the record itself, and not\nthe actual record.\n\nIf the filter needs to access information from the QC record itself the\n``SinglepointRecordFilter`` class should be used instead as it more efficiently\nretrieves the records and associated molecule objects from the QCFractal\ninstances.",
   "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