Understanding the Outputs¶
In this section, there is a description for all the output files provided at each processing stage. Important outputs from RABIES are stored into datasink/ folders, which will be generated in the output folder specified at execution.
Preprocessing Outputs¶
Multiple datasink folders are generated during preprocessing for different output types: anat_datasink/, bold_datasink/, commonspace_datasink/, transforms_datasink/ and confounds_datasink/.
anat_datasink/: Includes the inhomogeneity-correction anatomical scans
anat_preproc: anatomical scans after inhomogeneity correction
bold_datasink/: Includes all outputs related to the functional scans, where files are either resampled onto the native or commonspace of the EPI.
native_bold: preprocessed EPI timeseries resampled to nativespace
native_brain_mask: brain mask in nativespace
native_WM_mask: WM mask in nativespace
native_CSF_mask: CSF mask in nativespace
native_labels: atlas labels in nativespace
native_bold_ref: a reference 3D EPI image generated from native_bold
commonspace_bold: preprocessed EPI timeseries resampled to commonspace
commonspace_mask: brain mask in commonspace
commonspace_WM_mask: WM mask in commonspace
commonspace_CSF_mask: CSF mask in commonspace
commonspace_vascular_mask: vascular mask in commonspace
commonspace_labels: atlas labels in commonspace
commonspace_resampled_template: the commonspace anatomical template, resampled to the EPI’s dimensions
input_bold: the raw EPI scans provided as inputs in the BIDS data folder
initial_bold_ref: the initial reference 3D EPI image generated from input_bold
inho_cor_bold: the reference 3D EPI (initial_bold_ref) after inhomogeneity correction, which is later used for registration of the EPI
inho_cor_bold_warped2anat: inho_cor_bold after co-registration to the associated anatomical image (anat_preproc)
std_map_preprocess: the temporal standard deviation at each voxel on the commonspace_bold
tSNR_map_preprocess: the temporal signal-to-noise ratio (tSNR) of the commonspace_bold
unbiased_template_datasink/: Outputs related to the generation of the unbiased template using https://github.com/CoBrALab/optimized_antsMultivariateTemplateConstruction
unbiased_template: the unbiased template generated from the input dataset scans
warped_unbiased_template: the unbiased template, registered to the reference atlas in commonspace
transforms_datasink/: datasink for all the relevant transform files resampling between the different spaces. The bold_to_anat registration transformed the raw EPI to overlap with the anatomical image, correcting for susceptibility distortions, which corresponds to the native space. The native_to_unbiased registration overlaps every scans to the generated unbiased template, and then the unbiased_to_atlas corresponds to the registration of the unbiased template with the reference atlas, which defines the commonspace.
bold_to_anat_affine: affine transforms from the EPI co-registration to the anatomical image
bold_to_anat_warp: non-linear transforms from the EPI co-registration to the anatomical image
bold_to_anat_inverse_warp: inverse of the non-linear transforms from the EPI co-registration to the anatomical image
native_to_unbiased_affine: affine transforms for the alignment between native space and the unbiased template
native_to_unbiased_warp: non-linear transforms for the alignment between native space and the unbiased template
native_to_unbiased_inverse_warp: inverse of the non-linear transforms for the alignment between native space and the unbiased template
unbiased_to_atlas_affine: affine transforms for the alignment between unbiased template and the atlas in commonspace
unbiased_to_atlas_warp: non-linear transforms for the alignment between unbiased template and the atlas in commonspace
unbiased_to_atlas_inverse_warp: inverse of the non-linear transforms for the alignment between unbiased template and the atlas in commonspace
confounds_datasink/: regroups data features which are later relevant for subsequent confound correction
confounds_csv: a CSV file grouping a set of nuisance timeseries, which can be used for confound regression. The timeseries generated are detailed in the Nuisance timecourse estimation documentation (https://rabies.readthedocs.io/en/latest/preprocessing.html#nuisance-timecourse-estimation).
FD_csv: a CSV file with timescourses for either the mean or maximal framewise displacement (FD) estimations.
FD_voxelwise: a Nifti image which contains framewise displacement timecourses at each voxel
pos_voxelwise: a Nifti image which contains the relative positioning of each voxel across time
Confound Correction Outputs¶
Important outputs from confound correction will be found in the confound_correction_datasink/:
confound_correction_datasink/:
cleaned_timeseries: cleaned timeseries after the application of confound correction
frame_censoring_mask: contains CSV files each recording as a boolean vector which timepoints were censored if frame censoring was applied.
aroma_out: if
--run_aromais selected, this folder contains outputs from running ICA-AROMA, which includes the MELODIC ICA outputs and the component classification results
Analysis Outputs¶
Outputs from analyses will be found in the analysis_datasink/, whereas outputs relevant to the --data_diagnosis are found in data_diagnosis_datasink/:
analysis_datasink/:
group_ICA_dir: complete output from MELODIC ICA, which the melodic_IC.nii.gz Nifti which gives all spatial components, and report/ folder which includes a HTML visualization.
matrix_data_file: .pkl file which contains a 2D numpy array representing the whole-brain correlation matrix. If
--ROI_type parcellatedis selected, the row/column indices of the array are matched in increasing order of the atlas ROI label number.matrix_fig: .png file which displays the correlation matrix
seed_correlation_maps: nifti files for seed-based connectivity analysis, where each seed provided in
--seed_listhas an associated voxelwise correlation mapsdual_regression_nii: the spatial maps from dual regression, which correspond to the linear coefficients from the second regression. The list of 3D spatial maps obtained are concatenated into a 4D Nifti file, where the order of component is consistent with the priors provided in
--prior_maps.dual_regression_timecourse_csv: a CSV file which stores the outputs from the first linear regression during dual regression. This corresponds to a timecourse associated to each prior component from
--prior_maps.dual_ICA_filename: spatial components fitted during Dual ICA
dual_ICA_timecourse_csv: timecourses associated to each components fitted during Dual ICA
data_diagnosis_datasink/:
figure_temporal_diagnosis: PNG file which displays scan-level temporal features from
--data_diagnosisfigure_spatial_diagnosis: PNG file which displays scan-level spatial features from
--data_diagnosisdataset_diagnosis: group-level features of data quality from
--data_diagnosisDR{component #}_QC_maps.png: The _QC_maps.png files are PNGs displaying statistical maps relevant to analysis quality control. The DR refers to dual regression analysis, and the {component #} is relating the file to one of the BOLD components specified in
--prior_bold_idxDR{component #}_QC_stats.csv: a follow-up to _QC_maps.png which allows for the quantitative categorization of data quality outcomes in Desrosiers-Gregoire et al. (in prep.)
seed_FC{seed #}_QC_maps.png: same statistical maps as with DR{component #}_QC_maps.png, but for seed-based connectivity analysis
seed_FC{seed #}_QC_stats.csv: same measures as with DR{component #}_QC_maps.png, but for seed-based connectivity analysis
spatial_crosscorrelations.png: a display of the group-level correlation between pairs of spatial features from figure_spatial_diagnosis
temporal_info_csv: CSV file containing the data plotted with figure_temporal_diagnosis
spatial_VE_nii: Nifti file with the confound regression variance explained at each voxel
temporal_std_nii: the standard deviation at each voxel after confound correction
GS_corr_nii: the correlation of each voxel with the global signal
DVARS_corr_nii: the correlation of each voxel with DVARS
FD_corr_nii:the correlation of each voxel with framewise displacement