Skip to contents

All functions

new_sg_image()
Create a new sg_image object
new_sg_mask()
Create a new sg_mask object
new_sg_trained_model()
Create a new sg_trained_model object
sgCanvasOutput() renderSgCanvas()
Shiny bindings for the cell canvas
sg_active_learning_loop()
Prepare annotation tasks for caller-driven segmentation refinement
sg_app()
Build the segmantR Shiny application
sg_apply_corrections()
Apply manual corrections to a segmentation mask
sg_canvas()
Draw cell boundaries on a microscopy image
sg_canvas_correct()
Apply a cell canvas correction
sg_cleanup_labels()
Clean up a label mask
sg_control_capabilities()
Control service capabilities (segmantR-control-v1)
sg_create_annotation_task()
Create an annotation task for human review
sg_dataset_manifest()
Describe a training dataset
sg_display_levels()
Display levels from positive and negative reference cells
sg_display_range()
Display range of fluorescence values
sg_envi_info()
Read and validate an ENVI header without reading pixel data
sg_evaluate_segmentation()
Evaluate segmentation quality
sg_example_image()
Load a bundled example image
sg_example_mask()
Load a bundled example mask
sg_export_interchange()
Export to the neutral interchange format
sg_export_mask()
Export mask to file
sg_export_qupath()
Export segmantR objects or a StarDist protocol for QuPath
sg_extract_features()
Extract per-cell features from an image and mask
sg_filter_cells()
Filter cells by morphological criteria
sg_hash_assets()
Hash, write or verify a bundle inventory
sg_image_channels()
List the channels of a multi-page microscopy TIFF
sg_import_interchange()
Import interchange data
sg_import_qupath()
Import QuPath results into segmantR
sg_interchange_capabilities()
Interchange capability report
sg_interchange_manifest()
Build an interchange manifest
sg_load_model()
Load a packaged segmantR model
sg_mask_legend()
Effective legend of a mask
sg_stage_mask() sg_review_mask() sg_replace_mask()
Stage, review or replace masks
sg_mask_revision()
Content revision of a mask
sg_mask_status()
Review state of a mask
sg_mask_to_polygons()
Convert mask to polygon geometries
sg_merge_masks()
Merge nuclear and cell body masks
sg_model_card()
Display a formatted model card
sg_package_model()
Package a trained model for sharing
sg_plot_comparison()
Side-by-side comparison of two masks
sg_plot_features()
Scatter plot of cell features
sg_plot_mask()
Render a mask as a coloured image
sg_plot_metrics()
Bar chart of evaluation metrics
sg_plot_overlay()
Overlay cell boundaries on an image
sg_predict_model()
Predict with a trained model
sg_prepare_training_data()
Prepare training data tiles
sg_preprocess()
Preprocess an image
sg_protocol_get()
Get a registered protocol
sg_protocol_list()
List registered segmentation protocols
sg_protocol_run()
Run a declarative segmentation protocol
sg_protocol_schema()
Protocol schema and parameter specifications
sg_protocol_validate()
Validate a protocol, optionally against an image and parameters
sg_read_envi()
Read an ENVI cube window into an sg_image
sg_read_field()
Read a square multichannel field around a point
sg_read_fields()
Read many square fields, for example cell galleries
sg_read_image()
Read an image file
sg_read_window()
Read a rectangular pixel window of one channel
sg_roi
Histology ROI objects
sg_roi_add_layer()
Add a layer to a project
sg_roi_add_roi()
Add an ROI to a project layer
sg_roi_area()
ROI area
sg_roi_bbox()
ROI bounding box
sg_roi_buffer()
Buffer an ROI
sg_roi_centroid()
ROI centroid
sg_roi_check_containment()
Check cross-layer containment
sg_roi_check_geometry()
Check the geometry of every ROI in a project
sg_roi_circle()
Create a circular ROI
sg_roi_clamp()
Clip an ROI to image bounds
sg_roi_contains()
Test whether points fall inside an ROI
sg_roi_dims()
Image dimensions at a pyramid level
sg_roi_distance()
Distance between two ROIs
sg_roi_ellipse()
Create an elliptical ROI
sg_roi_fix_geometry()
Repair the geometry of a project
sg_roi_flip_y()
Flip an ROI's y-axis
sg_roi_frame()
Declare the coordinate frame for histology ROIs
sg_roi_freehand()
Create a freehand ROI
sg_roi_from_geojson()
Convert a GeoJSON feature to an ROI
sg_roi_from_sf()
Create an ROI from an existing sf geometry
sg_roi_layer()
Create a layer
sg_roi_layer_add()
Add an ROI to a layer
sg_roi_layer_n()
Number of ROIs in a layer
sg_roi_layer_remove()
Remove an ROI from a layer
sg_roi_layer_rois()
Layer ROI table
sg_roi_layers()
Layer summary table
sg_roi_mask()
Rasterise ROIs to a mask
sg_roi_mask_boundary()
Object boundaries of a mask
sg_roi_mask_derive()
Derive a training mask from layer masks
sg_roi_mask_legend()
Legend of a mask
sg_roi_mask_preview()
Downsampled preview of a mask
sg_roi_mask_stack()
Stack per-layer masks into a 3D array
sg_roi_mask_stats()
Per-value statistics of a mask
sg_roi_overlaps()
Test whether two ROIs intersect
sg_roi_point()
Create a point ROI
sg_roi_polygon()
Create a polygon ROI
sg_roi_project()
Create an annotation project
sg_roi_read_geojson()
Read ROIs from a GeoJSON file
sg_roi_read_qupath()
Read ROIs from a QuPath GeoJSON file
sg_roi_rect()
Create a rectangular ROI
sg_roi_remove_layer()
Remove a layer from a project
sg_roi_remove_roi()
Remove an ROI from a project
sg_roi_rescale()
Rescale an ROI between pyramid levels
sg_roi_ring()
Ring (annulus) along an ROI margin
sg_roi_rois()
Query the ROIs of a project
sg_roi_rois_overlap()
Pairwise ROI overlaps within a layer
sg_roi_union() sg_roi_intersect() sg_roi_difference() sg_roi_symdiff()
Set operations on ROIs
sg_roi_simplify()
Simplify an ROI
sg_roi_snap()
Snap ROI vertices to a grid
sg_roi_style()
Layer style
sg_roi_summary()
Summarise a project
sg_roi_transform()
Transform an ROI between pyramid levels using real image dimensions
sg_roi_validate()
Validate a project's invariants
sg_roi_write_geojson()
Write a project's ROIs to GeoJSON
sg_roi_write_qupath()
Write a project's ROIs as QuPath GeoJSON
sg_run_app()
Launch the segmantR Shiny application
sg_segment_cellpose()
Cellpose cell segmentation
sg_segment_mesmer()
Mesmer (DeepCell) cell segmentation
sg_segment_propagate()
Voronoi propagation from nuclear seeds
sg_segment_stardist()
StarDist cell segmentation
sg_segment_threshold()
Threshold-based cell segmentation
sg_segment_watershed()
Marker-controlled watershed segmentation
sg_select_channel()
Select one analysis channel from an image
sg_setup_python()
Set up a Python environment for deep learning backends
sg_slide_display_ranges()
Slide-wide display ranges from sampled image blocks
sg_stain_deconvolve()
Separate H&E stain channels by colour deconvolution
sg_stardist_capabilities()
StarDist adapter capabilities
sg_stardist_manifest()
Describe a StarDist model for exchange
sg_stardist_parameter_map()
Map StarDist protocol parameters to Python or QuPath
sg_train_cellpose()
Fine-tune a Cellpose model on user-corrected masks
sg_train_stardist()
Train a StarDist 2D model
sg_validate_interchange()
Validate interchange data
sg_validate_training_manifest()
Validate a training dataset manifest