FilamentSpec

Bases: BaseModel

Declares a pickable object to be a filament: a continuous, typically helical or tubular assembly (e.g. microtubules, actin) that is annotated with ordered points along its axis.

Stored on the object as metadata["copick"]["filament"] (plain JSON), so clients that do not know filaments read the object as an ordinary particle and preserve the declaration when they rewrite a configuration. Picks of a filament object follow the filament pick conventions: instance_id is the filament ID (starting at 1, 0 = unassigned), points are grouped by filament and ordered along it, and the transform's +Z axis is the local tangent in point order.

Attributes:

• polar (Optional[bool]) –

  Whether the structure has a polarity (True for microtubules and actin). None if not stated.

• helical_rise_a (Optional[float]) –

  Axial rise per subunit in Angstrom. Descriptive only: it is never used as a default sampling distance along the filament.

• helical_twist_deg (Optional[float]) –

  Twist per subunit in degrees. Descriptive only.

model_config = ConfigDict(extra='allow')

polar: Optional[bool] = None

helical_rise_a: Optional[float] = Field(None, gt=0)

helical_twist_deg: Optional[float] = None