Index

_

__enter__() (xnatctl.core.client.XNATClient method)

__exit__() (xnatctl.core.client.XNATClient method) __init__() (xnatctl.core.client.XNATClient method)

A

accessibility (xnatctl.models.project.Project attribute) acquisition_site (xnatctl.models.session.Session attribute) add_profile() (xnatctl.core.config.Config method) add_user_to_groups() (xnatctl.services.admin.AdminService method) AdminService (class in xnatctl.services.admin) age (xnatctl.models.session.Session attribute) archive() (xnatctl.services.prearchive.PrearchiveService method) archive_destination_params() (in module xnatctl.services.uploads)

archive_mode (xnatctl.core.config.Profile attribute) ARCHIVING (xnatctl.models.progress.OperationPhase attribute) audit_log() (xnatctl.services.admin.AdminService method) AuditLogger (class in xnatctl.core.logging) authenticate() (xnatctl.core.client.XNATClient method) AuthenticationError AuthManager (class in xnatctl.core.auth) auto_reauth (xnatctl.core.client.XNATClient attribute)

B

base_url (xnatctl.core.client.XNATClient attribute) BaseModel (class in xnatctl.models.base) BaseService (class in xnatctl.services.base) batch_id (xnatctl.models.progress.UploadProgress attribute) batches_failed (xnatctl.models.progress.UploadSummary attribute) batches_succeeded (xnatctl.models.progress.UploadSummary attribute)

batches_total (xnatctl.models.progress.UploadSummary attribute) BatchOperationError bytes_percent (xnatctl.models.progress.DownloadProgress property) (xnatctl.models.progress.UploadProgress property) bytes_received (xnatctl.models.progress.DownloadProgress attribute) bytes_sent (xnatctl.models.progress.UploadProgress attribute)

C

cacheable (xnatctl.models.resource.Resource attribute) CachedSession (class in xnatctl.core.auth) cancel() (xnatctl.services.pipelines.PipelineService method) category (xnatctl.models.resource.Resource attribute) clear_session() (xnatctl.core.auth.AuthManager method) close() (xnatctl.core.client.XNATClient method) collect_dicom_files() (in module xnatctl.services.uploads) COMPLETE (xnatctl.models.progress.OperationPhase attribute) condition (xnatctl.models.scan.Scan attribute) Config (class in xnatctl.core.config)

ConfigurationError ConnectionError content (xnatctl.models.resource.Resource attribute) create() (xnatctl.services.projects.ProjectService method) (xnatctl.services.resources.ResourceService method) (xnatctl.services.sessions.SessionService method) (xnatctl.services.subjects.SubjectService method) create_progress() (in module xnatctl.core.output) create_spinner() (in module xnatctl.core.output) created_at (xnatctl.core.auth.CachedSession attribute) current (xnatctl.models.progress.Progress attribute)

D

dcm_accession_number (xnatctl.models.session.Session attribute) dcm_patient_id (xnatctl.models.session.Session attribute) dcm_patient_name (xnatctl.models.session.Session attribute) debug() (xnatctl.core.logging.LogContext method) default_profile (xnatctl.core.config.Config attribute) default_project (xnatctl.core.config.Profile attribute) delete() (xnatctl.core.client.XNATClient method) (xnatctl.services.prearchive.PrearchiveService method) (xnatctl.services.projects.ProjectService method) (xnatctl.services.resources.ResourceService method) (xnatctl.services.scans.ScanService method) (xnatctl.services.sessions.SessionService method) (xnatctl.services.subjects.SubjectService method) delete_multiple() (xnatctl.services.scans.ScanService method) description (xnatctl.models.project.Project attribute) DicomError

DicomParseError DicomStoreError DICOMStoreSummary (class in xnatctl.services.uploads) direct_archive (xnatctl.core.config.Profile attribute) display_id (xnatctl.models.base.XNATResource property) dob (xnatctl.models.subject.Subject attribute) download_resource() (xnatctl.services.downloads.DownloadService method) download_scan() (xnatctl.services.downloads.DownloadService method) download_scans() (xnatctl.services.downloads.DownloadService method) download_session() (xnatctl.services.downloads.DownloadService method) DownloadError DOWNLOADING (xnatctl.models.progress.OperationPhase attribute) DownloadProgress (class in xnatctl.models.progress) DownloadService (class in xnatctl.services.downloads) DownloadSummary (class in xnatctl.models.progress) duration (xnatctl.models.progress.OperationResult attribute)

