Library API (application program interface)

Information on specific functions, classes, and methods.

• nireports package
  • Subpackages
    • nireports.assembler package
      • Subpackages
        • nireports.assembler.data package
          • load()
          • load.readable()
          • load.as_path()
          • load.cached()
      • Submodules
        • nireports.assembler.export module
        • nireports.assembler.misc module
          • dict2html()
          • read_crashfile()
          • unfold_columns()
        • nireports.assembler.pyodide module
        • nireports.assembler.report module
          • Report
            • Report.footer
            • Report.generate_report()
            • Report.header
            • Report.index()
            • Report.navbar
            • Report.out_filename
            • Report.process_plugins()
            • Report.sections
            • Report.template_path
            • Report.title
          • SubReport
            • SubReport.isnested
            • SubReport.name
            • SubReport.reportlets
            • SubReport.title
        • nireports.assembler.reportlet module
          • Reportlet
            • Reportlet.components
            • Reportlet.description
            • Reportlet.is_empty()
            • Reportlet.name
            • Reportlet.subtitle
            • Reportlet.title
        • nireports.assembler.tools module
          • generate_reports()
          • run_reports()
    • nireports.cli package
    • nireports.interfaces package
      • CompCorVariancePlot
      • ConfoundsCorrelationPlot
      • FMRISummary
      • PlotContours
      • PlotMosaic
      • PlotSpikes
      • RaincloudPlot
      • Subpackages
        • nireports.interfaces.reporting package
          • Submodules
            • nireports.interfaces.reporting.base module
              • RegistrationRC
              • ReportingInterface
              • ResampleBeforeAfterRPT
              • SegmentationRC
              • SimpleBeforeAfterRPT
              • SurfaceSegmentationRC
            • nireports.interfaces.reporting.masks module
              • ACompCorRPT
              • BETRPT
              • BrainExtractionRPT
              • ROIsPlot
              • SimpleShowMaskRPT
              • TCompCorRPT
            • nireports.interfaces.reporting.registration module
              • ApplyTOPUPRPT
              • ApplyXFMRPT
              • BBRegisterRPT
              • FLIRTRPT
              • FUGUERPT
              • MRICoregRPT
              • ResampleBeforeAfterRPT
              • SimpleBeforeAfterRPT
            • nireports.interfaces.reporting.segmentation module
              • FASTRPT
              • ICA_AROMARPT
              • MELODICRPT
              • ReconAllRPT
      • Submodules
        • nireports.interfaces.base module
        • nireports.interfaces.dmri module
          • DWIHeatmap
        • nireports.interfaces.fmri module
          • FMRISummary
        • nireports.interfaces.mosaic module
          • PlotContours
          • PlotMosaic
          • PlotSpikes
        • nireports.interfaces.nuisance module
          • CompCorVariancePlot
          • ConfoundsCorrelationPlot
          • RaincloudPlot
    • nireports.reportlets package
      • Subpackages
        • nireports.reportlets.modality package
          • Submodules
            • nireports.reportlets.modality.dwi module
              • draw_circles()
              • draw_points()
              • get_segment_labels()
              • get_segments()
              • nii_to_carpetplot_data()
              • plot_dwi()
              • plot_gradients()
              • plot_heatmap()
              • plot_tissue_values()
              • rotation_matrix()
            • nireports.reportlets.modality.func module
              • fMRIPlot
                • fMRIPlot.confounds
                • fMRIPlot.detrend
                • fMRIPlot.nskip
                • fMRIPlot.paired_carpet
                • fMRIPlot.plot()
                • fMRIPlot.segments
                • fMRIPlot.sort_carpet
                • fMRIPlot.spikes
                • fMRIPlot.timeseries
                • fMRIPlot.tr
      • Submodules
        • nireports.reportlets.mosaic module
          • plot_mosaic()
          • plot_registration()
          • plot_segmentation()
          • plot_segs()
          • plot_slice()
          • plot_slice_tern()
          • plot_spikes()
        • nireports.reportlets.notebook module
          • display()
        • nireports.reportlets.nuisance module
          • confoundplot()
          • confounds_correlation_plot()
          • plot_carpet()
          • plot_dist()
          • plot_fd()
          • plot_qi2()
          • plot_raincloud()
          • plot_vline()
          • spikesplot()
        • nireports.reportlets.surface module
          • cifti_surfaces_plot()
        • nireports.reportlets.utils module
          • DisplayObject
            • DisplayObject.frame_axes
          • combine_svg()
          • compose_view()
          • cuts_from_bbox()
          • extract_svg()
          • get_parula()
          • robust_set_limits()
          • svg2str()
          • svg_compress()
          • transform_to_2d()
        • nireports.reportlets.xca module
          • compcor_variance_plot()
          • plot_melodic_components()
    • nireports.tools package
      • Submodules
        • nireports.tools.ndimage module
          • load_api()
          • rotate_affine()
          • rotation2canonical()
        • nireports.tools.timeseries module
          • cifti_timeseries()
          • get_tr()
          • nifti_timeseries()
