Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

Index: number
SerialIndex: { @type: "serial-index" } & number

Serial index of an element in the structure across all units

SizeThresholds: typeof DefaultSizeThresholds

Variables

DefaultSizeThresholds: { fiberResidueCount: number; highSymmetryUnitCount: number; largeResidueCount: number; mediumResidueCount: number; smallResidueCount: number }

Type declaration

  • fiberResidueCount: number

    Fiber-like structure are consider small when below this

  • highSymmetryUnitCount: number

    Structures above largeResidueCount are consider huge when they have a highSymmetryUnitCount or gigantic when not

  • largeResidueCount: number

    Must be lower to be large (big ribosomes like 4UG0 should still be large)

  • mediumResidueCount: number

    Must be lower to be medium

  • smallResidueCount: number

    Must be lower to be small

Index: <internal>.Provider<<internal>.Structure, { value: <internal>.Value<undefined | number> }, undefined | number>

Functions

  • Check if the structures or their parents are equal

    Parameters

    Returns boolean

  • Check if the structures or their parents are equivalent

    Parameters

    Returns boolean

  • Hash based on all unit.model conformation values in the structure

    Parameters

    Returns number

  • Parameters

    Returns string

  • getSize(structure: <internal>.Structure, thresholds?: Partial<{ fiberResidueCount: number; highSymmetryUnitCount: number; largeResidueCount: number; mediumResidueCount: number; smallResidueCount: number }>, residueCountFactor?: number): Size
  • Parameters

    • structure: <internal>.Structure
    • Optional thresholds: Partial<{ fiberResidueCount: number; highSymmetryUnitCount: number; largeResidueCount: number; mediumResidueCount: number; smallResidueCount: number }>
    • Optional residueCountFactor: number

      modifies the threshold counts, useful when estimating the size of a structure comprised of multiple models

    Returns Size

  • Parameters

    Returns number

  • Parameters

    • x: any

    Returns x is <internal>.Structure.Loci

  • Parameters

    Returns boolean

  • Parameters

    Returns number

  • Construct a Structure from a model.

    Generally, a single unit corresponds to a single chain, with the exception of consecutive "single atom chains" with same entity_id and same auth_asym_id.

    Parameters

    Returns <internal>.Structure

Generated using TypeDoc