Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

These documents are designed for all types of users of XNAT.

It's important to note that your role as a user is defined by the project that you are working in. In a typical XNAT, any person can create a project and upload data, thereby becoming a "Project Owner." This gives you full permissions to create, upload, modify and delete data within that project. However, in someone else's project, you may be given fewer permissions as a Project Member or Project Collaborator. Learn more about user permissions in XNAT. 

Also, your XNAT administrator may have created custom roles within XNAT, which could be tied to specific user workflows. If there are differences between your XNAT screen and the screenshots seen here, these user permission and accessibility settings may be a contributing factor.

User Registration and Login

...

User Registration and Accounts in XNAT

...

Create from template
templateName29425665
templateId29425665
titlePassword Reset and User Lockout Settings
buttonLabelCreate: Password Reset and User Lockout Settings

Create from template
templateName29425665
templateId29425665
titleInviting Users via Email
buttonLabelCreate: Inviting Users via Email

 

Related Topics:

Content by Label
showLabelsfalse
showSpacefalse
cqllabel = "xnat-users"
labelsxnat-users


Project Setup

Any registered user can create a project in XNAT, unless an administrator has removed that ability. 

How To Create and Manage Projects

Related Topics:

Content by Label
showLabelsfalse
showSpacefalse
sort

...

title

...

cqllabel = "xnat-projects"

 

Within Project Admin, create sub-pages: 

  • Data Import and Anonymization Settings
  • Notification Settings
  • Adding and Configuring Pipelines for your Project
  • Working with Custom Variables

Create from template
templateName29425665
templateId29425665
titleAdding Resource Files to Projects
buttonLabelCreate: Adding Resource Files to Projects

 

labelsxnat-projects


Project Administration

Info

All Project Admin tasks are accessible in the "Manage" tab at the top of the project report page, unless otherwise specified.

Content by Label
showLabelsfalse
showSpacefalse
cqllabel = "project-admin"
labelsproject-admin



Working With Subjects

Info

These activities can be performed by Project Owners and Project Members

Create from template
templateName29425665
templateId29425665
titleCreating Subjects
buttonLabelCreate: Creating Subjects

Create from template
templateName29425665
templateId29425665
titleCustomizing Subject Metadata with Custom Variables
buttonLabelCreate: Customizing Subject Metadata with Custom Variables

Create from template
templateName29425665
templateId29425665
titleAdding Resource Files to Subjects
buttonLabelCreate: Adding Resource Files to Subjects

 

How to Create and Manage Subjects

Related topics:

Content by Label
showLabelsfalse
showSpacefalse
sorttitle
operatorAND
cqllabel = "xnat-subjects" and label = "using-xnat"
labelsusing-xnat xnat-subjects



Uploading Image Data to XNAT

Info

Data uploads can be performed by any Project Owner or Project Collaborator, or any other role with "Create" permissions on your project.

XNAT Supports multiple image session types out of the box. The most commonly used are MR, PET and CT. Additional image session types, (e.g. MEG) can be added by your XNAT Administrator. See Adding Data Types to XNAT

Create from template
templateName29425665
templateId29425665
titleImage Session Upload Methods
buttonLabelCreate: Image Session Upload Methods

Create from template
templateName29425665
templateId29425665
titleHow to Send Image Data to XNAT from a Scanner
buttonLabelCreate from template: How to Send Image Data to XNAT from a Scanner

Create from template
templateName29425665
templateId29425665
titleHow to Query PACS for an Image Session
buttonLabelCreate from template: How to Query PACS for an Image Session

Create from template
templateName29425665
templateId29425665
titleDICOM Anonymization Settings
buttonLabelCreate from template: DICOM Anonymization Settings

Create from template
templateName29425665
templateId29425665
titleUsing the Prearchive
buttonLabelCreate from template: Using the Prearchive

Create from template
templateName29425665
templateId29425665
titleHow XNAT Merges Image Sessions on Re-upload
buttonLabelCreate from template: How XNAT Merges Image Sessions on Re-upload

Create from template
templateName29425665
templateId29425665
titleScan Type Cleanup
buttonLabelCreate from template: Scan Type Cleanup

Create from template
templateName29425665
templateId29425665
title Working with PET Sessions
buttonLabelCreate from template: Working with PET Sessions

Create from template
templateName29425665
templateId29425665
titleWorking with PET-MR Sessions
buttonLabelCreate from template: Working with PET-MR Sessions

 

How To Upload Image Sessions

Related topics:

