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

property data_type¶: Property of type: str

property description¶: Property of type: str

property id¶: Property of type: str

property 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, xnat.mixin.AbstractResource

property label¶: Property of type: str

property note¶: Property of type: str

property tags¶: listing of xnat.classes.AbstractResourceTags

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

Bases: xnat.classes.XNATSubObjectMixin

property 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.XNATSubObjectMixin

property 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

property 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

property 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

property 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

property name¶: Property of type: str

name_code¶: Property of type: listing of xnat.classes.DicomCodedValue

property parameters¶: Property of type: str

property source¶: Property of type: str

property 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

property 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

property name¶: Property of type: str

property source¶: Property of type: str

property units¶: Property of type: str

property 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

property active_ingredient¶: Property of type: str

property agent¶: Property of type: str

property concentration¶

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

Property of type: float

property flow_duration¶

In s

Property of type: float

property flow_rate¶

In ml/s

Property of type: float

property route¶

Administration route

Property of type: str

property total_dose¶

Total amount of undiluted agent (in ml)

Property of type: float

property 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

property 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

property acquisition_number¶

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

Property of type: int

property 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

property convolution_kernel¶

Label describing convolution kernel or algorithm used for reconstruction

Property of type: str

property 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

property distance_source_to_detector¶

Distance from source to detector center, in mm

Property of type: float

property 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

property exposure¶

in mA

Property of type: float

property exposure_time¶

in ms

Property of type: float

property filter¶

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

Property of type: str

property 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

property gantry_tilt¶

Nominal scanning gantry tilt angle, in degrees

Property of type: float

property generator_power¶

Power to the x-ray generator, in kW

Property of type: float

property image_type¶: Property of type: str

property kvp¶

Peak output of X-ray generator, in kV

Property of type: float

property options¶: Property of type: str

property orientation¶: Property of type: str

property 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

property rotation_direction¶

CW=clockwise; CC=counterclockwise

Property of type: str

property subject_position¶: Property of type: str

property table_feed_per_rotation¶

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

Property of type: float

property table_height¶

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

Property of type: float

property table_speed¶

in mm/s

Property of type: float

voxel_res¶: Property of type: listing of xnat.classes.CtScanDataParametersVoxelres

property 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

property single¶

Width of a single row of acquired data, in mm

Property of type: float

property 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

property x¶: Property of type: int

property 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

property units¶: Property of type: str

property x¶: Property of type: float

property y¶: Property of type: float

property 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

property 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

property 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

property 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

property age¶: Property of type: int

property birth_weight¶: Property of type: float

property dob¶: Property of type: datetime.date

property education¶: Property of type: int

property education_desc¶: Property of type: str

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

Property of type: int

property ethnicity¶: Property of type: str

property gender¶: Property of type: str

property gestational_age¶: Property of type: float

property handedness¶: Property of type: str

height¶: Property of type: listing of xnat.classes.DemographicDataHeight

property post_menstrual_age¶: Property of type: float

property race¶: Property of type: str

property race2¶: Property of type: str

property race3¶: Property of type: str

property race4¶: Property of type: str

property race5¶: Property of type: str

property race6¶: Property of type: str

property ses¶

Socioeconomic status

Property of type: int

weight¶: Property of type: listing of xnat.classes.DemographicDataWeight

property 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

property 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

property 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

property 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, xnat.mixin.DerivedData

provenance¶: Property of type: listing of xnat.classes.Process

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

Bases: xnat.classes.XNATNestedObjectMixin

property designator¶: Property of type: str

property meaning¶: Property of type: str

property value¶: Property of type: str

property 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

property cache_path¶: Property of type: str

property content¶

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

Property of type: str

property description¶

Free-form comments about files

Property of type: str

dimensions¶: Property of type: listing of xnat.classes.DicomSeriesDimensions

property format¶

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

Property of type: str

property image_set¶: listing of xnat.classes.DicomSeriesImageset

property orientation¶: Property of type: str

property 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

property volumes¶: Property of type: int

property x¶: Property of type: int

property y¶: Property of type: int

property 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

property instance_number¶: Property of type: int

property sop_instance_uid¶: Property of type: str

property 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

property units¶: Property of type: str

