API Reference

• Series Class
  • Series
    • Series.SOPClassUID
    • Series.SOPInstanceUIDs
    • Series.accessionNumber
    • Series.align()
    • Series.axes
    • Series.bodyPartExamined
    • Series.bvalues
    • Series.color
    • Series.colormap_label
    • Series.columns
    • Series.dicomTemplate
    • Series.find_axis()
    • Series.frameOfReferenceUID
    • Series.fuse_mask()
    • Series.getDicomAttribute()
    • Series.getPositionForVoxel()
    • Series.getVoxelForPosition()
    • Series.get_roi()
    • Series.get_roi_mask()
    • Series.get_slice_axis()
    • Series.get_tag_axis()
    • Series.get_transformation_components_xyz()
    • Series.imagePositions
    • Series.imageType
    • Series.input_format
    • Series.input_order
    • Series.input_sort
    • Series.laterality
    • Series.modality
    • Series.orientation
    • Series.patientBirthDate
    • Series.patientID
    • Series.patientName
    • Series.patientPosition
    • Series.photometricInterpretation
    • Series.protocolName
    • Series.rows
    • Series.seriesDate
    • Series.seriesDescription
    • Series.seriesInstanceUID
    • Series.seriesNumber
    • Series.seriesTime
    • Series.setDicomAttribute()
    • Series.shape
    • Series.show()
    • Series.sliceLocations
    • Series.slices
    • Series.sort_on
    • Series.spacing
    • Series.studyID
    • Series.studyInstanceUID
    • Series.tags
    • Series.timeline
    • Series.to_channels()
    • Series.to_rgb()
    • Series.transformationMatrix
    • Series.vertices_from_grid()
    • Series.windowCenter
    • Series.windowWidth
    • Series.write()
• Collections Class
  • Study
    • Study.write()
  • Patient
    • Patient.write()
  • Cohort
    • Cohort.write()
• Viewer Class
  • Viewer
    • Viewer.advance_data()
    • Viewer.get_roi()
    • Viewer.set_default_viewport()
    • Viewer.toggle_hide()
    • Viewer.upper_left_text()
    • Viewer.upper_right_text()
    • Viewer.viewport_advance()
    • Viewer.viewport_set()
• Imagedata packages
  • Module Axis
    • UniformAxis
    • UniformLengthAxis
    • VariableAxis
  • Module cmdline
    • CommaSepAction
    • DictAction
    • DtypeAction
    • InputOrderAction
    • OutputFormatAction
    • SortOnAction
  • Module imagedata.header
    • Header
      • Header.add_geometry()
      • Header.add_template()
      • Header.find_axis()
      • Header.new_uid()
      • Header.set_default_values()
  • Module imagedata.readdata
    • NoArchiveError
    • NoTransportError
    • UnknownOptionType
    • read()
    • sorted_plugins_dicom_first()
    • str_to_dtype()
    • write()
• Formats API Reference
  • Module imagedata.formats.abstractplugin
    • AbstractPlugin
      • AbstractPlugin.authors
      • AbstractPlugin.description
      • AbstractPlugin.getPositionForVoxel()
      • AbstractPlugin.getTimeline()
      • AbstractPlugin.getVoxelForPosition()
      • AbstractPlugin.name
      • AbstractPlugin.read()
      • AbstractPlugin.replace_geometry_attributes()
      • AbstractPlugin.url
      • AbstractPlugin.version
      • AbstractPlugin.write_3d_numpy()
      • AbstractPlugin.write_4d_numpy()
    • NoOtherInstance
  • Module imagedata.formats.dicomplugin
    • DICOMPlugin
      • DICOMPlugin.create_affine()
      • DICOMPlugin.extractDicomAttributes()
      • DICOMPlugin.getDicomAttribute()
      • DICOMPlugin.getOriginForSlice()
      • DICOMPlugin.get_dicom_files()
      • DICOMPlugin.read()
      • DICOMPlugin.read_files()
      • DICOMPlugin.removePrivateTags()
      • DICOMPlugin.setDicomAttribute()
      • DICOMPlugin.sort_images()
      • DICOMPlugin.write_3d_numpy()
      • DICOMPlugin.write_4d_numpy()
      • DICOMPlugin.write_enhanced()
      • DICOMPlugin.write_slice()
    • FilesGivenForMultipleURLs
    • NoDICOMAttributes
    • UnevenSlicesError
    • UnknownTag
    • ValueErrorWrapperPrecisionError
  • Module imagedata.formats.itkplugin
    • DependencyError
    • ITKPlugin
      • ITKPlugin.get_image_from_numpy()
      • ITKPlugin.write_3d_numpy()
      • ITKPlugin.write_4d_numpy()
      • ITKPlugin.write_numpy_itk()
    • ImageTypeError
  • Module imagedata.formats.matplugin
    • DependencyError
    • ImageTypeError
    • MatPlugin
      • MatPlugin.write_3d_numpy()
      • MatPlugin.write_4d_numpy()
    • MatrixDimensionNotImplemented
    • MultipleVariablesInMatlabFile
  • Module imagedata.formats.niftiplugin
    • NiftiPlugin
      • NiftiPlugin.extensions
      • NiftiPlugin.write_3d_numpy()
      • NiftiPlugin.write_4d_numpy()
      • NiftiPlugin.write_numpy_nifti()
