API

Data Structures

• Geometry
  • Constructor
    • Geometry
      • Geometry
        • Geometry.actor
        • Geometry.begin_interaction()
        • Geometry.change_representation()
        • Geometry.color_points()
        • Geometry.end_interaction()
        • Geometry.geometry_type
        • Geometry.get_number_of_points()
        • Geometry.merge()
        • Geometry.normals
        • Geometry.points
        • Geometry.quaternions
        • Geometry.set_appearance()
        • Geometry.set_color()
        • Geometry.set_scalars()
        • Geometry.set_visibility()
        • Geometry.setup_lod()
        • Geometry.swap_data()
        • Geometry.visible
  • Core Data Properties
    • Geometry.points
      • Geometry.points
    • Geometry.normals
      • Geometry.normals
    • Geometry.quaternions
      • Geometry.quaternions
    • Geometry.sampling_rate
      • Geometry.sampling_rate
    • Geometry.model
      • Geometry.model
    • Geometry.actor
      • Geometry.actor
    • Geometry.visible
      • Geometry.visible
  • Visualization Control
    • Geometry.set_color
      • Geometry.set_color()
    • Geometry.set_visibility
      • Geometry.set_visibility()
    • Geometry.set_appearance
      • Geometry.set_appearance()
    • Geometry.change_representation
      • Geometry.change_representation()
    • Geometry.is_mesh_representation
      • Geometry.is_mesh_representation()
  • Point Coloring
    • Geometry.color_points
      • Geometry.color_points()
    • Geometry.set_scalars
      • Geometry.set_scalars()
  • Data Manipulation
    • Geometry.swap_data
      • Geometry.swap_data()
    • Geometry.merge
      • Geometry.merge()
    • Geometry.subset
      • Geometry.subset()
    • Geometry.get_point_data
      • Geometry.get_point_data()
  • Utility Functions
    • Geometry.get_number_of_points
      • Geometry.get_number_of_points()
  • Serialization
    • Geometry.__getstate__
      • Geometry.__getstate__()
    • Geometry.__setstate__
      • Geometry.__setstate__()
  • Indexing
• VolumeGeometry
  • Constructor
    • VolumeGeometry
      • VolumeGeometry
        • VolumeGeometry.set_appearance()
        • VolumeGeometry.update_isovalue()
        • VolumeGeometry.update_isovalue_quantile()
        • VolumeGeometry.update_target_resolution()
  • Volume Operations
    • VolumeGeometry.update_isovalue
      • VolumeGeometry.update_isovalue()
    • VolumeGeometry.update_isovalue_quantile
      • VolumeGeometry.update_isovalue_quantile()
    • VolumeGeometry.set_appearance
      • VolumeGeometry.set_appearance()
• GeometryTrajectory
  • Constructor
    • GeometryTrajectory
      • GeometryTrajectory
        • GeometryTrajectory.display_frame()
        • GeometryTrajectory.frames
  • Trajectory Control
    • GeometryTrajectory.frames
      • GeometryTrajectory.frames
    • GeometryTrajectory.display_frame
      • GeometryTrajectory.display_frame()
• DataContainer
  • Constructor
    • DataContainer
      • DataContainer
        • DataContainer.add()
        • DataContainer.clear()
        • DataContainer.get()
        • DataContainer.get_actors()
        • DataContainer.highlight()
        • DataContainer.highlight_points()
        • DataContainer.refresh_lod()
        • DataContainer.remove()
        • DataContainer.update()
        • DataContainer.update_appearance()
        • DataContainer.uuid_to_index()
  • Data Access and Management
    • DataContainer.add
      • DataContainer.add()
    • DataContainer.remove
      • DataContainer.remove()
    • DataContainer.get
      • DataContainer.get()
    • DataContainer.update
      • DataContainer.update()
    • DataContainer.clear
      • DataContainer.clear()
    • DataContainer.get_actors
      • DataContainer.get_actors()
  • UUID Resolution
    • DataContainer.uuid_to_index
      • DataContainer.uuid_to_index()
  • Visualization Control
    • DataContainer.highlight
      • DataContainer.highlight()
    • DataContainer.highlight_points
      • DataContainer.highlight_points()
    • DataContainer.update_appearance
      • DataContainer.update_appearance()
  • Container Length