property x¶: Property of type: float

property y¶: Property of type: float

property 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

property 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

property 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

property 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

property high_cut_off¶: Property of type: str

property low_cut_off¶: Property of type: str

property name¶: Property of type: str

property notch¶: Property of type: str

property 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

property 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

property duration¶: Property of type: float

property 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

property impedance¶: listing of xnat.classes.EegScanDataSoftwarefiltersimpedancesImpedance

property 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

property name¶: Property of type: str

property 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

property data_format_version¶: Property of type: str

property 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

property 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

property 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

property 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, xnat.mixin.ExperimentData

property acquisition_site¶: Property of type: str

property date¶

Date on which experiment was conducted

Property of type: datetime.date

delay¶: Property of type: listing of xnat.classes.ExperimentDataDelay

property duration¶

Duration of experiment

Property of type: datetime.timedelta

property fields¶: listing of xnat.classes.ExperimentDataFields

investigator¶: Property of type: listing of xnat.classes.InvestigatorData

property note¶

Free form text for misc. information

Property of type: str

property original¶: Property of type: str

property project¶: Property of type: str

property protocol¶: Property of type: str

property resources¶: listing of xnat.classes.AbstractResource

property sharing¶: listing of xnat.classes.ExperimentDataSharing

property time¶

Time experiment was conducted

Property of type: datetime.time

validation¶: Property of type: listing of xnat.classes.ValidationData

property version¶: Property of type: int

property visit¶: Property of type: str

property 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

property 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

property 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

property label¶: Property of type: str

property project¶: Property of type: str

property protocol¶: Property of type: str

property 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

property data_type¶: Property of type: str

property description¶: Property of type: str

property fields¶: listing of xnat.classes.FieldDefinitionGroupFields

property id¶: Property of type: str

property project_specific¶: Property of type: bool

property 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

property datatype¶: Property of type: str

property group¶: Property of type: str

property name¶: Property of type: str

property possible_values¶: listing of xnat.classes.FieldDefinitionGroupFieldsFieldPossiblevalues

property required¶: Property of type: bool

property sequence¶: Property of type: int

property type¶: Property of type: str

property 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

property 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

property 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'¶

property cat_id¶

property collection¶

property data¶: The data of the current object (data fields only)

delete()¶: Remove the item from XNATSession

property digest¶

download(*args, **kwargs)¶

download_stream(*args, **kwargs)¶

property file_content¶

property file_format¶

property file_size¶

property file_tags¶

property fulldata¶: The full data of the current object (incl children, meta etc)

property id¶

open()¶

property path¶

property 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

property 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

property image_session_id¶: Property of type: str

property in_¶: listing of xnat.classes.AbstractResource

property out¶: listing of xnat.classes.AbstractResource

property 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

property 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

property volumes¶: Property of type: int

property x¶: Property of type: int

property y¶: Property of type: int

property 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

property 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

property volumes¶: Property of type: int

property x¶: Property of type: int

property y¶: Property of type: int

property 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

property units¶: Property of type: str

property x¶: Property of type: float

property y¶: Property of type: float

property 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

property units¶: Property of type: str

property x¶: Property of type: float

property y¶: Property of type: float

property 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, xnat.mixin.ImageScanData

property condition¶: Property of type: str

property documentation¶: Property of type: str

property file¶: listing of xnat.classes.AbstractResource

property frames¶: Property of type: int

property image_session_id¶: Property of type: str

property modality¶: Property of type: str

property note¶: Property of type: str

property operator¶

Free form text to indicate individuals who operated scanner

Property of type: str

property project¶: Property of type: str

property quality¶: Property of type: str

scanner¶

Free form text to indicate name/ID of scanner

Property of type: listing of xnat.classes.ImageScanDataScanner

property series_class¶: Property of type: str

property series_description¶: Property of type: str

property sharing¶: listing of xnat.classes.ImageScanDataSharing

property start_date¶

Date the scan started

Property of type: datetime.date

property start_time¶

Time the scan started

Property of type: datetime.time

property type¶: Property of type: str

property 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

property manufacturer¶: Property of type: str

property model¶: Property of type: str

property 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

property label¶: Property of type: str