• Archives API Reference
  • Module imagedata.archives.abstractarchive
    • AbstractArchive
      • AbstractArchive.add_localfile()
      • AbstractArchive.authors
      • AbstractArchive.base
      • AbstractArchive.basename()
      • AbstractArchive.close()
      • AbstractArchive.construct_filename()
      • AbstractArchive.description
      • AbstractArchive.exists()
      • AbstractArchive.getmembers()
      • AbstractArchive.getnames()
      • AbstractArchive.is_file()
      • AbstractArchive.mimetypes
      • AbstractArchive.name
      • AbstractArchive.new_local_file()
      • AbstractArchive.open()
      • AbstractArchive.path
      • AbstractArchive.root
      • AbstractArchive.set_member_naming_scheme()
      • AbstractArchive.to_localfile()
      • AbstractArchive.transport
      • AbstractArchive.url
      • AbstractArchive.use_query()
      • AbstractArchive.version
      • AbstractArchive.writedata()
    • Member
    • NoOtherInstance
    • WriteMultipleArchives
  • Module imagedata.archives.filesystemarchive
    • FilesystemArchive
      • FilesystemArchive.add_localfile()
      • FilesystemArchive.base
      • FilesystemArchive.basename()
      • FilesystemArchive.close()
      • FilesystemArchive.construct_filename()
      • FilesystemArchive.exists()
      • FilesystemArchive.getmembers()
      • FilesystemArchive.getnames()
      • FilesystemArchive.is_file()
      • FilesystemArchive.new_local_file()
      • FilesystemArchive.open()
      • FilesystemArchive.path
      • FilesystemArchive.root
      • FilesystemArchive.to_localfile()
      • FilesystemArchive.use_query()
      • FilesystemArchive.writedata()
    • NoSuchFile
    • ReadOnlyError
    • WriteOnFile
  • Module imagedata.archives.zipfilearchive
    • WriteFileIO
      • WriteFileIO.close()
    • ZipfileArchive
      • ZipfileArchive.add_localfile()
      • ZipfileArchive.base
      • ZipfileArchive.basename()
      • ZipfileArchive.close()
      • ZipfileArchive.construct_filename()
      • ZipfileArchive.exists()
      • ZipfileArchive.getmembers()
      • ZipfileArchive.getnames()
      • ZipfileArchive.is_file()
      • ZipfileArchive.new_local_file()
      • ZipfileArchive.open()
      • ZipfileArchive.path
      • ZipfileArchive.root
      • ZipfileArchive.to_localfile()
      • ZipfileArchive.use_query()
      • ZipfileArchive.writedata()
• Transports API Reference
  • Module imagedata.transports.abstracttransport
    • AbstractTransport
      • AbstractTransport.authors
      • AbstractTransport.close()
      • AbstractTransport.description
      • AbstractTransport.exists()
      • AbstractTransport.info()
      • AbstractTransport.isfile()
      • AbstractTransport.name
      • AbstractTransport.open()
      • AbstractTransport.schemes
      • AbstractTransport.url
      • AbstractTransport.version
      • AbstractTransport.walk()
    • NoOtherInstance
  • Module imagedata.transports.dicomtransport
    • AssociationFailed
    • AssociationNotEstablished
    • DicomTransport
      • DicomTransport.close()
      • DicomTransport.exists()
      • DicomTransport.info()
      • DicomTransport.isfile()
      • DicomTransport.open()
      • DicomTransport.store()
      • DicomTransport.walk()
  • Module imagedata.transports.filetransport
    • FileTransport
      • FileTransport.close()
      • FileTransport.exists()
      • FileTransport.info()
      • FileTransport.isfile()
      • FileTransport.open()
      • FileTransport.walk()
  • Module imagedata.transports.xnattransport
    • XnatTransport
      • XnatTransport.close()
      • XnatTransport.exists()
      • XnatTransport.info()
      • XnatTransport.isfile()
      • XnatTransport.open()
      • XnatTransport.walk()
• Apps API Reference
  • Apps Diffusion API Reference
    • Module imagedata.apps.diffusion
      • get_b_value()
      • get_g_vectors()