Warning: This document is for an old version of smriprep. The main version is master.

Library API (application program interface)

Information on specific functions, classes, and methods.

• smriprep.cli package
  • Submodules
    • smriprep.cli.run module
      • build_opts()
      • build_workflow()
      • check_deps()
      • get_parser()
      • main()
• smriprep.interfaces package
  • DerivativesDataSink
    • DerivativesDataSink.out_path_base
  • Submodules
    • smriprep.interfaces.cifti module
      • GenerateDScalar
    • smriprep.interfaces.freesurfer module
      • MRIsConvertData
      • MakeMidthickness
      • ReconAll
        • ReconAll.cmdline
    • smriprep.interfaces.reports module
      • AboutSummary
      • FSSurfaceReport
      • SubjectSummary
      • SummaryInterface
    • smriprep.interfaces.surf module
      • AggregateSurfaces
      • FixGiftiMetadata
      • MakeRibbon
      • NormalizeSurf
      • fix_gifti_metadata()
      • make_ribbon()
      • normalize_surfs()
    • smriprep.interfaces.templateflow module
      • TemplateDesc
      • TemplateFlowSelect
      • fetch_template_files()
    • smriprep.interfaces.workbench module
      • CreateSignedDistanceVolume
      • SurfaceAffineRegression
      • SurfaceApplyAffine
      • SurfaceApplyWarpfield
      • SurfaceModifySphere
      • SurfaceResample
      • SurfaceSphereProjectUnproject
• smriprep.utils package
  • Submodules
    • smriprep.utils.bids module
      • collect_derivatives()
      • write_bidsignore()
      • write_derivative_description()
    • smriprep.utils.misc module
      • apply_lut()
      • fs_isRunning()
      • stringify_sessions()
• smriprep.workflows package
  • Submodules
    • smriprep.workflows.anatomical module
      • init_anat_fit_wf()
      • init_anat_preproc_wf()
      • init_anat_template_wf()
    • smriprep.workflows.base module
      • init_single_subject_wf()
      • init_smriprep_wf()
    • smriprep.workflows.norm module
    • smriprep.workflows.outputs module
      • init_anat_reports_wf()
      • init_ds_anat_volumes_wf()
      • init_ds_dseg_wf()
      • init_ds_fs_registration_wf()
      • init_ds_fs_segs_wf()
      • init_ds_grayord_metrics_wf()
      • init_ds_mask_wf()
      • init_ds_surface_masks_wf()
      • init_ds_surface_metrics_wf()
      • init_ds_surfaces_wf()
      • init_ds_template_registration_wf()
      • init_ds_template_wf()
      • init_ds_tpms_wf()
      • init_template_iterator_wf()
    • smriprep.workflows.surfaces module
      • init_anat_ribbon_wf()
      • init_autorecon_resume_wf()
      • init_cortex_masks_wf()
      • init_fsLR_reg_wf()
      • init_gifti_morphometrics_wf()
      • init_gifti_surfaces_wf()
      • init_hcp_morphometrics_wf()
      • init_morph_grayords_wf()
      • init_msm_sulc_wf()
      • init_refinement_wf()
      • init_resample_surfaces_wf()
      • init_segs_to_native_wf()
      • init_surface_derivatives_wf()
      • init_surface_recon_wf()