property 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, xnat.mixin.ImageSessionData

property assessors¶: listing of xnat.classes.ImageAssessorData

property dcm_accession_number¶

DICOM Accession Number (0008,0050)

Property of type: str

property dcm_patient_birth_date¶

DICOM Patient’s Birth Date (0010,0030)

Property of type: datetime.date

property dcm_patient_id¶

DICOM Patient ID (0010,0020)

Property of type: str

property dcm_patient_name¶

DICOM Patient’s Name (0010,0010)

Property of type: str

property dcm_patient_weight¶

DICOM Patient’s Weight (0010,1031)

Property of type: float

property modality¶: Property of type: str

property operator¶

Free form text to indicate individuals who operated scanner

Property of type: str

property prearchive_path¶: Property of type: str

property reconstructions¶: listing of xnat.classes.ReconstructedImageData

property regions¶: listing of xnat.classes.RegionResource

scanner¶

Free form text to indicate name/ID of scanner

Property of type: listing of xnat.classes.ImageSessionDataScanner

property scans¶: listing of xnat.classes.ImageScanData

property session_type¶: Property of type: str

property study_id¶: Property of type: str

property 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

property manufacturer¶: Property of type: str

property 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

property 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, xnat.mixin.InvestigatorData

property department¶: Property of type: str

property email¶: Property of type: str

property firstname¶: Property of type: str

property institution¶: Property of type: str

property lastname¶: Property of type: str

property phone¶: Property of type: str

property 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

property 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.XNATSubObjectMixin

property 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

property 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

property blurring¶

Bluring, Ghosting, or Ringing artifacts on the Scan

Property of type: str

property flow¶: Property of type: str

property image_contrast¶: Property of type: str

property inhomogeneity¶: Property of type: str

property interpac_motion¶: Property of type: str

property susceptibility¶: Property of type: str

property 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

property 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

property field_strength¶

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

Property of type: str

property file_name_uuid¶: Property of type: str

property 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

property 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

property 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

property acq_time¶: Property of type: str

property acq_type¶: Property of type: str

property add_param¶: listing of xnat.classes.AddField

property coil¶

Free form text to indicate the coil used in this scan

Property of type: str

property coil_elements¶: Property of type: str

property delta_te¶: Property of type: float

diffusion¶: Property of type: listing of xnat.classes.MrScanDataParametersDiffusion

property dti_acq_count¶: Property of type: int

property echo_spacing¶

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

Property of type: float

property flip¶: Property of type: int

fov¶: Property of type: listing of xnat.classes.MrScanDataParametersFov

property 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

property orientation¶: Property of type: str

property origin¶: Property of type: str

property partitions¶: Property of type: int

property phase_encoding_direction¶

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

Property of type: str

property pixel_bandwidth¶

Reciprocal of the total sampling period, in Hz/pixel

Property of type: float

property pmc¶: Property of type: str

property readout_sample_spacing¶: Property of type: str

property scan_options¶: Property of type: str

property scan_sequence¶: Property of type: str

property seq_variant¶: Property of type: str

property sequence¶: Property of type: str

property subject_position¶: Property of type: str

property te¶: Property of type: float

property ti¶: Property of type: float

property 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

property anisotropy_type¶: Property of type: str

property b_max¶: Property of type: str

property b_values¶: Property of type: str

property directionality¶: Property of type: str

property orientations¶: Property of type: str

property 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

property x¶: Property of type: int

property 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

property direction¶: Property of type: str

property direction_positive¶

from Siemens image shadow data (0029,1010) PhaseEncodingDirectionPositive

Property of type: str

property polarity_swap¶: Property of type: str

property 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

property x¶: Property of type: int

property 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

property units¶: Property of type: str

property x¶: Property of type: float

property y¶: Property of type: float

property 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

property coil¶

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

Property of type: str

property field_strength¶

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

Property of type: str

property marker¶

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

Property of type: str

property 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

property 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

property illumination_power¶

Power of the illuminator in microwatts at corneal plane

Property of type: str

property illumination_wavelength¶

Wavelength of the illuminator, in nm

Property of type: str

property image_type¶: Property of type: str

property 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

property x¶: Property of type: int

property 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

property units¶: Property of type: str