• Session
  • Constructor
    • Session
      • Session
        • Session.apply()
        • Session.filter()
        • Session.group()
        • Session.list_filtered()
        • Session.load_session()
        • Session.log_command()
        • Session.measure()
        • Session.merge()
        • Session.open()
        • Session.remove()
        • Session.resolve()
        • Session.resolve_many()
        • Session.save()
        • Session.save_session()
        • Session.ungroup()
  • Target Resolution
    • Session.resolve
      • Session.resolve()
    • Session.resolve_many
      • Session.resolve_many()
  • File I/O
    • Session.open
      • Session.open()
    • Session.save
      • Session.save()
    • Session.save_session
      • Session.save_session()
    • Session.load_session
      • Session.load_session()
  • Operations
    • Session.apply
      • Session.apply()
    • Session.measure
      • Session.measure()
  • Filtering and Queries
    • Session.filter
      • Session.filter()
    • Session.list_filtered
      • Session.list_filtered()
  • Container Manipulation
    • Session.remove
      • Session.remove()
    • Session.merge
      • Session.merge()
    • Session.group
      • Session.group()
    • Session.ungroup
      • Session.ungroup()
  • Logging
    • Session.log_command
      • Session.log_command()
• MosaicData
  • Constructor
    • MosaicData
      • MosaicData
        • MosaicData.activate_viewing_mode()
        • MosaicData.format_datalist()
        • MosaicData.get_tree_state()
        • MosaicData.load_session()
        • MosaicData.open_file()
        • MosaicData.refresh_actors()
        • MosaicData.refresh_lod()
        • MosaicData.register_session_hook()
        • MosaicData.reset()
        • MosaicData.swap_area_picker()
        • MosaicData.to_file()
        • MosaicData.visibility_unselected()
  • File I/O
    • MosaicData.open_file
      • MosaicData.open_file()
    • MosaicData.to_file
      • MosaicData.to_file()
    • MosaicData.load_session
      • MosaicData.load_session()
    • MosaicData.reset
      • MosaicData.reset()
  • Interaction Modes
    • MosaicData.activate_viewing_mode
      • MosaicData.activate_viewing_mode()
    • MosaicData.activate_picking_mode
      • MosaicData.activate_picking_mode()
    • MosaicData.swap_area_picker
      • MosaicData.swap_area_picker()
    • MosaicData.highlight_clusters_from_selected_points
      • MosaicData.highlight_clusters_from_selected_points()
  • Visualization
    • MosaicData.set_coloring_mode
      • MosaicData.set_coloring_mode()
    • MosaicData.visibility_unselected
      • MosaicData.visibility_unselected()
    • MosaicData.refresh_lod
      • MosaicData.refresh_lod()
    • MosaicData.refresh_actors
      • MosaicData.refresh_actors()
  • Session Hooks
    • MosaicData.register_session_hook
      • MosaicData.register_session_hook()
  • Utilities
    • MosaicData.format_datalist
      • MosaicData.format_datalist()
    • MosaicData.get_tree_state
      • MosaicData.get_tree_state()