E

education (xnatctl.models.subject.Subject attribute) ERROR (xnatctl.models.progress.OperationPhase attribute) error() (xnatctl.core.logging.LogContext method) errors (xnatctl.models.progress.OperationResult attribute) (xnatctl.models.progress.Progress attribute)

ethnicity (xnatctl.models.subject.Subject attribute) expires_at (xnatctl.core.auth.CachedSession attribute) extract (xnatctl.core.config.Profile attribute)

F

failed (xnatctl.models.progress.OperationResult attribute) (xnatctl.services.uploads.DICOMStoreSummary attribute) file_count (xnatctl.models.resource.Resource attribute) (xnatctl.models.scan.Scan attribute) file_name (xnatctl.models.progress.DownloadProgress attribute) file_path (xnatctl.models.progress.DownloadProgress attribute) (xnatctl.models.progress.UploadProgress attribute) file_size (xnatctl.models.resource.Resource attribute) (xnatctl.models.scan.Scan attribute)

file_size_display (xnatctl.models.resource.Resource property) file_size_mb (xnatctl.models.resource.Resource property) (xnatctl.models.scan.Scan property) format (xnatctl.models.resource.Resource attribute) frames (xnatctl.models.scan.Scan attribute) from_dict() (xnatctl.core.auth.CachedSession class method) (xnatctl.core.config.Profile class method) from_string() (xnatctl.core.output.OutputFormat class method)

G

gender (xnatctl.models.subject.Subject attribute) get() (xnatctl.core.client.XNATClient method) (xnatctl.services.pipelines.PipelineService method) (xnatctl.services.prearchive.PrearchiveService method) (xnatctl.services.projects.ProjectService method) (xnatctl.services.resources.ResourceService method) (xnatctl.services.scans.ScanService method) (xnatctl.services.sessions.SessionService method) (xnatctl.services.subjects.SubjectService method) get_audit_logger() (in module xnatctl.core.logging) get_credentials() (xnatctl.core.auth.AuthManager method) get_json() (xnatctl.core.client.XNATClient method) get_logger() (in module xnatctl.core.logging) get_profile() (xnatctl.core.config.Config method)

get_resources() (xnatctl.services.scans.ScanService method) (xnatctl.services.sessions.SessionService method) get_scans() (xnatctl.services.prearchive.PrearchiveService method) (xnatctl.services.sessions.SessionService method) get_server_info() (xnatctl.services.admin.AdminService method) get_session_info() (xnatctl.core.auth.AuthManager method) get_session_token() (xnatctl.core.auth.AuthManager method) get_sessions() (xnatctl.services.projects.ProjectService method) (xnatctl.services.subjects.SubjectService method) get_site_config() (xnatctl.services.admin.AdminService method) get_subjects() (xnatctl.services.projects.ProjectService method) get_token_from_env() (xnatctl.core.auth.AuthManager method) get_user() (xnatctl.services.admin.AdminService method) group (xnatctl.models.subject.Subject attribute)

H

handedness (xnatctl.models.subject.Subject attribute) has_errors (xnatctl.models.progress.Progress property)

has_profile() (xnatctl.core.config.Config method) has_valid_session() (xnatctl.core.auth.AuthManager method)

I

id (xnatctl.models.base.XNATResource attribute) info() (xnatctl.core.logging.LogContext method) insert_date (xnatctl.models.base.XNATResource attribute) insert_user (xnatctl.models.base.XNATResource attribute) invalidate_session() (xnatctl.core.client.XNATClient method) InvalidIdentifierError

InvalidPortError InvalidURLError is_authenticated (xnatctl.core.client.XNATClient property) is_complete (xnatctl.models.progress.Progress property) is_expired() (xnatctl.core.auth.CachedSession method) is_retryable_status() (in module xnatctl.services.uploads)

J

JSON (xnatctl.core.output.OutputFormat attribute)

L