property x¶: Property of type: float

property y¶: Property of type: float

property 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

property 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

property closed¶: Property of type: bool

property end_date¶: Property of type: datetime.datetime

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

Property of type: str

property protocol_id¶: Property of type: str

property protocol_version¶: Property of type: int

property start_date¶: Property of type: datetime.datetime

property status¶: Property of type: str

property subject_id¶: Property of type: str

property terminal¶: Property of type: bool

property visit_name¶: Property of type: str

property 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

property acceptable_voxel_size¶: Property of type: str

property acquisition¶: Property of type: str

property bottom_cutoff¶: Property of type: str

property correct_filters¶: Property of type: str

property correct_iterations_and_subsets¶: Property of type: str

property correct_reconstruction_algorithm¶: Property of type: str

property correct_slice_thickness¶: Property of type: str

property processing_errors¶: listing of str

property qc_outcome¶: Property of type: str

property qc_outcome_reason¶: Property of type: str

property reason_frames_unacceptable¶: Property of type: str

property reconstruction_algorithm_used¶: Property of type: str

property top_cutoff¶: Property of type: str

property 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

property 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

property 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

property add_param¶: listing of xnat.classes.AddField

property annotation¶: Property of type: str

property bed_position¶: Property of type: float

property bin_size¶

Width of view sample (in cm)

Property of type: float

property 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

property ecat_calibration_factor¶: Property of type: float

property facility¶: Property of type: str

property 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

property 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

property gate_duration¶

Gate duration (in msec)

Property of type: int

property mt_1_1¶

Matrix transformation element (1,1).

Property of type: float

property mt_1_2¶

Matrix transformation element (1,2).

Property of type: float

property mt_1_3¶

Matrix transformation element (1,3).

Property of type: float

property mt_1_4¶

Matrix transformation element (1,4).

Property of type: float

property mt_2_1¶

Matrix transformation element (2,1).

Property of type: float

property mt_2_2¶

Matrix transformation element (2,2).

Property of type: float

property mt_2_3¶

Matrix transformation element (2,3).

Property of type: float

property mt_2_4¶

Matrix transformation element (2,4).

Property of type: float

property mt_3_1¶

Matrix transformation element (3,1).

Property of type: float

property mt_3_2¶

Matrix transformation element (3,2).

Property of type: float

property mt_3_3¶

Matrix transformation element (3,3).

Property of type: float

property mt_3_4¶

Matrix transformation element (3,4).

Property of type: float

property num_accepted_beats¶

Number of accepted beats for this gate

Property of type: int

property num_angles¶

Number of angles from sinogram

Property of type: float

property num_gates¶: Property of type: int

property num_planes¶: Property of type: int

property num_relements¶

Number R elements from sinogram

Property of type: float

offset¶: Property of type: listing of xnat.classes.PetScanDataParametersOffset

property orientation¶: Property of type: int

property original_file_name¶

Scan file creation name

Property of type: str

pixel_size¶: Property of type: listing of xnat.classes.PetScanDataParametersPixelsize

property plane_separation¶: Physical distance between adjacent planes (in cm.)

Property of type: float

property 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

property r_wave_offset¶: R wave offset (For phase sliced studies, average, in msec)

Property of type: int

property 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

property recon_views¶

Number of views used to reconstruct the data

Property of type: int

property 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

property scatter_type¶: Enumerated type (0=None, 1=Deconvolution, 2=Simulated, 3=Dual Energy)

Property of type: int

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

Property of type: int

property transaxial_fov¶

Diameter (in cm.) of transaxial view

Property of type: float

zfilter¶: Property of type: listing of xnat.classes.PetScanDataParametersZfilter

property 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

property num¶

Number of dimensions

Property of type: int

property x¶

Dimension along x axis

Property of type: int

property y¶

Dimension along y axis

Property of type: int

property 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

property 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

property frame¶: listing of xnat.classes.PetScanDataParametersFramesFrame

property 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

property length¶: Property of type: float

property number¶: Property of type: str

property starttime¶: Property of type: float

property 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

property x¶

Offset in x axis for recon target (in cm)

Property of type: float

property y¶

Offset in y axis for recon target (in cm)

