Library API (application program interface)

Information on specific functions, classes, and methods.

• dmriprep.config package
  • Configuration sections
    • _Config
      • _Config.get()
      • _Config.load()
  • Usage
  • Logging
  • Other responsibilities
  • dumps()
  • environment
    • environment.cpu_count
    • environment.exec_docker_version
    • environment.exec_env
    • environment.free_mem
    • environment.nipype_version
    • environment.overcommit_limit
    • environment.overcommit_policy
    • environment.templateflow_version
    • environment.version
  • execution
    • execution.bids_database_dir
    • execution.bids_description_hash
    • execution.bids_dir
    • execution.bids_filters
    • execution.boilerplate_only
    • execution.dataset_links
    • execution.debug
    • execution.derivatives
    • execution.dmriprep_dir
    • execution.fs_license_file
    • execution.fs_subjects_dir
    • execution.init()
    • execution.layout
    • execution.log_dir
    • execution.log_level
    • execution.low_mem
    • execution.md_only_boilerplate
    • execution.notrack
    • execution.output_dir
    • execution.output_layout
    • execution.output_spaces
    • execution.participant_label
    • execution.processing_groups
    • execution.reports_only
    • execution.run_uuid
    • execution.session_label
    • execution.sloppy
    • execution.templateflow_home
    • execution.work_dir
    • execution.write_graph
  • from_dict()
  • get()
  • init_spaces()
  • load()
  • loggers
    • loggers.cli
    • loggers.default
    • loggers.init()
    • loggers.interface
    • loggers.utils
    • loggers.workflow
  • nipype
    • nipype.crashfile_format
    • nipype.get_linked_libs
    • nipype.get_plugin()
    • nipype.init()
    • nipype.memory_gb
    • nipype.nprocs
    • nipype.omp_nthreads
    • nipype.parameterize_dirs
    • nipype.plugin
    • nipype.plugin_args
    • nipype.resource_monitor
    • nipype.stop_on_first_crash
  • redirect_warnings()
  • seeds
    • seeds.ants
    • seeds.init()
    • seeds.master
    • seeds.numpy
  • to_filename()
  • workflow
    • workflow.anat_only
    • workflow.cifti_output
    • workflow.dwi2anat_dof
    • workflow.dwi2anat_init
    • workflow.fallback_total_readout_time
    • workflow.fmap_bspline
    • workflow.fmap_demean
    • workflow.force
    • workflow.fs_no_resume
    • workflow.hires
    • workflow.ignore
    • workflow.level
    • workflow.run_msmsulc
    • workflow.run_reconall
    • workflow.skull_strip_fixed_seed
    • workflow.skull_strip_t1w
    • workflow.skull_strip_template
    • workflow.spaces
    • workflow.subject_anatomical_reference
    • workflow.use_bbr
    • workflow.use_syn_sdc
• dmriprep.interfaces package
  • BIDSDataGrabber
  • DerivativesDataSink
    • DerivativesDataSink.out_path_base
  • Submodules
    • dmriprep.interfaces.bids module
      • BIDSSourceFile
      • BIDSURI
        • BIDSURI.input_spec
      • CreateFreeSurferID
    • dmriprep.interfaces.images module
      • ExtractB0
      • RescaleB0
    • dmriprep.interfaces.reports module
      • AboutSummary
      • DiffusionSummary
      • SubjectSummary
      • SummaryInterface
    • dmriprep.interfaces.vectors module
      • CheckGradientTable
• dmriprep.utils package
  • Submodules
    • dmriprep.utils.bids module
      • collect_derivatives()
      • extract_entities()
      • validate_input_dir()
      • write_bidsignore()
      • write_derivative_description()
    • dmriprep.utils.images module
      • extract_b0()
      • get_list_data()
      • match_transforms()
      • rescale_b0()
      • save_3d_to_4d()
      • save_4d_to_3d()
      • summarize_images()
    • dmriprep.utils.misc module
      • check_deps()
      • estimate_image_mem_usage()
      • fips_enabled()
      • fmt_subjects_sessions()
    • dmriprep.utils.vectors module
      • DiffusionGradientTable
        • DiffusionGradientTable.affine
        • DiffusionGradientTable.b0mask
        • DiffusionGradientTable.bvals
        • DiffusionGradientTable.bvecs
        • DiffusionGradientTable.count_shells
        • DiffusionGradientTable.generate_rasb()
        • DiffusionGradientTable.generate_vecval()
        • DiffusionGradientTable.gradients
        • DiffusionGradientTable.normalize()
        • DiffusionGradientTable.normalized
        • DiffusionGradientTable.pole
        • DiffusionGradientTable.reorient_rasb()
        • DiffusionGradientTable.to_filename()
      • bvecs2ras()
      • calculate_pole()
      • normalize_gradients()
      • rasb_dwi_length_check()
• dmriprep.workflows package
  • Subpackages
    • dmriprep.workflows.dwi package
      • Submodules
        • dmriprep.workflows.dwi.base module
          • init_dwi_wf()
        • dmriprep.workflows.dwi.eddy module
          • gen_eddy_textfiles()
          • init_eddy_wf()
        • dmriprep.workflows.dwi.outputs module
          • init_dwi_derivatives_wf()
          • init_reportlets_wf()
  • Submodules
    • dmriprep.workflows.base module
      • clean_datasinks()
      • get_estimator()
      • init_dmriprep_wf()
      • init_single_subject_wf()
      • map_fieldmap_estimation()