label (xnatctl.models.base.XNATResource attribute) list() (xnatctl.services.pipelines.PipelineService method) (xnatctl.services.prearchive.PrearchiveService method) (xnatctl.services.projects.ProjectService method) (xnatctl.services.resources.ResourceService method) (xnatctl.services.scans.ScanService method) (xnatctl.services.sessions.SessionService method) (xnatctl.services.subjects.SubjectService method) list_files() (xnatctl.services.resources.ResourceService method)

list_jobs() (xnatctl.services.pipelines.PipelineService method) list_users() (xnatctl.services.admin.AdminService method) load() (xnatctl.core.config.Config class method) load_session() (xnatctl.core.auth.AuthManager method) log() (xnatctl.core.logging.LogContext method) log_context() (in module xnatctl.core.logging) log_dir (xnatctl.services.uploads.DICOMStoreSummary attribute) log_operation() (xnatctl.core.logging.AuditLogger method) LogContext (class in xnatctl.core.logging)

M

max_retries (xnatctl.core.client.XNATClient attribute) mb_received (xnatctl.models.progress.DownloadProgress property) mb_sent (xnatctl.models.progress.UploadProgress property) merge_subjects() (xnatctl.services.subjects.SubjectService method) message (xnatctl.models.progress.Progress attribute) modality (xnatctl.models.scan.Scan attribute) (xnatctl.models.session.Session attribute) model_config (xnatctl.models.base.BaseModel attribute) (xnatctl.models.base.XNATResource attribute) (xnatctl.models.project.Project attribute) (xnatctl.models.resource.Resource attribute) (xnatctl.models.scan.Scan attribute) (xnatctl.models.session.Session attribute) (xnatctl.models.subject.Subject attribute)

module xnatctl.core.auth xnatctl.core.exceptions xnatctl.core.logging xnatctl.core.output xnatctl.core.validation xnatctl.models.progress xnatctl.services.downloads xnatctl.services.uploads move() (xnatctl.services.prearchive.PrearchiveService method)

N

name (xnatctl.models.project.Project attribute) NetworkError

note (xnatctl.models.scan.Scan attribute) (xnatctl.models.session.Session attribute)

O

OperationError OperationPhase (class in xnatctl.models.progress) OperationResult (class in xnatctl.models.progress) operator (xnatctl.models.session.Session attribute)

output_format (xnatctl.core.config.Config attribute) output_path (xnatctl.models.progress.DownloadSummary attribute) OutputFormat (class in xnatctl.core.output) overwrite (xnatctl.core.config.Profile attribute)

P

paginate() (xnatctl.core.client.XNATClient method) password (xnatctl.core.client.XNATClient attribute) (xnatctl.core.config.Profile attribute) PathValidationError percent (xnatctl.models.progress.Progress property) PermissionDeniedError phase (xnatctl.models.progress.Progress attribute) pi (xnatctl.models.project.Project property) pi_firstname (xnatctl.models.project.Project attribute) pi_lastname (xnatctl.models.project.Project attribute) ping() (xnatctl.core.client.XNATClient method) PipelineService (class in xnatctl.services.pipelines) post() (xnatctl.core.client.XNATClient method) PrearchiveService (class in xnatctl.services.prearchive) PREPARING (xnatctl.models.progress.OperationPhase attribute) print_error() (in module xnatctl.core.output) print_info() (in module xnatctl.core.output)

print_json() (in module xnatctl.core.output) print_key_value() (in module xnatctl.core.output) print_output() (in module xnatctl.core.output) print_success() (in module xnatctl.core.output) print_table() (in module xnatctl.core.output) print_warning() (in module xnatctl.core.output) PROCESSING (xnatctl.models.progress.OperationPhase attribute) Profile (class in xnatctl.core.config) ProfileNotFoundError profiles (xnatctl.core.config.Config attribute) Progress (class in xnatctl.models.progress) Project (class in xnatctl.models.project) project (xnatctl.models.resource.Resource attribute) (xnatctl.models.scan.Scan attribute) (xnatctl.models.session.Session attribute) (xnatctl.models.subject.Subject attribute) ProjectService (class in xnatctl.services.projects) put() (xnatctl.core.client.XNATClient method)

Q

quality (xnatctl.models.scan.Scan attribute)

R

