diff --git a/.doctrees/api/datman.config.doctree b/.doctrees/api/datman.config.doctree
index ea69540b..14fddccb 100644
Binary files a/.doctrees/api/datman.config.doctree and b/.doctrees/api/datman.config.doctree differ
diff --git a/.doctrees/api/datman.dashboard.doctree b/.doctrees/api/datman.dashboard.doctree
index 276ac6da..2fffd423 100644
Binary files a/.doctrees/api/datman.dashboard.doctree and b/.doctrees/api/datman.dashboard.doctree differ
diff --git a/.doctrees/api/datman.exceptions.doctree b/.doctrees/api/datman.exceptions.doctree
index ac2011e4..2d9b06b7 100644
Binary files a/.doctrees/api/datman.exceptions.doctree and b/.doctrees/api/datman.exceptions.doctree differ
diff --git a/.doctrees/api/datman.exporters.doctree b/.doctrees/api/datman.exporters.doctree
index e7147389..b26cb5de 100644
Binary files a/.doctrees/api/datman.exporters.doctree and b/.doctrees/api/datman.exporters.doctree differ
diff --git a/.doctrees/api/datman.fs_log_scraper.doctree b/.doctrees/api/datman.fs_log_scraper.doctree
index 872ac88c..1b0484bc 100644
Binary files a/.doctrees/api/datman.fs_log_scraper.doctree and b/.doctrees/api/datman.fs_log_scraper.doctree differ
diff --git a/.doctrees/api/datman.header_checks.doctree b/.doctrees/api/datman.header_checks.doctree
index 0b6e7869..fd461792 100644
Binary files a/.doctrees/api/datman.header_checks.doctree and b/.doctrees/api/datman.header_checks.doctree differ
diff --git a/.doctrees/api/datman.metrics.doctree b/.doctrees/api/datman.metrics.doctree
index 3c08589b..b8f86218 100644
Binary files a/.doctrees/api/datman.metrics.doctree and b/.doctrees/api/datman.metrics.doctree differ
diff --git a/.doctrees/api/datman.scan.doctree b/.doctrees/api/datman.scan.doctree
index 708e9e78..3e9a78d1 100644
Binary files a/.doctrees/api/datman.scan.doctree and b/.doctrees/api/datman.scan.doctree differ
diff --git a/.doctrees/api/datman.scan_list.doctree b/.doctrees/api/datman.scan_list.doctree
index c1d1d756..1e03fd5c 100644
Binary files a/.doctrees/api/datman.scan_list.doctree and b/.doctrees/api/datman.scan_list.doctree differ
diff --git a/.doctrees/api/datman.scanid.doctree b/.doctrees/api/datman.scanid.doctree
index 63bfe916..bb79e171 100644
Binary files a/.doctrees/api/datman.scanid.doctree and b/.doctrees/api/datman.scanid.doctree differ
diff --git a/.doctrees/api/datman.utils.doctree b/.doctrees/api/datman.utils.doctree
index edf97d33..8144ebc1 100644
Binary files a/.doctrees/api/datman.utils.doctree and b/.doctrees/api/datman.utils.doctree differ
diff --git a/.doctrees/api/datman.xnat.doctree b/.doctrees/api/datman.xnat.doctree
index 8f1124fa..e9ecf139 100644
Binary files a/.doctrees/api/datman.xnat.doctree and b/.doctrees/api/datman.xnat.doctree differ
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
index 34148797..86ca86bd 100644
Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ
diff --git a/api/datman.config.html b/api/datman.config.html
index 7f5b09e5..168274ae 100644
--- a/api/datman.config.html
+++ b/api/datman.config.html
@@ -112,16 +112,16 @@
These can both be overridden at __init__.py
-
-class datman.config.TagInfo(export_settings, site_settings=None)[source]
+class datman.config.TagInfo(export_settings, site_settings=None)[source]
Bases: object
-
-get(tag, field=None)[source]
+get(tag, field=None)[source]
-
-keys()[source]
+keys()[source]
@@ -135,11 +135,11 @@
-
-class datman.config.config(filename=None, system=None, study=None)[source]
+class datman.config.config(filename=None, system=None, study=None)[source]
Bases: object
-
-get_key(key, site=None, ignore_defaults=False, defaults_only=False)[source]
+get_key(key, site=None, ignore_defaults=False, defaults_only=False)[source]
Searches the configuration from most specific settings to least to
allow overrides + additional settings to be discovered.
Searches from site (if given) -> study -> local system -> system wide
@@ -153,24 +153,24 @@
-
-get_path(path_type, study=None)[source]
+get_path(path_type, study=None)[source]
returns the absolute path to a folder type
-
-get_sites(study=None)[source]
+get_sites(study=None)[source]
-
-get_study_base(study=None)[source]
+get_study_base(study=None)[source]
Return the base directory for a study
-
-get_study_tags(study=None)[source]
+get_study_tags(study=None)[source]
Returns a dictionary of study tags mapped to the sites defined for
that tag.
If a study has not been set then an exception is raised
@@ -178,7 +178,7 @@
-
-get_tags(site=None, study=None)[source]
+get_tags(site=None, study=None)[source]
Returns a TagInfo instance.
If you get the tags without a study set or without specifying a site
you get the configuration of all defined tags from ‘ExportSettings’ in
@@ -192,7 +192,7 @@
-
-get_xnat_projects(study=None)[source]
+get_xnat_projects(study=None)[source]
@@ -202,12 +202,12 @@
-
-load_yaml(filename)[source]
+load_yaml(filename)[source]
-
-map_xnat_archive_to_project(filename)[source]
+map_xnat_archive_to_project(filename)[source]
Maps the XNAT tag (e.g. SPN01) to the project name e.g. SPINS
Can either supply a full filename in which case only the first part
is considered or just a tag.
@@ -222,7 +222,7 @@
-
-set_study(study_name)[source]
+set_study(study_name)[source]
This function can take just the study ID for every study except DTI. So
where possible, please give it an exact match to a project name or a
full session ID.
@@ -252,7 +252,7 @@
-
-datman.config.study_required(wrapper=None, enabled=None, adapter=None, proxy=<class 'FunctionWrapper'>)[source]
+datman.config.study_required(wrapper=None, enabled=None, adapter=None, proxy=<class 'FunctionWrapper'>)[source]
diff --git a/api/datman.dashboard.html b/api/datman.dashboard.html
index 5ba6ba64..f6f118b0 100644
--- a/api/datman.dashboard.html
+++ b/api/datman.dashboard.html
@@ -106,27 +106,27 @@
datman.dashboard module
-
-datman.dashboard.add_scan(name, tag=None, series=None, description=None, source_id=None)[source]
+datman.dashboard.add_scan(name, tag=None, series=None, description=None, source_id=None)[source]
-
-datman.dashboard.add_session(name, date=None)[source]
+datman.dashboard.add_session(name, date=None)[source]
-
-datman.dashboard.add_subject(name)[source]
+datman.dashboard.add_subject(name)[source]
-
-datman.dashboard.dashboard_required(f)[source]
+datman.dashboard.dashboard_required(f)[source]
-
-datman.dashboard.filename_required(f)[source]
+datman.dashboard.filename_required(f)[source]
This decorator checks that the wrapped function has received a datman
style file name as either a string or as a datman.scanid.Identifier
instance with kwargs tag, series, and description set.
@@ -136,22 +136,22 @@
-
-datman.dashboard.get_bids_scan(name)[source]
+datman.dashboard.get_bids_scan(name)[source]
-
-datman.dashboard.get_bids_subject(bids_name, bids_session, study=None)[source]
+datman.dashboard.get_bids_subject(bids_name, bids_session, study=None)[source]
-
-datman.dashboard.get_default_user()[source]
+datman.dashboard.get_default_user()[source]
-
-datman.dashboard.get_project(name=None, tag=None, site=None, create=False)[source]
+datman.dashboard.get_project(name=None, tag=None, site=None, create=False)[source]
Return a study from the dashboard database that either matches the
study name (e.g. ‘SPINS’) or matches a study tag (e.g. ‘SPN01’) + an
optional site code to help locate the correct study when the same code
@@ -160,17 +160,17 @@
-
-datman.dashboard.get_scan(name, tag=None, series=None, description=None, source_id=None, create=False)[source]
+datman.dashboard.get_scan(name, tag=None, series=None, description=None, source_id=None, create=False)[source]
-
-datman.dashboard.get_session(name, create=False, date=None)[source]
+datman.dashboard.get_session(name, create=False, date=None)[source]
-
-datman.dashboard.get_study_subjects(study, site=None, phantoms=False)[source]
+datman.dashboard.get_study_subjects(study, site=None, phantoms=False)[source]
Pulls a list of subjects from the dashboard from a specified study
- Parameters
@@ -188,12 +188,12 @@
-
-datman.dashboard.get_subject(name, create=False)[source]
+datman.dashboard.get_subject(name, create=False)[source]
-
-datman.dashboard.release_db(f)[source]
+datman.dashboard.release_db(f)[source]
This decorator ensures that transactions are ended after exit.
Read operations on the database open a transaction. This transaction
isnt terminated until a rollback or commit happens or until the
@@ -204,7 +204,7 @@
-
-datman.dashboard.scanid_required(f)[source]
+datman.dashboard.scanid_required(f)[source]
This decorator checks that the wrapped function’s first argument is an
instance of datman.scanid.Identifier and attempts to convert it if not.
A DashboardException will be raised if an Identifier isn’t found or can’t
@@ -213,7 +213,7 @@
-
-datman.dashboard.set_study_status(name, is_open)[source]
+datman.dashboard.set_study_status(name, is_open)[source]
diff --git a/api/datman.exceptions.html b/api/datman.exceptions.html
index 314df411..eff7aa68 100644
--- a/api/datman.exceptions.html
+++ b/api/datman.exceptions.html
@@ -107,64 +107,64 @@
Defines the exceptions used by datman sub-modules
-
-exception datman.exceptions.ConfigException[source]
+exception datman.exceptions.ConfigException[source]
Bases: Exception
-
-exception datman.exceptions.DashboardException[source]
+exception datman.exceptions.DashboardException[source]
Bases: Exception
Default exception for dashboard errors
-
-exception datman.exceptions.ExportException[source]
+exception datman.exceptions.ExportException[source]
Bases: Exception
-
-exception datman.exceptions.ExporterException[source]
+exception datman.exceptions.ExporterException[source]
Bases: Exception
Default exception for errors exporting data from raw.
-
-exception datman.exceptions.InputException[source]
+exception datman.exceptions.InputException[source]
Bases: Exception
-
-exception datman.exceptions.MetadataException[source]
+exception datman.exceptions.MetadataException[source]
Bases: Exception
-
-exception datman.exceptions.ParseException[source]
+exception datman.exceptions.ParseException[source]
Bases: Exception
For participant ID parsing issues.
-
-exception datman.exceptions.QCException[source]
+exception datman.exceptions.QCException[source]
Bases: Exception
-
-exception datman.exceptions.UndefinedSetting[source]
+exception datman.exceptions.UndefinedSetting[source]
Bases: Exception
-
-exception datman.exceptions.XnatException[source]
+exception datman.exceptions.XnatException[source]
Bases: Exception
Default exception for XNAT errors
diff --git a/api/datman.exporters.html b/api/datman.exporters.html
index d8cd2c76..d37a112a 100644
--- a/api/datman.exporters.html
+++ b/api/datman.exporters.html
@@ -114,17 +114,17 @@
unique key that can be referenced in config files (e.g. ‘nii’).
-
-class datman.exporters.BidsExporter(config, session, experiment, bids_opts=None, **kwargs)[source]
+class datman.exporters.BidsExporter(config, session, experiment, bids_opts=None, **kwargs)[source]
Bases: datman.exporters.SessionExporter
An exporter that runs dcm2bids.
-
-add_repeat_num()[source]
+add_repeat_num()[source]
-
-export(raw_data_dir, **kwargs)[source]
+export(raw_data_dir, **kwargs)[source]
Exports raw data to the current Exporter’s format.
- Parameters
@@ -136,12 +136,12 @@
-
-get_sidecars()[source]
+get_sidecars()[source]
-
-needs_raw_data()[source]
+needs_raw_data()[source]
Whether raw data must be downloaded for the Exporter.
- Returns
@@ -159,7 +159,7 @@
-
-outputs_exist()[source]
+outputs_exist()[source]
Whether outputs have already been generated for this Exporter.
- Returns
@@ -180,12 +180,12 @@
-
-class datman.exporters.DBExporter(config, session, experiment, **kwargs)[source]
+class datman.exporters.DBExporter(config, session, experiment, **kwargs)[source]
Bases: datman.exporters.SessionExporter
Add a datman-style session and its contents to datman’s QC dashboard.
-
-add_tech_notes(session)[source]
+add_tech_notes(session)[source]
Add the path to a scan session’s tech notes to the database.
- Parameters
@@ -197,12 +197,12 @@
-
-errors_outdated(scan, fname)[source]
+errors_outdated(scan, fname)[source]
-
-export(*args, **kwargs)[source]
+export(*args, **kwargs)[source]
Exports raw data to the current Exporter’s format.
- Parameters
@@ -214,7 +214,7 @@
-
-get_bids_name(dm_name, session)[source]
+get_bids_name(dm_name, session)[source]
Get BIDS style scan name from a datman style nifti.
- Returns
@@ -232,13 +232,13 @@
-
-classmethod get_output_dir(session)[source]
+classmethod get_output_dir(session)[source]
Retrieve the exporter’s output dir without needing an instance.
-
-make_scan(file_stem)[source]
+make_scan(file_stem)[source]
Add a single scan to datman’s QC dashboard.
- Parameters
@@ -249,7 +249,7 @@
-
-make_session()[source]
+make_session()[source]
Add the current session to datman’s QC database.
- Returns
@@ -282,7 +282,7 @@
-
-needs_raw_data()[source]
+needs_raw_data()[source]
Whether raw data must be downloaded for the Exporter.
- Returns
@@ -300,7 +300,7 @@
-
-outputs_exist()[source]
+outputs_exist()[source]
Whether outputs have already been generated for this Exporter.
- Returns
@@ -321,12 +321,12 @@
-
-class datman.exporters.DcmExporter(output_dir, fname_root, echo_dict=None, dry_run=False, **kwargs)[source]
+class datman.exporters.DcmExporter(output_dir, fname_root, echo_dict=None, dry_run=False, **kwargs)[source]
Bases: datman.exporters.SeriesExporter
Export a single dicom from a scan.
-
-export(raw_data_dir, **kwargs)[source]
+export(raw_data_dir, **kwargs)[source]
Exports raw data to the current Exporter’s format.
- Parameters
@@ -350,12 +350,12 @@
-
-class datman.exporters.Exporter[source]
+class datman.exporters.Exporter[source]
Bases: abc.ABC
An abstract base class for all Exporters.
-
-abstract export(raw_data_dir, **kwargs)[source]
+abstract export(raw_data_dir, **kwargs)[source]
Exports raw data to the current Exporter’s format.
- Parameters
@@ -367,13 +367,13 @@
-
-classmethod get_output_dir(session)[source]
+classmethod get_output_dir(session)[source]
Retrieve the exporter’s output dir without needing an instance.
-
-make_output_dir()[source]
+make_output_dir()[source]
Creates the directory where the Exporter’s outputs will be stored.
- Returns
@@ -387,7 +387,7 @@
-
-abstract needs_raw_data()[source]
+abstract needs_raw_data()[source]
Whether raw data must be downloaded for the Exporter.
- Returns
@@ -405,7 +405,7 @@
-
-abstract outputs_exist()[source]
+abstract outputs_exist()[source]
Whether outputs have already been generated for this Exporter.
- Returns
@@ -426,12 +426,12 @@
-
-class datman.exporters.NiiExporter(output_dir, fname_root, echo_dict=None, dry_run=False, **kwargs)[source]
+class datman.exporters.NiiExporter(output_dir, fname_root, echo_dict=None, dry_run=False, **kwargs)[source]
Bases: datman.exporters.SeriesExporter
Export a series to nifti format with datman-style names.
-
-export(raw_data_dir, **kwargs)[source]
+export(raw_data_dir, **kwargs)[source]
Exports raw data to the current Exporter’s format.
- Parameters
@@ -448,7 +448,7 @@
-
-move_file(gen_file)[source]
+move_file(gen_file)[source]
Move the temp outputs of dcm2niix to the intended output directory.
- Parameters
@@ -460,7 +460,7 @@
-
-report_issues(stem, messages)[source]
+report_issues(stem, messages)[source]
Write an error log if dcm2niix had errors during conversion.
- Parameters
@@ -482,12 +482,12 @@
-
-class datman.exporters.NiiLinkExporter(config, session, experiment, **kwargs)[source]
+class datman.exporters.NiiLinkExporter(config, session, experiment, **kwargs)[source]
Bases: datman.exporters.SessionExporter
Populates a study’s nii folder with symlinks pointing to the bids dir.
-
-belongs_to_session(nifti_path)[source]
+belongs_to_session(nifti_path)[source]
Check if a nifti belongs to this repeat or another for this session.
- Parameters
@@ -509,7 +509,7 @@
-
-clear_errors(dm_file)[source]
+clear_errors(dm_file)[source]
Remove an error file from a previous BIDs export issue.
- Parameters
@@ -520,7 +520,7 @@
-
-export(*args, **kwargs)[source]
+export(*args, **kwargs)[source]
Exports raw data to the current Exporter’s format.
- Parameters
@@ -537,7 +537,7 @@
-
-get_bids_niftis()[source]
+get_bids_niftis()[source]
Get all nifti files from a BIDS session.
- Returns
@@ -555,7 +555,7 @@
-
-get_dm_names()[source]
+get_dm_names()[source]
Get the datman-style scan names for an entire XNAT experiment.
- Returns
@@ -573,18 +573,18 @@
-
-get_error_file(dm_file)[source]
+get_error_file(dm_file)[source]
-
-classmethod get_output_dir(session)[source]
+classmethod get_output_dir(session)[source]
Retrieve the exporter’s output dir without needing an instance.
-
-get_series_num(side_car)[source]
+get_series_num(side_car)[source]
Find the correct series number for a scan.
Most JSON side car files have the correct series number already.
However, series that are split during nifti conversion (e.g.
@@ -607,7 +607,7 @@
-
-make_datman_name(bids_path, scan_tag)[source]
+make_datman_name(bids_path, scan_tag)[source]
Create a Datman-style file name for a bids file.
- Parameters
@@ -628,7 +628,7 @@
-
-make_link(dm_file, bids_file)[source]
+make_link(dm_file, bids_file)[source]
Create a symlink in the datman style that points to a bids file.
- Parameters
@@ -643,7 +643,7 @@
-
-match_dm_to_bids(dm_names, bids_names)[source]
+match_dm_to_bids(dm_names, bids_names)[source]
Match each datman file name to its BIDS equivalent.
- Parameters
@@ -671,7 +671,7 @@
-
-needs_raw_data()[source]
+needs_raw_data()[source]
Whether raw data must be downloaded for the Exporter.
- Returns
@@ -689,7 +689,7 @@
-
-outputs_exist()[source]
+outputs_exist()[source]
Whether outputs have already been generated for this Exporter.
- Returns
@@ -703,7 +703,7 @@
-
-report_errors(dm_file)[source]
+report_errors(dm_file)[source]
Create an error file to report probable BIDS conversion issues.
- Parameters
@@ -721,7 +721,7 @@
-
-class datman.exporters.SeriesExporter(output_dir, fname_root, echo_dict=None, dry_run=False, **kwargs)[source]
+class datman.exporters.SeriesExporter(output_dir, fname_root, echo_dict=None, dry_run=False, **kwargs)[source]
Bases: datman.exporters.Exporter
A base class for exporters that take a single series as input.
@@ -731,7 +731,7 @@
-
-needs_raw_data()[source]
+needs_raw_data()[source]
Whether raw data must be downloaded for the Exporter.
- Returns
@@ -749,7 +749,7 @@
-
-outputs_exist()[source]
+outputs_exist()[source]
Whether outputs have already been generated for this Exporter.
- Returns
@@ -765,7 +765,7 @@
-
-class datman.exporters.SessionExporter(config, session, experiment, dry_run=False, **kwargs)[source]
+class datman.exporters.SessionExporter(config, session, experiment, dry_run=False, **kwargs)[source]
Bases: datman.exporters.Exporter
A base class for exporters that take an entire session as input.
Subclasses should override __init__ (without changing basic input args)
@@ -776,12 +776,12 @@
-
-class datman.exporters.SharedExporter(config, session, experiment, bids_opts=None, **kwargs)[source]
+class datman.exporters.SharedExporter(config, session, experiment, bids_opts=None, **kwargs)[source]
Bases: datman.exporters.SessionExporter
Export an XNAT ‘shared’ experiment.
-
-export(*args, **kwargs)[source]
+export(*args, **kwargs)[source]
Exports raw data to the current Exporter’s format.
- Parameters
@@ -798,7 +798,7 @@
-
-find_bids_files(name_map=None)[source]
+find_bids_files(name_map=None)[source]
Find all bids files that have been created for the source session.
- Parameters
@@ -820,7 +820,7 @@
-
-find_dm_files(dir_type, name_map=None)[source]
+find_dm_files(dir_type, name_map=None)[source]
Find datman-style source files in all listed directory types.
- Parameters
@@ -847,7 +847,7 @@
-
-find_resource_files(name_map=None)[source]
+find_resource_files(name_map=None)[source]
Find all source session resources files.
- Parameters
@@ -869,7 +869,7 @@
-
-find_source_session(config, experiment)[source]
+find_source_session(config, experiment)[source]
Find the original data on the filesystem.
- Parameters
@@ -895,13 +895,13 @@
-
-classmethod get_output_dir(session)[source]
+classmethod get_output_dir(session)[source]
Retrieve the exporter’s output dir without needing an instance.
-
-make_name_map(dm_dirs, use_bids=False)[source]
+make_name_map(dm_dirs, use_bids=False)[source]
Create a dictionary of source files to their ‘shared’ alias.
- Parameters
@@ -928,7 +928,7 @@
-
-needs_raw_data()[source]
+needs_raw_data()[source]
Whether raw data must be downloaded for the Exporter.
- Returns
@@ -946,7 +946,7 @@
-
-outputs_exist()[source]
+outputs_exist()[source]
Whether outputs have already been generated for this Exporter.
- Returns
@@ -967,7 +967,7 @@
-
-datman.exporters.get_exporter(key, scope='series')[source]
+datman.exporters.get_exporter(key, scope='series')[source]
Find an exporter class for a given key identifier.
- Parameters
diff --git a/api/datman.fs_log_scraper.html b/api/datman.fs_log_scraper.html
index a9bc6cf2..b98acddb 100644
--- a/api/datman.fs_log_scraper.html
+++ b/api/datman.fs_log_scraper.html
@@ -110,63 +110,63 @@
The FSLog class aggregates/parses the most useful details from the log files.
-
-class datman.fs_log_scraper.FSLog(freesurfer_folder)[source]
+class datman.fs_log_scraper.FSLog(freesurfer_folder)[source]
Bases: object
-
-static get_args(cmd_args)[source]
+static get_args(cmd_args)[source]
-
-get_date(date_str)[source]
+get_date(date_str)[source]
-
-get_kernel(log_uname)[source]
+get_kernel(log_uname)[source]
-
-static get_niftis(cmd_args)[source]
+static get_niftis(cmd_args)[source]
-
-get_subject(subject_field)[source]
+get_subject(subject_field)[source]
-
-parse_recon_done(recon_done)[source]
+parse_recon_done(recon_done)[source]
-
-read_log(path)[source]
+read_log(path)[source]
-
-datman.fs_log_scraper.check_diff(log_field, standards_field)[source]
+datman.fs_log_scraper.check_diff(log_field, standards_field)[source]
-
-datman.fs_log_scraper.choose_standard_sub(subject_logs)[source]
+datman.fs_log_scraper.choose_standard_sub(subject_logs)[source]
-
-datman.fs_log_scraper.make_standards(standard_log)[source]
+datman.fs_log_scraper.make_standards(standard_log)[source]
-
-datman.fs_log_scraper.scrape_logs(fs_output_folders, standards=None, col_headers=False)[source]
+datman.fs_log_scraper.scrape_logs(fs_output_folders, standards=None, col_headers=False)[source]
Takes a list of paths to freesurfer output folders and generates a list of
log lines containing differences relative to a ‘standard’ subject.
A field will be left empty if no differences are found
@@ -174,7 +174,7 @@
-
-datman.fs_log_scraper.verify_standards(standards_dict, expected_keys)[source]
+datman.fs_log_scraper.verify_standards(standards_dict, expected_keys)[source]
diff --git a/api/datman.header_checks.html b/api/datman.header_checks.html
index 42337f60..ddf146ec 100644
--- a/api/datman.header_checks.html
+++ b/api/datman.header_checks.html
@@ -108,47 +108,47 @@
files.
+datman.header_checks.check_bvals(series_path, standard_path)[source]
+datman.header_checks.compare_headers(series, standard, ignore=None, tolerance=None)[source]
+datman.header_checks.construct_diffs(series_json, standard_json, ignored_fields=None, tolerances=None, dti=False)[source]
+datman.header_checks.find_bvals(json_path)[source]
-
-datman.header_checks.handle_diff(value, expected, tolerance=None)[source]
+datman.header_checks.handle_diff(value, expected, tolerance=None)[source]
+datman.header_checks.parse_file(file_path)[source]
+datman.header_checks.read_json(json_file)[source]
+datman.header_checks.remove_fields(json_contents, fields)[source]
+datman.header_checks.write_diff_log(diffs, output_path)[source]
diff --git a/api/datman.metrics.html b/api/datman.metrics.html
index c798deaa..87e2dab1 100644
--- a/api/datman.metrics.html
+++ b/api/datman.metrics.html
@@ -107,11 +107,11 @@
Classes and functions for generating QC metrics.
-
-class datman.metrics.ABCDPHAMetrics(input_nii, output_dir)[source]
+class datman.metrics.ABCDPHAMetrics(input_nii, output_dir)[source]
Bases: datman.metrics.Metric
-
-generate()[source]
+generate()[source]
@@ -123,11 +123,11 @@
-
-class datman.metrics.AnatMetrics(input_nii, output_dir)[source]
+class datman.metrics.AnatMetrics(input_nii, output_dir)[source]
Bases: datman.metrics.Metric
-
-generate(img_gap=5, width=1600)[source]
+generate(img_gap=5, width=1600)[source]
@@ -139,11 +139,11 @@
-
-class datman.metrics.AnatPHAMetrics(input_nii, output_dir)[source]
+class datman.metrics.AnatPHAMetrics(input_nii, output_dir)[source]
Bases: datman.metrics.Metric
-
-generate()[source]
+generate()[source]
@@ -155,11 +155,11 @@
-
-class datman.metrics.DTIMetrics(nii_input, output_dir, bval=None, bvec=None)[source]
+class datman.metrics.DTIMetrics(nii_input, output_dir, bval=None, bvec=None)[source]
Bases: datman.metrics.MetricDTI
-
-generate(img_gap=2, width=1600)[source]
+generate(img_gap=2, width=1600)[source]
@@ -171,11 +171,11 @@
-
-class datman.metrics.DTIPHAMetrics(nii_input, output_dir, bval=None, bvec=None)[source]
+class datman.metrics.DTIPHAMetrics(nii_input, output_dir, bval=None, bvec=None)[source]
Bases: datman.metrics.MetricDTI
-
-generate()[source]
+generate()[source]
@@ -187,11 +187,11 @@
-
-class datman.metrics.FMRIMetrics(input_nii, output_dir)[source]
+class datman.metrics.FMRIMetrics(input_nii, output_dir)[source]
Bases: datman.metrics.Metric
-
-generate(img_gap=2, width=1600)[source]
+generate(img_gap=2, width=1600)[source]
@@ -203,11 +203,11 @@
-
-class datman.metrics.FMRIPHAMetrics(input_nii, output_dir)[source]
+class datman.metrics.FMRIPHAMetrics(input_nii, output_dir)[source]
Bases: datman.metrics.Metric
-
-generate()[source]
+generate()[source]
@@ -219,16 +219,16 @@
-
-class datman.metrics.IgnoreMetrics(input_nii, output_dir)[source]
+class datman.metrics.IgnoreMetrics(input_nii, output_dir)[source]
Bases: datman.metrics.Metric
-
-exists()[source]
+exists()[source]
-
-generate()[source]
+generate()[source]
@@ -238,43 +238,43 @@
-
-write_manifest(overwrite=False)[source]
+write_manifest(overwrite=False)[source]
-
-class datman.metrics.Metric(input_nii, output_dir)[source]
+class datman.metrics.Metric(input_nii, output_dir)[source]
Bases: abc.ABC
-
-command_succeeded(command_name)[source]
+command_succeeded(command_name)[source]
-
-exists()[source]
+exists()[source]
-
-abstract generate()[source]
+abstract generate()[source]
-
-classmethod get_requirements()[source]
+classmethod get_requirements()[source]
-
-classmethod is_runnable()[source]
+classmethod is_runnable()[source]
-
-make_image(output, img_gap=2, width=1600, nii_input=None)[source]
+make_image(output, img_gap=2, width=1600, nii_input=None)[source]
Uses FSL’s slicer function to generate a png from a nifti file.
- Parameters
@@ -293,12 +293,12 @@
-
-make_manifest()[source]
+make_manifest()[source]
-
-make_montage(output)[source]
+make_montage(output)[source]
Uses FSL’s slicer function to generate a montage of three slices.
- Parameters
@@ -314,12 +314,12 @@
-
-abstract outputs()[source]
+abstract outputs()[source]
-
-read_manifest()[source]
+read_manifest()[source]
@@ -329,7 +329,7 @@
-
-run(command, output)[source]
+run(command, output)[source]
Run a command if outputs are still needed.
- Parameters
@@ -347,29 +347,29 @@
-
-set_outputs()[source]
+set_outputs()[source]
-
-write_manifest(overwrite=False)[source]
+write_manifest(overwrite=False)[source]
-
-class datman.metrics.MetricDTI(nii_input, output_dir, bval=None, bvec=None)[source]
+class datman.metrics.MetricDTI(nii_input, output_dir, bval=None, bvec=None)[source]
Bases: datman.metrics.Metric
-
-class datman.metrics.QAPHAMetrics(nii_input, output_dir, bval=None, bvec=None)[source]
+class datman.metrics.QAPHAMetrics(nii_input, output_dir, bval=None, bvec=None)[source]
Bases: datman.metrics.MetricDTI
-
-generate()[source]
+generate()[source]
@@ -379,14 +379,14 @@
-
-update_expected_outputs()[source]
+update_expected_outputs()[source]
-
-class datman.metrics.QCOutput(order: int = - 1, title: str = None, caption: str = None)[source]
+class datman.metrics.QCOutput(order: int = - 1, title: str = None, caption: str = None)[source]
Bases: object
-
@@ -407,7 +407,7 @@
-
-datman.metrics.get_handlers(subject)[source]
+datman.metrics.get_handlers(subject)[source]
Returns the set of QC functions to use for a subject.
- Parameters
diff --git a/api/datman.scan.html b/api/datman.scan.html
index 7708b90e..3ce812ed 100644
--- a/api/datman.scan.html
+++ b/api/datman.scan.html
@@ -111,7 +111,7 @@
become out of date if this is not true.
-
-class datman.scan.DatmanNamed(ident)[source]
+class datman.scan.DatmanNamed(ident)[source]
Bases: object
A parent class for all classes that will obey the datman naming scheme
@@ -123,7 +123,7 @@
-
-class datman.scan.Scan(subject_id, config, bids_root=None)[source]
+class datman.scan.Scan(subject_id, config, bids_root=None)[source]
Bases: datman.scan.DatmanNamed
Holds all information for a single scan (session).
@@ -142,17 +142,17 @@
datman naming convention
-
-find_files(file_stem, format='nii')[source]
+find_files(file_stem, format='nii')[source]
-
-get_resource_dir(session)[source]
+get_resource_dir(session)[source]
-
-get_tagged_nii(tag)[source]
+get_tagged_nii(tag)[source]
@@ -164,7 +164,7 @@
-
-class datman.scan.Series(path)[source]
+class datman.scan.Series(path)[source]
Bases: datman.scan.DatmanNamed
Holds all information about a series file of any format (e.g. nifti).
diff --git a/api/datman.scan_list.html b/api/datman.scan_list.html
index f3aab9ed..67889bbf 100644
--- a/api/datman.scan_list.html
+++ b/api/datman.scan_list.html
@@ -131,18 +131,18 @@
-
-class datman.scan_list.ScanEntryABC(scan_path)[source]
+class datman.scan_list.ScanEntryABC(scan_path)[source]
Bases: object
-
-abstract get_target_name()[source]
+abstract get_target_name()[source]
-
-datman.scan_list.generate_scan_list(scan_entry_class, zip_files, dest_dir)[source]
+datman.scan_list.generate_scan_list(scan_entry_class, zip_files, dest_dir)[source]
Use this function to generate a scans.csv file of the expected format.
- scan_entry_class: A subclass of ScanEntryABC that will be used to
generate each entry in scans.csv
@@ -154,22 +154,22 @@
-
-datman.scan_list.get_scan_list_contents(scans_csv)[source]
+datman.scan_list.get_scan_list_contents(scans_csv)[source]
-
-datman.scan_list.make_new_entries(processed_scans, zip_files, EntryClass)[source]
+datman.scan_list.make_new_entries(processed_scans, zip_files, EntryClass)[source]
-
-datman.scan_list.start_new_scan_list(output)[source]
+datman.scan_list.start_new_scan_list(output)[source]
-
-datman.scan_list.update_scans_csv(output, new_entries)[source]
+datman.scan_list.update_scans_csv(output, new_entries)[source]
diff --git a/api/datman.scanid.html b/api/datman.scanid.html
index 12a775ff..e48828a3 100644
--- a/api/datman.scanid.html
+++ b/api/datman.scanid.html
@@ -115,25 +115,25 @@
-
-class datman.scanid.BIDSFile(subject, session, suffix, task=None, acq=None, ce=None, dir=None, rec=None, run=None, echo=None, mod=None)[source]
+class datman.scanid.BIDSFile(subject, session, suffix, task=None, acq=None, ce=None, dir=None, rec=None, run=None, echo=None, mod=None)[source]
Bases: object
-
-class datman.scanid.DatmanIdentifier(identifier, settings=None)[source]
+class datman.scanid.DatmanIdentifier(identifier, settings=None)[source]
Bases: datman.scanid.Identifier
Parses a datman-style ID into fields.
The datman convention is detailed
here
-
-get_xnat_experiment_id()[source]
+get_xnat_experiment_id()[source]
-
-get_xnat_subject_id()[source]
+get_xnat_subject_id()[source]
@@ -165,60 +165,60 @@
-
-class datman.scanid.Identifier[source]
+class datman.scanid.Identifier[source]
Bases: abc.ABC
-
-get_bids_name()[source]
+get_bids_name()[source]
-
-get_full_subjectid()[source]
+get_full_subjectid()[source]
-
-get_full_subjectid_with_timepoint()[source]
+get_full_subjectid_with_timepoint()[source]
-
-get_full_subjectid_with_timepoint_session()[source]
+get_full_subjectid_with_timepoint_session()[source]
-
-abstract get_xnat_experiment_id()[source]
+abstract get_xnat_experiment_id()[source]
-
-abstract get_xnat_subject_id()[source]
+abstract get_xnat_subject_id()[source]
-
-match(identifier)[source]
+match(identifier)[source]
-
-class datman.scanid.KCNIIdentifier(identifier, settings=None)[source]
+class datman.scanid.KCNIIdentifier(identifier, settings=None)[source]
Bases: datman.scanid.Identifier
Parses a KCNI style ID into datman-style fields.
The KCNI convention is detailed
here.
-
-get_xnat_experiment_id()[source]
+get_xnat_experiment_id()[source]
-
-get_xnat_subject_id()[source]
+get_xnat_subject_id()[source]
@@ -245,7 +245,7 @@
-
-datman.scanid.get_field(match, field, settings=None)[source]
+datman.scanid.get_field(match, field, settings=None)[source]
Find the value of an ID field, allowing for user specified changes.
- Parameters
@@ -273,7 +273,7 @@
-
-datman.scanid.get_kcni_identifier(identifier, settings=None)[source]
+datman.scanid.get_kcni_identifier(identifier, settings=None)[source]
Get a KCNIIdentifier from a valid string or an identifier.
- Parameters
@@ -303,39 +303,39 @@
-
-datman.scanid.get_session_num(ident)[source]
+datman.scanid.get_session_num(ident)[source]
For those times when you always want a numeric session (including
for phantoms who are technically always session ‘1’)
-
-datman.scanid.get_subid(current_subid, settings=None)[source]
+datman.scanid.get_subid(current_subid, settings=None)[source]
-
-datman.scanid.is_phantom(identifier)[source]
+datman.scanid.is_phantom(identifier)[source]
-
-datman.scanid.is_scanid(identifier)[source]
+datman.scanid.is_scanid(identifier)[source]
-
-datman.scanid.is_scanid_with_session(identifier)[source]
+datman.scanid.is_scanid_with_session(identifier)[source]
-
-datman.scanid.make_filename(ident, tag, series, description, ext=None)[source]
+datman.scanid.make_filename(ident, tag, series, description, ext=None)[source]
-
-datman.scanid.parse(identifier, settings=None)[source]
+datman.scanid.parse(identifier, settings=None)[source]
Parse a subject ID matching a supported naming convention.
The ‘settings’ flag can be used to exclude any IDs that do not match the
specified convention, or to translate certain ID fields to maintain
@@ -397,12 +397,12 @@
-
-datman.scanid.parse_bids_filename(path)[source]
+datman.scanid.parse_bids_filename(path)[source]
-
-datman.scanid.parse_filename(path)[source]
+datman.scanid.parse_filename(path)[source]
Parse a datman style file name.
- Parameters
diff --git a/api/datman.utils.html b/api/datman.utils.html
index ce340897..1444dfe8 100644
--- a/api/datman.utils.html
+++ b/api/datman.utils.html
@@ -107,13 +107,13 @@
A collection of utilities for generally munging imaging data.
-
-class datman.utils.XNATConnection(xnat_url, user_name, password)[source]
+class datman.utils.XNATConnection(xnat_url, user_name, password)[source]
Bases: object
-
-class datman.utils.cd(path)[source]
+class datman.utils.cd(path)[source]
Bases: object
A context manager for changing directory. Since best practices dictate
returning to the original directory, saves the original directory and
@@ -124,7 +124,7 @@
-
-datman.utils.check_dependency_configured(program_name, shell_cmd=None, env_vars=None)[source]
+datman.utils.check_dependency_configured(program_name, shell_cmd=None, env_vars=None)[source]
- <program_name> Name to add to the exception message if the program is
not correctly configured.
@@ -140,12 +140,12 @@
-
-datman.utils.check_returncode(returncode)[source]
+datman.utils.check_returncode(returncode)[source]
-
-datman.utils.define_folder(path)[source]
+datman.utils.define_folder(path)[source]
Sets a variable to be the path to a folder. Also, if the folder does not
exist, this makes it so, unless we lack the permissions to do so, which
leads to a graceful exit.
@@ -153,18 +153,15 @@
-
-datman.utils.filter_niftis(candidates)[source]
+datman.utils.filter_niftis(candidates)[source]
Takes a list and returns all items that contain the extensions
‘.nii’ or ‘.nii.gz’.
-
-datman.utils.find_tech_notes(folder)[source]
-Find any technotes located within a folder.
-If only one PDF is found it is assumed to be the tech notes. If multiple
-are found, unless one contains the string ‘TechNotes’, the first pdf is
-guessed to be the tech notes.
+datman.utils.find_tech_notes(folder)[source]
+Find any technotes located within a given folder.
- Parameters
folder (