schrodinger.project.surface_map_utils module

schrodinger.project.surface_map_utils.get_selected_maps(project: Project) → list[ProjectSurface]

Get volume-based surfaces from all map-only entries selected in the Project Table.

Parameters:

project – The project to get surfaces from.

Raises:

ValueError – If the project is None.

Returns:

A list of ProjectSurface objects corresponding to the volume-based surfaces for map-only entries in the project.

schrodinger.project.surface_map_utils.get_included_maps(project: Project) → list[ProjectSurface]

Get volume-based surfaces from all map-only entries included in the Workspace.

Parameters:

project – The project to get surfaces from.

Raises:

ValueError – If the project is None.

Returns:

A list of ProjectSurface objects corresponding to the volume-based surfaces for map-only entries in the project.

schrodinger.project.surface_map_utils.get_map_by_entry_id(project: Project, entry_id: int) → list[ProjectSurface]

Get volume-based surfaces for a given map-only entry with the specified entry ID.

Parameters:

• project – The project to get surfaces from.

• entry_id – The entry ID to look up.

Raises:

ValueError – If the project is None or if the entry ID is not found in the project or if the entry ID does not correspond to a map-only entry.

Returns:

A list of ProjectSurface objects corresponding to the volume-based surfaces for the given map-only entry.