race (xnatctl.models.subject.Subject attribute) rebuild() (xnatctl.services.prearchive.PrearchiveService method) refresh_catalogs() (xnatctl.services.admin.AdminService method) remove_profile() (xnatctl.core.config.Config method) remove_user_from_groups() (xnatctl.services.admin.AdminService method) rename() (xnatctl.services.subjects.SubjectService method) rename_batch() (xnatctl.services.subjects.SubjectService method) rename_pattern() (xnatctl.services.subjects.SubjectService method)

Resource (class in xnatctl.models.resource) resource_count (xnatctl.models.session.Session attribute) ResourceError ResourceExistsError ResourceNotFoundError ResourceService (class in xnatctl.services.resources) RetryExhaustedError run() (xnatctl.services.pipelines.PipelineService method)

S

save() (xnatctl.core.config.Config method) save_session() (xnatctl.core.auth.AuthManager method) Scan (class in xnatctl.models.scan) scan_count (xnatctl.models.session.Session attribute) scan_id (xnatctl.models.resource.Resource attribute) scanner (xnatctl.models.scan.Scan attribute) (xnatctl.models.session.Session attribute) ScanService (class in xnatctl.services.scans) secondary_id (xnatctl.models.project.Project attribute) sent (xnatctl.services.uploads.DICOMStoreSummary attribute) series_description (xnatctl.models.scan.Scan attribute) ServerUnreachableError ses (xnatctl.models.subject.Subject attribute) Session (class in xnatctl.models.session) session_count (xnatctl.models.project.Project attribute) (xnatctl.models.subject.Subject attribute) session_date (xnatctl.models.session.Session attribute) session_id (xnatctl.models.progress.DownloadSummary attribute) (xnatctl.models.progress.UploadSummary attribute) (xnatctl.models.resource.Resource attribute) (xnatctl.models.scan.Scan attribute) session_token (xnatctl.core.client.XNATClient attribute) session_type (xnatctl.models.session.Session attribute) SessionExpiredError

SessionService (class in xnatctl.services.sessions) set_accessibility() (xnatctl.services.projects.ProjectService method) set_default_profile() (xnatctl.core.config.Config method) set_field() (xnatctl.services.sessions.SessionService method) set_note() (xnatctl.services.scans.ScanService method) set_quality() (xnatctl.services.scans.ScanService method) set_site_config() (xnatctl.services.admin.AdminService method) setup_logging() (in module xnatctl.core.logging) share() (xnatctl.services.sessions.SessionService method) split_into_batches() (in module xnatctl.services.uploads) split_into_n_batches() (in module xnatctl.services.uploads) src (xnatctl.models.subject.Subject attribute) start_time (xnatctl.models.scan.Scan attribute) status() (xnatctl.services.pipelines.PipelineService method) Subject (class in xnatctl.models.subject) subject_count (xnatctl.models.project.Project attribute) subject_id (xnatctl.models.session.Session attribute) subject_label (xnatctl.models.session.Session attribute) SubjectService (class in xnatctl.services.subjects) succeeded (xnatctl.models.progress.OperationResult attribute) success (xnatctl.models.progress.OperationResult attribute) (xnatctl.models.progress.Progress attribute) (xnatctl.services.uploads.DICOMStoreSummary attribute) success_rate (xnatctl.models.progress.OperationResult property)

T

TABLE (xnatctl.core.output.OutputFormat attribute) table_columns() (xnatctl.models.project.Project class method) (xnatctl.models.resource.Resource class method) (xnatctl.models.scan.Scan class method) (xnatctl.models.session.Session class method) (xnatctl.models.subject.Subject class method) throughput_mbps (xnatctl.models.progress.DownloadSummary property) (xnatctl.models.progress.UploadSummary property) time (xnatctl.models.session.Session attribute) timeout (xnatctl.core.client.XNATClient attribute) (xnatctl.core.config.Profile attribute) TimeoutError to_dict() (xnatctl.core.auth.CachedSession method) (xnatctl.core.config.Profile method) (xnatctl.models.base.BaseModel method) to_row() (xnatctl.models.base.BaseModel method) (xnatctl.models.project.Project method) (xnatctl.models.resource.Resource method) (xnatctl.models.scan.Scan method) (xnatctl.models.session.Session method) (xnatctl.models.subject.Subject method)

