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.

Code Example

Constructors

OEBioUnitExtractionOptions()=default
OEBioUnitExtractionOptions(const OEBioUnitExtractionOptions &)=default

Default and copy constructor that constructs a OEBioUnitExtractionOptions object.

operator=

OEBioUnitExtractionOptions &
  operator=(const OEBioUnitExtractionOptions &)=default

Assignment operator.

GetMaxAtoms

unsigned GetMaxAtoms() const

Returns the maximum number of atoms for the extracted biounit.

GetMaxParts

unsigned GetMaxParts() const

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

GetMinScore

unsigned GetMinScore() const

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

GetPreferAuthorRecord

bool GetPreferAuthorRecord() const

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

GetSuperpose

bool GetSuperpose() const

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

SetMaxAtoms

void SetMaxAtoms(unsigned maxAtoms)

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

SetMaxParts

void SetMaxParts(unsigned maxParts)

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

SetMinScore

void SetMinScore(int minScore)

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

SetPreferAuthorRecord

void SetPreferAuthorRecord(bool preferAuthor)

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

SetSuperpose

void SetSuperpose(bool superpose)

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

See also