OERxnAutomapperOptions

Attention

This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

class OERxnAutomapperOptions

Encapsulates the properties that control reaction mapping using OERxnAutomapper.

Constructors

OERxnAutomapperOptions() -> OERxnAutomapperOptions

Default constructor that initializes an OERxnAutomapperOptions object with the following properties:

**Default parameters of OERxnAutomapperOptions**
Description	Option	Default value
Mapping Method	`GetMappingMethod()`	`OERxnAutomapMethod_MCSMapping`
MCS Mapping Mode	`GetMCSExhaustiveMode()`	`false`
Clear Mapping	`GetClearMapping()`	`true`
Extend Mapping	`GetExtendMappedRegions()`	`true`
Strict Mapping	`GetStrictMapping()`	`false`

OERxnAutomapperOptions(arg2: OERxnAutomapperOptions) -> OERxnAutomapperOptions

Copy constructor.

GetClearMapping

GetClearMapping() -> bool

Returns whether existing atom-atom mappings should be cleared prior to attempting the reaction mapping activity. Existing atom-atom mappings may be used to guide the reaction mapping activity if not cleared.

GetExtendMappedRegions

GetExtendMappedRegions() -> bool

Returns whether unassigned mapped regions can be augmented with unambiguous reactant and product atom correspondences to maximize the size of the reaction mapping.

GetMappingMethod

GetMappingMethod() -> int

Returns the requested mapping method to use for the reaction mapping correspondence.

GetMCSExhaustiveMode

GetMCSExhaustiveMode() -> bool

Returns whether the exhaustive MCS mapping mode should being used when the automapping is using the MCS method.

GetStrictMapping

GetStrictMapping() -> bool

Returns the requested activation state for strict reaction mapping validation activities.

SetClearMapping

SetClearMapping(value: bool) -> bool

Sets whether existing atom-atom mappings should be cleared prior to attempting the reaction mapping activity. Existing atom-atom mappings may be used to guide the reaction mapping activity if not cleared.

SetExtendMappedRegions

SetExtendMappedRegions(value: bool) -> bool

Sets whether unassigned mapped regions can be augmented with unambiguous reactant and product atom correspondences to maximize the size of the reaction mapping.

SetMappingMethod

SetMappingMethod(value: int) -> bool

Sets the requested mapping method to use for the reaction mapping correspondence. This is simply a placeholder for future methods, currently only an MCS mapping approach is available.

SetMCSExhaustiveMode

SetMCSExhaustiveMode(value: bool) -> bool

Sets whether the slower exhaustive MCS mapping mode should be used when the automapping is using the MCS method.

SetStrictMapping

SetStrictMapping(value: bool) -> bool

Enables or disables strict reaction mapping validation activities.