token (xnatctl.core.auth.CachedSession attribute) total (xnatctl.models.progress.OperationResult attribute) (xnatctl.models.progress.Progress attribute) total_bytes (xnatctl.models.progress.DownloadProgress attribute) (xnatctl.models.progress.UploadProgress attribute) total_files (xnatctl.models.progress.DownloadSummary attribute) (xnatctl.models.progress.UploadSummary attribute) (xnatctl.services.uploads.DICOMStoreSummary attribute) total_mb (xnatctl.models.progress.DownloadProgress property) (xnatctl.models.progress.UploadProgress property) total_size_mb (xnatctl.models.progress.DownloadSummary attribute) (xnatctl.models.progress.UploadSummary attribute) TransferCircuitBreakerError TransferConfigError TransferConflictError TransferError TransferVerificationError type (xnatctl.models.scan.Scan attribute)

U

upload_dicom() (xnatctl.services.uploads.UploadService method) upload_dicom_gradual() (xnatctl.services.uploads.UploadService method) upload_dicom_gradual_files() (xnatctl.services.uploads.UploadService method) upload_dicom_parallel() (xnatctl.services.uploads.UploadService method) upload_dicom_store() (xnatctl.services.uploads.UploadService method) upload_directory() (xnatctl.services.resources.ResourceService method) upload_file() (xnatctl.services.resources.ResourceService method) upload_id (xnatctl.models.progress.UploadSummary attribute) upload_resource() (xnatctl.services.uploads.UploadService method) upload_with_retry() (in module xnatctl.services.uploads)

UploadError UPLOADING (xnatctl.models.progress.OperationPhase attribute) UploadProgress (class in xnatctl.models.progress) UploadService (class in xnatctl.services.uploads) UploadSummary (class in xnatctl.models.progress) uri (xnatctl.models.base.XNATResource attribute) url (xnatctl.core.auth.CachedSession attribute) (xnatctl.core.config.Profile attribute) username (xnatctl.core.auth.CachedSession attribute) (xnatctl.core.client.XNATClient attribute) (xnatctl.core.config.Profile attribute)

V

validate_ae_title() (in module xnatctl.core.validation) validate_archive_path() (in module xnatctl.core.validation) validate_dicom_directory() (in module xnatctl.core.validation) validate_path_exists() (in module xnatctl.core.validation) validate_path_writable() (in module xnatctl.core.validation) validate_port() (in module xnatctl.core.validation) validate_project_id() (in module xnatctl.core.validation) validate_project_list() (in module xnatctl.core.validation) validate_regex_pattern() (in module xnatctl.core.validation) validate_resource_label() (in module xnatctl.core.validation) validate_scan_id() (in module xnatctl.core.validation) validate_scan_ids_input() (in module xnatctl.core.validation)

validate_server_url() (in module xnatctl.core.validation) validate_session_id() (in module xnatctl.core.validation) validate_subject_id() (in module xnatctl.core.validation) validate_timeout() (in module xnatctl.core.validation) validate_url_or_none() (in module xnatctl.core.validation) validate_workers() (in module xnatctl.core.validation) validate_xnat_identifier() (in module xnatctl.core.validation) ValidationError verified (xnatctl.models.progress.DownloadSummary attribute) verify_ssl (xnatctl.core.client.XNATClient attribute) (xnatctl.core.config.Profile attribute) visit_id (xnatctl.models.session.Session attribute)

W

wait() (xnatctl.services.pipelines.PipelineService method) warning() (xnatctl.core.logging.LogContext method)

whoami() (xnatctl.core.client.XNATClient method) workers (xnatctl.core.config.Profile attribute) workspace (xnatctl.services.uploads.DICOMStoreSummary attribute)

X

XNATClient (class in xnatctl.core.client) xnatctl.core.auth module xnatctl.core.exceptions module xnatctl.core.logging module xnatctl.core.output module xnatctl.core.validation module

xnatctl.models.progress module xnatctl.services.downloads module xnatctl.services.uploads module XNATCtlError XNATResource (class in xnatctl.models.base) xsi_type (xnatctl.models.base.XNATResource attribute)

Y

yob (xnatctl.models.subject.Subject attribute)