Bids Utils
==========

.. py:module:: petpal.utils.bids_utils

.. autoapi-nested-parse::

   This module contains utilities for handling `Brain Imaging Data Structure (BIDS) <https://bids.neuroimaging.io/>`_
   datasets. It simplifies the creation and management of BIDS projects, offering functions for building project scaffolds,
   handling file paths, and managing neuroimaging data files. Key features include scaffolding BIDS projects, caching
   filepaths for efficient retrieval, and supporting various neuroimaging file types through integration with `nibabel`.




Functions
---------

.. toctree::
   :hidden:

   /autoapi/petpal/utils/bids_utils/add_description_to_bids_path
   /autoapi/petpal/utils/bids_utils/validate_filepath_as_bids
   /autoapi/petpal/utils/bids_utils/validate_directory_as_bids
   /autoapi/petpal/utils/bids_utils/parse_path_to_get_subject_and_session_id
   /autoapi/petpal/utils/bids_utils/snake_to_camel_case
   /autoapi/petpal/utils/bids_utils/gen_bids_like_filename
   /autoapi/petpal/utils/bids_utils/gen_bids_like_dir_path
   /autoapi/petpal/utils/bids_utils/gen_bids_like_filepath

.. autoapisummary::
   :nosignatures:

   petpal.utils.bids_utils.add_description_to_bids_path
   petpal.utils.bids_utils.validate_filepath_as_bids
   petpal.utils.bids_utils.validate_directory_as_bids
   petpal.utils.bids_utils.parse_path_to_get_subject_and_session_id
   petpal.utils.bids_utils.snake_to_camel_case
   petpal.utils.bids_utils.gen_bids_like_filename
   petpal.utils.bids_utils.gen_bids_like_dir_path
   petpal.utils.bids_utils.gen_bids_like_filepath