SMARTSFilter

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

A filter which will remove or retain records which were computed for molecules which match specific SMARTS patterns.

Show JSON schema

{
   "title": "SMARTSFilter",
   "description": "A filter which will remove or retain records which were computed for molecules\nwhich match specific SMARTS patterns.",
   "type": "object",
   "properties": {
      "smarts_to_include": {
         "title": "Smarts To Include",
         "description": "Only QC records computed for molecules that match one or more of the SMARTS patterns in this list will be retained. This option is mutually exclusive with ``smarts_to_exclude``.",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "smarts_to_exclude": {
         "title": "Smarts To Exclude",
         "description": "Any QC records computed for molecules that match one or more of the SMARTS patterns in this list will be discarded. This option is mutually exclusive with ``smarts_to_include``.",
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   }
}

Fields

smarts_to_exclude (Optional[List[str]])
smarts_to_include (Optional[List[str]])

field smarts_to_include: Optional[List[str]] = None

Only QC records computed for molecules that match one or more of the SMARTS patterns in this list will be retained. This option is mutually exclusive with smarts_to_exclude.

Validated by

_validate_mutually_exclusive

field smarts_to_exclude: Optional[List[str]] = None

Any QC records computed for molecules that match one or more of the SMARTS patterns in this list will be discarded. This option is mutually exclusive with smarts_to_include.

Validated by

_validate_mutually_exclusive

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