User Guide
Developer Guide
Recipe
save()
load()
optimize()
resume()
list_standards()
set_group()
save_manifest()
hausdorff_95()
API Reference
RecipeAction
ActionRecipe
RecordingEffectProxy
to_dict()
from_dict()
paint()
erase()
set_param()
set_algorithm()
from_function_recipe()
paintAt()
eraseAt()
slice_to()
append_actions()
list_action_recipes()
ActionRecorder
is_recording()
action_count()
has_callback()
set_action_callback()
start()
stop()
record_paint()
record_parameter_change()
record_algorithm_change()
record_screenshot()
record_note()
record_pass()
record_fail()
AlgorithmCharacterizer
characterize()
characterize_all()
create_comparison()
save_profiles()
load_profiles()
PerformanceMetrics
OptimalPreset
ExampleScreenshot
AlgorithmProfile
AlgorithmComparison
get_summary()
get_best_for_dice()
get_fastest()
get_most_efficient()
get_display_name()
AlgorithmReportGenerator
generate_report()
save_report()
generate_algorithm_report()
SegmentationMetrics
ComparisonMetrics
jaccard()
compute()
compute_slice_metrics()
format_summary()
last_metrics()
compute_metrics_from_nodes()
export_seg_to_array()
ContourRenderer
get_morphological_outline()
find_contours()
draw_contours()
create_comparison_image()
create_error_image()
create_combined_image()
clear_cache()
DICOMLabelMapSegPlugin
examineForImport()
f_inv()
gamma()
register_plugin()
is_labelmap_seg()
DependencySpec
DependencyManager
is_available()
ensure_available()
clear_session()
get_dependency_manager()
DicomManager
database()
ensure_database_initialized()
generate_uid()
create_synthetic_dicom()
export_segmentation_as_dicom_seg()
load_segmentation_by_uid()
get_segmentations_for_volume()
get_series_description()
EmbeddedWizardPanel
build_ui()
update_sample_count()
get_answers()
set_recommendation()
get_recommendation()
current_step()
hide()
show()
GoldStandardManager
save_as_gold()
load_gold()
get_dicom_seg_path()
list_gold_standards()
gold_exists()
get_gold_path()
update_metadata()
update_statistics()
delete_gold()
save_reference_screenshot()
compare_statistics()
format_statistics()
format_comparison()
IntensityAnalyzer
analyze()
TimingResult
TimingContext
MetricValue
MetricsCollector
duration_ms()
duration_seconds()
timing()
record_metric()
get_metrics()
get_timing()
get_metric()
clear()
ComparisonModel
TrialModelMapper
best_trial()
best_score()
trial_count()
group_by_algorithm()
get_top_n_per_algorithm()
group_by_dice_range()
group_by_trial_numbers()
create_gold_standard_model()
get_best_overall()
filter_by_algorithm()
filter_by_min_dice()
quick_compare_algorithms()
quick_compare_top_trials()
ParameterSpec
RecipeSpec
OptimizationConfig
validate()
create_default_config()
OptunaTrialResult
OptimizationResults
OptunaOptimizer
set_dicom_info()
create_study()
suggest_params()
wrapped_objective()
get_param_importance()
report_intermediate()
get_best_params()
get_best_value()
run_optimization_with_recipe()
objective()
ParameterRecommender
recommend()
ParameterWizard
handle_interaction_event()
on_foreground_sampled()
on_background_sampled()
on_boundary_traced()
generate_recommendation()
apply_recommendation()
clear_samples()
PerformanceCache
CacheStats
computeOrGetCached()
getOrComputeGradient()
isValidFor()
onMouseRelease()
invalidate()
reset()
log_summary()
ReviewRecord
RatingManager
label()
from_string()
set_reviewer()
start_session()
rate_trial()
get_rating()
get_all_ratings()
export_csv()
export_json()
execute()
list_recipes()
RecordedStroke
RecordedParamChange
RecipeRecorder
record_stroke()
record_param_change()
get_global_recorder()
start_recording()
stop_recording()
RecipeResult
RecipeRunner
run()
run_recipe()
RecipeTestResult
RecipeTestSuiteResult
RecipeTestRunner
passed()
passed_count()
total_count()
discover_recipes()
run_recipe_test()
run_all()
run_recipe_tests()
ReportGenerator
generate_markdown()
save_markdown()
generate_summary()
save_summary()
DicomInfo
TrialData
OptimizationRun
ResultsLoader
get_trial()
get_algorithm_trials()
list_runs()
get_gold_standard_path()
ScreenshotInfo
ScreenshotGroup
ScreenshotCapture
next_number()
set_base_folder()
new_group()
current_group()
screenshot()
capture_layout()
capture_slice_view()
capture_layout_with_3d()
capture_3d_view()
capture_widget()
update_description()
get_all_screenshots()
get_group_screenshots()
get_screenshots_by_tags()
get_doc_screenshots()
ScreenshotViewer
set_screenshots()
load_from_directory()
select()
get_selected()
select_next()
select_previous()
view_full_size()
copy_path_to_clipboard()
get_count()
BrushOutlinePipeline
setSliceWidget()
updateOutline()
setCrosshairSettings()
updatePreview()
hidePreview()
cleanup()
register()
clone()
icon()
helpText()
setupOptionsFrame()
onCrosshairColorPicker()
onCrosshairSettingsChanged()
onPresetChanged()
onResetPreset()
applyPreset()
brushRadiusMm()
edgeSensitivityValue()
onRadiusChanged()
onSensitivityChanged()
onZoneChanged()
onSamplingMethodChanged()
onAdvancedParamChanged()
onSphereModeChanged()
onPreviewModeChanged()
onModeChanged()
onWizardClicked()
setAlgorithm()
setRadiusMm()
setEdgeSensitivity()
setThresholdRange()
onAlgorithmChanged()
onThresholdChanged()
onAutoThresholdChanged()
onThresholdMethodChanged()
onSetFromSeedClicked()
onCachingChanged()
onBackendChanged()
activate()
deactivate()
setMRMLDefaults()
updateGUIFromMRML()
updateMRMLFromGUI()
interactionNodeModified()
layoutChanged()
processViewNodeEvents()
sourceVolumeNodeChanged()
masterVolumeNodeChanged()
referenceGeometryChanged()
processInteractionEvents()
processPoint()
computeAdaptiveMask()
applyMaskToSegment()
MetricsResult
StrokeRecord
StrokeMetricsTracker
compute_dice_only()
SequenceRecorder
ViewGroupManager
SceneViewBookmarks
step_count()
record_step()
add_note()
goto_step()
get_note_at_step()
get_browser_node()
get_sequence()
is_linked()
enable_linking()
disable_linking()
set_linked()
setup_slice_observer()
get_slice_offset()
get_slice_range()
set_slice_offset()
count()
add_bookmark()
restore_bookmark()
list_bookmarks()
get_bookmark_name()
remove_bookmark()
clear_all()
SegmentationCheckpoint
SteppingRecipeRunner
size_bytes()
total_steps()
is_at_start()
is_at_end()
is_branching()
set_step_callback()
set_checkpoint_callback()
setup()
step_forward()
step_backward()
run_to_end()
get_current_action()
get_next_action()
start_branch()
stop_branch()
add_manual_action()
save_branch()
get_checkpoint_stats()
Assertion
TestResult
TestCaseInfo
failed_assertions()
verify()
teardown()
TestContext
output_folder()
assertions()
screenshots()
metrics()
set_screenshot_context()
screenshot_slice_view()
screenshot_3d_view()
metric()
log()
assert_true()
assert_false()
assert_equal()
assert_not_equal()
assert_greater()
assert_greater_equal()
assert_less()
assert_less_equal()
assert_is_not_none()
assert_is_none()
assert_almost_equal()
TestRegistry
unregister()
get()
list_tests()
list_categories()
register_test()
decorator()
TestRunFolder
create()
path()
screenshots_folder()
logs_folder()
save_metadata()
save_results()
save_screenshot_manifest()
copy_slicer_log()
append_manual_action()
TestSuiteResult
TestRunner
failed_count()
run_test()
run_suite()
discover_tests()
VisualizationController
load_gold_segmentation()
load_gold_from_dicom_cache()
load_test_segmentation_from_dicom()
set_view_mode()
toggle_gold()
toggle_test()
get_gold_node()
get_test_node()
WizardAnalyzer
analyze_intensities()
analyze_shape()
estimate_boundary_roughness()
WizardSamples
IntensityAnalysisResult
ShapeAnalysisResult
WizardRecommendation
has_foreground()
has_background()
has_boundary()
foreground_count()
background_count()
clear_foreground()
clear_background()
clear_boundary()
threshold_range()
is_well_separated()
is_small_structure()
is_large_structure()
has_smooth_boundary()
is_high_confidence()
has_warnings()
has_threshold_suggestion()
WizardSampler
is_active()
process_event()
get_samples()
sample_count()
isComplete()
get_questions_answers()
was_applied()
Algorithm Reference
AdaptiveBrush provides multiple segmentation algorithms, each with different strengths.