Attention

This API is currently available in C++ and Python.

OEBioUnitExtractionOptions

class OEBioUnitExtractionOptions : public OESystem::OEOptions

This class stores the optional parameter sets for biounit extraction for use in the OEExtractBioUnits function.

Constructors

OEBioUnitExtractionOptions() -> OEBioUnitExtractionOptions
OEBioUnitExtractionOptions(arg2: OEBioUnitExtractionOptions) -> OEBioUnitExtractionOptions

Default and copy constructor that constructs a OEBioUnitExtractionOptions object.

GetMaxAtoms

GetMaxAtoms() -> int

Returns the maximum number of atoms for the extracted biounit.

GetMaxParts

GetMaxParts() -> int

Returns the maximum number of parts for a given transformation required to generate a biounit.

GetMinScore

GetMinScore() -> int

Returns the minimum score required for the biounit extraction’s sequence alignment.

GetPreferAuthorRecord

GetPreferAuthorRecord() -> bool

Returns the boolean whether or not to prefer the author or software record for biounit extraction.

GetSuperpose

GetSuperpose() -> bool

Returns the boolean whether or not to superpose the output biounit to the input reference structure.

SetMaxAtoms

SetMaxAtoms(value: int) -> bool

Sets the maximum number of atoms allowed for the extracted biounit.

SetMaxParts

SetMaxParts(value: int) -> bool

Sets the maximum number of parts allowed for a given transformation required to generate a biounit.

SetMinScore

SetMinScore(value: int) -> bool

Sets the minimum score required for the biounit extraction’s sequence alignment.

SetPreferAuthorRecord

SetPreferAuthorRecord(value: bool) -> bool

Sets the boolean of whether or not to prefer the author or software record for biounit extraction.

SetSuperpose

SetSuperpose(value: bool) -> bool

Sets the boolean whether or not to superpose the output biounit to the input reference structure.

See also