get_recon_matrix_pe

bidsaid.metadata.get_recon_matrix_pe(nifti_file_or_img, phase_encoding_axis)[source]

Get the reconstruction matrix of the phase encoding axis.

Parameters

nifti_file_or_imgstr, Path, or Nifti1Image: Path to the NIfTI file or a NIfTI image.
phase_encoding_axisLiteral["i", "j", "k"]: The axis phase encoding was applied to.

Returns

int: The value of the reconstruction matrix for phase_encoding_axis, which is just the shape of the data in that dimension.