Property of type: float

property 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

property x¶

X dimension pixel size (in cm)

Property of type: float

property y¶

Y dimension pixel size (in cm)

Property of type: float

property 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

property x¶

Resolution in the x dimension (in cm)

Property of type: float

property y¶

Resolution in the y dimension (in cm)

Property of type: float

property 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

property code¶: Property of type: int

property cutoff¶: Property of type: float

property order¶: Property of type: int

property 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

property code¶: Property of type: int

property cutoff¶: Property of type: float

property order¶: Property of type: int

property 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

property blood_glucose¶: Property of type: float

property blood_glucose_time¶: Property of type: datetime.datetime

property blood_glucose_units¶: Property of type: str

property patient_id¶

Patient identification descriptor

Property of type: str

property patient_name¶

Patient name (free format ASCII)

Property of type: str

property stabilization¶

Free form text to indicate method used to stabilize head

Property of type: str

property start_time¶: Property of type: datetime.datetime

property start_time_injection¶: Property of type: datetime.datetime

property start_time_scan¶: Property of type: datetime.datetime

property 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

property name¶: Property of type: str

property specific_activity¶: Property of type: float

property start_time¶: Property of type: datetime.datetime

total_mass¶: Property of type: listing of xnat.classes.PetSessionDataTracerTotalmass

property transmissions¶: Property of type: int

property 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

property 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

property 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

property 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

property 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

property blood_glucose¶: Property of type: float

property blood_glucose_time¶: Property of type: datetime.datetime

property blood_glucose_units¶: Property of type: str

property coil¶

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

Property of type: str

property field_strength¶

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

Property of type: str

property marker¶

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

Property of type: str

property patient_id¶

Patient identification descriptor

Property of type: str

property patient_name¶

Patient name (free format ASCII)

Property of type: str

property stabilization¶

Free form text to indicate method used to stabilize head

Property of type: str

property start_time¶: Property of type: datetime.datetime

property start_time_injection¶: Property of type: datetime.datetime

property start_time_scan¶: Property of type: datetime.datetime

property 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

property name¶: Property of type: str

property specific_activity¶: Property of type: float

property start_time¶: Property of type: datetime.datetime

total_mass¶: Property of type: listing of xnat.classes.PetmrSessionDataTracerTotalmass

property transmissions¶: Property of type: int

property 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

property 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

property 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

property 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

property 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

property 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, xnat.mixin.ProjectData

property active¶: Property of type: bool

property aliases¶: listing of xnat.classes.ProjectDataAliases

property description¶: Property of type: str

property fields¶: listing of xnat.classes.ProjectDataFields

property investigators¶: listing of xnat.classes.InvestigatorData

property keywords¶: Property of type: str

property name¶: Property of type: str

pi¶: Property of type: listing of xnat.classes.InvestigatorData

property publications¶: listing of xnat.classes.PublicationResource

property secondary_id¶: Property of type: str

property study_protocol¶: listing of xnat.classes.AbstractProtocol

property 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

property 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

property 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

property group¶: Property of type: str

property label¶: Property of type: str

property project¶: Property of type: str

property 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

property abstract¶: Property of type: str

property citation¶: Property of type: str

property commentary¶: Property of type: str

property doi¶: Property of type: str

property is_primary¶: Property of type: bool

property medline¶: Property of type: str

property other¶: Property of type: str

property pubmed¶: Property of type: str

property title¶: Property of type: str

property 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

property scans¶: listing of xnat.classes.QcAssessmentDataScans

property 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

property id¶: Property of type: str

scan_statistics¶: Property of type: listing of xnat.classes.AbstractStatistics

property 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

property 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

property comments¶: Property of type: str

property incidental_findings¶

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

Property of type: str

property pass_¶: Property of type: str

property payable¶: Property of type: str

property rater¶: Property of type: str

property rescan¶: Property of type: str

property resolvable¶: Property of type: str

property retrain¶: Property of type: str

property scans¶: listing of xnat.classes.QcScanData

property 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

property comments¶: Property of type: str

property coverage¶: Property of type: str

property fields¶: listing of xnat.classes.QcScanDataFields

property image_scan_id¶: Property of type: str

property motion¶: Property of type: str

