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]

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.check_bvals(series_path, standard_path)[source]
-datman.header_checks.compare_headers(series, standard, ignore=None, tolerance=None)[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.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.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.parse_file(file_path)[source]
-datman.header_checks.read_json(json_file)[source]
+datman.header_checks.read_json(json_file)[source]
-datman.header_checks.remove_fields(json_contents, fields)[source]
+datman.header_checks.remove_fields(json_contents, fields)[source]
-datman.header_checks.write_diff_log(diffs, output_path)[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 (str) – A full path to a folder to search.

@@ -184,7 +181,7 @@
-datman.utils.get_all_headers_in_folder(path, recurse=False)[source]
+datman.utils.get_all_headers_in_folder(path, recurse=False)[source]

Get DICOM headers for all files in the given path.

Returns a dictionary mapping path->headers for all files (headers == None for files that are not dicoms).

@@ -192,7 +189,7 @@
-datman.utils.get_archive_headers(path, stop_after_first=False)[source]
+datman.utils.get_archive_headers(path, stop_after_first=False)[source]

Get dicom headers from a scan archive.

Path can be a path to a tarball or zip of dicom folders, or a folder. It is assumed that this archive contains the dicoms from a single exam, organized @@ -206,7 +203,7 @@

-datman.utils.get_extension(path)[source]
+datman.utils.get_extension(path)[source]

Get the filename extension on this path.

This is a slightly more sophisticated version of os.path.splitext in that this will correctly return the extension for ‘.tar.gz’ files, for example. @@ -215,7 +212,7 @@

-datman.utils.get_files_with_tag(parentdir, tag, fuzzy=False)[source]
+datman.utils.get_files_with_tag(parentdir, tag, fuzzy=False)[source]

Returns a list of files that have the specified tag.

Filenames must conform to the datman naming convention (see scanid.parse_filename) in order to be considered.

@@ -225,13 +222,13 @@
-datman.utils.get_folder_headers(path, stop_after_first=False)[source]
+datman.utils.get_folder_headers(path, stop_after_first=False)[source]

Generate a dictionary of subfolders and dicom headers.

-datman.utils.get_loaded_modules()[source]
+datman.utils.get_loaded_modules()[source]

Returns a space separated list of loaded modules

These are modules loaded by the environment-modules system. This function just looks in the LOADEDMODULES environment variable for the list.

@@ -239,17 +236,17 @@
-datman.utils.get_relative_source(source, target)[source]
+datman.utils.get_relative_source(source, target)[source]
-datman.utils.get_resources(open_zipfile)[source]
+datman.utils.get_resources(open_zipfile)[source]
-datman.utils.get_subject_metadata(config=None, study=None, allow_partial=False)[source]
+datman.utils.get_subject_metadata(config=None, study=None, allow_partial=False)[source]

Returns all QC’d session IDs mapped to any blacklisted scans they have

This will collect and organize all checklist and blacklist data for a study. Sessions that do not have a completed checklist entry will have @@ -282,67 +279,67 @@

-datman.utils.get_tarfile_headers(path, stop_after_first=False)[source]
+datman.utils.get_tarfile_headers(path, stop_after_first=False)[source]

Get headers for dicom files within a tarball

-datman.utils.get_xnat_credentials(config, xnat_cred)[source]
+datman.utils.get_xnat_credentials(config, xnat_cred)[source]
-datman.utils.get_zipfile_headers(path, stop_after_first=False)[source]
+datman.utils.get_zipfile_headers(path, stop_after_first=False)[source]

Get headers for a dicom file within a zipfile

-datman.utils.has_permissions(path)[source]
+datman.utils.has_permissions(path)[source]

Checks for write access to submitted path.

-datman.utils.is_dicom(fileobj)[source]
+datman.utils.is_dicom(fileobj)[source]
-datman.utils.is_named_like_a_dicom(path)[source]
+datman.utils.is_named_like_a_dicom(path)[source]
-datman.utils.locate_metadata(filename, study=None, subject=None, config=None, path=None)[source]
+datman.utils.locate_metadata(filename, study=None, subject=None, config=None, path=None)[source]
-datman.utils.make_temp_directory(suffix='', prefix='tmp', path=None)[source]
+datman.utils.make_temp_directory(suffix='', prefix='tmp', path=None)[source]
-datman.utils.make_zip(source_dir, dest_zip)[source]
+datman.utils.make_zip(source_dir, dest_zip)[source]
-datman.utils.makedirs(path)[source]
+datman.utils.makedirs(path)[source]

Make the directory (including parent directories) if they don’t exist

-datman.utils.nifti_basename(fpath)[source]
+datman.utils.nifti_basename(fpath)[source]

return basename without extension (either .nii.gz or .nii)

-datman.utils.read_blacklist(study=None, scan=None, subject=None, config=None, path=None, bids_ses=None, use_bids=False)[source]
+datman.utils.read_blacklist(study=None, scan=None, subject=None, config=None, path=None, bids_ses=None, use_bids=False)[source]

This function is used to look up blacklisted scans. If the dashboard is found it ONLY checks the dashboard database. Otherwise it expects a datman style ‘blacklist’ file on the filesystem.

@@ -380,7 +377,7 @@
-datman.utils.read_checklist(study=None, subject=None, config=None, path=None, bids_id=None, bids_ses=None, use_bids=False)[source]
+datman.utils.read_checklist(study=None, subject=None, config=None, path=None, bids_id=None, bids_ses=None, use_bids=False)[source]

This function is used to look-up QC checklist entries. If the dashboard is found it will ONLY check the dashboard database, otherwise it expects a datman style ‘checklist’ file on the filesystem.

@@ -413,22 +410,22 @@
-datman.utils.read_credentials(cred_file)[source]
+datman.utils.read_credentials(cred_file)[source]
-datman.utils.read_json(path)[source]
+datman.utils.read_json(path)[source]
-datman.utils.remove_empty_files(path)[source]
+datman.utils.remove_empty_files(path)[source]
-datman.utils.run(cmd, dryrun=False, specialquote=True, verbose=True)[source]
+datman.utils.run(cmd, dryrun=False, specialquote=True, verbose=True)[source]

Runs the command in default shell, returning STDOUT and a return code. The return code uses the python convention of 0 for success, non-zero for failure

@@ -436,13 +433,13 @@
-datman.utils.run_dummy_q(list_of_names)[source]
+datman.utils.run_dummy_q(list_of_names)[source]

This holds the script until all of the queued items are done.

-datman.utils.split_path(path)[source]
+datman.utils.split_path(path)[source]

Splits a path into all the component parts, returns a list

>>> split_path('a/b/c/d.txt')
 ['a', 'b', 'c', 'd.txt']
@@ -452,14 +449,14 @@
 
 
-datman.utils.splitext(path)[source]
+datman.utils.splitext(path)[source]

Function that will remove extension, including specially-defined extensions that fool os.path.splitext

-datman.utils.submit_job(cmd, job_name, log_dir, system='other', cpu_cores=1, walltime='2:00:00', dryrun=False, partition=None, argslist='', workdir='/tmp')[source]
+datman.utils.submit_job(cmd, job_name, log_dir, system='other', cpu_cores=1, walltime='2:00:00', dryrun=False, partition=None, argslist='', workdir='/tmp')[source]

submits a job or joblist the queue depending on the system

Parameters
@@ -481,12 +478,12 @@
-datman.utils.update_blacklist(entries, study=None, config=None, path=None)[source]
+datman.utils.update_blacklist(entries, study=None, config=None, path=None)[source]
-datman.utils.update_checklist(entries, study=None, config=None, path=None)[source]
+datman.utils.update_checklist(entries, study=None, config=None, path=None)[source]

Add or update QC checklist entries.

This will preferentially update the dashboard database (ignoring any ‘checklist.csv’ files) unless the dashboard is not installed or a specific @@ -513,7 +510,7 @@

-datman.utils.validate_subject_id(subject_id, config)[source]
+datman.utils.validate_subject_id(subject_id, config)[source]

Ensures subject ID correctness based on configuration settings.

This checks that a given ID:
    @@ -551,12 +548,12 @@
    -datman.utils.write_json(path, contents)[source]
    +datman.utils.write_json(path, contents)[source]
    -datman.utils.write_metadata(lines, path, retry=3)[source]
    +datman.utils.write_metadata(lines, path, retry=3)[source]

    Repeatedly attempts to write lines to <path>. The destination file will be overwritten with <lines> so any contents you wish to preserve should be contained within the list.

    diff --git a/api/datman.xnat.html b/api/datman.xnat.html index d8e75be5..e1a90910 100644 --- a/api/datman.xnat.html +++ b/api/datman.xnat.html @@ -107,11 +107,11 @@

    Module to interact with the xnat server

    -class datman.xnat.XNATExperiment(project, subject_name, experiment_json)[source]
    +class datman.xnat.XNATExperiment(project, subject_name, experiment_json)[source]

    Bases: datman.xnat.XNATObject

    -assign_scan_names(config, ident)[source]
    +assign_scan_names(config, ident)[source]

    Assign a datman style name to each scan in this experiment.

    This will populate the XnatScan.names and XnatScan.tags fields for any scan that matches the study’s export configuration.

    @@ -129,7 +129,7 @@
    -download(xnat, dest_folder, zip_name=None)[source]
    +download(xnat, dest_folder, zip_name=None)[source]

    Download a zip file containing all data for this session. Returns the path to the new file if download is successful, raises an exception if not

    @@ -148,7 +148,7 @@
    -get_autorun_ids(xnat)[source]
    +get_autorun_ids(xnat)[source]

    Find the ID(s) of the ‘autorun.xml’ workflow

    XNAT has this obnoxious, on-by-default and seemingly impossible to disable, ‘workflow’ called AutoRun.xml. It appears to do nothing other @@ -178,13 +178,13 @@

    -get_resources(xnat_connection)[source]
    +get_resources(xnat_connection)[source]

    Returns a list of all resource URIs from this session.

    -is_shared()[source]
    +is_shared()[source]

    Detect if the experiment is shared from another XNAT Project.

    Shared sessions have identical metadata to their source sessions, the only way to tell a link apart from source data is to look for a @@ -195,17 +195,17 @@

    -class datman.xnat.XNATObject[source]
    +class datman.xnat.XNATObject[source]

    Bases: abc.ABC

    -class datman.xnat.XNATScan(experiment, scan_json)[source]
    +class datman.xnat.XNATScan(experiment, scan_json)[source]

    Bases: datman.xnat.XNATObject

    -download(xnat_conn, output_dir)[source]
    +download(xnat_conn, output_dir)[source]

    Download all dicoms for this series.

    This will download all files in the series, and if successful, set the download_dir attribute to the destination folder.

    @@ -229,50 +229,50 @@
    -is_derived()[source]
    +is_derived()[source]
    -is_multiecho()[source]
    +is_multiecho()[source]
    -is_usable(strict=False)[source]
    +is_usable(strict=False)[source]
    -raw_dicoms_exist()[source]
    +raw_dicoms_exist()[source]
    -set_datman_name(base_name, tags)[source]
    +set_datman_name(base_name, tags)[source]
    -set_tag(tag_map)[source]
    +set_tag(tag_map)[source]
    -class datman.xnat.XNATSubject(subject_json)[source]
    +class datman.xnat.XNATSubject(subject_json)[source]

    Bases: datman.xnat.XNATObject

    -datman.xnat.get_auth(username=None, file_path=None)[source]
    +datman.xnat.get_auth(username=None, file_path=None)[source]
    -datman.xnat.get_connection(config, site=None, url=None, auth=None, server_cache=None)[source]
    +datman.xnat.get_connection(config, site=None, url=None, auth=None, server_cache=None)[source]

    Create (or retrieve) a connection to an XNAT server

    Parameters
    @@ -307,19 +307,19 @@
    -datman.xnat.get_port_str(config=None, port=None)[source]
    +datman.xnat.get_port_str(config=None, port=None)[source]

    Returns a port string of the format :portnum

    Will raise KeyError if port is None and config file doesn’t define XnatPort

    -datman.xnat.get_server(config=None, url=None, port=None)[source]
    +datman.xnat.get_server(config=None, url=None, port=None)[source]
    -class datman.xnat.xnat(server, username, password)[source]
    +class datman.xnat.xnat(server, username, password)[source]

    Bases: object

    @@ -328,19 +328,19 @@
    -create_resource_folder(study, session, experiment, label)[source]
    +create_resource_folder(study, session, experiment, label)[source]

    Creates a resource subfolder and returns the xnat identifier.

    -delete_resource(project, session, experiment, resource_group_id, resource_id, retries=3)[source]
    +delete_resource(project, session, experiment, resource_group_id, resource_id, retries=3)[source]

    Delete a resource file from xnat

    -dismiss_autorun(experiment)[source]
    +dismiss_autorun(experiment)[source]

    Mark the AutoRun.xml pipeline as finished.

    AutoRun.xml gets stuck as ‘Queued’ and can cause failures at renaming and deletion. This marks the pipeline as ‘Complete’ to prevent it from @@ -355,7 +355,7 @@

    -find_project(subject_id, projects=None)[source]
    +find_project(subject_id, projects=None)[source]

    Find the project a subject belongs to.

    Parameters
    @@ -381,7 +381,7 @@
    -find_subject(project, exper_id)[source]
    +find_subject(project, exper_id)[source]

    Find the parent subject ID for an experiment.

    Parameters
    @@ -407,7 +407,7 @@
    -get_dicom(project, session, experiment, scan, filename=None, retries=3)[source]
    +get_dicom(project, session, experiment, scan, filename=None, retries=3)[source]

    Downloads a dicom file from xnat to filename If filename is not specified creates a temporary file and returns the path to that, user needs to be responsible @@ -416,7 +416,7 @@

    -get_experiment(project, subject_id, exper_id, create=False)[source]
    +get_experiment(project, subject_id, exper_id, create=False)[source]

    Get an experiment from the XNAT server.

    Parameters
    @@ -447,7 +447,7 @@
    -get_experiment_ids(project, subject='')[source]
    +get_experiment_ids(project, subject='')[source]

    Retrieve all experiment IDs belonging to an XNAT subject.

    Parameters
    @@ -471,7 +471,7 @@
    -get_projects(project='')[source]
    +get_projects(project='')[source]

    Query the XNAT server for project metadata.

    Parameters
    @@ -500,7 +500,7 @@
    -get_resource(project, session, experiment, resource_group_id, resource_id, filename=None, retries=3, zipped=True)[source]
    +get_resource(project, session, experiment, resource_group_id, resource_id, filename=None, retries=3, zipped=True)[source]

    Download a single resource from xnat to filename If filename is not specified creates a temporary file and returns the path to that, user needs to be responsible for @@ -509,7 +509,7 @@

    -get_resource_archive(project, session, experiment, resource_id, filename=None, retries=3)[source]
    +get_resource_archive(project, session, experiment, resource_id, filename=None, retries=3)[source]

    Download a resource archive from xnat to filename If filename is not specified creates a temporary file and returns the path to that, user needs to be responsible format @@ -518,20 +518,20 @@

    -get_resource_ids(study, session, experiment, folderName=None, create=True)[source]
    +get_resource_ids(study, session, experiment, folderName=None, create=True)[source]

    Return a list of resource id’s (subfolders) from an experiment

    -get_resource_list(study, session, experiment, resource_id)[source]
    +get_resource_list(study, session, experiment, resource_id)[source]

    The list of non-dicom resources associated with an experiment returns a list of dicts, mostly interested in ID and name

    -get_scan(project, subject_id, exper_id, scan_id)[source]
    +get_scan(project, subject_id, exper_id, scan_id)[source]

    Get a scan from the XNAT server.

    Parameters
    @@ -561,7 +561,7 @@
    -get_scan_ids(project, subject, experiment)[source]
    +get_scan_ids(project, subject, experiment)[source]

    Retrieve all scan IDs for an XNAT experiment.

    Parameters
    @@ -585,7 +585,7 @@
    -get_subject(project, subject_id, create=False)[source]
    +get_subject(project, subject_id, create=False)[source]

    Get a subject from the XNAT server.

    Parameters
    @@ -615,7 +615,7 @@
    -get_subject_ids(project)[source]
    +get_subject_ids(project)[source]

    Retrieve the IDs for all subjects within an XNAT project.

    Parameters
    @@ -640,7 +640,7 @@
    -make_experiment(project, subject, experiment)[source]
    +make_experiment(project, subject, experiment)[source]

    Make a new (empty) experiment on the XNAT server.

    Parameters
    @@ -658,7 +658,7 @@
    -make_subject(project, subject)[source]
    +make_subject(project, subject)[source]

    Make a new (empty) subject on the XNAT server.

    Parameters
    @@ -675,20 +675,20 @@
    -open_session()[source]
    +open_session()[source]

    Open a session with the XNAT server.

    -put_dicoms(project, subject, experiment, filename, retries=3)[source]
    +put_dicoms(project, subject, experiment, filename, retries=3)[source]

    Upload an archive of dicoms to XNAT filename: archive to upload

    -put_resource(project, subject, experiment, filename, data, folder, retries=3)[source]
    +put_resource(project, subject, experiment, filename, data, folder, retries=3)[source]

    POST a resource file to the xnat server

    Parameters
    @@ -703,7 +703,7 @@
    -rename_experiment(project, subject, old_name, new_name)[source]
    +rename_experiment(project, subject, old_name, new_name)[source]

    Change an experiment’s name on XNAT.

    Parameters
    @@ -731,7 +731,7 @@
    -rename_subject(project, old_name, new_name, rename_exp=False)[source]
    +rename_subject(project, old_name, new_name, rename_exp=False)[source]

    Change a subjects’s name on XNAT.

    Parameters
    diff --git a/searchindex.js b/searchindex.js index c4bd1082..41c89d13 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["README","api","api/datman","api/datman.config","api/datman.dashboard","api/datman.exceptions","api/datman.exporters","api/datman.fs_log_scraper","api/datman.header_checks","api/datman.metrics","api/datman.scan","api/datman.scan_list","api/datman.scanid","api/datman.utils","api/datman.xnat","changes","contributing","datman_conf","datman_files","index","installation","links","script_overview"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,sphinx:56},filenames:["README.rst","api.rst","api/datman.rst","api/datman.config.rst","api/datman.dashboard.rst","api/datman.exceptions.rst","api/datman.exporters.rst","api/datman.fs_log_scraper.rst","api/datman.header_checks.rst","api/datman.metrics.rst","api/datman.scan.rst","api/datman.scan_list.rst","api/datman.scanid.rst","api/datman.utils.rst","api/datman.xnat.rst","changes.rst","contributing.rst","datman_conf.rst","datman_files.rst","index.rst","installation.rst","links.rst","script_overview.rst"],objects:{"":[[2,0,0,"-","datman"]],"datman.config":[[3,1,1,"","TagInfo"],[3,1,1,"","config"],[3,5,1,"","study_required"]],"datman.config.TagInfo":[[3,2,1,"","get"],[3,2,1,"","keys"],[3,3,1,"","series_map"]],"datman.config.config":[[3,2,1,"","get_key"],[3,2,1,"","get_path"],[3,2,1,"","get_sites"],[3,2,1,"","get_study_base"],[3,2,1,"","get_study_tags"],[3,2,1,"","get_tags"],[3,2,1,"","get_xnat_projects"],[3,4,1,"","install_config"],[3,2,1,"","load_yaml"],[3,2,1,"","map_xnat_archive_to_project"],[3,2,1,"","set_study"],[3,4,1,"","study_config"],[3,4,1,"","study_config_file"],[3,4,1,"","study_name"],[3,4,1,"","system_config"]],"datman.dashboard":[[4,5,1,"","add_scan"],[4,5,1,"","add_session"],[4,5,1,"","add_subject"],[4,5,1,"","dashboard_required"],[4,5,1,"","filename_required"],[4,5,1,"","get_bids_scan"],[4,5,1,"","get_bids_subject"],[4,5,1,"","get_default_user"],[4,5,1,"","get_project"],[4,5,1,"","get_scan"],[4,5,1,"","get_session"],[4,5,1,"","get_study_subjects"],[4,5,1,"","get_subject"],[4,5,1,"","release_db"],[4,5,1,"","scanid_required"],[4,5,1,"","set_study_status"]],"datman.exceptions":[[5,6,1,"","ConfigException"],[5,6,1,"","DashboardException"],[5,6,1,"","ExportException"],[5,6,1,"","ExporterException"],[5,6,1,"","InputException"],[5,6,1,"","MetadataException"],[5,6,1,"","ParseException"],[5,6,1,"","QCException"],[5,6,1,"","UndefinedSetting"],[5,6,1,"","XnatException"]],"datman.exceptions.XnatException":[[5,4,1,"","message"],[5,4,1,"","session"],[5,4,1,"","study"]],"datman.exporters":[[6,1,1,"","BidsExporter"],[6,1,1,"","DBExporter"],[6,1,1,"","DcmExporter"],[6,1,1,"","Exporter"],[6,1,1,"","NiiExporter"],[6,1,1,"","NiiLinkExporter"],[6,1,1,"","SeriesExporter"],[6,1,1,"","SessionExporter"],[6,1,1,"","SharedExporter"],[6,5,1,"","get_exporter"]],"datman.exporters.BidsExporter":[[6,2,1,"","add_repeat_num"],[6,2,1,"","export"],[6,2,1,"","get_sidecars"],[6,2,1,"","needs_raw_data"],[6,2,1,"","outputs_exist"],[6,4,1,"","type"]],"datman.exporters.DBExporter":[[6,2,1,"","add_tech_notes"],[6,2,1,"","errors_outdated"],[6,2,1,"","export"],[6,2,1,"","get_bids_name"],[6,2,1,"","get_output_dir"],[6,2,1,"","make_scan"],[6,2,1,"","make_session"],[6,3,1,"","names"],[6,2,1,"","needs_raw_data"],[6,2,1,"","outputs_exist"],[6,4,1,"","type"]],"datman.exporters.DcmExporter":[[6,2,1,"","export"],[6,4,1,"","ext"],[6,4,1,"","type"]],"datman.exporters.Exporter":[[6,2,1,"","export"],[6,2,1,"","get_output_dir"],[6,2,1,"","make_output_dir"],[6,2,1,"","needs_raw_data"],[6,2,1,"","outputs_exist"],[6,4,1,"","type"]],"datman.exporters.NiiExporter":[[6,2,1,"","export"],[6,4,1,"","ext"],[6,2,1,"","move_file"],[6,2,1,"","report_issues"],[6,4,1,"","type"]],"datman.exporters.NiiLinkExporter":[[6,2,1,"","belongs_to_session"],[6,2,1,"","clear_errors"],[6,2,1,"","export"],[6,4,1,"","ext"],[6,2,1,"","get_bids_niftis"],[6,2,1,"","get_dm_names"],[6,2,1,"","get_error_file"],[6,2,1,"","get_output_dir"],[6,2,1,"","get_series_num"],[6,2,1,"","make_datman_name"],[6,2,1,"","make_link"],[6,2,1,"","match_dm_to_bids"],[6,2,1,"","needs_raw_data"],[6,2,1,"","outputs_exist"],[6,2,1,"","report_errors"],[6,4,1,"","type"]],"datman.exporters.SeriesExporter":[[6,4,1,"","ext"],[6,2,1,"","needs_raw_data"],[6,2,1,"","outputs_exist"]],"datman.exporters.SharedExporter":[[6,2,1,"","export"],[6,4,1,"","ext"],[6,2,1,"","find_bids_files"],[6,2,1,"","find_dm_files"],[6,2,1,"","find_resource_files"],[6,2,1,"","find_source_session"],[6,2,1,"","get_output_dir"],[6,2,1,"","make_name_map"],[6,2,1,"","needs_raw_data"],[6,2,1,"","outputs_exist"],[6,4,1,"","type"]],"datman.fs_log_scraper":[[7,1,1,"","FSLog"],[7,5,1,"","check_diff"],[7,5,1,"","choose_standard_sub"],[7,5,1,"","make_standards"],[7,5,1,"","scrape_logs"],[7,5,1,"","verify_standards"]],"datman.fs_log_scraper.FSLog":[[7,2,1,"","get_args"],[7,2,1,"","get_date"],[7,2,1,"","get_kernel"],[7,2,1,"","get_niftis"],[7,2,1,"","get_subject"],[7,2,1,"","parse_recon_done"],[7,2,1,"","read_log"]],"datman.header_checks":[[8,5,1,"","check_bvals"],[8,5,1,"","compare_headers"],[8,5,1,"","construct_diffs"],[8,5,1,"","find_bvals"],[8,5,1,"","handle_diff"],[8,5,1,"","parse_file"],[8,5,1,"","read_json"],[8,5,1,"","remove_fields"],[8,5,1,"","write_diff_log"]],"datman.metrics":[[9,1,1,"","ABCDPHAMetrics"],[9,1,1,"","AnatMetrics"],[9,1,1,"","AnatPHAMetrics"],[9,1,1,"","DTIMetrics"],[9,1,1,"","DTIPHAMetrics"],[9,1,1,"","FMRIMetrics"],[9,1,1,"","FMRIPHAMetrics"],[9,1,1,"","IgnoreMetrics"],[9,1,1,"","Metric"],[9,1,1,"","MetricDTI"],[9,1,1,"","QAPHAMetrics"],[9,1,1,"","QCOutput"],[9,5,1,"","get_handlers"]],"datman.metrics.ABCDPHAMetrics":[[9,2,1,"","generate"],[9,4,1,"","outputs"]],"datman.metrics.AnatMetrics":[[9,2,1,"","generate"],[9,4,1,"","outputs"]],"datman.metrics.AnatPHAMetrics":[[9,2,1,"","generate"],[9,4,1,"","outputs"]],"datman.metrics.DTIMetrics":[[9,2,1,"","generate"],[9,4,1,"","outputs"]],"datman.metrics.DTIPHAMetrics":[[9,2,1,"","generate"],[9,4,1,"","outputs"]],"datman.metrics.FMRIMetrics":[[9,2,1,"","generate"],[9,4,1,"","outputs"]],"datman.metrics.FMRIPHAMetrics":[[9,2,1,"","generate"],[9,4,1,"","outputs"]],"datman.metrics.IgnoreMetrics":[[9,2,1,"","exists"],[9,2,1,"","generate"],[9,4,1,"","outputs"],[9,2,1,"","write_manifest"]],"datman.metrics.Metric":[[9,2,1,"","command_succeeded"],[9,2,1,"","exists"],[9,2,1,"","generate"],[9,2,1,"","get_requirements"],[9,2,1,"","is_runnable"],[9,2,1,"","make_image"],[9,2,1,"","make_manifest"],[9,2,1,"","make_montage"],[9,3,1,"","manifest_path"],[9,2,1,"","outputs"],[9,2,1,"","read_manifest"],[9,4,1,"","requires"],[9,2,1,"","run"],[9,2,1,"","set_outputs"],[9,2,1,"","write_manifest"]],"datman.metrics.QAPHAMetrics":[[9,2,1,"","generate"],[9,4,1,"","outputs"],[9,2,1,"","update_expected_outputs"]],"datman.metrics.QCOutput":[[9,4,1,"","caption"],[9,4,1,"","order"],[9,4,1,"","title"]],"datman.scan":[[10,1,1,"","DatmanNamed"],[10,1,1,"","Scan"],[10,1,1,"","Series"]],"datman.scan.Scan":[[10,2,1,"","find_files"],[10,2,1,"","get_resource_dir"],[10,2,1,"","get_tagged_nii"],[10,3,1,"","niftis"]],"datman.scan_list":[[11,1,1,"","ScanEntryABC"],[11,5,1,"","generate_scan_list"],[11,5,1,"","get_scan_list_contents"],[11,5,1,"","make_new_entries"],[11,5,1,"","start_new_scan_list"],[11,5,1,"","update_scans_csv"]],"datman.scan_list.ScanEntryABC":[[11,2,1,"","get_target_name"]],"datman.scanid":[[12,1,1,"","BIDSFile"],[12,1,1,"","DatmanIdentifier"],[12,1,1,"","Identifier"],[12,1,1,"","KCNIIdentifier"],[12,5,1,"","get_field"],[12,5,1,"","get_kcni_identifier"],[12,5,1,"","get_session_num"],[12,5,1,"","get_subid"],[12,5,1,"","is_phantom"],[12,5,1,"","is_scanid"],[12,5,1,"","is_scanid_with_session"],[12,5,1,"","make_filename"],[12,5,1,"","parse"],[12,5,1,"","parse_bids_filename"],[12,5,1,"","parse_filename"]],"datman.scanid.DatmanIdentifier":[[12,2,1,"","get_xnat_experiment_id"],[12,2,1,"","get_xnat_subject_id"],[12,4,1,"","pha_pattern"],[12,4,1,"","pha_re"],[12,4,1,"","scan_pattern"],[12,4,1,"","scan_re"],[12,3,1,"","session"]],"datman.scanid.Identifier":[[12,2,1,"","get_bids_name"],[12,2,1,"","get_full_subjectid"],[12,2,1,"","get_full_subjectid_with_timepoint"],[12,2,1,"","get_full_subjectid_with_timepoint_session"],[12,2,1,"","get_xnat_experiment_id"],[12,2,1,"","get_xnat_subject_id"],[12,2,1,"","match"]],"datman.scanid.KCNIIdentifier":[[12,2,1,"","get_xnat_experiment_id"],[12,2,1,"","get_xnat_subject_id"],[12,4,1,"","pha_pattern"],[12,4,1,"","pha_re"],[12,4,1,"","scan_pattern"],[12,4,1,"","scan_re"]],"datman.utils":[[13,1,1,"","XNATConnection"],[13,1,1,"","cd"],[13,5,1,"","check_dependency_configured"],[13,5,1,"","check_returncode"],[13,5,1,"","define_folder"],[13,5,1,"","filter_niftis"],[13,5,1,"","find_tech_notes"],[13,5,1,"","get_all_headers_in_folder"],[13,5,1,"","get_archive_headers"],[13,5,1,"","get_extension"],[13,5,1,"","get_files_with_tag"],[13,5,1,"","get_folder_headers"],[13,5,1,"","get_loaded_modules"],[13,5,1,"","get_relative_source"],[13,5,1,"","get_resources"],[13,5,1,"","get_subject_metadata"],[13,5,1,"","get_tarfile_headers"],[13,5,1,"","get_xnat_credentials"],[13,5,1,"","get_zipfile_headers"],[13,5,1,"","has_permissions"],[13,5,1,"","is_dicom"],[13,5,1,"","is_named_like_a_dicom"],[13,5,1,"","locate_metadata"],[13,5,1,"","make_temp_directory"],[13,5,1,"","make_zip"],[13,5,1,"","makedirs"],[13,5,1,"","nifti_basename"],[13,5,1,"","read_blacklist"],[13,5,1,"","read_checklist"],[13,5,1,"","read_credentials"],[13,5,1,"","read_json"],[13,5,1,"","remove_empty_files"],[13,5,1,"","run"],[13,5,1,"","run_dummy_q"],[13,5,1,"","split_path"],[13,5,1,"","splitext"],[13,5,1,"","submit_job"],[13,5,1,"","update_blacklist"],[13,5,1,"","update_checklist"],[13,5,1,"","validate_subject_id"],[13,5,1,"","write_json"],[13,5,1,"","write_metadata"]],"datman.xnat":[[14,1,1,"","XNATExperiment"],[14,1,1,"","XNATObject"],[14,1,1,"","XNATScan"],[14,1,1,"","XNATSubject"],[14,5,1,"","get_auth"],[14,5,1,"","get_connection"],[14,5,1,"","get_port_str"],[14,5,1,"","get_server"],[14,1,1,"","xnat"]],"datman.xnat.XNATExperiment":[[14,2,1,"","assign_scan_names"],[14,2,1,"","download"],[14,2,1,"","get_autorun_ids"],[14,2,1,"","get_resources"],[14,2,1,"","is_shared"]],"datman.xnat.XNATScan":[[14,2,1,"","download"],[14,2,1,"","is_derived"],[14,2,1,"","is_multiecho"],[14,2,1,"","is_usable"],[14,2,1,"","raw_dicoms_exist"],[14,2,1,"","set_datman_name"],[14,2,1,"","set_tag"]],"datman.xnat.xnat":[[14,4,1,"","auth"],[14,2,1,"","create_resource_folder"],[14,2,1,"","delete_resource"],[14,2,1,"","dismiss_autorun"],[14,2,1,"","find_project"],[14,2,1,"","find_subject"],[14,2,1,"","get_dicom"],[14,2,1,"","get_experiment"],[14,2,1,"","get_experiment_ids"],[14,2,1,"","get_projects"],[14,2,1,"","get_resource"],[14,2,1,"","get_resource_archive"],[14,2,1,"","get_resource_ids"],[14,2,1,"","get_resource_list"],[14,2,1,"","get_scan"],[14,2,1,"","get_scan_ids"],[14,2,1,"","get_subject"],[14,2,1,"","get_subject_ids"],[14,4,1,"","headers"],[14,2,1,"","make_experiment"],[14,2,1,"","make_subject"],[14,2,1,"","open_session"],[14,2,1,"","put_dicoms"],[14,2,1,"","put_resource"],[14,2,1,"","rename_experiment"],[14,2,1,"","rename_subject"],[14,4,1,"","server"],[14,4,1,"","session"]],datman:[[3,0,0,"-","config"],[4,0,0,"-","dashboard"],[5,0,0,"-","exceptions"],[6,0,0,"-","exporters"],[7,0,0,"-","fs_log_scraper"],[8,0,0,"-","header_checks"],[9,0,0,"-","metrics"],[10,0,0,"-","scan"],[11,0,0,"-","scan_list"],[12,0,0,"-","scanid"],[13,0,0,"-","utils"],[14,0,0,"-","xnat"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","property","Python property"],"4":["py","attribute","Python attribute"],"5":["py","function","Python function"],"6":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:property","4":"py:attribute","5":"py:function","6":"py:exception"},terms:{"0":[0,12,13,15,17,19,22],"00":13,"005":17,"02":15,"0rc1":15,"1":[0,9,12,13,14,15,17,19],"10":22,"1000":17,"11":15,"111":17,"1111":17,"112":17,"1600":9,"16649196":[0,19],"1_snr_adc":9,"2":[0,9,12,13,14,15,17,19],"2006":[0,19],"2011":[0,19],"2014":22,"2019":15,"2020":15,"212":[0,19],"212_spectra":[0,19],"22":17,"222":17,"23":[0,19],"245":15,"247":15,"248":15,"250":15,"251":15,"252":15,"2_b0distortionratio":9,"3":[0,9,12,13,14,15,17,19],"333":17,"3_eddycurrentdistort":9,"4":[9,12],"443":17,"444":17,"4_avenyqratio":9,"5":[0,9,19,22],"59":[0,19],"5_favalu":9,"6":[0,9,12,19],"60dir":17,"7":9,"777":17,"8":[9,12],"9":[9,12,17],"999":17,"abstract":[6,9,11,12],"boolean":[6,17],"break":16,"case":[3,12,16,17],"class":[1,3,6,7,9,10,11,12,13,14],"default":[3,5,6,9,12,13,14,17,18],"do":[12,13,14,18],"export":[1,2,5,14,17,18,20],"function":[0,1,3,4,6,8,9,11,12,13,17,19],"import":[17,19,22],"int":[9,12],"long":4,"new":[6,14,16,17,19],"return":[3,4,6,9,11,12,13,14],"short":[0,6,17,19],"static":7,"super":[6,11],"switch":[3,13],"true":[6,10,13,14,17],"try":[16,17,18],"var":[13,17],"while":[4,12,14],A:[0,4,6,7,9,10,11,12,13,14,17,18,19],And:17,As:[3,12,17],At:17,By:[3,18],For:[0,5,12,17,18,19],If:[3,6,9,10,12,13,14,16,17,20],In:17,It:[0,13,14,17,18,19],NOT:[14,18],OR:13,On:20,One:[3,17],Or:17,That:[11,18],The:[0,3,6,7,9,10,11,12,13,14,17,18,19,20,22],These:[0,3,13,17,19,20,22],To:[0,6,11,17,19,20],Will:[13,14],_:12,__init__:[3,6,11],_b0:9,_bad_fd:[0,19],_corr:[0,9,19],_direct:9,_fd:[0,9,19],_imag:9,_montag:9,_plot:9,_qascripts_bold:[0,9,19],_qascripts_dti:[0,9,19],_raw:9,_scanlength:[0,9,19],_se:12,_sfnr:[0,9,19],_spectra:[0,9,19],_spikecount:9,_stat:[0,9,19],aa:18,abc:[6,9,12,14,17],abcd:[9,17],abcd_dmri:17,abcd_fmri:17,abcdphametr:9,abl:17,about:[7,10,13,18],abov:[0,17,19],absolut:[0,3,10,14,19],accept:[12,13,16,17],access:[10,13,14,17,20],accident:13,accur:6,accuraci:6,acq:[12,18],acquisit:[0,12,17,19],acquisitiontim:17,across:[0,19],act:17,action:14,activ:[0,19],actual:[6,16],ad:[14,16,18],adapt:3,add:[0,6,13,16,18,19,20],add_repeat_num:6,add_scan:4,add_sess:4,add_subject:4,add_tech_not:6,addit:[3,13,16,18,20,22],address:17,adni:[0,9,19],afni:[20,22],after:[4,10,13,16],again:17,against:17,aggreg:7,al:[0,19],alia:6,alias:6,all:[0,3,6,10,12,13,14,15,16,17,19,20,22],alloc:13,allow:[3,6,12,17],allow_parti:13,alphanumer:12,alreadi:[6,11,14,17],also:[0,6,13,14,17,19,20],alwai:12,an:[0,3,4,6,12,13,14,16,17,18,19,22],anaconda:[0,19],analysi:[0,19],analyt:[0,19],anat:[17,18],anatmetr:9,anatphametr:9,ani:[6,7,9,10,12,13,14,16,17,18,20,22],anoth:[6,12,14,17],anotherxnat:17,anyon:16,anyth:17,ap:[6,18],apart:14,api:[14,17,19],appear:[14,18],appli:[4,6,12,14,16,17,18,22],applic:19,ar:[0,4,6,7,9,12,13,14,16,17,18,19,20,22],archiv:[0,3,13,14,17,19],aren:16,arg:6,argslist:13,argument:[4,6,13],aris:[0,19],arm1:17,arm2:17,arm3:17,artifact:[0,19],asid:12,assess:[0,19],asset:[0,17,19,20],assign:[14,17],assign_scan_nam:14,associ:14,assum:[10,13,17],assur:[0,19],attempt:[4,13,14,16],attend:17,attribut:[6,10,14],auth:14,authent:22,autom:16,automat:[0,19],autorun:14,avail:[17,20],averag:[0,19],b0:[0,9,19],b0distort:9,b0fieldsourc:18,b:13,back:[13,17],bad:[0,19],base:[3,5,6,7,9,10,11,12,13,14,17,22],base_nam:14,basenam:13,basic:6,becaus:[14,17],becom:[0,10,17,19],been:[3,6,9,13,17,18,20,22],befor:[13,14,16,17,18],begin:17,behav:17,behavior:14,being:[0,13,17,19],belong:[6,10,13,14,17,18,22],belongs_to_sess:6,below:[12,16,17,20],benefit:17,best:13,between:[0,3,7,9,17,19],bewar:14,bid:[6,10,12,13,17,18,22],bids_fil:6,bids_id:13,bids_nam:[4,6],bids_opt:6,bids_path:6,bids_root:10,bids_s:13,bids_sess:4,bidsexport:6,bidsfil:12,bidsifi:17,bin:[20,22],blacklist:[13,19,22],blacklistdel:[17,22],block:[13,17,20],bold:[0,9,19],bool:[6,13,14],both:3,boxx:17,brain:[0,19],bravo:17,bug:[15,16],builder:16,bval:9,bvec:9,bytestr:15,c:13,ca:17,cach:14,calcul:[0,19],call:[6,11,12,14],camelcas:17,can:[3,4,6,11,12,13,14,16,17,18,20,22],candid:13,cannot:6,capit:17,caption:9,car:[6,17],care:13,caus:[12,13,14,17],cb:18,cd:[0,13,19,20],ce:12,centralslic:9,certain:[10,12,14],chanc:16,chang:[6,10,12,13,14,15,16,17],changelog:16,charact:[12,17],chavez:[0,19],check:[4,6,13,14,16],check_bval:8,check_dependency_configur:13,check_diff:7,check_returncod:13,checklist:[13,15,17,19,22],choose_standard_sub:7,chronolog:[0,19],circumv:13,classmethod:[6,9],clean:14,clear_error:6,clevi:17,clock:13,clone:[0,19,20],cmd:13,cmd_arg:7,cmh:17,cmt:17,code:[4,11,12,13,15,16,17],col_head:7,collect:[0,13,17,19],colon:16,column:18,com:[0,17,19,20],come:16,comma:[13,18],command:[9,13,16,20],command_nam:9,command_succeed:9,comment:[13,17,18],comment_field:17,commit:4,common:16,compar:[8,17],compare_head:8,comparison:17,compil:12,complet:[0,4,6,13,14,16,17,19,22],complianc:16,complic:17,compon:13,comput:3,conda:[0,19],conf_dir:20,config:[1,2,6,10,13,14,17,18,20,22],config_templ:17,configdir:[17,20],configexcept:5,configur:[3,10,13,14,18,19,20,22],conflict:3,conform:[12,13,14],connect:[0,4,14,17,19],consequ:14,consid:[3,13],consist:[12,17],construct:17,construct_diff:8,consult:14,contact:17,contain:[6,7,11,12,13,14,17,18,19],content:[6,10,13,17,22],context:[13,17],continu:16,contribut:19,control:18,convent:[10,12,13,14,17,22],convers:[6,15],convert:[4,12,17,22],copi:[17,20],core:[13,17],correct:[0,4,6,11,13,17,18,19],correctli:[13,16,17,18,20,22],correl:[0,9,19],correspond:12,corrupt:[0,19],could:[0,19],count:17,cpu_cor:13,creat:[0,4,6,10,11,12,14,17,19,20],create_resource_fold:14,creation:14,cred_fil:13,credenti:20,criteria:[4,18],csv:[0,9,11,13,17,19,22],current:[3,6,10,13,14,17,18,20],current_subid:12,customlabel:18,cut:[0,19],d:[0,13,19],dashboard:[1,2,5,6,13,17,18,22],dashboard_requir:4,dashboardexcept:[4,5],data:[0,5,6,10,13,14,17,18,19,20,22],data_dir:20,databas:[0,4,6,13,18,19,22],dataset:6,datatyp:[0,18,19],date:[4,10,17],date_field:17,date_str:7,datman:[1,17,18,20,22],datman_asset:[0,19],datman_id:11,datman_log:17,datmanassetsdir:[17,20],datmanidentifi:12,datmannam:10,datmanprojectsdir:[17,20],db:6,dbexport:6,dcm2bid:[6,17,19,22],dcm2niix:[6,20,22],dcm:[6,17],dcmdump:18,dcmexport:6,decemb:15,decod:15,decor:4,decorrel:[0,19],def:11,defaults_onli:3,defin:[0,3,5,6,9,11,13,14,17,19,22],define_fold:13,definit:[0,17,19],delet:[13,14,17,22],delete_resourc:14,dep:16,depend:[0,6,13,16,17,19,20,22],deposit:[14,22],deprec:15,deriv:11,describ:[12,17,18,20],descript:[0,4,12,13,17,18,19,22],design:[0,19],dest_dir:11,dest_fold:14,dest_zip:13,destin:[11,13,14],detail:[7,12,13,17],detect:[14,17,20],determin:17,deviat:[0,19],dicom:[0,6,11,12,13,14,17,18,19,22],dicom_patientname1:18,dicom_patientnamen:18,dicom_studyid1:18,dicom_studyidn:18,dict:[6,9,12,13,14],dictat:13,dictionari:[3,6,9,12,13,14,17],diff:8,differ:[0,3,6,7,14,17,19,22],differenti:3,diffimg:9,diffmask:9,dir:[6,12,13],dir_typ:6,direct:[0,9,19],directli:[13,20],directori:[3,6,10,11,13,17,20,22],disabl:14,discov:[3,6],discuss:22,dismiss:14,dismiss_autorun:14,displac:[0,19],displai:22,distinguish:[0,17,19],dm_blacklist_rm:[17,18,19],dm_config:[3,20],dm_dir:6,dm_file:6,dm_link:[15,18,19],dm_link_shared_id:[17,18,19],dm_log_serv:17,dm_name:6,dm_parse_ea:17,dm_parse_fac:19,dm_parse_gngo:17,dm_parse_nback:17,dm_qc_report:[17,19,20],dm_redcap_scan_complet:[17,19,20],dm_sftp:[17,19,20],dm_system:[3,13,17,20],dm_task_fil:[15,17,19],dm_xnat_extract:[17,18,19,20],dm_xnat_upload:[17,19],doc:16,docker:19,document:[16,18,22],doe:[0,6,10,12,13,14,17,19,20],doesn:[0,13,14,17,19],doesnt:[12,13,14,17],domain:17,don:[0,4,13,19,20],done:13,dont:13,download:[6,14,17,22],download_dir:14,downstream:13,drift:[0,19],drift_bx:[0,19],driftperc:[0,19],drop:13,dry_run:6,dryrun:13,dti01:12,dti15t:3,dti3t:3,dti60:17,dti:[0,3,8,9,12,17,19],dti_fieldmap:18,dtimetr:9,dtiphametr:9,due:20,dure:[0,6,17,19],dwi_dir:18,e:[3,4,6,10,12,13,16,17,20],each:[0,6,11,13,14,17,18,19],easi:10,echo:[12,17],echo_dict:6,echonumb:17,echotim:17,edat2:17,eddycurrentdist:9,either:[3,4,13,17],els:6,elsewher:17,empti:[6,7,13,14],enabl:3,encod:[0,19],end:[4,6,17],enh:16,enough:11,ensur:[4,6,12,13,16],enter:18,entir:[6,13],entri:[6,11,13,14,17,18],entryclass:11,env:[0,17,19],env_var:13,environ:[0,3,13,14,17,19,20,22],environmenterror:13,ep2d:17,epi:18,eprim:22,equival:6,error:[5,6],errors_outd:6,et:[0,19],etc:[0,13,17,19],even:[13,14],event:17,everi:[3,17],exact:[3,9],exactli:17,exam:[0,13,19],exampl:[0,11,12,13,19],examplescanentri:11,except:[1,2,3,13,14,17],excerpt:17,exclam:16,exclud:12,exist:[0,3,6,9,13,14,16,17,18,19],exit:[4,13],expect:[3,4,6,7,8,9,11,13,17],expected_kei:7,exper_id:14,experi:[6,14],experienc:14,experiment_json:14,export_set:3,exporterexcept:5,exportexcept:5,exportinfo:[3,22],exportset:3,express:17,ext:[6,12],extens:[6,13,17,18],extern:[19,22],extract:3,f:4,face:22,fail:[13,14],failur:[13,14],fals:[3,4,6,7,8,9,13,14,17],fbirn:[0,9,19],fbrin:[0,19],fd:[0,19],feat:16,featur:[16,17],fewer:17,field:[3,7,8,11,12,13,14,17],file:[0,3,4,6,7,8,9,10,11,12,13,14,16,19,20,22],file_path:[8,14],file_stem:[6,10],filenam:[3,13,14],filename_requir:4,fileobj:13,filesystem:[6,13],fill:17,filter:4,filter_nifti:13,find:[6,12,13,14,16,17,18,22],find_bids_fil:6,find_bval:8,find_dm_fil:6,find_fil:10,find_project:14,find_resource_fil:6,find_source_sess:6,find_subject:14,find_tech_not:13,findabl:13,finish:[14,18],first:[3,4,13,14,15,17,18],fit:17,fix:[15,16],flag:[12,13,20],flair:18,flake8:16,fluctuat:[0,19],fmap:[6,17,18],fmri:[0,9,17,19],fmri_fieldmap:18,fmrimetr:9,fmriphametr:9,fname:6,fname_root:6,folder:[0,3,6,7,13,14,16,17,18,19,20,22],foldernam:14,follow:[0,16,17,19],fool:13,form:17,format:[6,10,11,12,13,14,16,17,18,22],found:[3,4,6,7,13,14,17,22],fpath:13,framewis:[0,19],freeform:17,freesurf:7,freesurfer_fold:7,friedman:[0,19],from:[0,3,4,5,6,7,9,10,12,13,14,15,16,17,18,19,20,22],fs_log_scrap:[1,2],fs_output_fold:7,fsl:[9,20,22],fslog:7,ftp:22,ftpport:17,ftpserver:17,full:[3,6,9,12,13,14,17,20],fulli:[13,17],fullnam:17,functionwrapp:3,further:[0,19],fuzzi:13,g:[3,4,6,10,12,17,20],gap:9,gen_fil:6,gener:[0,6,7,9,11,13,17,18,19,20,22],generate_scan_list:11,get:[3,4,6,12,13,14,17,18],get_all_headers_in_fold:13,get_archive_head:13,get_arg:7,get_auth:14,get_autorun_id:14,get_bids_nam:[6,12],get_bids_nifti:6,get_bids_scan:4,get_bids_subject:4,get_connect:14,get_dat:7,get_default_us:4,get_dicom:14,get_dm_nam:6,get_error_fil:6,get_experi:14,get_experiment_id:14,get_export:6,get_extens:13,get_field:12,get_files_with_tag:13,get_folder_head:13,get_full_subjectid:12,get_full_subjectid_with_timepoint:12,get_full_subjectid_with_timepoint_sess:12,get_handl:9,get_kcni_identifi:12,get_kei:3,get_kernel:7,get_loaded_modul:13,get_nifti:7,get_output_dir:6,get_path:3,get_port_str:14,get_project:[4,14],get_relative_sourc:13,get_requir:9,get_resourc:[13,14],get_resource_arch:14,get_resource_dir:10,get_resource_id:14,get_resource_list:14,get_scan:[4,14],get_scan_id:14,get_scan_list_cont:11,get_series_num:6,get_serv:14,get_sess:4,get_session_num:12,get_sidecar:6,get_sit:3,get_study_bas:3,get_study_subject:4,get_study_tag:3,get_subid:12,get_subject:[4,7,14],get_subject_id:14,get_subject_metadata:13,get_tag:3,get_tagged_nii:10,get_tarfile_head:13,get_target_nam:11,get_xnat_credenti:13,get_xnat_experiment_id:12,get_xnat_project:3,get_xnat_subject_id:12,get_zipfile_head:13,git:[0,19,20],github:[0,15,19,20],give:[3,14,16,17],given:[3,4,6,9,10,12,13,14,17],global:[0,17,19],global_corr:[0,19],glossari:19,gmean:[0,19],gmean_bx:[0,19],go:[13,17,18],goe:[11,17,18],gold:[8,22],good:[0,19],gov:[0,19],grab:14,grace:13,grappa:17,greatli:14,group:12,guarante:22,guess:13,gui:14,guidelin:16,gz:[0,6,9,13,19],ha:[3,4,13,14,17,18],had:[6,18],hand:17,handle_diff:8,happen:4,has_permiss:13,have:[0,6,13,14,17,18,19,20,22],haven:9,head:[0,19],header:[0,8,11,12,13,14,17,18,19],header_check:[1,2],headerfield:17,headerfieldtoler:17,help:[4,16,17,18],here:[0,11,12,16,17,18,19,20,22],higher:[0,19],hold:[10,13,17,18,20],home:17,how:[12,17,22],howev:[6,17],html:[0,18,19],http:[0,17,19,20],httperror:14,human:[0,17,19],i:[3,13,16,17],id:[3,4,5,6,10,11,12,13,14,17,18,20],ident:[10,12,14,17],identif:12,identifi:[0,3,4,6,10,12,13,14,17,18,19],idl:4,idmap:22,idtyp:12,ignor:[8,13,16,17,22],ignore_default:3,ignored_field:8,ignoreheaderfield:17,ignoremetr:9,imag:[0,9,13,17,19],imagetyp:17,img_gap:9,implement:6,imposs:14,includ:[6,12,13,17,18,20],incorrect:13,index:19,indic:[13,16,17,18],info:[12,17,18],inform:[0,1,4,7,10,11,18,19],init:6,initi:[13,17,18],input:[6,9],input_nii:9,inputexcept:5,insert:9,insid:[16,17],instal:[0,3,13,16,17,18,19,22],install_config:3,instanc:[0,3,4,6,10,11,12,13,14,19],instantan:[0,19],instead:[6,13,15,17,18,20],instrument:17,integ:17,integr:[13,17,20],intend:[6,11],intended_name1:18,intended_namen:18,intens:[0,19],intensitii:[0,19],interact:[14,17,20],interchang:14,interest:[13,14],interf:14,interfac:19,introduc:16,ip:17,is_complet:17,is_deriv:14,is_dicom:13,is_multiecho:14,is_named_like_a_dicom:13,is_open:4,is_phantom:12,is_runn:9,is_scanid:12,is_scanid_with_sess:12,is_shar:14,is_us:14,isn:[4,6],isnt:[4,13],isopen:17,issu:[5,6,16,20],item:13,its:[6,12,14,17],itself:[3,17],j:[0,18,19],januari:15,job:[13,17],job_nam:13,joblist:13,join:3,jonathan:[0,19],jpg:9,json:[6,8,17,19],json_cont:8,json_fil:8,json_path:8,just:[3,13,15,17,20],kcni:[12,17],kcniidentifi:12,keep:17,kei:[3,6,12,17],kept:17,keyerror:14,keyword:[0,19],kind:[0,19],kit:22,know:[0,19],known_host:22,kwarg:[4,6],l:[0,19],label:[14,17],lack:13,larg:[0,6,19,20],last:17,launch:14,lead:13,least:[3,17],left:[7,17],less:17,letter:17,level:[0,2,17,19],librari:[0,11,19],licens:20,like:[14,16,17,18],limit:17,line:[7,13,17,18,20],linear:[0,19],link:[0,14,17,19,22],linux:20,list:[4,6,7,11,13,14,16,17,18,20],list_of_nam:13,listen:17,liter:17,ll:20,load:13,load_yaml:3,loadedmodul:13,local:[3,17,20],locat:[3,4,13,14,17,18],locate_metadata:13,log:[6,7,13,16,22],log_dir:13,log_field:7,log_unam:7,logserv:17,logserverdir:17,longer:16,look:[0,13,14,16,19],low:[0,19],lowest:[0,19],machin:17,made:14,mag1:17,mag2:17,magn:[0,19],magphan_adni_manu:[0,19],mai:[6,10,13,16,17,18,22],main:[3,17,20],main_config:[17,20],maintain:12,major:[0,19],make:[6,10,11,13,14,20,22],make_datman_nam:6,make_experi:14,make_filenam:12,make_imag:9,make_link:6,make_manifest:9,make_montag:9,make_name_map:6,make_new_entri:11,make_output_dir:6,make_scan:6,make_sess:6,make_standard:7,make_subject:14,make_temp_directori:13,make_zip:13,makedir:13,manag:[0,11,12,13,17,19,20],mangl:[12,13,17],mani:17,manifest_path:9,manufacturersmodelnam:17,map:[3,6,9,12,13,14,17],map_xnat_archive_to_project:3,mark:[14,16],maskcentralslic:9,match:[0,3,4,6,10,12,13,14,17,19],match_dm_to_bid:6,matlab:[20,22],matlabpath:[0,19],maxabsrm:[0,19],maxim:16,maximum:[0,19],maxrelrm:[0,19],mean:[0,17,19],mean_fd:[0,19],mean_sfnr:[0,19],meanabsrm:[0,19],meanrelrm:[0,19],meant:[14,17],measur:[0,19],measures:[0,19],mem:13,merg:3,messag:[5,6,13,17],meta:[17,18,22],metadata:[14,18],metadata_path:11,metadataexcept:[5,13],method:[1,6,12,17],metric:[0,1,2,17,19,22],metricdti:9,might:12,minc:22,mind:17,minu:[6,18],miss:6,mm:[0,19],mnc:17,mod:12,modal:[0,12,19],modalitylabel:18,model:6,modifi:[6,12,14,15,17],modul:[1,2,19],montag:9,more:[0,12,13,14,16,17,18,19],most:[0,3,6,7,17,19],mostli:14,motion:[0,19],mount:17,move:6,move_fil:6,mr:12,mrfolder:17,mrftppass:17,mri:[0,17,19],mruser:17,multicent:[0,19],multipl:[3,4,12,13,17,18],mung:13,must:[6,9,13,17,18,22],my_instru:17,my_zip_list:11,myftppass:17,myproject:17,myredcapserv:17,myriad:[0,19],myscan:17,mysftp:17,mystudi:17,mystudy_ut1:17,mysystem:17,mytoken:17,myuser:17,myxnat:17,n_bad_fd:[0,19],name:[0,3,4,6,9,10,11,12,13,14,17,18,19,20,22],name_map:6,nativ:12,nb0:[0,19],ncbi:[0,19],nd:17,ndir:[0,19],necessari:16,need:[0,6,9,14,16,17,19,20],needs_raw_data:6,network:[0,19],neuroimag:[0,19],new_entri:11,new_nam:14,newer:22,next:17,nf:17,nibabel:[0,19],nicknam:13,nifti:[0,6,8,9,10,17,18,19],nifti_basenam:13,nifti_path:6,nightli:17,nih:[0,19],nii:[0,6,9,10,13,17,18,19,22],nii_input:9,nii_link:6,niiexport:6,niilinkexport:6,nlm:[0,19],nois:[0,19],non:[12,13,14,17],none:[3,4,5,6,7,8,9,10,12,13,14,22],norm:17,note:[6,13,14,17,18,20,22],noth:14,nrrd:[17,22],num:12,number:[0,6,12,13,17,19],numer:[12,17],nyquistratio:9,obei:10,object:[3,6,7,9,10,11,12,13,14],obnoxi:14,obtain:[0,19],obvious:14,off:[0,13,19],offici:18,often:17,old:[16,17],old_nam:14,omit:[16,17],ommit:13,onc:[17,20],one:[0,6,12,13,14,16,17,18,19],ones:[0,15,19],onli:[0,3,13,14,17,19,22],onto:3,open:[4,14,16],open_sess:14,open_zipfil:13,oper:4,option:[4,6,9,10,12,13,14,16,18,20,22],order:[9,13],organ:[6,13,14,17],orig_id:12,orig_zip_name1:18,orig_zip_namen:18,origin:[6,12,13,17,22],os:[3,13],oserror:13,other:[0,6,12,13,14,16,17,19,20],otherwis:[6,13,14,17],otherxnat:17,our:[0,16,17,18,19],out:[10,17,20],outcount:[0,19],outcount_bx:[0,19],outlier:[0,19],outmax:[0,19],outmax_bx:[0,19],outmean_bx:[0,19],outmin:[0,19],output:[6,7,9,11,13,14,17,20],output_dir:[6,9,14],output_path:8,outputs_exist:6,outsid:17,over:[0,19],overrid:[3,6,10,19,22],overridden:[3,17],overwrit:[0,9,19],overwritten:13,own:[14,17,18,20],p:[12,17],pa:[6,18],packag:[0,1,16,19],page:[17,18,19,22],pair:17,par:9,par_id:17,paramet:[4,6,7,9,10,12,13,14,17],parent:[10,13,14,17],parentdir:13,pars:[0,5,7,12,13,14,19],parse_bids_filenam:12,parse_fil:8,parse_filenam:[12,13],parse_recon_don:7,parseexcept:[5,10,12,13],part:[3,13,17],partial:13,particip:[5,22],particular:6,partit:13,pass:[11,13,16,18],password:[13,14,17,20,22],path:[3,6,7,9,10,12,13,14,16,20,22],path_typ:3,patientnam:[11,18],pattern:3,pdf:[0,13,19],peopl:16,pep8:[15,16],pepolar_dwi_fmap:18,pepolar_rest_fmap:18,per:[0,17,19],perform:[0,18,19],permiss:13,person:13,pha:12,pha_:12,pha_pattern:12,pha_r:12,pha_typ:12,phantom:[0,4,12,17,19],phantomlab:[0,19],phaseencodingdirect:18,pip:[16,20],pipelin:[0,13,14,17,18,19],pixel:9,place:[0,17,19],plain:17,plan:20,pleas:[0,3,16,19],plot:9,png:9,pngappend:9,point:[0,6,17,19,22],popul:[6,14,18],port:[14,17],portion:[12,17],portnum:14,possibl:[3,6,16],post:14,power:[0,19],pr:16,practic:[0,13,19],pre:[0,17,18,19],prearchiv:[0,19],prefer:17,preferenti:13,prefix:[0,13,16,19,22],present:17,preserv:[13,17],prevent:[14,17],previou:6,previous:6,primari:[0,19],primarycontact:17,probabl:6,problem:[0,19],process:[0,13,18,19],processed_scan:11,produc:14,program:[13,19],program_nam:13,project:[0,3,14,19],projectdir:17,properti:[3,6,9,10,12],protocol:[0,19],provid:[13,17,20],proxi:3,pubm:[0,19],pull:[4,15,16,17],push:22,put:[13,22],put_dicom:14,put_resourc:14,py:[0,3,15,17,18,19,20],pylint:16,pyproject:16,pytest:16,python3:15,python:[0,13,15,17,19],pythonpath:[0,19],qa:[0,9,19],qa_dti:17,qaphametr:9,qascript:[0,19],qc:[0,6,9,13,17,18,19,22],qc_:[0,19],qc_study_cmh_0000_01:18,qc_study_cmh_0001_01:18,qcexcept:[5,9],qcing:[0,19],qcmon:[0,19,20],qcoutput:9,qcpha:17,qctype:17,qualifi:17,qualiti:18,queri:[14,17],queu:[13,14],queue:[13,17],r2014a:22,ra:17,radiu:[0,19],rais:[3,4,9,10,12,13,14],ran:20,rather:[0,19,20],ratio:[0,19],raw:[0,5,6,17,18,19,22],raw_data_dir:6,raw_dicoms_exist:14,re:[0,3,12,13,19],read:[0,3,4,13,14,17,18,19],read_blacklist:13,read_checklist:13,read_credenti:13,read_json:[8,13],read_log:7,read_manifest:9,readabl:[16,17],real:13,reason:18,rec:12,receiv:[4,17],recon_don:7,record:[17,18],record_id_field:17,recurs:13,redcap:[15,20,22],redcap_token:[17,20,22],redcapapiurl:17,redcapcom:17,redcapd:17,redcapeventid:17,redcapinstru:17,redcapprojectid:17,redcaprecordkei:17,redcapstatu:17,redcapstatusvalu:17,redcapsubj:17,redcaptoken:17,redcapurl:17,redefin:17,reduc:18,ref:[15,16],refactor:16,refer:[14,17],referenc:6,regex:17,regular:17,reject:12,rel:[0,7,17,19],releas:[15,16],release_db:4,relev:16,remotelogin:17,remoteprojectid:17,remov:[6,13,15,16,17,22],remove_empty_fil:13,remove_field:8,renam:[14,18],rename_exp:14,rename_experi:14,rename_subject:14,repeat:6,repeatedli:13,repetitiontim:17,replac:[16,20],report:[0,6,7,14,17,19],report_error:6,report_issu:6,request:[14,16,17],requir:[0,6,9,14,19,20],reson:[0,19],resourc:[6,14,17,22],resource_group_id:14,resource_id:14,respect:[6,17],respons:14,rest:[0,19],rest_dir:18,restrict:[3,12,14],result:[3,9,12],retri:[13,14],retriev:[6,12,14,17,18,20,22],returncod:13,reus:4,revers:17,review:18,right:17,risk:18,roi:[0,19],rollback:4,root:[0,10,18,19,20],rootdir:20,round:15,rst:[17,18],run:[0,4,6,7,9,12,13,14,16,17,18,19,20,22],run_dummy_q:13,s1:[0,19],s2:[0,19],s3:[0,19],s4:[0,19],s5:[0,19],s:[0,3,4,6,9,12,13,14,16,17,18,19,20,22],sag:17,sag_mprage_t1:18,same:[0,4,6,13,14,17,18,19,22],save:[11,13],scan:[0,1,2,6,9,11,12,13,14,17,19,22],scan_entry_class:11,scan_id:14,scan_json:14,scan_list:[1,2],scan_path:11,scan_pattern:12,scan_r:12,scan_tag:6,scanentryabc:11,scanid:[1,2,4,10,13,14,15],scanid_requir:4,scanlength:9,scans_csv:11,scheme:[10,17,22],scipi:[0,19],scope:6,scrape:7,scrape_log:7,script:[0,4,7,11,13,15,17,18,19,20],se:12,search:[3,6,13,14,17,19],second:[16,17,18],section2:9,section:17,see:[0,12,13,17,18,19],seemingli:14,self:[9,11],sensit:[12,16,17],sent:17,separ:[13,17,18],seri:[0,4,6,8,10,12,13,14,17,18,19],series_json:8,series_map:3,series_path:8,seriesdescript:[12,17,18],seriesexport:6,server:[14,17,22],server_cach:14,serverlogdir:17,session:[3,5,6,9,10,12,13,14,17,18,22],sessionexport:6,set:[0,3,4,6,9,12,13,14,18,19,20,22],set_datman_nam:14,set_output:9,set_studi:3,set_study_statu:4,set_tag:14,setup:[0,19],sfnr:9,sftp:[17,22],sge:17,share:[3,6,14,18],sharedexport:6,shell:[13,17],shell_cmd:13,should:[6,11,12,13,14,16,17,18,20],show:17,shown:20,side:[6,17],side_car:6,sidecarchang:18,sign:13,signal:[0,19],similar:[12,13],sinc:13,singl:[0,6,9,10,12,13,14,17,19,20],sit:[0,19],site:[3,4,12,13,14],site_set:3,sitetag:3,size:9,slice:9,slicer:[9,22],slightli:13,slurm:[13,17],small:17,snr:[0,19],snrimg:9,so:[0,3,13,14,19],sofia:[0,19],softwar:[20,22],some:[6,12,16,18,20,22],somefold:17,sometim:14,sophist:13,sourc:[3,4,5,6,7,8,9,10,11,12,13,14,17],source_dir:13,source_id:4,source_nam:18,space:[13,18],special:13,specialquot:13,specif:[1,3,4,13,14,17,20],specifi:[3,4,12,13,14,17,18],spectra:[0,19],spikecount:9,spin:[3,4,17],split:[6,13,17],split_path:13,splitext:13,spn01:[3,4],spn01_zhh_0018_01_01_rst_06_rest:[0,19],sprl:17,spuriou:[0,19],squar:[0,19],stack:[0,19],standard:[0,7,8,16,19,22],standard_json:8,standard_log:7,standard_path:8,standards_dict:7,standards_field:7,start:17,start_new_scan_list:11,state:[0,4,14,19],statu:14,std:[17,22],stdout:13,stdplotshist:9,stem:6,still:[9,17,20],stop_after_first:13,store:[6,10,14,17,18],str:[6,9,10,12,13,14],strict:14,string:[4,6,9,12,13,14,17],strip:16,stroke:[0,19],structur:[0,14,17,18,19],stu01:17,stu01_uto_10001_01_se01_mr:17,stuck:[4,14],studi:[0,3,4,5,6,10,12,13,14,18,19,20,22],study1:17,study1_config:17,study1_site_0000_01_01:18,study1_site_0001_01_01:18,study1_ut2_abc0001_01_01:17,study2_site_0000_01_01:18,study2_site_0001_01_01:18,study3_site_0000_01_01:18,study_config:[3,17],study_config_fil:3,study_nam:3,study_nicknam:20,study_requir:3,study_site_0000_01_01_tag_00:18,studya:17,studyb:17,studyb_cmh:17,studyc:17,studyid:18,studytag:[3,17],style:[4,6,12,13,14,16,17],sub:5,sub_id_field:17,subclass:[6,11,12],subfold:[13,14],subject:[0,4,7,9,10,11,12,13,14,15,17,18,19],subject_field:7,subject_id:[10,13,14],subject_json:14,subject_log:7,subject_nam:14,submit:[13,17],submit_job:13,submodul:1,subset:[17,18],success:[13,14],suffix:[12,13],suppli:[3,13],support:[12,13],survei:[17,22],symlink:[6,22],system:[3,13,17,20],system_config:3,systemat:[0,11,19],systemset:20,t1:[0,17,18,19],t1w:18,t2:17,t2w_spc_vnav:17,t:[0,4,6,9,12,13,14,16,17,19,20],tabl:17,tag:[0,3,4,6,10,12,13,14,16,17,19],tag_map:14,taginfo:3,take:[0,3,6,7,13,17,19],taken:[0,6,19],tar:13,tarbal:[0,13,19],target:13,target_nam:18,target_subject:18,task:[12,22],taskregex:17,tech:[6,13],technic:12,technot:13,tell:[14,16],temp:6,tempfil:14,templat:17,tempor:[0,19],temporari:[14,17],tend:14,termin:4,test:[16,17],text:22,than:[14,17,20],thei:[0,3,13,17,18,19],them:[3,12,14,16,17,22],thi:[0,3,4,6,10,11,12,13,14,16,17,18,19,20,22],thing:[0,19],third:18,those:12,though:[14,20],three:[0,9,17,19],through:[0,6,14,19],tigrlab:[0,19,20],tigrlab_scan_completed_complet:17,time:[0,12,13,19],timepoint:12,timeseri:[0,19],titl:[9,16,17],tmp:[13,17],todai:[0,19],token:[17,20,22],toler:[8,17],toml:16,tool:[17,18,22],top:2,tr:[0,19],track:[0,19],transact:4,translat:[12,17],treat:17,trigger:17,tsnr:[0,19],tsnr_bx:[0,19],tsv:22,tumor:[0,19],tune:17,tupl:[12,14],two:[0,3,6,17,18,19],txt:[13,17],type:[0,3,6,9,12,13,14,16,17,18,19,20,22],typo:17,u:20,unabl:14,unassign:[0,19],undefin:17,undefinedset:[3,5],under:[0,6,14,19],undergo:18,unexpect:14,uniform:10,uniqu:[6,17],unit:16,univers:6,unless:13,unlik:17,unset:[14,17],until:[4,13],up:[0,6,13,14,17,19],updat:[13,15,16,20],update_blacklist:13,update_checklist:13,update_expected_output:9,update_scans_csv:11,upload:[14,17,22],uri:14,url:[14,17],us:[0,3,5,7,9,11,12,13,14,16,17,18,19,20,22],use_bid:[6,13],user:[12,14,17,18,20,22],user_nam:13,usernam:[14,17,20,22],usesredcap:17,usual:17,ut1:[12,17],ut2:[12,17],util:[1,2,8,20],uto:[12,17],v:20,valid:[6,10,12,14],validate_subject_id:13,valu:[0,3,8,10,12,13,17,18,19],variabl:[3,13,14,15,17,20,22],variou:17,vector:[0,19],verbos:13,veri:16,verifi:13,verify_standard:7,versa:17,version:[13,15,16,22],versu:14,vice:17,visual:9,voxel:[0,19],wa:[0,3,6,13,14,17,18,19],wai:[11,14,17,20],wait:4,walltim:13,want:[12,13,20],warn:10,we:[0,13,16,19],weight:[0,19],welcom:16,well:[4,22],were:[13,17],what:[0,16,17,19],whatev:[17,18],when:[0,4,11,12,13,14,16,17,18,19],whenev:[6,16],where:[3,6,10,11,13,14,17],whether:[6,13,14,17],which:[0,3,6,13,17,18,19],who:[12,13,17,20],whole:[0,19],why:18,wide:[3,14],width:9,wish:13,within:[4,12,13,14,17,18,20],without:[0,3,6,13,16,19,20],work:[4,6,13,17,22],workdir:13,workflow:14,would:17,wrap:4,wrapper:3,write:[0,6,9,13,16,17,19],write_diff_log:8,write_json:13,write_manifest:9,write_metadata:13,wrong:[11,18],www:[0,19],x:13,xml:14,xnat:[0,1,2,3,5,6,19,20,22],xnat_conn:14,xnat_connect:14,xnat_cr:13,xnat_fetch_sess:[17,19],xnat_pass:[17,20,22],xnat_url:13,xnat_us:[17,20,22],xnatarch:17,xnatconnect:13,xnatconvent:17,xnatcredenti:17,xnatexcept:[5,14],xnatexperi:[6,14],xnatlogin:17,xnatobject:14,xnatport:[14,17],xnatscan:14,xnatserv:17,xnatsourc:[17,22],xnatsourcearch:17,xnatsourcecredenti:17,xnatsubject:14,xxx:17,yaml:[3,17],yet:13,yml:[17,20],you:[0,3,12,13,16,17,18,19,20],your:[0,16,17,19,20],yrk:17,z0:12,z:12,zero:13,zip:[11,13,14,17,18,22],zip_fil:11,zip_nam:14,zipfil:[0,13,14,19]},titles:["Introduction","Library API (application program interface)","datman package","datman.config module","datman.dashboard module","datman.exceptions module","datman.exporters module","datman.fs_log_scraper module","datman.header_checks module","datman.metrics module","datman.scan module","datman.scan_list module","datman.scanid module","datman.utils module","datman.xnat module","What\u2019s new?","Contributing to Datman","Configuration Files","Other important files","datman","Installation","<no title>","Script Overview"],titleterms:{"export":6,"import":18,"new":15,api:1,applic:1,blacklist:[17,18],checklist:18,config:3,configur:17,contain:20,contribut:16,control:[0,19],csv:18,dashboard:4,datman:[0,2,3,4,5,6,7,8,9,10,11,12,13,14,16,19],dcm2bid:18,dm_blacklist_rm:22,dm_link:22,dm_link_shared_id:22,dm_parse_fac:22,dm_qc_report:22,dm_redcap_scan_complet:22,dm_sftp:22,dm_task_fil:22,dm_xnat_extract:22,dm_xnat_upload:22,docker:20,exampl:[17,18],except:5,exportinfo:17,exportset:17,extern:18,file:[17,18],fs_log_scrap:7,ftp:17,glossari:17,gold:17,header_check:8,idmap:17,indic:19,instal:20,interfac:1,introduct:[0,19],json:18,librari:1,link:18,log:17,metadata:17,metric:9,modul:[3,4,5,6,7,8,9,10,11,12,13,14],option:17,other:18,overrid:17,overview:[0,19,22],packag:2,path:17,pattern:17,program:1,project:17,qualiti:[0,19],redcap:17,requir:17,s:15,scan:[10,18],scan_list:11,scanid:12,script:22,set:17,site:17,standard:17,studi:17,submodul:2,systemset:17,tabl:19,task:17,util:13,what:15,xnat:[14,17],xnat_fetch_sess:22}}) \ No newline at end of file +Search.setIndex({docnames:["README","api","api/datman","api/datman.config","api/datman.dashboard","api/datman.exceptions","api/datman.exporters","api/datman.fs_log_scraper","api/datman.header_checks","api/datman.metrics","api/datman.scan","api/datman.scan_list","api/datman.scanid","api/datman.utils","api/datman.xnat","changes","contributing","datman_conf","datman_files","index","installation","links","script_overview"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,sphinx:56},filenames:["README.rst","api.rst","api/datman.rst","api/datman.config.rst","api/datman.dashboard.rst","api/datman.exceptions.rst","api/datman.exporters.rst","api/datman.fs_log_scraper.rst","api/datman.header_checks.rst","api/datman.metrics.rst","api/datman.scan.rst","api/datman.scan_list.rst","api/datman.scanid.rst","api/datman.utils.rst","api/datman.xnat.rst","changes.rst","contributing.rst","datman_conf.rst","datman_files.rst","index.rst","installation.rst","links.rst","script_overview.rst"],objects:{"":[[2,0,0,"-","datman"]],"datman.config":[[3,1,1,"","TagInfo"],[3,1,1,"","config"],[3,5,1,"","study_required"]],"datman.config.TagInfo":[[3,2,1,"","get"],[3,2,1,"","keys"],[3,3,1,"","series_map"]],"datman.config.config":[[3,2,1,"","get_key"],[3,2,1,"","get_path"],[3,2,1,"","get_sites"],[3,2,1,"","get_study_base"],[3,2,1,"","get_study_tags"],[3,2,1,"","get_tags"],[3,2,1,"","get_xnat_projects"],[3,4,1,"","install_config"],[3,2,1,"","load_yaml"],[3,2,1,"","map_xnat_archive_to_project"],[3,2,1,"","set_study"],[3,4,1,"","study_config"],[3,4,1,"","study_config_file"],[3,4,1,"","study_name"],[3,4,1,"","system_config"]],"datman.dashboard":[[4,5,1,"","add_scan"],[4,5,1,"","add_session"],[4,5,1,"","add_subject"],[4,5,1,"","dashboard_required"],[4,5,1,"","filename_required"],[4,5,1,"","get_bids_scan"],[4,5,1,"","get_bids_subject"],[4,5,1,"","get_default_user"],[4,5,1,"","get_project"],[4,5,1,"","get_scan"],[4,5,1,"","get_session"],[4,5,1,"","get_study_subjects"],[4,5,1,"","get_subject"],[4,5,1,"","release_db"],[4,5,1,"","scanid_required"],[4,5,1,"","set_study_status"]],"datman.exceptions":[[5,6,1,"","ConfigException"],[5,6,1,"","DashboardException"],[5,6,1,"","ExportException"],[5,6,1,"","ExporterException"],[5,6,1,"","InputException"],[5,6,1,"","MetadataException"],[5,6,1,"","ParseException"],[5,6,1,"","QCException"],[5,6,1,"","UndefinedSetting"],[5,6,1,"","XnatException"]],"datman.exceptions.XnatException":[[5,4,1,"","message"],[5,4,1,"","session"],[5,4,1,"","study"]],"datman.exporters":[[6,1,1,"","BidsExporter"],[6,1,1,"","DBExporter"],[6,1,1,"","DcmExporter"],[6,1,1,"","Exporter"],[6,1,1,"","NiiExporter"],[6,1,1,"","NiiLinkExporter"],[6,1,1,"","SeriesExporter"],[6,1,1,"","SessionExporter"],[6,1,1,"","SharedExporter"],[6,5,1,"","get_exporter"]],"datman.exporters.BidsExporter":[[6,2,1,"","add_repeat_num"],[6,2,1,"","export"],[6,2,1,"","get_sidecars"],[6,2,1,"","needs_raw_data"],[6,2,1,"","outputs_exist"],[6,4,1,"","type"]],"datman.exporters.DBExporter":[[6,2,1,"","add_tech_notes"],[6,2,1,"","errors_outdated"],[6,2,1,"","export"],[6,2,1,"","get_bids_name"],[6,2,1,"","get_output_dir"],[6,2,1,"","make_scan"],[6,2,1,"","make_session"],[6,3,1,"","names"],[6,2,1,"","needs_raw_data"],[6,2,1,"","outputs_exist"],[6,4,1,"","type"]],"datman.exporters.DcmExporter":[[6,2,1,"","export"],[6,4,1,"","ext"],[6,4,1,"","type"]],"datman.exporters.Exporter":[[6,2,1,"","export"],[6,2,1,"","get_output_dir"],[6,2,1,"","make_output_dir"],[6,2,1,"","needs_raw_data"],[6,2,1,"","outputs_exist"],[6,4,1,"","type"]],"datman.exporters.NiiExporter":[[6,2,1,"","export"],[6,4,1,"","ext"],[6,2,1,"","move_file"],[6,2,1,"","report_issues"],[6,4,1,"","type"]],"datman.exporters.NiiLinkExporter":[[6,2,1,"","belongs_to_session"],[6,2,1,"","clear_errors"],[6,2,1,"","export"],[6,4,1,"","ext"],[6,2,1,"","get_bids_niftis"],[6,2,1,"","get_dm_names"],[6,2,1,"","get_error_file"],[6,2,1,"","get_output_dir"],[6,2,1,"","get_series_num"],[6,2,1,"","make_datman_name"],[6,2,1,"","make_link"],[6,2,1,"","match_dm_to_bids"],[6,2,1,"","needs_raw_data"],[6,2,1,"","outputs_exist"],[6,2,1,"","report_errors"],[6,4,1,"","type"]],"datman.exporters.SeriesExporter":[[6,4,1,"","ext"],[6,2,1,"","needs_raw_data"],[6,2,1,"","outputs_exist"]],"datman.exporters.SharedExporter":[[6,2,1,"","export"],[6,4,1,"","ext"],[6,2,1,"","find_bids_files"],[6,2,1,"","find_dm_files"],[6,2,1,"","find_resource_files"],[6,2,1,"","find_source_session"],[6,2,1,"","get_output_dir"],[6,2,1,"","make_name_map"],[6,2,1,"","needs_raw_data"],[6,2,1,"","outputs_exist"],[6,4,1,"","type"]],"datman.fs_log_scraper":[[7,1,1,"","FSLog"],[7,5,1,"","check_diff"],[7,5,1,"","choose_standard_sub"],[7,5,1,"","make_standards"],[7,5,1,"","scrape_logs"],[7,5,1,"","verify_standards"]],"datman.fs_log_scraper.FSLog":[[7,2,1,"","get_args"],[7,2,1,"","get_date"],[7,2,1,"","get_kernel"],[7,2,1,"","get_niftis"],[7,2,1,"","get_subject"],[7,2,1,"","parse_recon_done"],[7,2,1,"","read_log"]],"datman.header_checks":[[8,5,1,"","check_bvals"],[8,5,1,"","compare_headers"],[8,5,1,"","construct_diffs"],[8,5,1,"","find_bvals"],[8,5,1,"","handle_diff"],[8,5,1,"","parse_file"],[8,5,1,"","read_json"],[8,5,1,"","remove_fields"],[8,5,1,"","write_diff_log"]],"datman.metrics":[[9,1,1,"","ABCDPHAMetrics"],[9,1,1,"","AnatMetrics"],[9,1,1,"","AnatPHAMetrics"],[9,1,1,"","DTIMetrics"],[9,1,1,"","DTIPHAMetrics"],[9,1,1,"","FMRIMetrics"],[9,1,1,"","FMRIPHAMetrics"],[9,1,1,"","IgnoreMetrics"],[9,1,1,"","Metric"],[9,1,1,"","MetricDTI"],[9,1,1,"","QAPHAMetrics"],[9,1,1,"","QCOutput"],[9,5,1,"","get_handlers"]],"datman.metrics.ABCDPHAMetrics":[[9,2,1,"","generate"],[9,4,1,"","outputs"]],"datman.metrics.AnatMetrics":[[9,2,1,"","generate"],[9,4,1,"","outputs"]],"datman.metrics.AnatPHAMetrics":[[9,2,1,"","generate"],[9,4,1,"","outputs"]],"datman.metrics.DTIMetrics":[[9,2,1,"","generate"],[9,4,1,"","outputs"]],"datman.metrics.DTIPHAMetrics":[[9,2,1,"","generate"],[9,4,1,"","outputs"]],"datman.metrics.FMRIMetrics":[[9,2,1,"","generate"],[9,4,1,"","outputs"]],"datman.metrics.FMRIPHAMetrics":[[9,2,1,"","generate"],[9,4,1,"","outputs"]],"datman.metrics.IgnoreMetrics":[[9,2,1,"","exists"],[9,2,1,"","generate"],[9,4,1,"","outputs"],[9,2,1,"","write_manifest"]],"datman.metrics.Metric":[[9,2,1,"","command_succeeded"],[9,2,1,"","exists"],[9,2,1,"","generate"],[9,2,1,"","get_requirements"],[9,2,1,"","is_runnable"],[9,2,1,"","make_image"],[9,2,1,"","make_manifest"],[9,2,1,"","make_montage"],[9,3,1,"","manifest_path"],[9,2,1,"","outputs"],[9,2,1,"","read_manifest"],[9,4,1,"","requires"],[9,2,1,"","run"],[9,2,1,"","set_outputs"],[9,2,1,"","write_manifest"]],"datman.metrics.QAPHAMetrics":[[9,2,1,"","generate"],[9,4,1,"","outputs"],[9,2,1,"","update_expected_outputs"]],"datman.metrics.QCOutput":[[9,4,1,"","caption"],[9,4,1,"","order"],[9,4,1,"","title"]],"datman.scan":[[10,1,1,"","DatmanNamed"],[10,1,1,"","Scan"],[10,1,1,"","Series"]],"datman.scan.Scan":[[10,2,1,"","find_files"],[10,2,1,"","get_resource_dir"],[10,2,1,"","get_tagged_nii"],[10,3,1,"","niftis"]],"datman.scan_list":[[11,1,1,"","ScanEntryABC"],[11,5,1,"","generate_scan_list"],[11,5,1,"","get_scan_list_contents"],[11,5,1,"","make_new_entries"],[11,5,1,"","start_new_scan_list"],[11,5,1,"","update_scans_csv"]],"datman.scan_list.ScanEntryABC":[[11,2,1,"","get_target_name"]],"datman.scanid":[[12,1,1,"","BIDSFile"],[12,1,1,"","DatmanIdentifier"],[12,1,1,"","Identifier"],[12,1,1,"","KCNIIdentifier"],[12,5,1,"","get_field"],[12,5,1,"","get_kcni_identifier"],[12,5,1,"","get_session_num"],[12,5,1,"","get_subid"],[12,5,1,"","is_phantom"],[12,5,1,"","is_scanid"],[12,5,1,"","is_scanid_with_session"],[12,5,1,"","make_filename"],[12,5,1,"","parse"],[12,5,1,"","parse_bids_filename"],[12,5,1,"","parse_filename"]],"datman.scanid.DatmanIdentifier":[[12,2,1,"","get_xnat_experiment_id"],[12,2,1,"","get_xnat_subject_id"],[12,4,1,"","pha_pattern"],[12,4,1,"","pha_re"],[12,4,1,"","scan_pattern"],[12,4,1,"","scan_re"],[12,3,1,"","session"]],"datman.scanid.Identifier":[[12,2,1,"","get_bids_name"],[12,2,1,"","get_full_subjectid"],[12,2,1,"","get_full_subjectid_with_timepoint"],[12,2,1,"","get_full_subjectid_with_timepoint_session"],[12,2,1,"","get_xnat_experiment_id"],[12,2,1,"","get_xnat_subject_id"],[12,2,1,"","match"]],"datman.scanid.KCNIIdentifier":[[12,2,1,"","get_xnat_experiment_id"],[12,2,1,"","get_xnat_subject_id"],[12,4,1,"","pha_pattern"],[12,4,1,"","pha_re"],[12,4,1,"","scan_pattern"],[12,4,1,"","scan_re"]],"datman.utils":[[13,1,1,"","XNATConnection"],[13,1,1,"","cd"],[13,5,1,"","check_dependency_configured"],[13,5,1,"","check_returncode"],[13,5,1,"","define_folder"],[13,5,1,"","filter_niftis"],[13,5,1,"","find_tech_notes"],[13,5,1,"","get_all_headers_in_folder"],[13,5,1,"","get_archive_headers"],[13,5,1,"","get_extension"],[13,5,1,"","get_files_with_tag"],[13,5,1,"","get_folder_headers"],[13,5,1,"","get_loaded_modules"],[13,5,1,"","get_relative_source"],[13,5,1,"","get_resources"],[13,5,1,"","get_subject_metadata"],[13,5,1,"","get_tarfile_headers"],[13,5,1,"","get_xnat_credentials"],[13,5,1,"","get_zipfile_headers"],[13,5,1,"","has_permissions"],[13,5,1,"","is_dicom"],[13,5,1,"","is_named_like_a_dicom"],[13,5,1,"","locate_metadata"],[13,5,1,"","make_temp_directory"],[13,5,1,"","make_zip"],[13,5,1,"","makedirs"],[13,5,1,"","nifti_basename"],[13,5,1,"","read_blacklist"],[13,5,1,"","read_checklist"],[13,5,1,"","read_credentials"],[13,5,1,"","read_json"],[13,5,1,"","remove_empty_files"],[13,5,1,"","run"],[13,5,1,"","run_dummy_q"],[13,5,1,"","split_path"],[13,5,1,"","splitext"],[13,5,1,"","submit_job"],[13,5,1,"","update_blacklist"],[13,5,1,"","update_checklist"],[13,5,1,"","validate_subject_id"],[13,5,1,"","write_json"],[13,5,1,"","write_metadata"]],"datman.xnat":[[14,1,1,"","XNATExperiment"],[14,1,1,"","XNATObject"],[14,1,1,"","XNATScan"],[14,1,1,"","XNATSubject"],[14,5,1,"","get_auth"],[14,5,1,"","get_connection"],[14,5,1,"","get_port_str"],[14,5,1,"","get_server"],[14,1,1,"","xnat"]],"datman.xnat.XNATExperiment":[[14,2,1,"","assign_scan_names"],[14,2,1,"","download"],[14,2,1,"","get_autorun_ids"],[14,2,1,"","get_resources"],[14,2,1,"","is_shared"]],"datman.xnat.XNATScan":[[14,2,1,"","download"],[14,2,1,"","is_derived"],[14,2,1,"","is_multiecho"],[14,2,1,"","is_usable"],[14,2,1,"","raw_dicoms_exist"],[14,2,1,"","set_datman_name"],[14,2,1,"","set_tag"]],"datman.xnat.xnat":[[14,4,1,"","auth"],[14,2,1,"","create_resource_folder"],[14,2,1,"","delete_resource"],[14,2,1,"","dismiss_autorun"],[14,2,1,"","find_project"],[14,2,1,"","find_subject"],[14,2,1,"","get_dicom"],[14,2,1,"","get_experiment"],[14,2,1,"","get_experiment_ids"],[14,2,1,"","get_projects"],[14,2,1,"","get_resource"],[14,2,1,"","get_resource_archive"],[14,2,1,"","get_resource_ids"],[14,2,1,"","get_resource_list"],[14,2,1,"","get_scan"],[14,2,1,"","get_scan_ids"],[14,2,1,"","get_subject"],[14,2,1,"","get_subject_ids"],[14,4,1,"","headers"],[14,2,1,"","make_experiment"],[14,2,1,"","make_subject"],[14,2,1,"","open_session"],[14,2,1,"","put_dicoms"],[14,2,1,"","put_resource"],[14,2,1,"","rename_experiment"],[14,2,1,"","rename_subject"],[14,4,1,"","server"],[14,4,1,"","session"]],datman:[[3,0,0,"-","config"],[4,0,0,"-","dashboard"],[5,0,0,"-","exceptions"],[6,0,0,"-","exporters"],[7,0,0,"-","fs_log_scraper"],[8,0,0,"-","header_checks"],[9,0,0,"-","metrics"],[10,0,0,"-","scan"],[11,0,0,"-","scan_list"],[12,0,0,"-","scanid"],[13,0,0,"-","utils"],[14,0,0,"-","xnat"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","property","Python property"],"4":["py","attribute","Python attribute"],"5":["py","function","Python function"],"6":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:property","4":"py:attribute","5":"py:function","6":"py:exception"},terms:{"0":[0,12,13,15,17,19,22],"00":13,"005":17,"02":15,"0rc1":15,"1":[0,9,12,13,14,15,17,19],"10":22,"1000":17,"11":15,"111":17,"1111":17,"112":17,"1600":9,"16649196":[0,19],"1_snr_adc":9,"2":[0,9,12,13,14,15,17,19],"2006":[0,19],"2011":[0,19],"2014":22,"2019":15,"2020":15,"212":[0,19],"212_spectra":[0,19],"22":17,"222":17,"23":[0,19],"245":15,"247":15,"248":15,"250":15,"251":15,"252":15,"2_b0distortionratio":9,"3":[0,9,12,13,14,15,17,19],"333":17,"3_eddycurrentdistort":9,"4":[9,12],"443":17,"444":17,"4_avenyqratio":9,"5":[0,9,19,22],"59":[0,19],"5_favalu":9,"6":[0,9,12,19],"60dir":17,"7":9,"777":17,"8":[9,12],"9":[9,12,17],"999":17,"abstract":[6,9,11,12],"boolean":[6,17],"break":16,"case":[3,12,16,17],"class":[1,3,6,7,9,10,11,12,13,14],"default":[3,5,6,9,12,13,14,17,18],"do":[12,13,14,18],"export":[1,2,5,14,17,18,20],"function":[0,1,3,4,6,8,9,11,12,13,17,19],"import":[17,19,22],"int":[9,12],"long":4,"new":[6,14,16,17,19],"return":[3,4,6,9,11,12,13,14],"short":[0,6,17,19],"static":7,"super":[6,11],"switch":[3,13],"true":[6,10,13,14,17],"try":[16,17,18],"var":[13,17],"while":[4,12,14],A:[0,4,6,7,9,10,11,12,13,14,17,18,19],And:17,As:[3,12,17],At:17,By:[3,18],For:[0,5,12,17,18,19],If:[3,6,9,10,12,13,14,16,17,20],In:17,It:[0,13,14,17,18,19],NOT:[14,18],OR:13,On:20,One:[3,17],Or:17,That:[11,18],The:[0,3,6,7,9,10,11,12,13,14,17,18,19,20,22],These:[0,3,13,17,19,20,22],To:[0,6,11,17,19,20],Will:[13,14],_:12,__init__:[3,6,11],_b0:9,_bad_fd:[0,19],_corr:[0,9,19],_direct:9,_fd:[0,9,19],_imag:9,_montag:9,_plot:9,_qascripts_bold:[0,9,19],_qascripts_dti:[0,9,19],_raw:9,_scanlength:[0,9,19],_se:12,_sfnr:[0,9,19],_spectra:[0,9,19],_spikecount:9,_stat:[0,9,19],aa:18,abc:[6,9,12,14,17],abcd:[9,17],abcd_dmri:17,abcd_fmri:17,abcdphametr:9,abl:17,about:[7,10,13,18],abov:[0,17,19],absolut:[0,3,10,14,19],accept:[12,13,16,17],access:[10,13,14,17,20],accident:13,accur:6,accuraci:6,acq:[12,18],acquisit:[0,12,17,19],acquisitiontim:17,across:[0,19],act:17,action:14,activ:[0,19],actual:[6,16],ad:[14,16,18],adapt:3,add:[0,6,13,16,18,19,20],add_repeat_num:6,add_scan:4,add_sess:4,add_subject:4,add_tech_not:6,addit:[3,13,16,18,20,22],address:17,adni:[0,9,19],afni:[20,22],after:[4,10,13,16],again:17,against:17,aggreg:7,al:[0,19],alia:6,alias:6,all:[0,3,6,10,12,13,14,15,16,17,19,20,22],alloc:13,allow:[3,6,12,17],allow_parti:13,alphanumer:12,alreadi:[6,11,14,17],also:[0,6,13,14,17,19,20],alwai:12,an:[0,3,4,6,12,13,14,16,17,18,19,22],anaconda:[0,19],analysi:[0,19],analyt:[0,19],anat:[17,18],anatmetr:9,anatphametr:9,ani:[6,7,9,10,12,13,14,16,17,18,20,22],anoth:[6,12,14,17],anotherxnat:17,anyon:16,anyth:17,ap:[6,18],apart:14,api:[14,17,19],appear:[14,18],appli:[4,6,12,14,16,17,18,22],applic:19,ar:[0,4,6,7,9,12,13,14,16,17,18,19,20,22],archiv:[0,3,13,14,17,19],aren:16,arg:6,argslist:13,argument:[4,6,13],aris:[0,19],arm1:17,arm2:17,arm3:17,artifact:[0,19],asid:12,assess:[0,19],asset:[0,17,19,20],assign:[14,17],assign_scan_nam:14,associ:14,assum:[10,13,17],assur:[0,19],attempt:[4,13,14,16],attend:17,attribut:[6,10,14],auth:14,authent:22,autom:16,automat:[0,19],autorun:14,avail:[17,20],averag:[0,19],b0:[0,9,19],b0distort:9,b0fieldsourc:18,b:13,back:[13,17],bad:[0,19],base:[3,5,6,7,9,10,11,12,13,14,17,22],base_nam:14,basenam:13,basic:6,becaus:[14,17],becom:[0,10,17,19],been:[3,6,9,13,17,18,20,22],befor:[13,14,16,17,18],begin:17,behav:17,behavior:14,being:[0,13,17,19],belong:[6,10,13,14,17,18,22],belongs_to_sess:6,below:[12,16,17,20],benefit:17,best:13,between:[0,3,7,9,17,19],bewar:14,bid:[6,10,12,13,17,18,22],bids_fil:6,bids_id:13,bids_nam:[4,6],bids_opt:6,bids_path:6,bids_root:10,bids_s:13,bids_sess:4,bidsexport:6,bidsfil:12,bidsifi:17,bin:[20,22],blacklist:[13,19,22],blacklistdel:[17,22],block:[13,17,20],bold:[0,9,19],bool:[6,13,14],both:3,boxx:17,brain:[0,19],bravo:17,bug:[15,16],builder:16,bval:9,bvec:9,bytestr:15,c:13,ca:17,cach:14,calcul:[0,19],call:[6,11,12,14],camelcas:17,can:[3,4,6,11,12,13,14,16,17,18,20,22],candid:13,cannot:6,capit:17,caption:9,car:[6,17],care:13,caus:[12,13,14,17],cb:18,cd:[0,13,19,20],ce:12,centralslic:9,certain:[10,12,14],chanc:16,chang:[6,10,12,13,14,15,16,17],changelog:16,charact:[12,17],chavez:[0,19],check:[4,6,13,14,16],check_bval:8,check_dependency_configur:13,check_diff:7,check_returncod:13,checklist:[13,15,17,19,22],choose_standard_sub:7,chronolog:[0,19],circumv:13,classmethod:[6,9],clean:14,clear_error:6,clevi:17,clock:13,clone:[0,19,20],cmd:13,cmd_arg:7,cmh:17,cmt:17,code:[4,11,12,13,15,16,17],col_head:7,collect:[0,13,17,19],colon:16,column:18,com:[0,17,19,20],come:16,comma:[13,18],command:[9,13,16,20],command_nam:9,command_succeed:9,comment:[13,17,18],comment_field:17,commit:4,common:16,compar:[8,17],compare_head:8,comparison:17,compil:12,complet:[0,4,6,13,14,16,17,19,22],complianc:16,complic:17,compon:13,comput:3,conda:[0,19],conf_dir:20,config:[1,2,6,10,13,14,17,18,20,22],config_templ:17,configdir:[17,20],configexcept:5,configur:[3,10,13,14,18,19,20,22],conflict:3,conform:[12,13,14],connect:[0,4,14,17,19],consequ:14,consid:[3,13],consist:[12,17],construct:17,construct_diff:8,consult:14,contact:17,contain:[6,7,11,12,13,14,17,18,19],content:[6,10,13,17,22],context:[13,17],continu:16,contribut:19,control:18,convent:[10,12,13,14,17,22],convers:[6,15],convert:[4,12,17,22],copi:[17,20],core:[13,17],correct:[0,4,6,11,13,17,18,19],correctli:[13,16,17,18,20,22],correl:[0,9,19],correspond:12,corrupt:[0,19],could:[0,19],count:17,cpu_cor:13,creat:[0,4,6,10,11,12,14,17,19,20],create_resource_fold:14,creation:14,cred_fil:13,credenti:20,criteria:[4,18],csv:[0,9,11,13,17,19,22],current:[3,6,10,13,14,17,18,20],current_subid:12,customlabel:18,cut:[0,19],d:[0,13,19],dashboard:[1,2,5,6,13,17,18,22],dashboard_requir:4,dashboardexcept:[4,5],data:[0,5,6,10,13,14,17,18,19,20,22],data_dir:20,databas:[0,4,6,13,18,19,22],dataset:6,datatyp:[0,18,19],date:[4,10,17],date_field:17,date_str:7,datman:[1,17,18,20,22],datman_asset:[0,19],datman_id:11,datman_log:17,datmanassetsdir:[17,20],datmanidentifi:12,datmannam:10,datmanprojectsdir:[17,20],db:6,dbexport:6,dcm2bid:[6,17,19,22],dcm2niix:[6,20,22],dcm:[6,17],dcmdump:18,dcmexport:6,decemb:15,decod:15,decor:4,decorrel:[0,19],def:11,defaults_onli:3,defin:[0,3,5,6,9,11,13,14,17,19,22],define_fold:13,definit:[0,17,19],delet:[13,14,17,22],delete_resourc:14,dep:16,depend:[0,6,13,16,17,19,20,22],deposit:[14,22],deprec:15,deriv:11,describ:[12,17,18,20],descript:[0,4,12,13,17,18,19,22],design:[0,19],dest_dir:11,dest_fold:14,dest_zip:13,destin:[11,13,14],detail:[7,12,13,17],detect:[14,17,20],determin:17,deviat:[0,19],dicom:[0,6,11,12,13,14,17,18,19,22],dicom_patientname1:18,dicom_patientnamen:18,dicom_studyid1:18,dicom_studyidn:18,dict:[6,9,12,13,14],dictat:13,dictionari:[3,6,9,12,13,14,17],diff:8,differ:[0,3,6,7,14,17,19,22],differenti:3,diffimg:9,diffmask:9,dir:[6,12,13],dir_typ:6,direct:[0,9,19],directli:[13,20],directori:[3,6,10,11,13,17,20,22],disabl:14,discov:[3,6],discuss:22,dismiss:14,dismiss_autorun:14,displac:[0,19],displai:22,distinguish:[0,17,19],dm_blacklist_rm:[17,18,19],dm_config:[3,20],dm_dir:6,dm_file:6,dm_link:[15,18,19],dm_link_shared_id:[17,18,19],dm_log_serv:17,dm_name:6,dm_parse_ea:17,dm_parse_fac:19,dm_parse_gngo:17,dm_parse_nback:17,dm_qc_report:[17,19,20],dm_redcap_scan_complet:[17,19,20],dm_sftp:[17,19,20],dm_system:[3,13,17,20],dm_task_fil:[15,17,19],dm_xnat_extract:[17,18,19,20],dm_xnat_upload:[17,19],doc:16,docker:19,document:[16,18,22],doe:[0,6,10,12,13,14,17,19,20],doesn:[0,13,14,17,19],doesnt:[12,13,14,17],domain:17,don:[0,4,13,19,20],done:13,dont:13,download:[6,14,17,22],download_dir:14,downstream:13,drift:[0,19],drift_bx:[0,19],driftperc:[0,19],drop:13,dry_run:6,dryrun:13,dti01:12,dti15t:3,dti3t:3,dti60:17,dti:[0,3,8,9,12,17,19],dti_fieldmap:18,dtimetr:9,dtiphametr:9,due:20,dure:[0,6,17,19],dwi_dir:18,e:[3,4,6,10,12,13,16,17,20],each:[0,6,11,13,14,17,18,19],easi:10,echo:[12,17],echo_dict:6,echonumb:17,echotim:17,edat2:17,eddycurrentdist:9,either:[3,4,13,17],els:6,elsewher:17,empti:[6,7,13,14],enabl:3,encod:[0,19],end:[4,6,17],enh:16,enough:11,ensur:[4,6,12,13,16],enter:18,entir:[6,13],entri:[6,11,13,14,17,18],entryclass:11,env:[0,17,19],env_var:13,environ:[0,3,13,14,17,19,20,22],environmenterror:13,ep2d:17,epi:18,eprim:22,equival:6,error:[5,6],errors_outd:6,et:[0,19],etc:[0,13,17,19],even:[13,14],event:17,everi:[3,17],exact:[3,9],exactli:17,exam:[0,13,19],exampl:[0,11,12,13,19],examplescanentri:11,except:[1,2,3,13,14,17],excerpt:17,exclam:16,exclud:12,exist:[0,3,6,9,13,14,16,17,18,19],exit:[4,13],expect:[3,4,6,7,8,9,11,13,17],expected_kei:7,exper_id:14,experi:[6,14],experienc:14,experiment_json:14,export_set:3,exporterexcept:5,exportexcept:5,exportinfo:[3,22],exportset:3,express:17,ext:[6,12],extens:[6,13,17,18],extern:[19,22],extract:3,f:4,face:22,fail:[13,14],failur:[13,14],fals:[3,4,6,7,8,9,13,14,17],fbirn:[0,9,19],fbrin:[0,19],fd:[0,19],feat:16,featur:[16,17],fewer:17,field:[3,7,8,11,12,13,14,17],file:[0,3,4,6,7,8,9,10,11,12,13,14,16,19,20,22],file_path:[8,14],file_stem:[6,10],filenam:[3,13,14],filename_requir:4,fileobj:13,filesystem:[6,13],fill:17,filter:4,filter_nifti:13,find:[6,12,13,14,16,17,18,22],find_bids_fil:6,find_bval:8,find_dm_fil:6,find_fil:10,find_project:14,find_resource_fil:6,find_source_sess:6,find_subject:14,find_tech_not:13,findabl:13,finish:[14,18],first:[3,4,14,15,17,18],fit:17,fix:[15,16],flag:[12,13,20],flair:18,flake8:16,fluctuat:[0,19],fmap:[6,17,18],fmri:[0,9,17,19],fmri_fieldmap:18,fmrimetr:9,fmriphametr:9,fname:6,fname_root:6,folder:[0,3,6,7,13,14,16,17,18,19,20,22],foldernam:14,follow:[0,16,17,19],fool:13,form:17,format:[6,10,11,12,13,14,16,17,18,22],found:[3,4,6,7,13,14,17,22],fpath:13,framewis:[0,19],freeform:17,freesurf:7,freesurfer_fold:7,friedman:[0,19],from:[0,3,4,5,6,7,9,10,12,13,14,15,16,17,18,19,20,22],fs_log_scrap:[1,2],fs_output_fold:7,fsl:[9,20,22],fslog:7,ftp:22,ftpport:17,ftpserver:17,full:[3,6,9,12,13,14,17,20],fulli:[13,17],fullnam:17,functionwrapp:3,further:[0,19],fuzzi:13,g:[3,4,6,10,12,17,20],gap:9,gen_fil:6,gener:[0,6,7,9,11,13,17,18,19,20,22],generate_scan_list:11,get:[3,4,6,12,13,14,17,18],get_all_headers_in_fold:13,get_archive_head:13,get_arg:7,get_auth:14,get_autorun_id:14,get_bids_nam:[6,12],get_bids_nifti:6,get_bids_scan:4,get_bids_subject:4,get_connect:14,get_dat:7,get_default_us:4,get_dicom:14,get_dm_nam:6,get_error_fil:6,get_experi:14,get_experiment_id:14,get_export:6,get_extens:13,get_field:12,get_files_with_tag:13,get_folder_head:13,get_full_subjectid:12,get_full_subjectid_with_timepoint:12,get_full_subjectid_with_timepoint_sess:12,get_handl:9,get_kcni_identifi:12,get_kei:3,get_kernel:7,get_loaded_modul:13,get_nifti:7,get_output_dir:6,get_path:3,get_port_str:14,get_project:[4,14],get_relative_sourc:13,get_requir:9,get_resourc:[13,14],get_resource_arch:14,get_resource_dir:10,get_resource_id:14,get_resource_list:14,get_scan:[4,14],get_scan_id:14,get_scan_list_cont:11,get_series_num:6,get_serv:14,get_sess:4,get_session_num:12,get_sidecar:6,get_sit:3,get_study_bas:3,get_study_subject:4,get_study_tag:3,get_subid:12,get_subject:[4,7,14],get_subject_id:14,get_subject_metadata:13,get_tag:3,get_tagged_nii:10,get_tarfile_head:13,get_target_nam:11,get_xnat_credenti:13,get_xnat_experiment_id:12,get_xnat_project:3,get_xnat_subject_id:12,get_zipfile_head:13,git:[0,19,20],github:[0,15,19,20],give:[3,14,16,17],given:[3,4,6,9,10,12,13,14,17],global:[0,17,19],global_corr:[0,19],glossari:19,gmean:[0,19],gmean_bx:[0,19],go:[13,17,18],goe:[11,17,18],gold:[8,22],good:[0,19],gov:[0,19],grab:14,grace:13,grappa:17,greatli:14,group:12,guarante:22,gui:14,guidelin:16,gz:[0,6,9,13,19],ha:[3,4,13,14,17,18],had:[6,18],hand:17,handle_diff:8,happen:4,has_permiss:13,have:[0,6,13,14,17,18,19,20,22],haven:9,head:[0,19],header:[0,8,11,12,13,14,17,18,19],header_check:[1,2],headerfield:17,headerfieldtoler:17,help:[4,16,17,18],here:[0,11,12,16,17,18,19,20,22],higher:[0,19],hold:[10,13,17,18,20],home:17,how:[12,17,22],howev:[6,17],html:[0,18,19],http:[0,17,19,20],httperror:14,human:[0,17,19],i:[3,13,16,17],id:[3,4,5,6,10,11,12,13,14,17,18,20],ident:[10,12,14,17],identif:12,identifi:[0,3,4,6,10,12,13,14,17,18,19],idl:4,idmap:22,idtyp:12,ignor:[8,13,16,17,22],ignore_default:3,ignored_field:8,ignoreheaderfield:17,ignoremetr:9,imag:[0,9,13,17,19],imagetyp:17,img_gap:9,implement:6,imposs:14,includ:[6,12,13,17,18,20],incorrect:13,index:19,indic:[13,16,17,18],info:[12,17,18],inform:[0,1,4,7,10,11,18,19],init:6,initi:[13,17,18],input:[6,9],input_nii:9,inputexcept:5,insert:9,insid:[16,17],instal:[0,3,13,16,17,18,19,22],install_config:3,instanc:[0,3,4,6,10,11,12,13,14,19],instantan:[0,19],instead:[6,13,15,17,18,20],instrument:17,integ:17,integr:[13,17,20],intend:[6,11],intended_name1:18,intended_namen:18,intens:[0,19],intensitii:[0,19],interact:[14,17,20],interchang:14,interest:[13,14],interf:14,interfac:19,introduc:16,ip:17,is_complet:17,is_deriv:14,is_dicom:13,is_multiecho:14,is_named_like_a_dicom:13,is_open:4,is_phantom:12,is_runn:9,is_scanid:12,is_scanid_with_sess:12,is_shar:14,is_us:14,isn:[4,6],isnt:[4,13],isopen:17,issu:[5,6,16,20],item:13,its:[6,12,14,17],itself:[3,17],j:[0,18,19],januari:15,job:[13,17],job_nam:13,joblist:13,join:3,jonathan:[0,19],jpg:9,json:[6,8,17,19],json_cont:8,json_fil:8,json_path:8,just:[3,13,15,17,20],kcni:[12,17],kcniidentifi:12,keep:17,kei:[3,6,12,17],kept:17,keyerror:14,keyword:[0,19],kind:[0,19],kit:22,know:[0,19],known_host:22,kwarg:[4,6],l:[0,19],label:[14,17],lack:13,larg:[0,6,19,20],last:17,launch:14,lead:13,least:[3,17],left:[7,17],less:17,letter:17,level:[0,2,17,19],librari:[0,11,19],licens:20,like:[14,16,17,18],limit:17,line:[7,13,17,18,20],linear:[0,19],link:[0,14,17,19,22],linux:20,list:[4,6,7,11,13,14,16,17,18,20],list_of_nam:13,listen:17,liter:17,ll:20,load:13,load_yaml:3,loadedmodul:13,local:[3,17,20],locat:[3,4,13,14,17,18],locate_metadata:13,log:[6,7,13,16,22],log_dir:13,log_field:7,log_unam:7,logserv:17,logserverdir:17,longer:16,look:[0,13,14,16,19],low:[0,19],lowest:[0,19],machin:17,made:14,mag1:17,mag2:17,magn:[0,19],magphan_adni_manu:[0,19],mai:[6,10,13,16,17,18,22],main:[3,17,20],main_config:[17,20],maintain:12,major:[0,19],make:[6,10,11,13,14,20,22],make_datman_nam:6,make_experi:14,make_filenam:12,make_imag:9,make_link:6,make_manifest:9,make_montag:9,make_name_map:6,make_new_entri:11,make_output_dir:6,make_scan:6,make_sess:6,make_standard:7,make_subject:14,make_temp_directori:13,make_zip:13,makedir:13,manag:[0,11,12,13,17,19,20],mangl:[12,13,17],mani:17,manifest_path:9,manufacturersmodelnam:17,map:[3,6,9,12,13,14,17],map_xnat_archive_to_project:3,mark:[14,16],maskcentralslic:9,match:[0,3,4,6,10,12,13,14,17,19],match_dm_to_bid:6,matlab:[20,22],matlabpath:[0,19],maxabsrm:[0,19],maxim:16,maximum:[0,19],maxrelrm:[0,19],mean:[0,17,19],mean_fd:[0,19],mean_sfnr:[0,19],meanabsrm:[0,19],meanrelrm:[0,19],meant:[14,17],measur:[0,19],measures:[0,19],mem:13,merg:3,messag:[5,6,13,17],meta:[17,18,22],metadata:[14,18],metadata_path:11,metadataexcept:[5,13],method:[1,6,12,17],metric:[0,1,2,17,19,22],metricdti:9,might:12,minc:22,mind:17,minu:[6,18],miss:6,mm:[0,19],mnc:17,mod:12,modal:[0,12,19],modalitylabel:18,model:6,modifi:[6,12,14,15,17],modul:[1,2,19],montag:9,more:[0,12,13,14,16,17,18,19],most:[0,3,6,7,17,19],mostli:14,motion:[0,19],mount:17,move:6,move_fil:6,mr:12,mrfolder:17,mrftppass:17,mri:[0,17,19],mruser:17,multicent:[0,19],multipl:[3,4,12,17,18],mung:13,must:[6,9,13,17,18,22],my_instru:17,my_zip_list:11,myftppass:17,myproject:17,myredcapserv:17,myriad:[0,19],myscan:17,mysftp:17,mystudi:17,mystudy_ut1:17,mysystem:17,mytoken:17,myuser:17,myxnat:17,n_bad_fd:[0,19],name:[0,3,4,6,9,10,11,12,13,14,17,18,19,20,22],name_map:6,nativ:12,nb0:[0,19],ncbi:[0,19],nd:17,ndir:[0,19],necessari:16,need:[0,6,9,14,16,17,19,20],needs_raw_data:6,network:[0,19],neuroimag:[0,19],new_entri:11,new_nam:14,newer:22,next:17,nf:17,nibabel:[0,19],nicknam:13,nifti:[0,6,8,9,10,17,18,19],nifti_basenam:13,nifti_path:6,nightli:17,nih:[0,19],nii:[0,6,9,10,13,17,18,19,22],nii_input:9,nii_link:6,niiexport:6,niilinkexport:6,nlm:[0,19],nois:[0,19],non:[12,13,14,17],none:[3,4,5,6,7,8,9,10,12,13,14,22],norm:17,note:[6,13,14,17,18,20,22],noth:14,nrrd:[17,22],num:12,number:[0,6,12,13,17,19],numer:[12,17],nyquistratio:9,obei:10,object:[3,6,7,9,10,11,12,13,14],obnoxi:14,obtain:[0,19],obvious:14,off:[0,13,19],offici:18,often:17,old:[16,17],old_nam:14,omit:[16,17],ommit:13,onc:[17,20],one:[0,6,12,14,16,17,18,19],ones:[0,15,19],onli:[0,3,13,14,17,19,22],onto:3,open:[4,14,16],open_sess:14,open_zipfil:13,oper:4,option:[4,6,9,10,12,13,14,16,18,20,22],order:[9,13],organ:[6,13,14,17],orig_id:12,orig_zip_name1:18,orig_zip_namen:18,origin:[6,12,13,17,22],os:[3,13],oserror:13,other:[0,6,12,13,14,16,17,19,20],otherwis:[6,13,14,17],otherxnat:17,our:[0,16,17,18,19],out:[10,17,20],outcount:[0,19],outcount_bx:[0,19],outlier:[0,19],outmax:[0,19],outmax_bx:[0,19],outmean_bx:[0,19],outmin:[0,19],output:[6,7,9,11,13,14,17,20],output_dir:[6,9,14],output_path:8,outputs_exist:6,outsid:17,over:[0,19],overrid:[3,6,10,19,22],overridden:[3,17],overwrit:[0,9,19],overwritten:13,own:[14,17,18,20],p:[12,17],pa:[6,18],packag:[0,1,16,19],page:[17,18,19,22],pair:17,par:9,par_id:17,paramet:[4,6,7,9,10,12,13,14,17],parent:[10,13,14,17],parentdir:13,pars:[0,5,7,12,13,14,19],parse_bids_filenam:12,parse_fil:8,parse_filenam:[12,13],parse_recon_don:7,parseexcept:[5,10,12,13],part:[3,13,17],partial:13,particip:[5,22],particular:6,partit:13,pass:[11,13,16,18],password:[13,14,17,20,22],path:[3,6,7,9,10,12,13,14,16,20,22],path_typ:3,patientnam:[11,18],pattern:3,pdf:[0,19],peopl:16,pep8:[15,16],pepolar_dwi_fmap:18,pepolar_rest_fmap:18,per:[0,17,19],perform:[0,18,19],permiss:13,person:13,pha:12,pha_:12,pha_pattern:12,pha_r:12,pha_typ:12,phantom:[0,4,12,17,19],phantomlab:[0,19],phaseencodingdirect:18,pip:[16,20],pipelin:[0,13,14,17,18,19],pixel:9,place:[0,17,19],plain:17,plan:20,pleas:[0,3,16,19],plot:9,png:9,pngappend:9,point:[0,6,17,19,22],popul:[6,14,18],port:[14,17],portion:[12,17],portnum:14,possibl:[3,6,16],post:14,power:[0,19],pr:16,practic:[0,13,19],pre:[0,17,18,19],prearchiv:[0,19],prefer:17,preferenti:13,prefix:[0,13,16,19,22],present:17,preserv:[13,17],prevent:[14,17],previou:6,previous:6,primari:[0,19],primarycontact:17,probabl:6,problem:[0,19],process:[0,13,18,19],processed_scan:11,produc:14,program:[13,19],program_nam:13,project:[0,3,14,19],projectdir:17,properti:[3,6,9,10,12],protocol:[0,19],provid:[13,17,20],proxi:3,pubm:[0,19],pull:[4,15,16,17],push:22,put:[13,22],put_dicom:14,put_resourc:14,py:[0,3,15,17,18,19,20],pylint:16,pyproject:16,pytest:16,python3:15,python:[0,13,15,17,19],pythonpath:[0,19],qa:[0,9,19],qa_dti:17,qaphametr:9,qascript:[0,19],qc:[0,6,9,13,17,18,19,22],qc_:[0,19],qc_study_cmh_0000_01:18,qc_study_cmh_0001_01:18,qcexcept:[5,9],qcing:[0,19],qcmon:[0,19,20],qcoutput:9,qcpha:17,qctype:17,qualifi:17,qualiti:18,queri:[14,17],queu:[13,14],queue:[13,17],r2014a:22,ra:17,radiu:[0,19],rais:[3,4,9,10,12,13,14],ran:20,rather:[0,19,20],ratio:[0,19],raw:[0,5,6,17,18,19,22],raw_data_dir:6,raw_dicoms_exist:14,re:[0,3,12,13,19],read:[0,3,4,13,14,17,18,19],read_blacklist:13,read_checklist:13,read_credenti:13,read_json:[8,13],read_log:7,read_manifest:9,readabl:[16,17],real:13,reason:18,rec:12,receiv:[4,17],recon_don:7,record:[17,18],record_id_field:17,recurs:13,redcap:[15,20,22],redcap_token:[17,20,22],redcapapiurl:17,redcapcom:17,redcapd:17,redcapeventid:17,redcapinstru:17,redcapprojectid:17,redcaprecordkei:17,redcapstatu:17,redcapstatusvalu:17,redcapsubj:17,redcaptoken:17,redcapurl:17,redefin:17,reduc:18,ref:[15,16],refactor:16,refer:[14,17],referenc:6,regex:17,regular:17,reject:12,rel:[0,7,17,19],releas:[15,16],release_db:4,relev:16,remotelogin:17,remoteprojectid:17,remov:[6,13,15,16,17,22],remove_empty_fil:13,remove_field:8,renam:[14,18],rename_exp:14,rename_experi:14,rename_subject:14,repeat:6,repeatedli:13,repetitiontim:17,replac:[16,20],report:[0,6,7,14,17,19],report_error:6,report_issu:6,request:[14,16,17],requir:[0,6,9,14,19,20],reson:[0,19],resourc:[6,14,17,22],resource_group_id:14,resource_id:14,respect:[6,17],respons:14,rest:[0,19],rest_dir:18,restrict:[3,12,14],result:[3,9,12],retri:[13,14],retriev:[6,12,14,17,18,20,22],returncod:13,reus:4,revers:17,review:18,right:17,risk:18,roi:[0,19],rollback:4,root:[0,10,18,19,20],rootdir:20,round:15,rst:[17,18],run:[0,4,6,7,9,12,13,14,16,17,18,19,20,22],run_dummy_q:13,s1:[0,19],s2:[0,19],s3:[0,19],s4:[0,19],s5:[0,19],s:[0,3,4,6,9,12,13,14,16,17,18,19,20,22],sag:17,sag_mprage_t1:18,same:[0,4,6,13,14,17,18,19,22],save:[11,13],scan:[0,1,2,6,9,11,12,13,14,17,19,22],scan_entry_class:11,scan_id:14,scan_json:14,scan_list:[1,2],scan_path:11,scan_pattern:12,scan_r:12,scan_tag:6,scanentryabc:11,scanid:[1,2,4,10,13,14,15],scanid_requir:4,scanlength:9,scans_csv:11,scheme:[10,17,22],scipi:[0,19],scope:6,scrape:7,scrape_log:7,script:[0,4,7,11,13,15,17,18,19,20],se:12,search:[3,6,13,14,17,19],second:[16,17,18],section2:9,section:17,see:[0,12,13,17,18,19],seemingli:14,self:[9,11],sensit:[12,16,17],sent:17,separ:[13,17,18],seri:[0,4,6,8,10,12,13,14,17,18,19],series_json:8,series_map:3,series_path:8,seriesdescript:[12,17,18],seriesexport:6,server:[14,17,22],server_cach:14,serverlogdir:17,session:[3,5,6,9,10,12,13,14,17,18,22],sessionexport:6,set:[0,3,4,6,9,12,13,14,18,19,20,22],set_datman_nam:14,set_output:9,set_studi:3,set_study_statu:4,set_tag:14,setup:[0,19],sfnr:9,sftp:[17,22],sge:17,share:[3,6,14,18],sharedexport:6,shell:[13,17],shell_cmd:13,should:[6,11,12,13,14,16,17,18,20],show:17,shown:20,side:[6,17],side_car:6,sidecarchang:18,sign:13,signal:[0,19],similar:[12,13],sinc:13,singl:[0,6,9,10,12,13,14,17,19,20],sit:[0,19],site:[3,4,12,13,14],site_set:3,sitetag:3,size:9,slice:9,slicer:[9,22],slightli:13,slurm:[13,17],small:17,snr:[0,19],snrimg:9,so:[0,3,13,14,19],sofia:[0,19],softwar:[20,22],some:[6,12,16,18,20,22],somefold:17,sometim:14,sophist:13,sourc:[3,4,5,6,7,8,9,10,11,12,13,14,17],source_dir:13,source_id:4,source_nam:18,space:[13,18],special:13,specialquot:13,specif:[1,3,4,13,14,17,20],specifi:[3,4,12,13,14,17,18],spectra:[0,19],spikecount:9,spin:[3,4,17],split:[6,13,17],split_path:13,splitext:13,spn01:[3,4],spn01_zhh_0018_01_01_rst_06_rest:[0,19],sprl:17,spuriou:[0,19],squar:[0,19],stack:[0,19],standard:[0,7,8,16,19,22],standard_json:8,standard_log:7,standard_path:8,standards_dict:7,standards_field:7,start:17,start_new_scan_list:11,state:[0,4,14,19],statu:14,std:[17,22],stdout:13,stdplotshist:9,stem:6,still:[9,17,20],stop_after_first:13,store:[6,10,14,17,18],str:[6,9,10,12,13,14],strict:14,string:[4,6,9,12,13,14,17],strip:16,stroke:[0,19],structur:[0,14,17,18,19],stu01:17,stu01_uto_10001_01_se01_mr:17,stuck:[4,14],studi:[0,3,4,5,6,10,12,13,14,18,19,20,22],study1:17,study1_config:17,study1_site_0000_01_01:18,study1_site_0001_01_01:18,study1_ut2_abc0001_01_01:17,study2_site_0000_01_01:18,study2_site_0001_01_01:18,study3_site_0000_01_01:18,study_config:[3,17],study_config_fil:3,study_nam:3,study_nicknam:20,study_requir:3,study_site_0000_01_01_tag_00:18,studya:17,studyb:17,studyb_cmh:17,studyc:17,studyid:18,studytag:[3,17],style:[4,6,12,13,14,16,17],sub:5,sub_id_field:17,subclass:[6,11,12],subfold:[13,14],subject:[0,4,7,9,10,11,12,13,14,15,17,18,19],subject_field:7,subject_id:[10,13,14],subject_json:14,subject_log:7,subject_nam:14,submit:[13,17],submit_job:13,submodul:1,subset:[17,18],success:[13,14],suffix:[12,13],suppli:[3,13],support:[12,13],survei:[17,22],symlink:[6,22],system:[3,13,17,20],system_config:3,systemat:[0,11,19],systemset:20,t1:[0,17,18,19],t1w:18,t2:17,t2w_spc_vnav:17,t:[0,4,6,9,12,13,14,16,17,19,20],tabl:17,tag:[0,3,4,6,10,12,13,14,16,17,19],tag_map:14,taginfo:3,take:[0,3,6,7,13,17,19],taken:[0,6,19],tar:13,tarbal:[0,13,19],target:13,target_nam:18,target_subject:18,task:[12,22],taskregex:17,tech:[6,13],technic:12,technot:13,tell:[14,16],temp:6,tempfil:14,templat:17,tempor:[0,19],temporari:[14,17],tend:14,termin:4,test:[16,17],text:22,than:[14,17,20],thei:[0,3,13,17,18,19],them:[3,12,14,16,17,22],thi:[0,3,4,6,10,11,12,13,14,16,17,18,19,20,22],thing:[0,19],third:18,those:12,though:[14,20],three:[0,9,17,19],through:[0,6,14,19],tigrlab:[0,19,20],tigrlab_scan_completed_complet:17,time:[0,12,13,19],timepoint:12,timeseri:[0,19],titl:[9,16,17],tmp:[13,17],todai:[0,19],token:[17,20,22],toler:[8,17],toml:16,tool:[17,18,22],top:2,tr:[0,19],track:[0,19],transact:4,translat:[12,17],treat:17,trigger:17,tsnr:[0,19],tsnr_bx:[0,19],tsv:22,tumor:[0,19],tune:17,tupl:[12,14],two:[0,3,6,17,18,19],txt:[13,17],type:[0,3,6,9,12,13,14,16,17,18,19,20,22],typo:17,u:20,unabl:14,unassign:[0,19],undefin:17,undefinedset:[3,5],under:[0,6,14,19],undergo:18,unexpect:14,uniform:10,uniqu:[6,17],unit:16,univers:6,unless:13,unlik:17,unset:[14,17],until:[4,13],up:[0,6,13,14,17,19],updat:[13,15,16,20],update_blacklist:13,update_checklist:13,update_expected_output:9,update_scans_csv:11,upload:[14,17,22],uri:14,url:[14,17],us:[0,3,5,7,9,11,12,13,14,16,17,18,19,20,22],use_bid:[6,13],user:[12,14,17,18,20,22],user_nam:13,usernam:[14,17,20,22],usesredcap:17,usual:17,ut1:[12,17],ut2:[12,17],util:[1,2,8,20],uto:[12,17],v:20,valid:[6,10,12,14],validate_subject_id:13,valu:[0,3,8,10,12,13,17,18,19],variabl:[3,13,14,15,17,20,22],variou:17,vector:[0,19],verbos:13,veri:16,verifi:13,verify_standard:7,versa:17,version:[13,15,16,22],versu:14,vice:17,visual:9,voxel:[0,19],wa:[0,3,6,13,14,17,18,19],wai:[11,14,17,20],wait:4,walltim:13,want:[12,13,20],warn:10,we:[0,13,16,19],weight:[0,19],welcom:16,well:[4,22],were:[13,17],what:[0,16,17,19],whatev:[17,18],when:[0,4,11,12,13,14,16,17,18,19],whenev:[6,16],where:[3,6,10,11,13,14,17],whether:[6,13,14,17],which:[0,3,6,13,17,18,19],who:[12,13,17,20],whole:[0,19],why:18,wide:[3,14],width:9,wish:13,within:[4,12,13,14,17,18,20],without:[0,3,6,13,16,19,20],work:[4,6,13,17,22],workdir:13,workflow:14,would:17,wrap:4,wrapper:3,write:[0,6,9,13,16,17,19],write_diff_log:8,write_json:13,write_manifest:9,write_metadata:13,wrong:[11,18],www:[0,19],x:13,xml:14,xnat:[0,1,2,3,5,6,19,20,22],xnat_conn:14,xnat_connect:14,xnat_cr:13,xnat_fetch_sess:[17,19],xnat_pass:[17,20,22],xnat_url:13,xnat_us:[17,20,22],xnatarch:17,xnatconnect:13,xnatconvent:17,xnatcredenti:17,xnatexcept:[5,14],xnatexperi:[6,14],xnatlogin:17,xnatobject:14,xnatport:[14,17],xnatscan:14,xnatserv:17,xnatsourc:[17,22],xnatsourcearch:17,xnatsourcecredenti:17,xnatsubject:14,xxx:17,yaml:[3,17],yet:13,yml:[17,20],you:[0,3,12,13,16,17,18,19,20],your:[0,16,17,19,20],yrk:17,z0:12,z:12,zero:13,zip:[11,13,14,17,18,22],zip_fil:11,zip_nam:14,zipfil:[0,13,14,19]},titles:["Introduction","Library API (application program interface)","datman package","datman.config module","datman.dashboard module","datman.exceptions module","datman.exporters module","datman.fs_log_scraper module","datman.header_checks module","datman.metrics module","datman.scan module","datman.scan_list module","datman.scanid module","datman.utils module","datman.xnat module","What\u2019s new?","Contributing to Datman","Configuration Files","Other important files","datman","Installation","<no title>","Script Overview"],titleterms:{"export":6,"import":18,"new":15,api:1,applic:1,blacklist:[17,18],checklist:18,config:3,configur:17,contain:20,contribut:16,control:[0,19],csv:18,dashboard:4,datman:[0,2,3,4,5,6,7,8,9,10,11,12,13,14,16,19],dcm2bid:18,dm_blacklist_rm:22,dm_link:22,dm_link_shared_id:22,dm_parse_fac:22,dm_qc_report:22,dm_redcap_scan_complet:22,dm_sftp:22,dm_task_fil:22,dm_xnat_extract:22,dm_xnat_upload:22,docker:20,exampl:[17,18],except:5,exportinfo:17,exportset:17,extern:18,file:[17,18],fs_log_scrap:7,ftp:17,glossari:17,gold:17,header_check:8,idmap:17,indic:19,instal:20,interfac:1,introduct:[0,19],json:18,librari:1,link:18,log:17,metadata:17,metric:9,modul:[3,4,5,6,7,8,9,10,11,12,13,14],option:17,other:18,overrid:17,overview:[0,19,22],packag:2,path:17,pattern:17,program:1,project:17,qualiti:[0,19],redcap:17,requir:17,s:15,scan:[10,18],scan_list:11,scanid:12,script:22,set:17,site:17,standard:17,studi:17,submodul:2,systemset:17,tabl:19,task:17,util:13,what:15,xnat:[14,17],xnat_fetch_sess:22}}) \ No newline at end of file