API Reference
This section provides detailed API documentation for the SpinDoctor system.
API Reference:
- spindoctor.feature
NavFeatureNavReliabilityBreakdownbody_names_from_features()NavFeatureTypeBodyBlobGeometryBodyDiscGeometryCartographicModelGeometryLimbPolylineNavFeatureGeometryRingAnnulusGeometryRingEdgePolylineStarGeometryTerminatorPolylineBodyBlobFlagsBodyDiscFlagsCartographicModelFlagsLimbArcFlagsNavFeatureFlagsRingAnnulusFlagsRingEdgeFlagsStarFlagsTerminatorArcFlagscompose_dialog_overlay()compose_template_features()DEFAULT_RELIABILITY_THRESHOLDSFeatureReliabilityGateGatedFeatureRecordAGREEMENT_FACTOR_CAPCOMBINED_CONFIDENCE_CAPINCIDENCE_FACTOR_ANGLE_CAP_DEGINCIDENCE_FACTOR_CLIP_DEGJSON_INF_SENTINELMAX_INCIDENCE_FACTOR_CAPMIN_ANISOTROPIC_SMEAR_PX
- spindoctor.nav_orchestrator
NavOrchestratorOrchestratorPrepNavContextNavResultNavFeatureSummaryImageQualityThresholdsNavImageClassifierNavImageClassifierResultDEFAULT_DT_HALF_WIDTH_PXDEFAULT_EDGE_THRESHOLD_K_SIGMADEFAULT_IMAGE_GRADIENT_SIGMA_PXImageDerivativesConfigbuild_image_edge_dt()compute_all_image_derivatives()compute_image_gradient_vu()ProvenanceProvenanceMetadatacollect_provenance_metadata()EnsembleConfigderive_confidence_rank()ensemble()ConsensusSelectionconsensus_selection()corroborating_confidence()corroborating_members()result_param_vector()mahalanobis_distance()mixed_scale_pinvh()observable_basis()observable_intersection_basis()assert_diagnostic_fields_present()build_metadata_dict()InstrumentSettingsinstrument_settings_from_obs()
- spindoctor.nav_model
NavModelbuild_models_for_obs()BODY_SHAPE_TABLEBodyShapeDEFAULT_BODY_SHAPEload_body_shape()BODY_DISC_MAX_OVERFLOW_FRACTIONBODY_DISC_MIN_VISIBLE_LIT_FRACTIONBODY_POSITION_SLOP_FRACLIMB_ARC_MAX_UNCERTAINTY_PXNavModelBodyTERMINATOR_MIN_PHASE_FACTORTERMINATOR_MIN_VERTICESTITAN_BODY_NAMEbodies_in_extfov()limb_reliability()shape_features_suppressed()terminator_reliability()BODY_BLOB_MIN_DIAMETER_PXNavModelBodyBaseNavModelBodySimulatedNavModelRingsNavModelRingsBaseNavModelRingsSimulatedcreate_simulated_body()PredictedRingEdgePredictedRingFeaturepredict_ring_feature()NavModelTitan- spindoctor.nav_model.rings
- spindoctor.nav_model.stars
- spindoctor.nav_technique
NCCCovarianceTuningNavTechniqueROTATION_AT_EDGE_FRACTIONROTATION_UNOBSERVABLE_VARIANCEadd_model_error_floor()add_size_scaled_model_error()embed_rotation_unobservable()filter_technique_names()load_model_error_floor()load_ncc_covariance_tuning()log_confidence_breakdown()rotation_pivot_distance_px()rotation_unobservable_sigma_rad()search_window_for_obs()technique_tier()validate_registered_confidence_specs()NavFeasibilityReportNavTechniqueResultBodyBlobDiagnosticsBodyDiscDiagnosticsBodyLimbDiagnosticsBodyTerminatorDiagnosticsManualNavDiagnosticsNavTechniqueDiagnosticsRingAnnulusDiagnosticsRingEdgeDiagnosticsStarFieldDiagnosticsStarRefineDiagnosticsStarUniqueMatchDiagnosticsConfidenceBreakdownConfidenceSpecConfidenceTermConfidenceTermContributionevaluate_sigmoid_combination()ConfidenceConfigErrorload_confidence_spec()load_technique_tuning()CoarseSearchResultLMRefineResultRidgeRefineResultSecondaryBasinbuild_polyline_mask()coarse_ncc_search()coarse_ncc_search_scored()find_secondary_dt_minimum()gradient_ridge_refine()information_matrix_to_covariance()lm_subpixel_refine()polarity_filter()tukey_biweight_weights()BodyLimbNavBodyTerminatorNavBodyDiscCorrelateNavBodyBlobNavRingEdgeNavaggregate_edge_normal_angle_deg()RingAnnulusNavStarFieldFromCatalogNavStarRefineNavStarUniqueMatchNavNavTechniqueManualrun_manual_nav()
- spindoctor.reproj
BodyMosaicBodyMosaicDataBodyMosaicMergeStrategyBodyReprojResultUSE_MOSAIC_LIMITSRingMosaicRingMosaicDataRingMosaicMergeStrategyRingReprojResultCartographicModelResultcreate_cartographic_model()LambertModelLommelSeeligerModelMinnaertModelPhotometricModelphotometric_model_from_name()FRING_CORERingOrbitModelget_orbit_model_by_name()
- spindoctor.dataset
- spindoctor.obs
- spindoctor.annotation
- spindoctor.config
- spindoctor.support
AttrDictevaluate_candidate()fourier_shift()gradient_magnitude()int_to_signed()masked_ncc()matched_filter_covariance()navigate_single_scale_kpeaks()navigate_with_pyramid_kpeaks()nms_topk()peak_to_runner_up_ratio()per_metric()pmr_metric()psr_metric()upsampled_dft()apply_translation()sample_dt_bilinear()NavContractErrorclean_obj()dump_yaml()json_as_string()canonicalize()NavFilterKindNavFilterSpecapply_filter()clean_sclass()apply_linear_gamma_stretch()array_unzoom()array_zoom()crop_center()draw_circle()draw_line()draw_line_arrow()draw_rect()filter_downsample()filter_local_maximum()filter_sub_median()gaussian_blur_cov()gradient_magnitude()next_power_of_2()normalize_array()pad_array()pad_array_to_power_of_2()pad_top_left()require_finite_int_or_float()shift_array()unpad_array()cosmic_ray_mask()saturation_mask()current_git_version()dec_rad_to_dms()flatten_list()get_local_host_name()log_run_environment()mad_std()ra_rad_to_hms()safe_lstrip_zero()NavBaseestimate_background_and_sky_sigma()estimate_image_noise_sigma()NavStatusReasongrayscale_to_rgb_with_quantile_stretch()render_annotated_summary_rgb()dt_delta_str()et_to_utc()now_dt()now_iso()utc_to_et()MutableStar
- spindoctor.sim
clear_render_caches()render_combined_model()resolve_oversample()SimFrameStagedownsample_to_detector()new_sim_frame()run_pipeline()compose_scene_radiance()ScreenOpcheck_depth_ambiguity()check_halo_ambiguity()check_ring_system_ambiguity()translucent_screen_ops()create_simulated_body()render_single_body()render_single_mesh_body()TopoBodySpeccreate_topographic_body()AlbedoTextureSpecDiscTextureSpecTransitSpecalbedo_spec_from_params()apply_transits()disc_texture_spec_from_params()surface_texture_factor()transit_specs_from_params()MarchStatsReliefFieldmarch_shadows()synthesize_albedo_field()synthesize_relief_field()incidence_cosines()shade_surface()surge_factor()RingSystemMapshenyey_greenstein_phase()render_ring_system()ring_reflection_factor()faint_sky_cutoff_mag()render_sky_counts()render_stars()total_flux_for_vmag()apply_optics()apply_stray_light()effective_psf()instrument_defaults_on()apply_smear()smear_kernel()apply_distortion()apply_psf()psf_kernel()psf_truncation_for_instrument()apply_ghosts()DetectorParamsapply_detector()apply_saturation()quantize_dn()resolve_detector_params()DetectorParamsresolve_detector_params()apply_detector()apply_saturation()quantize_dn()add_banding()add_bias_structure()add_cosmic_rays()add_dark_current()add_hot_pixels()deposit_morphological_events()add_bright_dark_pairs()add_coherent_banding()add_dark_ramp()add_fixed_pattern_dn()add_fixed_pattern_response()add_residual_image()add_serial_tail()apply_beam_bend()apply_exposure_shading()apply_frame_transfer_smear()apply_telemetry()apply_alternating_lines()apply_cutout_window()apply_dead_columns()apply_dead_pixels()apply_edited_frame()apply_embedded_header()apply_line_garble()apply_missing_blocks()apply_missing_lines()apply_partial_lines()apply_pixel_spikes()apply_truncated_frame()apply_compression_dct()apply_resample_texture()apply_reseau_scars()marker_mask()measured_missing_blocks()measured_missing_lines()measured_partial_lines()measured_pixel_dropouts()planted_incidence()FeatureLocichoose_pixels()choose_rows()dilated_pixels()extract_feature_loci()AtmosphereLayersAtmosphereSpecHaloScreenapply_atmosphere()atmosphere_spec_from_params()hg_phase_factor()ArtifactModeModeParammode_available()mode_unavailable_message()normalize_instrument()resolve_mode_config()resolve_detector_defaults()resolve_mode_with_catalog()resolve_sky_pixel_scale_arcsec()resolve_star_flux_zero_point()EllipsoidProjectionellipsoid_image_normals()illumination_vector()lambert_from_normals()project_ellipsoid()MeshMeshBodySpecmake_irregular_mesh()mesh_spec_from_params()render_mesh_body_image()render_polyhedral_body()RingEdgeWaveRingOrbitRingOrbitModecompute_antialiasing_shade()compute_edge_radii_array()compute_edge_radius_at_angle()compute_edge_wave_dr()compute_orbit_radii()ring_los_depth()ring_orbit_from_mapping()ring_plane_from_sky()ring_radial_scale()ring_sky_from_plane()star_record_from_params()SimSceneValidationErrorbuild_nav_params()iter_scene_paths()load_sim_scene()save_sim_scene()scene_class_for_path()validate_sim_params()SimSceneValidationErrornavigator_matched_psf()resolve_extfov_margin()resolve_sim_inst_config()derive_effect_seed()stable_param_seed()render_scene_png()save_png()stretch_to_uint8()ArtifactIncidencemeasure_artifact_incidence()split_stationary_spikes()CohortSupportW1Resultcohort_support()w1_between_densities()w1_divergence()DynamicRangeStatsframe_dynamic_range()stratify_by_exposure()SkyPatchfind_uniform_patches()paired_difference_sigma()radial_power_spectrum()edge_normal_profiles()ee_radius()encircled_energy()profile_rise_width()radial_profile()
- spindoctor.ui
- spindoctor.navigate_image_files