• nireports.assembler package
  • Subpackages
    • nireports.assembler.data package
      • load()
      • load.readable()
      • load.as_path()
      • load.cached()
  • Submodules
    • nireports.assembler.export module
    • nireports.assembler.misc module
      • dict2html()
      • read_crashfile()
      • unfold_columns()
    • nireports.assembler.pyodide module
    • nireports.assembler.report module
      • Report
        • Report.footer
        • Report.generate_report()
        • Report.header
        • Report.index()
        • Report.navbar
        • Report.out_filename
        • Report.process_plugins()
        • Report.sections
        • Report.template_path
        • Report.title
      • SubReport
        • SubReport.isnested
        • SubReport.name
        • SubReport.reportlets
        • SubReport.title
    • nireports.assembler.reportlet module
      • Reportlet
        • Reportlet.components
        • Reportlet.description
        • Reportlet.is_empty()
        • Reportlet.name
        • Reportlet.subtitle
        • Reportlet.title
    • nireports.assembler.tools module
      • generate_reports()
      • run_reports()
• nireports.cli package
• nireports.interfaces package
  • CompCorVariancePlot
  • ConfoundsCorrelationPlot
  • FMRISummary
  • PlotContours
  • PlotMosaic
  • PlotSpikes
  • RaincloudPlot
  • Subpackages
    • nireports.interfaces.reporting package
      • Submodules
        • nireports.interfaces.reporting.base module
          • RegistrationRC
          • ReportingInterface
          • ResampleBeforeAfterRPT
          • SegmentationRC
          • SimpleBeforeAfterRPT
          • SurfaceSegmentationRC
        • nireports.interfaces.reporting.masks module
          • ACompCorRPT
          • BETRPT
          • BrainExtractionRPT
          • ROIsPlot
          • SimpleShowMaskRPT
          • TCompCorRPT
        • nireports.interfaces.reporting.registration module
          • ApplyTOPUPRPT
          • ApplyXFMRPT
          • BBRegisterRPT
          • FLIRTRPT
          • FUGUERPT
          • MRICoregRPT
          • ResampleBeforeAfterRPT
          • SimpleBeforeAfterRPT
        • nireports.interfaces.reporting.segmentation module
          • FASTRPT
          • ICA_AROMARPT
          • MELODICRPT
          • ReconAllRPT
  • Submodules
    • nireports.interfaces.base module
    • nireports.interfaces.dmri module
      • DWIHeatmap
    • nireports.interfaces.fmri module
      • FMRISummary
    • nireports.interfaces.mosaic module
      • PlotContours
      • PlotMosaic
      • PlotSpikes
    • nireports.interfaces.nuisance module
      • CompCorVariancePlot
      • ConfoundsCorrelationPlot
      • RaincloudPlot
• nireports.reportlets package
  • Subpackages
    • nireports.reportlets.modality package
      • Submodules
        • nireports.reportlets.modality.dwi module
          • draw_circles()
          • draw_points()
          • get_segment_labels()
          • get_segments()
          • nii_to_carpetplot_data()
          • plot_dwi()
          • plot_gradients()
          • plot_heatmap()
          • plot_tissue_values()
          • rotation_matrix()
        • nireports.reportlets.modality.func module
          • fMRIPlot
            • fMRIPlot.confounds
            • fMRIPlot.detrend
            • fMRIPlot.nskip
            • fMRIPlot.paired_carpet
            • fMRIPlot.plot()
            • fMRIPlot.segments
            • fMRIPlot.sort_carpet
            • fMRIPlot.spikes
            • fMRIPlot.timeseries
            • fMRIPlot.tr
  • Submodules
    • nireports.reportlets.mosaic module
      • plot_mosaic()
      • plot_registration()
      • plot_segmentation()
      • plot_segs()
      • plot_slice()
      • plot_slice_tern()
      • plot_spikes()
    • nireports.reportlets.notebook module
      • display()
    • nireports.reportlets.nuisance module
      • confoundplot()
      • confounds_correlation_plot()
      • plot_carpet()
      • plot_dist()
      • plot_fd()
      • plot_qi2()
      • plot_raincloud()
      • plot_vline()
      • spikesplot()
    • nireports.reportlets.surface module
      • cifti_surfaces_plot()
    • nireports.reportlets.utils module
      • DisplayObject
        • DisplayObject.frame_axes
      • combine_svg()
      • compose_view()
      • cuts_from_bbox()
      • extract_svg()
      • get_parula()
      • robust_set_limits()
      • svg2str()
      • svg_compress()
      • transform_to_2d()
    • nireports.reportlets.xca module
      • compcor_variance_plot()
      • plot_melodic_components()
• nireports.tools package
  • Submodules
    • nireports.tools.ndimage module
      • load_api()
      • rotate_affine()
      • rotation2canonical()
    • nireports.tools.timeseries module
      • cifti_timeseries()
      • get_tr()
      • nifti_timeseries()