bids.reports.parameters

Functions for building strings for individual parameters.

Functions

describe_bvals(bval_file)	Generate description of dMRI b-values.
describe_dmri_directions(img)	Generate description of diffusion directions.
describe_duration(files)	Generate general description of scan length from files.
describe_echo_times(files)	Generate description of echo times from metadata field.
describe_echo_times_fmap(files)	Generate description of echo times from metadata field for fmaps
describe_flip_angle(metadata)	Generate description of flip angle.
describe_func_duration(n_vols, tr)	Generate description of functional run length from repetition time and number of volumes.
describe_image_size(img)	Generate description imaging data sizes, including FOV, voxel size, and matrix size.
describe_inplane_accel(metadata)	Generate description of in-plane acceleration factor, if any.
describe_intendedfor_targets(metadata, layout)	Generate description of intended for targets.
describe_multiband_factor(metadata)	Generate description of the multi-band acceleration applied, if used.
describe_pe_direction(metadata, config)	Generate description of phase encoding direction.
describe_repetition_time(metadata)	Generate description of repetition time from metadata.
describe_sequence(metadata, config)	Extract and reformat imaging sequence(s) and variant(s) into pretty strings.
describe_slice_timing(img, metadata)	Generate description of slice timing from metadata.
get_size_str(img)	Extract and reformat voxel size, matrix size, FOV, and number of slices into strings.
get_slice_info(slice_times)	Extract slice order from slice timing info.