• DataContainerInteractor
  • Constructor
    • DataContainerInteractor
      • DataContainerInteractor
        • DataContainerInteractor.add_selection()
        • DataContainerInteractor.cluster()
        • DataContainerInteractor.compute_normals()
        • DataContainerInteractor.deselect()
        • DataContainerInteractor.downsample()
        • DataContainerInteractor.duplicate()
        • DataContainerInteractor.eventFilter()
        • DataContainerInteractor.remove_outliers()
        • DataContainerInteractor.render()
        • DataContainerInteractor.render_vtk()
        • DataContainerInteractor.set_selection_by_uuid()
        • DataContainerInteractor.skeletonize()
        • DataContainerInteractor.update()
        • DataContainerInteractor.visibility()
  • Interaction Modes
    • DataContainerInteractor.attach_area_picker
      • DataContainerInteractor.attach_area_picker()
    • DataContainerInteractor.activate_viewing_mode
      • DataContainerInteractor.activate_viewing_mode()
    • DataContainerInteractor.activate_drawing_mode
      • DataContainerInteractor.activate_drawing_mode()
    • DataContainerInteractor.activate_picking_mode
      • DataContainerInteractor.activate_picking_mode()
  • Selection
    • DataContainerInteractor.get_selected_geometries
      • DataContainerInteractor.get_selected_geometries()
    • DataContainerInteractor.set_selection_by_uuid
      • DataContainerInteractor.set_selection_by_uuid()
    • DataContainerInteractor.deselect
      • DataContainerInteractor.deselect()
    • DataContainerInteractor.deselect_points
      • DataContainerInteractor.deselect_points()
    • DataContainerInteractor.highlight_selected_points
      • DataContainerInteractor.highlight_selected_points()
    • DataContainerInteractor.highlight_clusters_from_selected_points
      • DataContainerInteractor.highlight_clusters_from_selected_points()
  • Data Management
    • DataContainerInteractor.add
      • DataContainerInteractor.add()
    • DataContainerInteractor.add_selection
      • DataContainerInteractor.add_selection()
    • DataContainerInteractor.merge
      • DataContainerInteractor.merge()
    • DataContainerInteractor.remove
      • DataContainerInteractor.remove()
    • DataContainerInteractor.update
      • DataContainerInteractor.update()
    • DataContainerInteractor.undo
      • DataContainerInteractor.undo()
  • Geometry Operations
    • DataContainerInteractor.cluster
      • DataContainerInteractor.cluster()
    • DataContainerInteractor.skeletonize
      • DataContainerInteractor.skeletonize()
    • DataContainerInteractor.downsample
      • DataContainerInteractor.downsample()
    • DataContainerInteractor.remove_outliers
      • DataContainerInteractor.remove_outliers()
    • DataContainerInteractor.compute_normals
      • DataContainerInteractor.compute_normals()
    • DataContainerInteractor.duplicate
      • DataContainerInteractor.duplicate()
    • DataContainerInteractor.visibility
      • DataContainerInteractor.visibility()
  • Visualization
    • DataContainerInteractor.next_color
      • DataContainerInteractor.next_color()
    • DataContainerInteractor.set_coloring_mode
      • DataContainerInteractor.set_coloring_mode()
    • DataContainerInteractor.change_representation
      • DataContainerInteractor.change_representation()
    • DataContainerInteractor.render
      • DataContainerInteractor.render()
    • DataContainerInteractor.render_vtk
      • DataContainerInteractor.render_vtk()
    • DataContainerInteractor.refresh_actors
      • DataContainerInteractor.refresh_actors()

Processing

• Operations
  • Point Cloud Processing
    • downsample
      • downsample()
    • remove_outliers
      • remove_outliers()
    • skeletonize
      • skeletonize()
  • Clustering
    • cluster
      • cluster()
  • Normal Computation
    • compute_normals
      • compute_normals()
  • Surface Fitting
    • fit
      • fit()
    • sample
      • sample()
  • Mesh Operations
    • remesh
      • remesh()
    • smooth
      • smooth()
  • Utility Functions
    • duplicate
      • duplicate()
    • visibility
      • visibility()
  • Operation Registry
    • GeometryOperations
      • GeometryOperations
        • GeometryOperations.cluster()
        • GeometryOperations.compute_normals()
        • GeometryOperations.downsample()
        • GeometryOperations.duplicate()
        • GeometryOperations.fit()
        • GeometryOperations.register()
        • GeometryOperations.remesh()
        • GeometryOperations.remove_outliers()
        • GeometryOperations.sample()
        • GeometryOperations.skeletonize()
        • GeometryOperations.smooth()
        • GeometryOperations.visibility()
