Library API (application program interface)

Information on specific functions, classes, and methods.

• sdcflows.cli package
  • Submodules
    • sdcflows.cli.main module
      • main()
    • sdcflows.cli.parser module
      • parse_args()
    • sdcflows.cli.workflow module
      • build_workflow()
• sdcflows.config module
  • Configuration sections
  • 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.total_memory
    • environment.version
  • execution
    • execution.ants_float
    • execution.bids_database_dir
    • execution.bids_database_wipe
    • execution.bids_description_hash
    • execution.bids_dir
    • execution.bids_filters
    • execution.cwd
    • execution.debug
    • execution.dry_run
    • execution.init()
    • execution.layout
    • execution.log_dir
    • execution.log_level
    • execution.notrack
    • execution.output_dir
    • execution.participant_label
    • execution.pdb
    • execution.run_uuid
    • execution.session_label
    • execution.sloppy
    • execution.templateflow_home
    • execution.work_dir
    • execution.write_graph
  • file_path
  • from_dict()
  • get()
  • load()
  • loggers
    • loggers.cli
    • loggers.default
    • loggers.getLogger()
    • loggers.init()
    • loggers.interface
    • loggers.utils
    • loggers.workflow
  • nipype
    • nipype.crashfile_format
    • nipype.get_linked_libs
    • nipype.get_plugin()
    • nipype.init()
    • nipype.local_hash_check
    • nipype.memory_gb
    • nipype.nprocs
    • nipype.omp_nthreads
    • nipype.plugin
    • nipype.plugin_args
    • nipype.remove_node_directories
    • nipype.resource_monitor
    • nipype.stop_on_first_crash
  • restore_env()
  • to_filename()
  • workflow
    • workflow.analysis_level
    • workflow.fmapless
    • workflow.species
    • workflow.template_id
• sdcflows.data package
  • load()
  • load.readable()
  • load.as_path()
  • load.cached()
  • Loader
    • Loader.readable()
    • Loader.as_path()
    • Loader.cached()
• sdcflows.fieldmaps module
  • EstimatorType
  • FieldmapEstimation
    • FieldmapEstimation.bids_id
    • FieldmapEstimation.get_workflow()
    • FieldmapEstimation.method
    • FieldmapEstimation.paths()
    • FieldmapEstimation.sanitized_id
    • FieldmapEstimation.sources
  • FieldmapFile
    • FieldmapFile.bids_root
    • FieldmapFile.check_path()
    • FieldmapFile.entities
    • FieldmapFile.find_meta
    • FieldmapFile.metadata
    • FieldmapFile.path
    • FieldmapFile.suffix
  • MetadataError
  • clear_registry()
  • get_identifier()
• sdcflows.interfaces package
  • Submodules
    • sdcflows.interfaces.brainmask module
      • BinaryDilation
      • BrainExtraction
      • Union
    • sdcflows.interfaces.bspline module
      • ApplyCoeffsField
      • BSplineApprox
      • TOPUPCoeffReorient
      • TransformCoefficients
      • bspline_grid()
    • sdcflows.interfaces.epi module
      • GetReadoutTime
      • SortPEBlips
    • sdcflows.interfaces.fmap module
      • CheckB0Units
      • CheckRegister
      • DisplacementsField2Fieldmap
      • PhaseMap2rads
      • Phasediff2Fieldmap
      • SubtractPhases
    • sdcflows.interfaces.reportlets module
      • FieldmapReportlet
    • sdcflows.interfaces.utils module
      • ConvertWarp
      • DenoiseImage
      • Deoblique
      • Flatten
      • PadSlices
      • PositiveDirectionCosines
      • Reoblique
      • ReorientImageAndMetadata
      • UniformGrid
• sdcflows.transform module
  • B0FieldTransform
    • B0FieldTransform.apply()
    • B0FieldTransform.coeffs
    • B0FieldTransform.fit()
    • B0FieldTransform.mapped
    • B0FieldTransform.to_displacements()
  • disp_to_fmap()
  • fmap_to_disp()
  • grid_bspline_weights()
  • unwarp_parallel()
  • worker()
• sdcflows.utils package
  • Submodules
    • sdcflows.utils.bimap module
      • EstimatorRegistry
        • EstimatorRegistry.get_key()
        • EstimatorRegistry.sources
      • bidict
        • bidict.add()
        • bidict.clear()
    • sdcflows.utils.epimanip module
      • epi_mask()
      • get_trt()
    • sdcflows.utils.misc module
      • front()
      • get_free_mem()
      • last()
    • sdcflows.utils.phasemanip module
      • au2rads()
      • delta_te()
      • phdiff2fmap()
      • subtract_phases()
    • sdcflows.utils.telemetry module
      • send_crumb()
      • setup_migas()
    • sdcflows.utils.tools module
      • brain_masker()
      • deoblique_and_zooms()
      • ensure_positive_cosines()
      • reorient_pedir()
      • resample_to_zooms()
    • sdcflows.utils.wrangler module
      • find_anatomical_estimators()
      • find_estimators()
• sdcflows.viz package
  • Submodules
    • sdcflows.viz.utils module
      • coolwarm_transparent()
      • plot_registration()
• sdcflows.workflows package
  • Subpackages
    • sdcflows.workflows.apply package
      • Submodules
        • sdcflows.workflows.apply.correction module
          • init_unwarp_wf()
        • sdcflows.workflows.apply.registration module
          • init_coeff2epi_wf()
    • sdcflows.workflows.fit package
      • Submodules
        • sdcflows.workflows.fit.base module
          • init_sdcflows_wf()
        • sdcflows.workflows.fit.fieldmap module
          • init_fmap_wf()
          • init_magnitude_wf()
          • init_phdiff_wf()
        • sdcflows.workflows.fit.pepolar module
          • init_3dQwarp_wf()
          • init_topup_wf()
        • sdcflows.workflows.fit.syn module
          • init_syn_preprocessing_wf()
          • init_syn_sdc_wf()
          • match_histogram()
  • Submodules
    • sdcflows.workflows.ancillary module
      • init_brainextraction_wf()
    • sdcflows.workflows.base module
      • init_fmap_preproc_wf()
    • sdcflows.workflows.outputs module
      • DerivativesDataSink
      • init_fmap_derivatives_wf()
      • init_fmap_reports_wf()