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)¶
-
class
xnat.classes.
AbstractProtocol
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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:
-
file_count
¶
-
file_size
¶
-
files
¶
-
fulldata
¶ The full data of the current object (incl children, meta etc)
-
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:
per_file
: Scans the directory and uploads file by filetar_memory
: Create a tar archive in memory and upload it in one gotgz_memory
: Create a gzipped tar file in memory and upload thattar_file
: Create a temporary tar file and upload thattgz_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:
-
-
class
xnat.classes.
AbstractResourceTags
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
AbstractStatistics
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
AbstractSubjectMetadata
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
AddField
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶ Bases:
xnat.classes.LONGVARCHAR
-
class
xnat.classes.
AddFieldString
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
AddIDString
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
AdditionalStatisticsDouble
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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
ofxnat.classes.DicomCodedValue
-
name_code
¶ Property of type:
listing
ofxnat.classes.DicomCodedValue
-
-
class
xnat.classes.
AliasString
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
ComputationData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
ContrastBolus
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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)¶
-
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
ofxnat.classes.CtScanDataDcmvalidation
-
parameters
¶ Property of type:
listing
ofxnat.classes.CtScanDataParameters
-
-
class
xnat.classes.
CtScanDataDcmvalidation
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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
ofxnat.classes.CtScanDataParametersCollimationwidth
-
contrast_bolus
¶ Property of type:
listing
ofxnat.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
ofxnat.classes.CtScanDataParametersDerivation
-
estimated_dose_saving
¶ Percent value of dose saving due to modulation; negative value indicates increased exposure
Property of type:
listing
ofxnat.classes.CtScanDataParametersEstimateddosesaving
-
focal_spots
¶ Size of focal spot, in mm; if multiple values, small dimensions before large
-
fov
¶ Property of type:
listing
ofxnat.classes.CtScanDataParametersFov
-
rescale
¶ Relationship between stored values (SV) and Hounsfield (HU): HU=m*SV+b
Property of type:
listing
ofxnat.classes.CtScanDataParametersRescale
-
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
-
voxel_res
¶ Property of type:
listing
ofxnat.classes.CtScanDataParametersVoxelres
-
-
class
xnat.classes.
CtScanDataParametersCollimationwidth
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
CtScanDataParametersDerivation
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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)¶
-
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)¶
-
class
xnat.classes.
CtSessionData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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
¶
-
-
class
xnat.classes.
DcmValidationString
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
DelayInteger
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
DemographicData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶ Bases:
xnat.classes.AbstractDemographicData
-
dob
¶ Property of type:
datetime.date
-
employment
¶ - Employment status: 0: Employed 1: Unemployed 2: Retired 3: Unknown or N/A
Property of type:
int
-
height
¶ Property of type:
listing
ofxnat.classes.DemographicDataHeight
-
weight
¶ Property of type:
listing
ofxnat.classes.DemographicDataWeight
-
-
class
xnat.classes.
DemographicDataHeight
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
DemographicDataWeight
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
DerivationString
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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
¶
-
resources
¶
-
-
class
xnat.classes.
DicomCodedValue
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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
-
dimensions
¶ Property of type:
listing
ofxnat.classes.DicomSeriesDimensions
-
image_set
¶
-
voxel_res
¶ Property of type:
listing
ofxnat.classes.DicomSeriesVoxelres
-
-
class
xnat.classes.
DicomSeriesDimensions
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
DicomSeriesImageset
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
DicomSeriesVoxelres
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
DoseFloat
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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)¶
-
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)¶
-
class
xnat.classes.
EcatValidationString
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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)¶
-
class
xnat.classes.
EegScanData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)¶ Bases:
xnat.classes.ImageScanData
-
channels
¶
-
parameters
¶ Property of type:
listing
ofxnat.classes.EegScanDataParameters
-
software_filters_impedances
¶ Property of type:
listing
ofxnat.classes.EegScanDataSoftwarefiltersimpedances
-
-
class
xnat.classes.
EegScanDataChannels
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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
ofxnat.classes.EegScanDataParametersDatarecord
-
-
class
xnat.classes.
EegScanDataParametersDatarecord
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
EegScanDataSoftwarefiltersimpedances
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
EegScanDataSoftwarefiltersimpedancesImpedance
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
EegSessionData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶ Bases:
xnat.classes.ImageSessionData
-
sampling_interval
¶ Property of type:
listing
ofxnat.classes.EegSessionDataSamplinginterval
-
sampling_rate
¶ Property of type:
listing
ofxnat.classes.EegSessionDataSamplingrate
-
-
class
xnat.classes.
EegSessionDataSamplinginterval
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
EegSessionDataSamplingrate
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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)¶
-
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)¶
-
class
xnat.classes.
EstimatedDoseSavingFloat
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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)¶
-
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'¶
-
date
¶ Date on which experiment was conducted
Property of type:
datetime.date
-
delay
¶ Property of type:
listing
ofxnat.classes.ExperimentDataDelay
-
duration
¶ Duration of experiment
Property of type:
datetime.timedelta
-
fields
¶
-
investigator
¶ Property of type:
listing
ofxnat.classes.InvestigatorData
-
label
¶
-
resources
¶
-
sharing
¶
-
time
¶ Time experiment was conducted
Property of type:
datetime.time
-
validation
¶ Property of type:
listing
ofxnat.classes.ValidationData
-
-
class
xnat.classes.
ExperimentDataDelay
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
ExperimentDataFields
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
ExperimentDataSharing
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
FieldDefinitionGroup
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶ Bases:
xnat.classes.XNATNestedObjectMixin
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
-
possible_values
¶ listing
ofxnat.classes.FieldDefinitionGroupFieldsFieldPossiblevalues
-
-
class
xnat.classes.
FieldDefinitionGroupFieldsFieldPossiblevalues
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
FieldString
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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)¶
-
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)¶
-
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)¶
-
class
xnat.classes.
HeightFloat
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
ImageAssessorData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶ Bases:
xnat.classes.DerivedData
-
parameters
¶
-
-
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
ofxnat.classes.ImageResourceDimensions
-
voxel_res
¶ Property of type:
listing
ofxnat.classes.ImageResourceVoxelres
-
-
class
xnat.classes.
ImageResourceDimensions
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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
ofxnat.classes.ImageResourceSeriesDimensions
-
voxel_res
¶ Property of type:
listing
ofxnat.classes.ImageResourceSeriesVoxelres
-
-
class
xnat.classes.
ImageResourceSeriesDimensions
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
ImageResourceSeriesVoxelres
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
ImageResourceVoxelres
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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'¶
-
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
-
download
(path, verbose=True)¶
-
download_dir
(target_dir, verbose=True)¶
-
files
¶
-
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
ofxnat.classes.ImageScanDataScanner
-
sharing
¶
-
start_date
¶ Date the scan started
Property of type:
datetime.date
-
start_time
¶ Time the scan started
Property of type:
datetime.time
-
validation
¶ Property of type:
listing
ofxnat.classes.ValidationData
-
-
class
xnat.classes.
ImageScanDataScanner
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
ImageScanDataSharing
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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
¶
-
create_assessor
(label, type_)¶
-
dcm_patient_birth_date
¶ DICOM Patient’s Birth Date (0010,0030)
Property of type:
datetime.date
-
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:
-
files
¶
-
reconstructions
¶
-
regions
¶
-
scanner
¶ Free form text to indicate name/ID of scanner
Property of type:
listing
ofxnat.classes.ImageSessionDataScanner
-
scans
¶
-
-
class
xnat.classes.
ImageSessionDataScanner
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
IntermediateFloat
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
InvestigatorData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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)¶
-
class
xnat.classes.
IsotopeString
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
LONGVARCHAR
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
LabelString
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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)¶
-
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)¶
-
class
xnat.classes.
MrAssessorData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
MrQcScanData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶ Bases:
xnat.classes.QcScanData
-
class
xnat.classes.
MrScanData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)¶ Bases:
xnat.classes.ImageScanData
-
dcm_validation
¶ Property of type:
listing
ofxnat.classes.MrScanDataDcmvalidation
-
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
-
parameters
¶ Property of type:
listing
ofxnat.classes.MrScanDataParameters
-
-
class
xnat.classes.
MrScanDataDcmvalidation
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
MrScanDataParameters
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶ Bases:
xnat.classes.XNATSubObjectMixin
-
add_param
¶
-
diffusion
¶ Property of type:
listing
ofxnat.classes.MrScanDataParametersDiffusion
-
echo_spacing
¶ in seconds; computed from Siemens private tags (0019,1028) Bandwidth Per Pixel Phase Encode and (0051,100b) AcquisitionMatrixText
Property of type:
float
-
fov
¶ Property of type:
listing
ofxnat.classes.MrScanDataParametersFov
-
in_plane_phase_encoding
¶ Property of type:
listing
ofxnat.classes.MrScanDataParametersInplanephaseencoding
-
matrix
¶ Property of type:
listing
ofxnat.classes.MrScanDataParametersMatrix
-
phase_encoding_direction
¶ from Siemens image shadow data (0029,1010), subfield 20. 1 for A>>P, 0 for P>>A
Property of type:
str
-
voxel_res
¶ Property of type:
listing
ofxnat.classes.MrScanDataParametersVoxelres
-
-
class
xnat.classes.
MrScanDataParametersDiffusion
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
MrScanDataParametersFov
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
MrScanDataParametersInplanephaseencoding
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
MrScanDataParametersMatrix
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
MrScanDataParametersVoxelres
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
MrSessionData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶ Bases:
xnat.classes.ImageSessionData
-
field_strength
¶ Free form text to indicate the field strength used in this scanning session
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)¶
-
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)¶
-
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
ofxnat.classes.OptScanDataDcmvalidation
-
parameters
¶ Property of type:
listing
ofxnat.classes.OptScanDataParameters
-
-
class
xnat.classes.
OptScanDataDcmvalidation
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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
ofxnat.classes.OptScanDataParametersFov
-
voxel_res
¶ Property of type:
listing
ofxnat.classes.OptScanDataParametersVoxelres
-
-
class
xnat.classes.
OptScanDataParametersFov
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
OptScanDataParametersVoxelres
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
OptSessionData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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)¶
-
class
xnat.classes.
OtherQcScanData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶ Bases:
xnat.classes.QcScanData
-
class
xnat.classes.
PVisitData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶ Bases:
xnat.classes.GenericData
-
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
-
start_date
¶ Property of type:
datetime.datetime
-
-
class
xnat.classes.
PetAssessorData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
PetQcScanData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶ Bases:
xnat.classes.QcScanData
-
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
ofxnat.classes.PetScanDataEcatvalidation
-
parameters
¶ Property of type:
listing
ofxnat.classes.PetScanDataParameters
-
-
class
xnat.classes.
PetScanDataEcatvalidation
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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
¶
-
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
ofxnat.classes.PetScanDataParametersDimensions
-
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
ofxnat.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
ofxnat.classes.PetScanDataParametersFrames
-
offset
¶ Property of type:
listing
ofxnat.classes.PetScanDataParametersOffset
-
pixel_size
¶ Property of type:
listing
ofxnat.classes.PetScanDataParametersPixelsize
-
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
-
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
-
resolution
¶ Property of type:
listing
ofxnat.classes.PetScanDataParametersResolution
-
rfilter
¶ Property of type:
listing
ofxnat.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
-
zfilter
¶ Property of type:
listing
ofxnat.classes.PetScanDataParametersZfilter
-
-
class
xnat.classes.
PetScanDataParametersDimensions
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
PetScanDataParametersFilter
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
PetScanDataParametersFrames
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
PetScanDataParametersFramesFrame
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
PetScanDataParametersOffset
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
PetScanDataParametersPixelsize
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
PetScanDataParametersResolution
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
PetScanDataParametersRfilter
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
PetScanDataParametersZfilter
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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_time
¶ Property of type:
datetime.datetime
-
start_time
¶ Property of type:
datetime.datetime
-
start_time_injection
¶ Property of type:
datetime.datetime
-
start_time_scan
¶ Property of type:
datetime.datetime
-
tracer
¶ Radio-Pharmaceutical
Property of type:
listing
ofxnat.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
ofxnat.classes.PetSessionDataTracerDose
-
intermediate
¶ Property of type:
listing
ofxnat.classes.PetSessionDataTracerIntermediate
-
isotope
¶ Property of type:
listing
ofxnat.classes.PetSessionDataTracerIsotope
-
start_time
¶ Property of type:
datetime.datetime
-
total_mass
¶ Property of type:
listing
ofxnat.classes.PetSessionDataTracerTotalmass
-
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)¶
-
class
xnat.classes.
PetSessionDataTracerIntermediate
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
PetSessionDataTracerIsotope
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
PetSessionDataTracerTotalmass
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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_time
¶ Property of type:
datetime.datetime
-
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
-
start_time
¶ Property of type:
datetime.datetime
-
start_time_injection
¶ Property of type:
datetime.datetime
-
start_time_scan
¶ Property of type:
datetime.datetime
-
tracer
¶ Radio-Pharmaceutical
Property of type:
listing
ofxnat.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
ofxnat.classes.PetmrSessionDataTracerDose
-
intermediate
¶ Property of type:
listing
ofxnat.classes.PetmrSessionDataTracerIntermediate
-
isotope
¶ Property of type:
listing
ofxnat.classes.PetmrSessionDataTracerIsotope
-
start_time
¶ Property of type:
datetime.datetime
-
total_mass
¶ Property of type:
listing
ofxnat.classes.PetmrSessionDataTracerTotalmass
-
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)¶
-
class
xnat.classes.
PetmrSessionDataTracerIntermediate
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
PetmrSessionDataTracerIsotope
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
PetmrSessionDataTracerTotalmass
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
PossibleValueString
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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'¶
-
aliases
¶
-
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:
-
experiments
¶
-
fields
¶
-
files
¶
-
fulluri
¶
-
investigators
¶
-
pi
¶ Property of type:
listing
ofxnat.classes.InvestigatorData
-
publications
¶
-
resources
¶
-
study_protocol
¶
-
subjects
¶
-
-
class
xnat.classes.
ProjectDataAliases
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
ProjectDataFields
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
ProjectParticipant
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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)¶
-
class
xnat.classes.
QcAssessmentData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶ Bases:
xnat.classes.MrAssessorData
-
class
xnat.classes.
QcAssessmentDataScans
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶ Bases:
xnat.classes.XNATSubObjectMixin
-
scan_statistics
¶ Property of type:
listing
ofxnat.classes.AbstractStatistics
-
-
class
xnat.classes.
QcAssessmentDataScansScanSliceqc
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶ Bases:
xnat.classes.XNATSubObjectMixin
-
slice_statistics
¶ Property of type:
listing
ofxnat.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
-
incidental_findings
¶ Possible clinical findings made during Quality Control. Not necessarily authorizative or clinical diagnoses. Further investigation required.
Property of type:
str
-
scans
¶
-
-
class
xnat.classes.
QcScanData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶ Bases:
xnat.classes.XNATNestedObjectMixin
-
fields
¶
-
rating
¶ Property of type:
listing
ofxnat.classes.QcScanDataRating
-
-
class
xnat.classes.
QcScanDataFields
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
QcScanDataRating
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
RatingString
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
ReconstructedImageData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶ Bases:
xnat.classes.XNATObjectMixin
-
computations
¶
-
parameters
¶
-
-
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
ofxnat.classes.AbstractResource
-
creator
¶ Property of type:
listing
ofxnat.classes.RegionResourceCreator
-
file
¶ details of the region file
Property of type:
listing
ofxnat.classes.AbstractResource
-
subregionlabels
¶
-
-
class
xnat.classes.
RegionResourceCreator
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
RegionResourceSubregionlabels
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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)¶
-
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)¶
-
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)¶
-
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)¶
-
class
xnat.classes.
SamplingIntervalFloat
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
SamplingRateFloat
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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)¶
-
class
xnat.classes.
SegScanData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, type=None, **kwargs)¶ Bases:
xnat.classes.ImageScanData
Bases:
xnat.classes.XNATSubObjectMixin
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)¶
-
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)¶
-
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
¶
-
additional_statistics
¶
-
-
class
xnat.classes.
StatisticsDataAddfield
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
StatisticsDataAdditionalstatistics
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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
¶
-
image_session_types
¶
-
subject_groups
¶
-
subject_variables
¶
-
-
class
xnat.classes.
StudyProtocolAcqconditions
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
StudyProtocolImagesessiontypes
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
StudyProtocolSubjectgroups
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
StudyProtocolSubjectvariables
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
SubjectAssessorData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶ Bases:
xnat.classes.ExperimentData
-
fulluri
¶
-
subject
¶
-
-
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
¶
-
demographics
¶ Property of type:
listing
ofxnat.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:
-
experiments
¶
-
fields
¶
-
files
¶
-
fulluri
¶
-
investigator
¶ Property of type:
listing
ofxnat.classes.InvestigatorData
-
label
¶
-
metadata
¶ Property of type:
listing
ofxnat.classes.AbstractSubjectMetadata
-
resources
¶
-
sharing
¶
-
-
class
xnat.classes.
SubjectDataAddid
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
SubjectDataFields
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
SubjectMetadata
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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
¶
-
-
class
xnat.classes.
SubjectVariablesDataVariables
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
TagString
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
TotalMassFloat
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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)¶
-
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
-
-
class
xnat.classes.
VariableString
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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
-
subregions
¶
-
-
class
xnat.classes.
VolumetricRegionSubregions
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
WeightFloat
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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¶
-
classmethod
-
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)¶
-
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
ofxnat.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
ofxnat.classes.ContrastBolus
-
fov
¶ Property of type:
listing
ofxnat.classes.XaScanDataParametersFov
-
pixel_res
¶ Property of type:
listing
ofxnat.classes.XaScanDataParametersPixelres
-
-
class
xnat.classes.
XaScanDataParametersFov
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
XaScanDataParametersPixelres
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
class
xnat.classes.
XaSessionData
(uri=None, xnat_session=None, id_=None, datafields=None, parent=None, fieldname=None, overwrites=None, **kwargs)¶
-
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)¶
-
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)¶
-
xnat.classes.
current_session
()¶