Generated XSD classes

XSD Classes Documentation

This is an overview of all generated classes based on the XSD files of central.xnat.org, without any extension types (only the default XSD files that come with XNAT 1.7)

class xnat.classes.AbstractDemographicData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATNestedObjectMixin

class xnat.classes.AbstractProtocol(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATNestedObjectMixin

data_type

Property of type: str

description

Property of type: str

id

Property of type: str

name

Property of type: str

class xnat.classes.AbstractResource(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, data_dir=None, upload_method=None, **kwargs)

Bases: xnat.classes.XNATObjectMixin

SECONDARY_LOOKUP_FIELD = 'label'
data

The data of the current object (data fields only)

download(path, verbose=True)
download_dir(target_dir, verbose=True)

Download the entire resource and unpack it in a given directory

Parameters:
  • target_dir (str) – directory to unpack to
  • verbose (bool) – show progress
file_count
file_size
files
fulldata

The full data of the current object (incl children, meta etc)

label

Property of type: str

note

Property of type: str

tags

listing of xnat.classes.AbstractResourceTags

upload(data, remotepath, overwrite=False, extract=False, **kwargs)
upload_dir(directory, overwrite=False, method='tgz_file', **kwargs)

Upload a directory to an XNAT resource. This means that if you do resource.upload_dir(directory) that if there is a file directory/a.txt it will be uploaded to resource/files/a.txt

The method has 5 options, default is tgz_file:

  1. per_file: Scans the directory and uploads file by file
  2. tar_memory: Create a tar archive in memory and upload it in one go
  3. tgz_memory: Create a gzipped tar file in memory and upload that
  4. tar_file: Create a temporary tar file and upload that
  5. tgz_file: Create a temporary gzipped tar file and upload that

The considerations are that sometimes you can fit things in memory so you can save disk IO by putting it in memory. The per file does not create additional archives, but has one request per file so might be slow when uploading many files.

Parameters:
  • directory (str) – The directory to upload
  • overwrite (bool) – Flag to force overwriting of files
  • method (str) – The method to use
class xnat.classes.AbstractResourceTags(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

name

Property of type: str

class xnat.classes.AbstractStatistics(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATNestedObjectMixin

class xnat.classes.AbstractSubjectMetadata(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATNestedObjectMixin

class xnat.classes.AddField(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.LONGVARCHAR

name

Property of type: str

class xnat.classes.AddFieldString(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

add_field

Property of type: str

class xnat.classes.AddIDString(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

add_id

Property of type: str

class xnat.classes.AdditionalStatisticsDouble(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

additional_statistics

Property of type: float

class xnat.classes.Algorithm(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATNestedObjectMixin

family

Property of type: listing of xnat.classes.DicomCodedValue

name

Property of type: str

name_code

Property of type: listing of xnat.classes.DicomCodedValue

parameters

Property of type: str

source

Property of type: str

version

Property of type: str

class xnat.classes.AliasString(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

alias

Property of type: str

class xnat.classes.ComputationData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATNestedObjectMixin

name

Property of type: str

source

Property of type: str

units

Property of type: str

value

Property of type: str

class xnat.classes.ContrastBolus(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATNestedObjectMixin

active_ingredient

Property of type: str

agent

Property of type: str

concentration

Concentration of active ingredient in diluted agent, in mg/ml

Property of type: float

flow_duration

In s

Property of type: float

flow_rate

In ml/s

Property of type: float

route

Administration route

Property of type: str

total_dose

Total amount of undiluted agent (in ml)

Property of type: float

volume

Total amount of diluted agent (in ml)

Property of type: float

class xnat.classes.CrScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.CrSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.CtScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

dcm_validation

Property of type: listing of xnat.classes.CtScanDataDcmvalidation

parameters

Property of type: listing of xnat.classes.CtScanDataParameters

class xnat.classes.CtScanDataDcmvalidation(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

status

Property of type: bool

class xnat.classes.CtScanDataParameters(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

acquisition_number

Number identifying the single continuous gathering of data over a period of time resulting in this image

Property of type: int

collection_diameter

Diameter of the region from which data were used to reconstruct this image, in mm

Property of type: float

collimation_width

Property of type: listing of xnat.classes.CtScanDataParametersCollimationwidth

contrast_bolus

Property of type: listing of xnat.classes.ContrastBolus

convolution_kernel

Label describing convolution kernel or algorithm used for reconstruction

Property of type: str

ct_divol

Computed Tomography Dose Index (CTDI_vol), according to IEC 60601-2-44, Ed. 2.1 (Clause 29.1.103.4); describes average dose for this image, in mGy

Property of type: float

derivation

Text description of how this image was derived

Property of type: listing of xnat.classes.CtScanDataParametersDerivation

distance_source_to_detector

Distance from source to detector center, in mm

Property of type: float

distance_source_to_patient

Distance from source to isocenter, in mm

Property of type: float

estimated_dose_saving

Percent value of dose saving due to modulation; negative value indicates increased exposure

Property of type: listing of xnat.classes.CtScanDataParametersEstimateddosesaving

exposure

in mA

Property of type: float

exposure_time

in ms

Property of type: float

filter

Label for the type of filter inserted into the x-ray beam

Property of type: str

focal_spots

Size of focal spot, in mm; if multiple values, small dimensions before large

listing of float

fov

Property of type: listing of xnat.classes.CtScanDataParametersFov

gantry_tilt

Nominal scanning gantry tilt angle, in degrees

Property of type: float

generator_power

Power to the x-ray generator, in kW

Property of type: float

image_type

Property of type: str

kvp

Peak output of X-ray generator, in kV

Property of type: float

options

Property of type: str

orientation

Property of type: str

pitch_factor

Ratio of table feed per rotation to total collimation width

Property of type: float

rescale

Relationship between stored values (SV) and Hounsfield (HU): HU=m*SV+b

Property of type: listing of xnat.classes.CtScanDataParametersRescale

rotation_direction

CW=clockwise; CC=counterclockwise

Property of type: str

subject_position

Property of type: str

table_feed_per_rotation

Motion of table during a complete revolution of the source around the gantry orbit, in mm

Property of type: float

table_height

Distance from top of patient table to center of rotation (below table > 0), in mm

Property of type: float

table_speed

in mm/s

Property of type: float

voxel_res

Property of type: listing of xnat.classes.CtScanDataParametersVoxelres

xray_tube_current

in mA

Property of type: float

class xnat.classes.CtScanDataParametersCollimationwidth(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

single

Width of a single row of acquired data, in mm

Property of type: float

total

Width of total collimation over the area of active x-ray detection, in mm

Property of type: float

class xnat.classes.CtScanDataParametersDerivation(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

class xnat.classes.CtScanDataParametersEstimateddosesaving(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

modulation

Label describing type of exposure modulation used to limit dose

Property of type: Unknown

class xnat.classes.CtScanDataParametersFov(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

x

Property of type: int

y

Property of type: int

class xnat.classes.CtScanDataParametersRescale(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

intercept

b

Property of type: Unknown

slope

m

Property of type: Unknown

class xnat.classes.CtScanDataParametersVoxelres(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

units

Property of type: str

x

Property of type: float

y

Property of type: float

z

Property of type: float

class xnat.classes.CtSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.DatatypeProtocol(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.AbstractProtocol

definitions

listing of xnat.classes.FieldDefinitionGroup

class xnat.classes.DcmValidationString(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

dcm_validation

Property of type: str

class xnat.classes.DelayInteger(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

delay

Property of type: int

class xnat.classes.DemographicData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.AbstractDemographicData

age

Property of type: int

birth_weight

Property of type: float

dob

Property of type: datetime.date

education

Property of type: int

education_desc

Property of type: str

employment
Employment status: 0: Employed 1: Unemployed 2: Retired 3: Unknown or N/A

Property of type: int

ethnicity

Property of type: str

gender

Property of type: str

gestational_age

Property of type: float

handedness

Property of type: str

height

Property of type: listing of xnat.classes.DemographicDataHeight

post_menstrual_age

Property of type: float

race

Property of type: str

race2

Property of type: str

race3

Property of type: str

race4

Property of type: str

race5

Property of type: str

race6

Property of type: str

ses

Socioeconomic status

Property of type: int

weight

Property of type: listing of xnat.classes.DemographicDataWeight

yob

Property of type: int

class xnat.classes.DemographicDataHeight(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

units

Property of type: str

class xnat.classes.DemographicDataWeight(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

units

Property of type: str

class xnat.classes.DerivationString(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

derivation

Property of type: str

class xnat.classes.DerivedData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ExperimentData

create_resource(label, format=None, data_dir=None, method=None)
download(path, verbose=True)
files
fulluri
provenance

Property of type: listing of xnat.classes.Process

resources

listing of xnat.classes.AbstractResource

class xnat.classes.DicomCodedValue(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATNestedObjectMixin

designator

Property of type: str

meaning

Property of type: str

value

Property of type: str

version

Property of type: str

class xnat.classes.DicomSeries(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, data_dir=None, upload_method=None, **kwargs)

Bases: xnat.classes.AbstractResource

cache_path

Property of type: str

content

Code indicating the contents of the image. E.g. GFC, T88

Property of type: str

description

Free-form comments about files

Property of type: str

dimensions

Property of type: listing of xnat.classes.DicomSeriesDimensions

format

Format of file. E.g. DICOM, Analyze, 4dfp

Property of type: str

image_set

listing of xnat.classes.DicomSeriesImageset

orientation

Property of type: str

uid

Property of type: str

voxel_res

Property of type: listing of xnat.classes.DicomSeriesVoxelres

class xnat.classes.DicomSeriesDimensions(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

volumes

Property of type: int

x

Property of type: int

y

Property of type: int

z

Property of type: int

class xnat.classes.DicomSeriesImageset(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

instance_number

Property of type: int

sop_instance_uid

Property of type: str

uri

Property of type: str

class xnat.classes.DicomSeriesVoxelres(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

units

Property of type: str

x

Property of type: float

y

Property of type: float

z

Property of type: float

class xnat.classes.DoseFloat(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

dose

Property of type: float

class xnat.classes.Dx3DCraniofacialScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.Dx3DCraniofacialSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.DxScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.DxSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.EcatValidationString(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

ecat_validation

Property of type: str

class xnat.classes.EcgScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.EcgSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.EegScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

channels

listing of xnat.classes.EegScanDataChannels

parameters

Property of type: listing of xnat.classes.EegScanDataParameters

software_filters_impedances

Property of type: listing of xnat.classes.EegScanDataSoftwarefiltersimpedances

class xnat.classes.EegScanDataChannels(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

high_cut_off

Property of type: str

low_cut_off

Property of type: str

name

Property of type: str

notch

Property of type: str

resolution

Property of type: float

class xnat.classes.EegScanDataParameters(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

data_record

Property of type: listing of xnat.classes.EegScanDataParametersDatarecord

number_of_data_records

Property of type: int

class xnat.classes.EegScanDataParametersDatarecord(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

duration

Property of type: float

units

Property of type: str

class xnat.classes.EegScanDataSoftwarefiltersimpedances(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

impedance

listing of xnat.classes.EegScanDataSoftwarefiltersimpedancesImpedance

mean

Property of type: float

class xnat.classes.EegScanDataSoftwarefiltersimpedancesImpedance(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

name

Property of type: str

value

Property of type: str

class xnat.classes.EegSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

data_format_version

Property of type: str

number_of_channels

Property of type: int

sampling_interval

Property of type: listing of xnat.classes.EegSessionDataSamplinginterval

sampling_rate

Property of type: listing of xnat.classes.EegSessionDataSamplingrate

class xnat.classes.EegSessionDataSamplinginterval(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

units

Property of type: str

class xnat.classes.EegSessionDataSamplingrate(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

units

Property of type: str

class xnat.classes.EpsScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.EpsSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.EsScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.EsSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.EstimatedDoseSavingFloat(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

estimated_dose_saving

Property of type: float

class xnat.classes.EsvScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.EsvSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.ExperimentData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATObjectMixin

SECONDARY_LOOKUP_FIELD = 'label'
acquisition_site

Property of type: str

date

Date on which experiment was conducted

Property of type: datetime.date

delay

Property of type: listing of xnat.classes.ExperimentDataDelay

duration

Duration of experiment

Property of type: datetime.timedelta

fields

listing of xnat.classes.ExperimentDataFields

investigator

Property of type: listing of xnat.classes.InvestigatorData

label
note

Free form text for misc. information

Property of type: str

original

Property of type: str

project

Property of type: str

protocol

Property of type: str

resources

listing of xnat.classes.AbstractResource

sharing

listing of xnat.classes.ExperimentDataSharing

time

Time experiment was conducted

Property of type: datetime.time

validation

Property of type: listing of xnat.classes.ValidationData

version

Property of type: int

visit

Property of type: str

visit_id

Property of type: str

class xnat.classes.ExperimentDataDelay(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

ref_expt_id

Property of type: str

class xnat.classes.ExperimentDataFields(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

name

Property of type: str

class xnat.classes.ExperimentDataSharing(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

label

Property of type: str

project

Property of type: str

protocol

Property of type: str

visit

Property of type: str

class xnat.classes.FieldDefinitionGroup(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATNestedObjectMixin

data_type

Property of type: str

description

Property of type: str

fields

listing of xnat.classes.FieldDefinitionGroupFields

id

Property of type: str

project_specific

Property of type: bool

shareable

Property of type: bool

class xnat.classes.FieldDefinitionGroupFields(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

datatype

Property of type: str

group

Property of type: str

name

Property of type: str

possible_values

listing of xnat.classes.FieldDefinitionGroupFieldsFieldPossiblevalues

required

Property of type: bool

sequence

Property of type: int

type

Property of type: str

xml_path

Property of type: str

class xnat.classes.FieldDefinitionGroupFieldsFieldPossiblevalues(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

display

Property of type: str

class xnat.classes.FieldString(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

field

Property of type: str

class xnat.classes.FileData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, path=None)

Bases: xnat.classes.XNATObjectMixin

SECONDARY_LOOKUP_FIELD = 'path'
delete()

Remove the item from XNATSession

download(*args, **kwargs)
download_stream(*args, **kwargs)
open()
path
size
class xnat.classes.GenericData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ExperimentData

class xnat.classes.GmScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.GmSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.GmvScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.GmvSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.HdScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.HdSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.HeightFloat(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

height

Property of type: float

class xnat.classes.ImageAssessorData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.DerivedData

image_session_id

Property of type: str

in_

listing of xnat.classes.AbstractResource

out

listing of xnat.classes.AbstractResource

parameters

listing of xnat.classes.AddField

class xnat.classes.ImageResource(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, data_dir=None, upload_method=None, **kwargs)

Bases: xnat.classes.Resource

dimensions

Property of type: listing of xnat.classes.ImageResourceDimensions

orientation

Property of type: str

voxel_res

Property of type: listing of xnat.classes.ImageResourceVoxelres

class xnat.classes.ImageResourceDimensions(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

volumes

Property of type: int

x

Property of type: int

y

Property of type: int

z

Property of type: int

class xnat.classes.ImageResourceSeries(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, data_dir=None, upload_method=None, **kwargs)

Bases: xnat.classes.ResourceSeries

dimensions

Property of type: listing of xnat.classes.ImageResourceSeriesDimensions

orientation

Property of type: str

voxel_res

Property of type: listing of xnat.classes.ImageResourceSeriesVoxelres

class xnat.classes.ImageResourceSeriesDimensions(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

volumes

Property of type: int

x

Property of type: int

y

Property of type: int

z

Property of type: int

class xnat.classes.ImageResourceSeriesVoxelres(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

units

Property of type: str

x

Property of type: float

y

Property of type: float

z

Property of type: float

class xnat.classes.ImageResourceVoxelres(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

units

Property of type: str

x

Property of type: float

y

Property of type: float

z

Property of type: float

class xnat.classes.ImageScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.XNATObjectMixin

SECONDARY_LOOKUP_FIELD = 'type'
condition

Property of type: str

create_resource(label, format=None, data_dir=None, method='tgz_file')
dicom_dump(fields=None)

Retrieve a dicom dump as a JSON data structure See the XAPI documentation for more detailed information: DICOM Dump Service

Parameters:fields (list) – Fields to filter for DICOM tags. It can either a tag name or tag number in the format GGGGEEEE (G = Group number, E = Element number)
Returns:JSON object (dict) representation of DICOM header
Return type:dict
documentation

Property of type: str

download(path, verbose=True)
download_dir(target_dir, verbose=True)
file

listing of xnat.classes.AbstractResource

files
frames

Property of type: int

image_session_id

Property of type: str

modality

Property of type: str

note

Property of type: str

operator

Free form text to indicate individuals who operated scanner

Property of type: str

project

Property of type: str

quality

Property of type: str

read_dicom(file=None, read_pixel_data=False, force=False)
resources
scanner

Free form text to indicate name/ID of scanner

Property of type: listing of xnat.classes.ImageScanDataScanner

series_class

Property of type: str

series_description

Property of type: str

sharing

listing of xnat.classes.ImageScanDataSharing

start_date

Date the scan started

Property of type: datetime.date

start_time

Time the scan started

Property of type: datetime.time

type

Property of type: str

uid

DICOM Series Instance UID (0020,000E)

Property of type: str

validation

Property of type: listing of xnat.classes.ValidationData

class xnat.classes.ImageScanDataScanner(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

manufacturer

Property of type: str

model

Property of type: str

software_version

Property of type: str

class xnat.classes.ImageScanDataSharing(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

label

Property of type: str

project

Property of type: str

class xnat.classes.ImageSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.SubjectAssessorData

assessors

listing of xnat.classes.ImageAssessorData

create_assessor(label, type_)
dcm_accession_number

DICOM Accession Number (0008,0050)

Property of type: str

dcm_patient_birth_date

DICOM Patient’s Birth Date (0010,0030)

Property of type: datetime.date

dcm_patient_id

DICOM Patient ID (0010,0020)

Property of type: str

dcm_patient_name

DICOM Patient’s Name (0010,0010)

Property of type: str

dcm_patient_weight

DICOM Patient’s Weight (0010,1031)

Property of type: float

download(path, verbose=True)
download_dir(target_dir, verbose=True)

Download the entire experiment and unpack it in a given directory. Note that this method will create a directory structure following $target_dir/{experiment.label} and unzip the experiment zips as given by XNAT into that. If the $target_dir/{experiment.label} does not exist, it will be created.

Parameters:
  • target_dir (str) – directory to create experiment directory in
  • verbose (bool) – show progress
files
modality

Property of type: str

operator

Free form text to indicate individuals who operated scanner

Property of type: str

prearchive_path

Property of type: str

reconstructions

listing of xnat.classes.ReconstructedImageData

regions

listing of xnat.classes.RegionResource

scanner

Free form text to indicate name/ID of scanner

Property of type: listing of xnat.classes.ImageSessionDataScanner

scans

listing of xnat.classes.ImageScanData

session_type

Property of type: str

share(project, label=None)
study_id

Property of type: str

uid

DICOM Study Instance UID (0020,000D)

Property of type: str

class xnat.classes.ImageSessionDataScanner(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

manufacturer

Property of type: str

model

Property of type: str

class xnat.classes.IntermediateFloat(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

intermediate

Property of type: float

class xnat.classes.InvestigatorData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATNestedObjectMixin

department

Property of type: str

email

Property of type: str

firstname

Property of type: str

id

Property of type: str

institution

Property of type: str

lastname

Property of type: str

phone

Property of type: str

title

Property of type: str

class xnat.classes.IoScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.IoSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.IsotopeString(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

isotope

Property of type: str

class xnat.classes.LONGVARCHAR(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATNestedObjectMixin

value

Property of type: str

class xnat.classes.LabelString(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

label

Property of type: str

class xnat.classes.MegScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.MegSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.MgScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.MgSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.MrAssessorData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageAssessorData

class xnat.classes.MrQcScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.QcScanData

blurring

Bluring, Ghosting, or Ringing artifacts on the Scan

Property of type: str

flow

Property of type: str

image_contrast

Property of type: str

inhomogeneity

Property of type: str

interpac_motion

Property of type: str

susceptibility

Property of type: str

wrap

Property of type: str

class xnat.classes.MrScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

coil

Free form text to indicate the coil used in this scanning session

Property of type: str

dcm_validation

Property of type: listing of xnat.classes.MrScanDataDcmvalidation

field_strength

Free form text to indicate the field strength used in this scanning session

Property of type: str

file_name_uuid

Property of type: str

marker

Free form text to indicate method used to mark left-right (e.g. Vitamin E capsule)

Property of type: str

parameters

Property of type: listing of xnat.classes.MrScanDataParameters

stabilization

Free form text to indicate method used to stabilize head

Property of type: str

class xnat.classes.MrScanDataDcmvalidation(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

status

Property of type: bool

class xnat.classes.MrScanDataParameters(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

acq_time

Property of type: str

acq_type

Property of type: str

add_param

listing of xnat.classes.AddField

coil

Free form text to indicate the coil used in this scan

Property of type: str

coil_elements

Property of type: str

delta_te

Property of type: float

diffusion

Property of type: listing of xnat.classes.MrScanDataParametersDiffusion

dti_acq_count

Property of type: int

echo_spacing

in seconds; computed from Siemens private tags (0019,1028) Bandwidth Per Pixel Phase Encode and (0051,100b) AcquisitionMatrixText

Property of type: float

flip

Property of type: int

fov

Property of type: listing of xnat.classes.MrScanDataParametersFov

image_type

Property of type: str

in_plane_phase_encoding

Property of type: listing of xnat.classes.MrScanDataParametersInplanephaseencoding

matrix

Property of type: listing of xnat.classes.MrScanDataParametersMatrix

orientation

Property of type: str

origin

Property of type: str

partitions

Property of type: int

phase_encoding_direction

from Siemens image shadow data (0029,1010), subfield 20. 1 for A>>P, 0 for P>>A

Property of type: str

pixel_bandwidth

Reciprocal of the total sampling period, in Hz/pixel

Property of type: float

pmc

Property of type: str

readout_sample_spacing

Property of type: str

scan_options

Property of type: str

scan_sequence

Property of type: str

seq_variant

Property of type: str

sequence

Property of type: str

subject_position

Property of type: str

te

Property of type: float

ti

Property of type: float

tr

Property of type: float

voxel_res

Property of type: listing of xnat.classes.MrScanDataParametersVoxelres

class xnat.classes.MrScanDataParametersDiffusion(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

anisotropy_type

Property of type: str

b_max

Property of type: str

b_values

Property of type: str

directionality

Property of type: str

orientations

Property of type: str

refocus_flip_angle

Property of type: str

class xnat.classes.MrScanDataParametersFov(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

x

Property of type: int

y

Property of type: int

class xnat.classes.MrScanDataParametersInplanephaseencoding(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

direction

Property of type: str

direction_positive

from Siemens image shadow data (0029,1010) PhaseEncodingDirectionPositive

Property of type: str

polarity_swap

Property of type: str

rotation

Property of type: str

class xnat.classes.MrScanDataParametersMatrix(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

x

Property of type: int

y

Property of type: int

class xnat.classes.MrScanDataParametersVoxelres(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

units

Property of type: str

x

Property of type: float

y

Property of type: float

z

Property of type: float

class xnat.classes.MrSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

coil

Free form text to indicate the coil used in this scanning session

Property of type: str

field_strength

Free form text to indicate the field strength used in this scanning session

Property of type: str

marker

Free form text to indicate method used to mark left-right (e.g. Vitamin E capsule)

Property of type: str

stabilization

Free form text to indicate method used to stabilize head

Property of type: str

class xnat.classes.MrsScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.NmScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.NmSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.OpScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.OpSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.OptScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

dcm_validation

Property of type: listing of xnat.classes.OptScanDataDcmvalidation

parameters

Property of type: listing of xnat.classes.OptScanDataParameters

class xnat.classes.OptScanDataDcmvalidation(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

status

Property of type: bool

class xnat.classes.OptScanDataParameters(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

fov

Property of type: listing of xnat.classes.OptScanDataParametersFov

illumination_power

Power of the illuminator in microwatts at corneal plane

Property of type: str

illumination_wavelength

Wavelength of the illuminator, in nm

Property of type: str

image_type

Property of type: str

laterality

Laterality of (paired) body part examined: R (right) or L (left)

Property of type: str

voxel_res

Property of type: listing of xnat.classes.OptScanDataParametersVoxelres

class xnat.classes.OptScanDataParametersFov(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

x

Property of type: int

y

Property of type: int

class xnat.classes.OptScanDataParametersVoxelres(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

units

Property of type: str

x

Property of type: float

y

Property of type: float

z

Property of type: float

class xnat.classes.OptSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.OtherDicomScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.OtherDicomSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.OtherQcScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.QcScanData

other

Property of type: str

class xnat.classes.PVisitData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.GenericData

closed

Property of type: bool

end_date

Property of type: datetime.datetime

notes
Can be used to take visit notes, explain reason for status (e.g. missed visit), etc.

Property of type: str

protocol_id

Property of type: str

protocol_version

Property of type: int

start_date

Property of type: datetime.datetime

status

Property of type: str

subject_id

Property of type: str

terminal

Property of type: bool

visit_name

Property of type: str

visit_type

Property of type: str

class xnat.classes.PetAssessorData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageAssessorData

class xnat.classes.PetQcScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.QcScanData

acceptable_voxel_size

Property of type: str

acquisition

Property of type: str

bottom_cutoff

Property of type: str

correct_filters

Property of type: str

correct_iterations_and_subsets

Property of type: str

correct_reconstruction_algorithm

Property of type: str

correct_slice_thickness

Property of type: str

processing_errors

listing of str

qc_outcome

Property of type: str

qc_outcome_reason

Property of type: str

reason_frames_unacceptable

Property of type: str

reconstruction_algorithm_used

Property of type: str

top_cutoff

Property of type: str

unacceptable_frames

Property of type: str

class xnat.classes.PetScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

ecat_validation

Property of type: listing of xnat.classes.PetScanDataEcatvalidation

parameters

Property of type: listing of xnat.classes.PetScanDataParameters

class xnat.classes.PetScanDataEcatvalidation(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

status

Property of type: bool

class xnat.classes.PetScanDataParameters(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

acq_type

Enumerated type (0=Undefined, 1=Blank, 2=Transmission, 3=Static emission, 4=Dynamic emission, 5=Gated emission, 6=Transmission rectilinear, 7=Emission rectilinear)

Property of type: int
add_param

listing of xnat.classes.AddField

annotation

Property of type: str

bed_position

Property of type: float

bin_size

Width of view sample (in cm)

Property of type: float

data_type

Enumerated type (0=Unkonwn Matrix Data Type, 1=Byte Data, 2=VAX_Ix2, 3=VAX_Ix4, 4=VAX_Rx4, 5=IEEE Float, 6=Sun short, 7=Sun long)

Property of type: int
dimensions

Property of type: listing of xnat.classes.PetScanDataParametersDimensions

ecat_calibration_factor

Property of type: float

facility

Property of type: str

file_type

Enumerated type (00=unknown, 01=Sinogram, 02=Image-16, 03=Attenuation Correction, 04=Normalization, 05=Polar Map, 06=Volume 8, 07=Volume 16, 08=Projection 8, 09=Projection 16, 10=Image 8, 11=3D Sinogram 16, 12=3D Sinogram 8, 13=3D Normalization, 14=3D Sinogram Fit)

Property of type: int
filter

Property of type: listing of xnat.classes.PetScanDataParametersFilter

filter_code

Enumerated type (0=all pass, 1=ramp, 2=Butterworth, 3=Hanning, 4=Hamming,5=Parzen, 6=Shepp, 7=Butterworth-order 2, 8=Gaussian, 9=Median,10=Boxcar)

Property of type: int
frames

Property of type: listing of xnat.classes.PetScanDataParametersFrames

gate_duration

Gate duration (in msec)

Property of type: int

mt_1_1

Matrix transformation element (1,1).

Property of type: float

mt_1_2

Matrix transformation element (1,2).

Property of type: float

mt_1_3

Matrix transformation element (1,3).

Property of type: float

mt_1_4

Matrix transformation element (1,4).

Property of type: float

mt_2_1

Matrix transformation element (2,1).

Property of type: float

mt_2_2

Matrix transformation element (2,2).

Property of type: float

mt_2_3

Matrix transformation element (2,3).

Property of type: float

mt_2_4

Matrix transformation element (2,4).

Property of type: float

mt_3_1

Matrix transformation element (3,1).

Property of type: float

mt_3_2

Matrix transformation element (3,2).

Property of type: float

mt_3_3

Matrix transformation element (3,3).

Property of type: float

mt_3_4

Matrix transformation element (3,4).

Property of type: float

num_accepted_beats

Number of accepted beats for this gate

Property of type: int

num_angles

Number of angles from sinogram

Property of type: float

num_gates

Property of type: int

num_planes

Property of type: int

num_relements

Number R elements from sinogram

Property of type: float

offset

Property of type: listing of xnat.classes.PetScanDataParametersOffset

orientation

Property of type: int

original_file_name

Scan file creation name

Property of type: str

pixel_size

Property of type: listing of xnat.classes.PetScanDataParametersPixelsize

plane_separation

Physical distance between adjacent planes (in cm.)

Property of type: float
processing_code

Bit mask (0=Not Processed, 1=Normalized, 2=Measured Attenuation Correction, 4=Calculated Attenuation Correction, 8=X smoothing, 16=Y smoothing, 32=Z smoothing, 64=2D scatter correction, 128=3D scatter correction, 256=Arc correction, 512=Decay correction, 1024=Online compression)

Property of type: int
r_wave_offset

R wave offset (For phase sliced studies, average, in msec)

Property of type: int
recon_type

Enumerated type (0=Filtered backprojection, 1=Forward projection 3D (PROMIS), 2=Ramp 3D, 3=FAVOR 3D, 4=SSRB, 5=Multi-slice rebinning, 6=FORE)

Property of type: int
recon_views

Number of views used to reconstruct the data

Property of type: int

recon_zoom

Reconstruction magnification factor (zoom)

Property of type: float

resolution

Property of type: listing of xnat.classes.PetScanDataParametersResolution

rfilter

Property of type: listing of xnat.classes.PetScanDataParametersRfilter

scatter_type

Enumerated type (0=None, 1=Deconvolution, 2=Simulated, 3=Dual Energy)

Property of type: int
system_type

Scanner model (i.e., 951, 951R, 953, 953B, 921, 922, 925, 961, 962, 966)

Property of type: int
transaxial_fov

Diameter (in cm.) of transaxial view

Property of type: float

zfilter

Property of type: listing of xnat.classes.PetScanDataParametersZfilter

zrotation_angle

Rotation in the xy plane (in degrees). Use righthand coordinate system for rotation angle sign.

Property of type: float
class xnat.classes.PetScanDataParametersDimensions(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

num

Number of dimensions

Property of type: int

x

Dimension along x axis

Property of type: int

y

Dimension along y axis

Property of type: int

z

Dimension along z axis

Property of type: int

class xnat.classes.PetScanDataParametersFilter(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

cutoff

Cutoff frequency

Property of type: float

class xnat.classes.PetScanDataParametersFrames(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

frame

listing of xnat.classes.PetScanDataParametersFramesFrame

num_frames

Property of type: str

class xnat.classes.PetScanDataParametersFramesFrame(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

length

Property of type: float

number

Property of type: str

starttime

Property of type: float

units

Property of type: str

class xnat.classes.PetScanDataParametersOffset(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

x

Offset in x axis for recon target (in cm)

Property of type: float

y

Offset in y axis for recon target (in cm)

Property of type: float

z

Offset in z axis for recon target (in cm)

Property of type: float

class xnat.classes.PetScanDataParametersPixelsize(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

x

X dimension pixel size (in cm)

Property of type: float

y

Y dimension pixel size (in cm)

Property of type: float

z

Z dimension pixel size (in cm)

Property of type: float

class xnat.classes.PetScanDataParametersResolution(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

x

Resolution in the x dimension (in cm)

Property of type: float

y

Resolution in the y dimension (in cm)

Property of type: float

z

Resolution in the z dimension (in cm)

Property of type: float

class xnat.classes.PetScanDataParametersRfilter(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

code

Property of type: int

cutoff

Property of type: float

order

Property of type: int

resolution

Property of type: float

class xnat.classes.PetScanDataParametersZfilter(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

code

Property of type: int

cutoff

Property of type: float

order

Property of type: int

resolution

Property of type: float

class xnat.classes.PetSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

blood_glucose

Property of type: float

blood_glucose_time

Property of type: datetime.datetime

blood_glucose_units

Property of type: str

patient_id

Patient identification descriptor

Property of type: str

patient_name

Patient name (free format ASCII)

Property of type: str

stabilization

Free form text to indicate method used to stabilize head

Property of type: str

start_time

Property of type: datetime.datetime

start_time_injection

Property of type: datetime.datetime

start_time_scan

Property of type: datetime.datetime

study_type

Study descriptor

Property of type: str

tracer

Radio-Pharmaceutical

Property of type: listing of xnat.classes.PetSessionDataTracer

class xnat.classes.PetSessionDataTracer(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

dose

Property of type: listing of xnat.classes.PetSessionDataTracerDose

intermediate

Property of type: listing of xnat.classes.PetSessionDataTracerIntermediate

isotope

Property of type: listing of xnat.classes.PetSessionDataTracerIsotope

name

Property of type: str

specific_activity

Property of type: float

start_time

Property of type: datetime.datetime

total_mass

Property of type: listing of xnat.classes.PetSessionDataTracerTotalmass

transmissions

Property of type: int

transmissions_starttime

Property of type: datetime.datetime

class xnat.classes.PetSessionDataTracerDose(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

units

Property of type: str

class xnat.classes.PetSessionDataTracerIntermediate(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

units

Property of type: str

class xnat.classes.PetSessionDataTracerIsotope(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

half_life

half-life in seconds

Property of type: float

class xnat.classes.PetSessionDataTracerTotalmass(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

units

Property of type: str

class xnat.classes.PetmrSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

blood_glucose

Property of type: float

blood_glucose_time

Property of type: datetime.datetime

blood_glucose_units

Property of type: str

coil

Free form text to indicate the coil used in this scanning session

Property of type: str

field_strength

Free form text to indicate the field strength used in this scanning session

Property of type: str

marker

Free form text to indicate method used to mark left-right (e.g. Vitamin E capsule)

Property of type: str

patient_id

Patient identification descriptor

Property of type: str

patient_name

Patient name (free format ASCII)

Property of type: str

stabilization

Free form text to indicate method used to stabilize head

Property of type: str

start_time

Property of type: datetime.datetime

start_time_injection

Property of type: datetime.datetime

start_time_scan

Property of type: datetime.datetime

study_type

Study descriptor

Property of type: str

tracer

Radio-Pharmaceutical

Property of type: listing of xnat.classes.PetmrSessionDataTracer

class xnat.classes.PetmrSessionDataTracer(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

dose

Property of type: listing of xnat.classes.PetmrSessionDataTracerDose

intermediate

Property of type: listing of xnat.classes.PetmrSessionDataTracerIntermediate

isotope

Property of type: listing of xnat.classes.PetmrSessionDataTracerIsotope

name

Property of type: str

specific_activity

Property of type: float

start_time

Property of type: datetime.datetime

total_mass

Property of type: listing of xnat.classes.PetmrSessionDataTracerTotalmass

transmissions

Property of type: int

transmissions_starttime

Property of type: datetime.datetime

class xnat.classes.PetmrSessionDataTracerDose(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

units

Property of type: str

class xnat.classes.PetmrSessionDataTracerIntermediate(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

units

Property of type: str

class xnat.classes.PetmrSessionDataTracerIsotope(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

half_life

half-life in seconds

Property of type: float

class xnat.classes.PetmrSessionDataTracerTotalmass(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

units

Property of type: str

class xnat.classes.PossibleValueString(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

possible_value

Property of type: str

class xnat.classes.ProjectData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, name=None, **kwargs)

Bases: xnat.classes.XNATObjectMixin

SECONDARY_LOOKUP_FIELD = 'name'
active

Property of type: bool

aliases

listing of xnat.classes.ProjectDataAliases

description

Property of type: str

download_dir(target_dir, verbose=True)

Download the entire project and unpack it in a given directory. Note that this method will create a directory structure following $target_dir/{project.name}/{subject.label}/{experiment.label} and unzip the experiment zips as given by XNAT into that. If the $target_dir/{project.name} does not exist, it will be created.

Parameters:
  • target_dir (str) – directory to create project directory in
  • verbose (bool) – show progress
experiments
fields

listing of xnat.classes.ProjectDataFields

files
fulluri
investigators

listing of xnat.classes.InvestigatorData

keywords

Property of type: str

name

Property of type: str

pi

Property of type: listing of xnat.classes.InvestigatorData

publications

listing of xnat.classes.PublicationResource

resources
secondary_id

Property of type: str

study_protocol

listing of xnat.classes.AbstractProtocol

subjects
type

Property of type: str

class xnat.classes.ProjectDataAliases(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

source

Property of type: str

class xnat.classes.ProjectDataFields(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

name

Property of type: str

class xnat.classes.ProjectParticipant(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATNestedObjectMixin

group

Property of type: str

label

Property of type: str

project

Property of type: str

subject_id

Property of type: str

class xnat.classes.PublicationResource(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, data_dir=None, upload_method=None, **kwargs)

Bases: xnat.classes.AbstractResource

abstract

Property of type: str

citation

Property of type: str

commentary

Property of type: str

doi

Property of type: str

is_primary

Property of type: bool

medline

Property of type: str

other

Property of type: str

pubmed

Property of type: str

title

Property of type: str

type

Property of type: str

class xnat.classes.QcAssessmentData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.MrAssessorData

scans

listing of xnat.classes.QcAssessmentDataScans

type

Property of type: str

class xnat.classes.QcAssessmentDataScans(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

id

Property of type: str

scan_statistics

Property of type: listing of xnat.classes.AbstractStatistics

slice_qc

listing of xnat.classes.QcAssessmentDataScansScanSliceqc

class xnat.classes.QcAssessmentDataScansScanSliceqc(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

number

Property of type: str

slice_statistics

Property of type: listing of xnat.classes.AbstractStatistics

class xnat.classes.QcManualAssessorData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageAssessorData

comments

Property of type: str

incidental_findings

Possible clinical findings made during Quality Control. Not necessarily authorizative or clinical diagnoses. Further investigation required.

Property of type: str

pass_

Property of type: str

payable

Property of type: str

rater

Property of type: str

rescan

Property of type: str

resolvable

Property of type: str

retrain

Property of type: str

scans

listing of xnat.classes.QcScanData

stereotactic_marker

Marker placed and located correctly.

Property of type: str

class xnat.classes.QcScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATNestedObjectMixin

comments

Property of type: str

coverage

Property of type: str

fields

listing of xnat.classes.QcScanDataFields

image_scan_id

Property of type: str

motion

Property of type: str

other_image_artifacts

Property of type: str

pass_

Property of type: str

rater

Property of type: str

rating

Property of type: listing of xnat.classes.QcScanDataRating

class xnat.classes.QcScanDataFields(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

name

Property of type: str

class xnat.classes.QcScanDataRating(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

scale

Property of type: str

class xnat.classes.RatingString(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

rating

Property of type: str

class xnat.classes.ReconstructedImageData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATObjectMixin

base_scan_type

Property of type: str

computations

listing of xnat.classes.ComputationData

id

Property of type: str

image_session_id

Property of type: str

in_

listing of xnat.classes.AbstractResource

in_scans

listing of str

out

listing of xnat.classes.AbstractResource

parameters

listing of xnat.classes.AddField

provenance

Property of type: listing of xnat.classes.Process

type

Property of type: str

class xnat.classes.RegionResource(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATNestedObjectMixin

baseimage

the details of the file against which this region was created

Property of type: listing of xnat.classes.AbstractResource

creator

Property of type: listing of xnat.classes.RegionResourceCreator

file

details of the region file

Property of type: listing of xnat.classes.AbstractResource

hemisphere

Property of type: str

name

Name of the region eg Brainstem

Property of type: str

session_id

Property of type: str

subregionlabels

listing of xnat.classes.RegionResourceSubregionlabels

class xnat.classes.RegionResourceCreator(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

firstname

Property of type: str

lastname

Property of type: str

class xnat.classes.RegionResourceSubregionlabels(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

hemisphere

Property of type: str

id

Property of type: str

class xnat.classes.Resource(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, data_dir=None, upload_method=None, **kwargs)

Bases: xnat.classes.AbstractResource

cache_path

Property of type: str

content

Code indicating the contents of the image. E.g. GFC, T88

Property of type: str

description

Free-form comments about file

Property of type: str

format

Format of file. E.g. DICOM, Analyze, 4dfp

Property of type: str

provenance

Property of type: listing of xnat.classes.Process

class xnat.classes.ResourceCatalog(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, data_dir=None, upload_method=None, **kwargs)

Bases: xnat.classes.Resource

class xnat.classes.ResourceSeries(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, data_dir=None, upload_method=None, **kwargs)

Bases: xnat.classes.AbstractResource

cache_path

Property of type: str

content

Code indicating the contents of the image. E.g. GFC, T88

Property of type: str

count

Property of type: int

description

Free-form comments about files

Property of type: str

format

Format of file. E.g. DICOM, Analyze, 4dfp

Property of type: str

name

Property of type: str

path

Property of type: str

pattern

Property of type: str

class xnat.classes.RfScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.RfSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.RtImageScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.RtSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.SamplingIntervalFloat(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

sampling_interval

Property of type: float

class xnat.classes.SamplingRateFloat(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

sampling_rate

Property of type: float

class xnat.classes.ScScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.ScannerString(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

scanner

Property of type: str

class xnat.classes.SegScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.ShareString(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

share

Property of type: str

class xnat.classes.SmScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.SmSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.SrScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.SrSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.StatisticsData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.AbstractStatistics

add_field

listing of xnat.classes.StatisticsDataAddfield

additional_statistics

listing of xnat.classes.StatisticsDataAdditionalstatistics

max

Property of type: float

mean

Property of type: float

min

Property of type: float

no_of_voxels

Property of type: int

snr

Property of type: float

stddev

Property of type: float

class xnat.classes.StatisticsDataAddfield(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

name

Property of type: str

class xnat.classes.StatisticsDataAdditionalstatistics(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

name

Property of type: str

class xnat.classes.StudyProtocol(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.AbstractProtocol

acq_conditions

listing of xnat.classes.StudyProtocolAcqconditions

image_session_types

listing of xnat.classes.StudyProtocolImagesessiontypes

subject_groups

listing of xnat.classes.StudyProtocolSubjectgroups

subject_variables

listing of xnat.classes.StudyProtocolSubjectvariables

class xnat.classes.StudyProtocolAcqconditions(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

description

Property of type: str

id

Property of type: str

name

Property of type: str

class xnat.classes.StudyProtocolImagesessiontypes(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

description

Property of type: str

id

Property of type: str

name

Property of type: str

class xnat.classes.StudyProtocolSubjectgroups(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

description

Property of type: str

id

Property of type: str

name

Property of type: str

class xnat.classes.StudyProtocolSubjectvariables(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

description

Property of type: str

id

Property of type: str

name

Property of type: str

class xnat.classes.SubjectAssessorData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ExperimentData

age

Property of type: float

fulluri
subject
subject_id

Property of type: str

class xnat.classes.SubjectData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATObjectMixin

SECONDARY_LOOKUP_FIELD = 'label'
add_id

listing of xnat.classes.SubjectDataAddid

demographics

Property of type: listing of xnat.classes.AbstractDemographicData

download_dir(target_dir, verbose=True)

Download the entire subject and unpack it in a given directory. Note that this method will create a directory structure following $target_dir/{subject.label}/{experiment.label} and unzip the experiment zips as given by XNAT into that. If the $target_dir/{subject.label} does not exist, it will be created.

Parameters:
  • target_dir (str) – directory to create subject directory in
  • verbose (bool) – show progress
experiments

listing of xnat.classes.SubjectAssessorData

fields

listing of xnat.classes.SubjectDataFields

files
fulluri
group

Property of type: str

initials

Property of type: str

investigator

Property of type: listing of xnat.classes.InvestigatorData

label
metadata

Property of type: listing of xnat.classes.AbstractSubjectMetadata

project

Property of type: str

resources

listing of xnat.classes.AbstractResource

share(project, label=None)
sharing

listing of xnat.classes.ProjectParticipant

src

Property of type: str

class xnat.classes.SubjectDataAddid(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

name

Property of type: str

class xnat.classes.SubjectDataFields(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

name

Property of type: str

class xnat.classes.SubjectMetadata(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.AbstractSubjectMetadata

cohort

Free form text to indicate recruitment/subject pool

Property of type: str

class xnat.classes.SubjectVariablesData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.SubjectAssessorData

variables

listing of xnat.classes.SubjectVariablesDataVariables

class xnat.classes.SubjectVariablesDataVariables(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

name

Property of type: str

class xnat.classes.TagString(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

tag

Property of type: str

class xnat.classes.TotalMassFloat(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

total_mass

Property of type: float

class xnat.classes.UsScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.UsSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.ValidationData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATNestedObjectMixin

date

Property of type: datetime.date

method

Property of type: str

notes

Property of type: str

status

Property of type: str

validated_by

Property of type: str

class xnat.classes.VariableString(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

variable

Property of type: str

class xnat.classes.VoiceAudioScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.VolumetricRegion(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATNestedObjectMixin

hemisphere

Property of type: str

name

Property of type: str

subregions

listing of xnat.classes.VolumetricRegionSubregions

units

Property of type: str

voxels

Property of type: int

class xnat.classes.VolumetricRegionSubregions(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

name

Property of type: str

voxels

Property of type: float

class xnat.classes.WeightFloat(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

weight

Property of type: float

class xnat.classes.XNATNestedObjectMixin(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.core.XNATNestedObject

xnat_session = None
class xnat.classes.XNATObjectMixin(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.core.XNATObject

classmethod query(*constraints)
xnat_session = None
class xnat.classes.XNATSubObjectMixin(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.core.XNATSubObject

xnat_session = None
class xnat.classes.Xa3DScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.Xa3DSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.XaScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

parameters

Property of type: listing of xnat.classes.XaScanDataParameters

class xnat.classes.XaScanDataParameters(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

contrast_bolus

Property of type: listing of xnat.classes.ContrastBolus

derivation

Text description of how this image was derived

Property of type: str

fov

Property of type: listing of xnat.classes.XaScanDataParametersFov

image_type

Property of type: str

options

Property of type: str

orientation

Orientation(s), separated by comma if multiple

Property of type: str

pixel_res

Property of type: listing of xnat.classes.XaScanDataParametersPixelres

class xnat.classes.XaScanDataParametersFov(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

x

Property of type: int

y

Property of type: int

class xnat.classes.XaScanDataParametersPixelres(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.XNATSubObjectMixin

units

Property of type: str

x

Property of type: int

y

Property of type: int

class xnat.classes.XaSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.XcScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.XcSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

class xnat.classes.XcvScanData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)

Bases: xnat.classes.ImageScanData

class xnat.classes.XcvSessionData(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)

Bases: xnat.classes.ImageSessionData

xnat.classes.current_session()