schrodinger.maestro_utils.surface_manager.surface_info module

class schrodinger.maestro_utils.surface_manager.surface_info.SurfaceInfo(entry_id: int, surface_name: str, surface_visible: bool, volume_based: bool, volume_name: str, volume_visible: bool, has_view_asl: bool = None, surface_area: float = None, isovalue: float = None, sigma: float = None, active_grid_size: float = None, comment: str = None)

Bases: object

Data class holding information about a particular surface.

Variables:

  • entry_id – Entry ID of the surface.

  • surface_name – Name of the surface.

  • surface_visible – Boolean indicating whether the surface is visible.

  • volume_based – Boolean indicating whether the surface is volume-based.

  • volume_name – Name of the volume.

  • volume_visible – Boolean indicating whether the volume is visible.

  • has_view_asl – Boolean indicating whether the surface has a view by ASL.

  • surface_area – Area of the surface.

  • isovalue – Isovalue of the surface if it is volume-based.

  • sigma – Sigma of the surface if it is volume-based.

  • active_grid_size – Active grid size of the surface if it is volume-based.

  • comment – Comment associated with the surface.

entry_id: int
surface_name: str
surface_visible: bool
volume_based: bool
volume_name: str
volume_visible: bool
has_view_asl: bool = None
surface_area: float = None
isovalue: float = None
sigma: float = None
active_grid_size: float = None
comment: str = None
classmethod getSurfaceInfo(surface_node_item: SurfaceNodeItem, project: Project) → SurfaceInfo

Get surface info object from a surface node item.

Parameters:

  • surface_node_item – The surface node item.

  • project – The project containing the surface.

Returns:

Corresponding surface info object.

__init__(entry_id: int, surface_name: str, surface_visible: bool, volume_based: bool, volume_name: str, volume_visible: bool, has_view_asl: bool = None, surface_area: float = None, isovalue: float = None, sigma: float = None, active_grid_size: float = None, comment: str = None) → None