• Parametrization
  • Base Class
    • Parametrization
      • Parametrization
        • Parametrization.compute_distance()
        • Parametrization.compute_normal()
        • Parametrization.fit()
        • Parametrization.points_per_sampling()
        • Parametrization.sample()
  • Geometric Shapes
    • Sphere
      • Sphere
        • Sphere.compute_distance()
        • Sphere.compute_normal()
        • Sphere.fit()
        • Sphere.points_per_sampling()
        • Sphere.sample()
    • Ellipsoid
      • Ellipsoid
        • Ellipsoid.compute_distance()
        • Ellipsoid.compute_normal()
        • Ellipsoid.fit()
        • Ellipsoid.points_per_sampling()
        • Ellipsoid.sample()
    • Cylinder
      • Cylinder
        • Cylinder.compute_normal()
        • Cylinder.fit()
        • Cylinder.points_per_sampling()
        • Cylinder.sample()
    • RBF
      • RBF
        • RBF.compute_normal()
        • RBF.fit()
        • RBF.points_per_sampling()
        • RBF.sample()
    • SplineCurve
      • SplineCurve
        • SplineCurve.compute_normal()
        • SplineCurve.fit()
        • SplineCurve.points_per_sampling()
        • SplineCurve.sample()
  • Triangular Meshes
    • TriangularMesh
      • TriangularMesh
        • TriangularMesh.add_projections()
        • TriangularMesh.compute_distance()
        • TriangularMesh.compute_normal()
        • TriangularMesh.fit()
        • TriangularMesh.geodesic_distance()
        • TriangularMesh.points_per_sampling()
        • TriangularMesh.sample()
    • BallPivoting
      • BallPivoting
        • BallPivoting.fit()
    • PoissonMesh
      • PoissonMesh
        • PoissonMesh.fit()
    • AlphaShape
      • AlphaShape
        • AlphaShape.fit()
    • FlyingEdges
      • FlyingEdges
        • FlyingEdges.fit()
  • Utilities
    • merge
      • merge()
  • Type Registry
• Parallel
  • BackgroundTaskManager
    • BackgroundTaskManager
      • BackgroundTaskManager
        • BackgroundTaskManager.cancel_task()
        • BackgroundTaskManager.clear_finished_tasks()
        • BackgroundTaskManager.get_task_output()
        • BackgroundTaskManager.submit_io_task()
        • BackgroundTaskManager.submit_task()
        • BackgroundTaskManager.submit_task_batch()
    • Signals
  • Convenience Functions
    • submit_task
      • submit_task()
    • submit_task_batch
      • submit_task_batch()
  • Usage Example

File I/O

• Formats
  • Reading
    • open_file
      • open_file()
  • Writing
    • OrientationsWriter
      • OrientationsWriter
        • OrientationsWriter.to_file()
    • write_density
      • write_density()
  • Session Files
    • is_session_file
      • is_session_file()
    • open_session
      • open_session()
    • write_session
      • write_session()
    • read_session_index
      • read_session_index()
    • read_session_meta
      • read_session_meta()
    • read_session_section
      • read_session_section()
  • Streaming
    • open_omezarr
      • open_omezarr()
    • ZarrImageSource
      • ZarrImageSource
        • ZarrImageSource.RequestData()
        • ZarrImageSource.RequestInformation()
  • Data Containers
    • GeometryDataContainer
      • GeometryDataContainer
    • VertexPropertyContainer
      • VertexPropertyContainer
        • VertexPropertyContainer.copy()
        • VertexPropertyContainer.get_property()
        • VertexPropertyContainer.merge()
        • VertexPropertyContainer.properties
        • VertexPropertyContainer.set_property()
  • Exceptions
    • mosaic.formats.NotASegmentationError
      • NotASegmentationError

GUI