Content by Label
showLabelsfalse
showSpacefalse
sorttitle
operatorAND
cqllabel = "using-xnat" and label = "uploading-data"
labelsusing-xnat uploading-data



Uploading Experiment Data to XNAT

Info

Data uploads can be performed by any Project Owner or Project Collaborator, or any other role with "Create" permissions on your project.

When any data type is added to XNAT, it will automatically have a data entry form created. (Some data types will have custom-formatted data entry forms.) Data can be entered manually, or it can be imported in bulk using our CSV uploader. 

Create from template
templateName29425665
templateId29425665
titleUsing the CSV Uploader
buttonLabelCreate from template: Using the CSV Uploader

 

Content by Label
showLabelsfalse
showSpacefalse
cqllabel = "uploading-expt-data"
labelsuploading-expt-data


Working with Scans

From an image session report page, users can compare scan details, add qualitative notes, open scans in the Image Viewer, download or delete scans. With XNAT 1.7.3, your system can be extended with the Selectable Table plugin to make scan operations even easier to use.

Content by Label
showLabelsfalse
showSpacefalse
cqllabel = "working-with-scans"



Running Pipelines and Containers on Project Data

Pipelines must be installed in XNAT by an XNAT administrator before they can be configured and used in your projects. Likewise, container actions for images and scripts must be configured by an XNAT Administrator. See Installing Pipelines

...

in XNAT

...

for more details.

Create from template
templateName29425665
templateId29425665
titleRunning Pipelines
buttonLabelCreate from template: Running Pipelines

Create from template
templateName29425665
templateId29425665
titleRunning Actions in Containers
buttonLabelCreate from template: Running Actions in Containers

 

Content by Label
showLabelsfalse
showSpacefalse
cqllabel in ("xnat-computing","xnat-pipelines")
labelsxnat-pipelines xnat-computing



Downloading Data from XNAT

Info

Any user with read access to your project data can download your project data.

Create from template
templateName29425665
templateId29425665
titleUsing the Image Downloader
buttonLabelCreate from template: Using the Image Downloader

 

How To Download Image Data From XNAT Projects

Related Topics:

Content by Label
showLabelsfalse
showSpacefalse
operatorAND
cqllabel = "xnat-downloads"
labelsxnat-downloads


Searching, Reporting and Data Mining

Info

Any user with read access to your project data can see that data in their searches.

Create from template
templateName29425665
templateId29425665
titleUsing the Standard Search
buttonLabelCreate from template: Using the Standard Search

Create from template
templateName29425665
templateId29425665
titleCreating an Advanced Search
buttonLabelCreate from template: Creating an Advanced Search

Create from template
templateName29425665
templateId29425665
titleBrowsing Data Types
buttonLabelCreate from template: Browsing Data Types

Create from template
templateName29425665
templateId29425665
titleEditing and Filtering Data Tables
buttonLabelCreate from template: Editing and Filtering Data Tables

Create from template
templateName29425665
templateId29425665
titleSaving Searches
buttonLabelCreate from template: Saving Searches

 

Content by Label
showLabelsfalse
showSpacefalse
cqllabel = "xnat-reporting"
labelsxnat-reporting


Sharing Data Within XNAT

Info

Any user with read access to your project data can share a copy of that data into their own project. The user will have project ownership of their project, but will not be able to directly modify their copy of the shared data.

Create from template
templateName29425665
templateId29425665
titleShare an Image Session
buttonLabelCreate from template: Share an Image Session

Create from template
templateName29425665
templateId29425665
titleShare a Subject and its Subject Assessors
buttonLabelCreate from template: Share a Subject and its Subject Assessors

Understanding Data Sharing in XNAT's Security Structure

Related Topics:

Content by Label
showLabelsfalse
showSpacefalse
cqllabel = "xnat-sharing"
labelsxnat-sharing

Using Anonymization within XNAT

XNAT frequently needs to examine and alter the contents of image objects. Uses include:

  1. Remove Protected Health Information (PHI)
  2. Re-identify with experiment-required identifiers
  3. Enable automatic mapping of Image objects into XNAT's Project/Subject/Session data model.
  4. Create custom functions. (e.g. DIAN project functions, send session/visit from XNAT )

Where Anonymization Happens in XNAT

How to Write an Anonymization Script

Advanced Topics in XNAT Usage

Content by Label
showLabelsfalse
showSpacefalse
operatorAND
cqllabel = "advanced-usage" and label = "using-xnat"
labelsusing-xnat advanced-usage