Reference Manual#
This section contains reference documentation of the CLI and Python classes. The code generated by XNAT based on a standard XNAT server XSD is contained in the final section.
- Command-line interface
- Code reference
XSD ClassesDocumentationAbstractDemographicDataAbstractProjectAssetAbstractProtocolAbstractResourceAbstractStatisticsAbstractSubjectMetadataAddFieldAlgorithmComputationDataContrastBolusCrScanDataCrSessionDataCtQcScanDataCtScanDataCtSessionDataDatatypeProtocolDemographicDataDerivedDataDicomCodedValueDicomSeriesDx3DCraniofacialScanDataDx3DCraniofacialSessionDataDxScanDataDxSessionDataEcgScanDataEcgSessionDataEegScanDataEegSessionDataEpsScanDataEpsSessionDataEsScanDataEsSessionDataEsvScanDataEsvSessionDataExperimentDataFieldDefinitionGroupFileDataGenericDataGmScanDataGmSessionDataGmvScanDataGmvSessionDataHdScanDataHdSessionDataImageAssessorDataImageResourceImageResourceSeriesImageScanDataImageSessionDataInvestigatorDataIoScanDataIoSessionDataMegScanDataMegSessionDataMgScanDataMgSessionDataMrAssessorDataMrQcScanDataMrScanDataMrSessionDataMrsScanDataNmScanDataNmSessionDataOpScanDataOpSessionDataOptScanDataOptSessionDataOtherDicomScanDataOtherDicomSessionDataOtherQcScanDataPVisitDataPetAssessorDataPetQcScanDataPetScanDataPetSessionDataPetmrSessionDataProjectDataProjectParticipantPublicationResourceQcAssessmentDataQcManualAssessorDataQcScanDataReconstructedImageDataRegionResourceResourceResourceCatalogResourceSeriesRfScanDataRfSessionDataRgScanDataRgSessionDataRtImageScanDataRtSessionDataScScanDataSegScanDataSmScanDataSmSessionDataSrScanDataSrSessionDataStatisticsDataStudyProtocolSubjectAssessorDataSubjectDataSubjectMetadataSubjectVariablesDataUsScanDataUsSessionDataValidationDataVoiceAudioScanDataVolumetricRegionXNATNestedObjectMixinXNATObjectMixinXNATSubObjectMixinXa3DScanDataXa3DSessionDataXaScanDataXaSessionDataXcScanDataXcSessionDataXcvScanDataXcvSessionDataXdatJsonbXdatLONGVARCHARXnatpyAbstractResourceTagsXnatpyAddFieldStringXnatpyAddIDStringXnatpyAdditionalStatisticsDoubleXnatpyAliasStringXnatpyCtScanDataDcmvalidationXnatpyCtScanDataParametersXnatpyCtScanDataParametersCollimationwidthXnatpyCtScanDataParametersDerivationXnatpyCtScanDataParametersEstimateddosesavingXnatpyCtScanDataParametersFovXnatpyCtScanDataParametersRescaleXnatpyCtScanDataParametersVoxelresXnatpyDcmValidationStringXnatpyDelayIntegerXnatpyDemographicDataHeightXnatpyDemographicDataWeightXnatpyDerivationStringXnatpyDicomSeriesDimensionsXnatpyDicomSeriesImagesetXnatpyDicomSeriesVoxelresXnatpyDoseFloatXnatpyEcatValidationStringXnatpyEegScanDataChannelsXnatpyEegScanDataParametersXnatpyEegScanDataParametersDatarecordXnatpyEegScanDataSoftwarefiltersimpedancesXnatpyEegScanDataSoftwarefiltersimpedancesImpedanceXnatpyEegSessionDataSamplingintervalXnatpyEegSessionDataSamplingrateXnatpyEstimatedDoseSavingFloatXnatpyExperimentDataDelayXnatpyExperimentDataFieldsXnatpyExperimentDataSharingXnatpyFieldDefinitionGroupFieldsXnatpyFieldDefinitionGroupFieldsFieldPossiblevaluesXnatpyFieldStringXnatpyHeightFloatXnatpyImageResourceDimensionsXnatpyImageResourceSeriesDimensionsXnatpyImageResourceSeriesVoxelresXnatpyImageResourceVoxelresXnatpyImageScanDataScannerXnatpyImageScanDataSharingXnatpyImageSessionDataScannerXnatpyIntermediateFloatXnatpyIsotopeStringXnatpyLabelStringXnatpyMrScanDataDcmvalidationXnatpyMrScanDataParametersXnatpyMrScanDataParametersDiffusionXnatpyMrScanDataParametersFovXnatpyMrScanDataParametersInplanephaseencodingXnatpyMrScanDataParametersMatrixXnatpyMrScanDataParametersVoxelresXnatpyOptScanDataDcmvalidationXnatpyOptScanDataParametersXnatpyOptScanDataParametersFovXnatpyOptScanDataParametersVoxelresXnatpyPetScanDataEcatvalidationXnatpyPetScanDataParametersXnatpyPetScanDataParametersDimensionsXnatpyPetScanDataParametersFilterXnatpyPetScanDataParametersFramesXnatpyPetScanDataParametersFramesFrameXnatpyPetScanDataParametersOffsetXnatpyPetScanDataParametersPixelsizeXnatpyPetScanDataParametersResolutionXnatpyPetScanDataParametersRfilterXnatpyPetScanDataParametersZfilterXnatpyPetSessionDataTracerXnatpyPetSessionDataTracerDoseXnatpyPetSessionDataTracerIntermediateXnatpyPetSessionDataTracerIsotopeXnatpyPetSessionDataTracerTotalmassXnatpyPetmrSessionDataTracerXnatpyPetmrSessionDataTracerDoseXnatpyPetmrSessionDataTracerIntermediateXnatpyPetmrSessionDataTracerIsotopeXnatpyPetmrSessionDataTracerTotalmassXnatpyPossibleValueStringXnatpyProjectDataAliasesXnatpyProjectDataFieldsXnatpyQcAssessmentDataScansXnatpyQcAssessmentDataScansScanSliceqcXnatpyQcScanDataFieldsXnatpyQcScanDataRatingXnatpyRatingStringXnatpyRegionResourceCreatorXnatpyRegionResourceSubregionlabelsXnatpySamplingIntervalFloatXnatpySamplingRateFloatXnatpyScannerStringXnatpyShareStringXnatpyStatisticsDataAddfieldXnatpyStatisticsDataAdditionalstatisticsXnatpyStudyProtocolAcqconditionsXnatpyStudyProtocolImagesessiontypesXnatpyStudyProtocolSubjectgroupsXnatpyStudyProtocolSubjectvariablesXnatpySubjectDataAddidXnatpySubjectDataFieldsXnatpySubjectVariablesDataVariablesXnatpyTagStringXnatpyTotalMassFloatXnatpyVariableStringXnatpyVolumetricRegionSubregionsXnatpyWeightFloatXnatpyXaScanDataParametersXnatpyXaScanDataParametersFovXnatpyXaScanDataParametersPixelrescurrent_session()