• Widgets
  • Core Interface Components
    • ObjectBrowserSidebar
      • ObjectBrowserSidebar
    • RibbonToolBar
      • RibbonToolBar
        • RibbonToolBar.minimumSizeHint()
        • RibbonToolBar.resizeEvent()
    • ContainerListWidget
      • ContainerListWidget
    • StyledListWidgetItem
      • StyledListWidgetItem
  • 3D Visualization Widgets
    • AxesWidget
      • AxesWidget
    • ScaleBarWidget
      • ScaleBarWidget
        • ScaleBarWidget.set_label_format()
        • ScaleBarWidget.set_units()
    • LegendWidget
      • LegendWidget
  • Volume and Time-series
    • TrajectoryPlayer
      • TrajectoryPlayer
        • TrajectoryPlayer.update_trajectories()
  • Interaction Control
    • ViewerModes
      • ViewerModes
    • CursorModeHandler
      • CursorModeHandler
    • StatusIndicator
      • StatusIndicator
        • StatusIndicator.connect_signals()
        • StatusIndicator.hide_progress()
        • StatusIndicator.show_progress()
        • StatusIndicator.update_progress()
  • Ribbon Utilities
    • create_button
      • create_button()
• Dialogs
  • Data Import/Export
    • ImportDataDialog
      • ImportDataDialog
    • ExportDialog
      • ExportDialog
        • ExportDialog.accept()
        • ExportDialog.get_current_settings()
        • ExportDialog.set_defaults()
  • Analysis Dialogs
    • PropertyAnalysisDialog
      • PropertyAnalysisDialog
        • PropertyAnalysisDialog.closeEvent()
        • PropertyAnalysisDialog.render()
    • HistogramDialog
      • HistogramDialog
        • HistogramDialog.closeEvent()
        • HistogramDialog.sizeHint()
    • GeometryPropertiesDialog
      • GeometryPropertiesDialog
        • GeometryPropertiesDialog.connect_signals()
        • GeometryPropertiesDialog.get_parameters()
        • GeometryPropertiesDialog.showEvent()
  • Processing Configuration
    • TemplateMatchingDialog
      • TemplateMatchingDialog
        • TemplateMatchingDialog.accept()
    • MeshMappingDialog
      • MeshMappingDialog
        • MeshMappingDialog.accept()
        • MeshMappingDialog.get_output_directory()
  • Distance Operations
    • DistanceCropDialog
      • DistanceCropDialog
        • DistanceCropDialog.accept()
        • DistanceCropDialog.closeEvent()
        • DistanceCropDialog.populate_lists()
        • DistanceCropDialog.reject()
  • DTS Dialogs
    • MeshEquilibrationDialog
      • MeshEquilibrationDialog
        • MeshEquilibrationDialog.accept()
        • MeshEquilibrationDialog.get_output_directory()
        • MeshEquilibrationDialog.get_parameters()
    • DTSScreeningDialog
      • DTSScreeningDialog
        • DTSScreeningDialog.closeEvent()
• Tabs
  • Main Tab Classes
    • SegmentationTab
      • SegmentationTab
        • SegmentationTab.eventFilter()
    • ModelTab
      • ModelTab
    • IntelligenceTab
      • IntelligenceTab
  • Segmentation Operations
    • SegmentationTab.show_ribbon
      • SegmentationTab.show_ribbon()
  • Modeling Operations
    • ModelTab.show_ribbon
      • ModelTab.show_ribbon()
  • Intelligence Operations
    • IntelligenceTab.show_ribbon
      • IntelligenceTab.show_ribbon()
• Interaction Styles
  • Mesh Editing
    • MeshEditInteractorStyle
      • MeshEditInteractorStyle
  • Curve Creation
    • CurveBuilderInteractorStyle
      • CurveBuilderInteractorStyle
        • CurveBuilderInteractorStyle.cleanup()
        • CurveBuilderInteractorStyle.on_left_button_down()
        • CurveBuilderInteractorStyle.on_mouse_move()