Record

Record is a base class grouping properties that are common to all types of DICOM records (Database, Patient, Study, Series).

Record is an abstract base class, meaning that it is inherited by all key classes but is not intended to be instantiated directly. It exists only to avoid duplicating properties in the individual derived classes.

Properties

Record.print()	Print a summary of the record and its contents.
Record.path()	Directory of the DICOM database
Record.empty()	Check if the record has data.
Record.files()	Return a list of all DICOM files saved in the database
Record.label()	Return a human-readable label describing the record.

Up and down the database

Record.parent()	Return the parent of the record.
Record.children(**kwargs)	Return all children of the record.
Record.siblings(**kwargs)	Return all siblings of the record.
Record.series([sort, sortby])	Return a list of series under the record.
Record.studies([sort, sortby])	Return a list of studies under the record.
Record.patients([sort, sortby])	Return a list of patients under the record.
Record.database()	Return the database of the record.

Editing a record

Record.new_patient(**kwargs)	Create a new patient.
Record.new_study(**kwargs)	Create a new study.
Record.new_series(**kwargs)	Create a new series.
Record.new_sibling([suffix])	Create a new sibling of the record under the same parent.
Record.new_pibling(**kwargs)	Create a new sibling of the parent record (pibling).
Record.new_child(**kwargs)	Create a new child of the record.
Record.remove()	Remove a record from the database.
Record.move_to(parent)	Move the record to another parent.
Record.copy_to(parent, **kwargs)	Return a copy of the record under another parent.
Record.copy(**kwargs)	Return a copy of the record under the same parent.

Save and restore

Record.save([path])	Save any changes made to the record.
Record.restore()	Restore the record to the last changed state.

Export to other formats

Record.export_as_dicom(path)	Export record in DICOM format to an external directory.
Record.export_as_png(path[, center, width, ...])	Export record in PNG format.
Record.export_as_csv(path)	Export record in CSV format to an external directory.
Record.export_as_nifti(path[, dims])	Export record in NIFTI format to an external directory.
Record.export_as_npy(path[, dims])	Export record in numpy's NPY format to an external directory.

User interactions

Record.message(message)	Print a message to the user.
Record.progress(value, maximum[, message])	Print progress message to the terminal..
Record.mute()	Prevent the object from sending status updates to the user
Record.unmute()	Allow the object from sending status updates to the user