property other_image_artifacts¶: Property of type: str

property pass_¶: Property of type: str

property 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

property 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

property 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

property 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

property base_scan_type¶: Property of type: str

property computations¶: listing of xnat.classes.ComputationData

property id¶: Property of type: str

property image_session_id¶: Property of type: str

property in_¶: listing of xnat.classes.AbstractResource

property in_scans¶: listing of str

property out¶: listing of xnat.classes.AbstractResource

property parameters¶: listing of xnat.classes.AddField

provenance¶: Property of type: listing of xnat.classes.Process

property 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

property hemisphere¶: Property of type: str

property name¶

Name of the region eg Brainstem

Property of type: str

property session_id¶: Property of type: str

property 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

property firstname¶: Property of type: str

property 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

property hemisphere¶: Property of type: str

property 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

property cache_path¶: Property of type: str

property content¶

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

Property of type: str

property description¶

Free-form comments about file

Property of type: str

property 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

property cache_path¶: Property of type: str

property content¶

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

Property of type: str

property count¶: Property of type: int

property description¶

Free-form comments about files

Property of type: str

property format¶

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

Property of type: str

property name¶: Property of type: str

property path¶: Property of type: str

property 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

property 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

property 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

property 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

property 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

property add_field¶: listing of xnat.classes.StatisticsDataAddfield

property additional_statistics¶: listing of xnat.classes.StatisticsDataAdditionalstatistics

property max¶: Property of type: float

property mean¶: Property of type: float

property min¶: Property of type: float

property no_of_voxels¶: Property of type: int

property snr¶: Property of type: float

property 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

property 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

property 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

property acq_conditions¶: listing of xnat.classes.StudyProtocolAcqconditions

property image_session_types¶: listing of xnat.classes.StudyProtocolImagesessiontypes

property subject_groups¶: listing of xnat.classes.StudyProtocolSubjectgroups

property 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

property description¶: Property of type: str

property id¶: Property of type: str

property 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

property description¶: Property of type: str

property id¶: Property of type: str

property 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

property description¶: Property of type: str

property id¶: Property of type: str

property 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

property description¶: Property of type: str

property id¶: Property of type: str

property 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, xnat.mixin.SubjectAssessorData

property age¶: Property of type: float

property 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, xnat.mixin.SubjectData

property add_id¶: listing of xnat.classes.SubjectDataAddid

demographics¶: Property of type: listing of xnat.classes.AbstractDemographicData

property experiments¶: listing of xnat.classes.SubjectAssessorData

property fields¶: listing of xnat.classes.SubjectDataFields

property group¶: Property of type: str

property initials¶: Property of type: str

investigator¶: Property of type: listing of xnat.classes.InvestigatorData

metadata¶: Property of type: listing of xnat.classes.AbstractSubjectMetadata

property project¶: Property of type: str

property resources¶: listing of xnat.classes.AbstractResource

property sharing¶: listing of xnat.classes.ProjectParticipant

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property date¶: Property of type: datetime.date

property method¶: Property of type: str

property notes¶: Property of type: str

property status¶: Property of type: str

property 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

property 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

property hemisphere¶: Property of type: str

property name¶: Property of type: str

property subregions¶: listing of xnat.classes.VolumetricRegionSubregions

property units¶: Property of type: str

property 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

property name¶: Property of type: str

property 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

property 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

property derivation¶

Text description of how this image was derived

Property of type: str

fov¶: Property of type: listing of xnat.classes.XaScanDataParametersFov

property image_type¶: Property of type: str

property options¶: Property of type: str

property 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

property x¶: Property of type: int

property 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

property units¶: Property of type: str

property x¶: Property of type: int

property 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()¶

Read the Docs v: 0.4.1

Versions: latest; stable; 0.4.1; 0.4.0; 0.3.28; 0.3.27; 0.3.26; 0.3.25; 0.3.24; 0.3.23; 0.3.22; 0.3.21; 0.3.20; 0.3.19; 0.3.18; 0.3.17; 0.3.16; 0.3.15; 0.3.14; 0.3.13; 0.3.12; 0.3.11; 0.3.10; develop

Downloads

On Read the Docs: Project Home; Builds