IMHOTEP Framework
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Pages
Public Member Functions | Properties | List of all members
DICOMLoader Class Reference
Inheritance diagram for DICOMLoader:
Inheritance graph
[legend]
Collaboration diagram for DICOMLoader:
Collaboration graph
[legend]

Public Member Functions

bool setDirectory (string path)
 
void parseDirectory (object sender, DoWorkEventArgs e)
 
void parseDirectoryCallback (object sender, RunWorkerCompletedEventArgs e)
 
bool startLoading (DICOMSeries toLoad, int slice=0)
 
bool startLoadingSlice (int index, int slice=0)
 
bool startLoadingSlice (string seriesUID, int slice=0)
 
bool startLoadingVolume (DICOMSeries toLoad)
 
bool startLoadingVolume (int index)
 
bool startLoadingVolume (string seriesUID)
 
void load (object sender, DoWorkEventArgs e)
 
void loadCallback (object sender, RunWorkerCompletedEventArgs e)
 
void Update ()
 
void unloadVolume ()
 

Properties

static DICOMLoader instance [get, set]
 
DICOM2D currentDICOM [get, set]
 
DICOM3D currentDICOMVolume [get, set]
 
DICOMSeries currentDICOMSeries [get, set]
 
bool isBusy [get, set]
 
List< DICOMSeries > availableSeries [get, set]
 

Detailed Description

Searches given directories for DICOMs and loads them (all in seperate threads). Usage: Set a directory using setDirectory. Once the directory has been parsed, a PatientEventSystem.Event.DICOM_NewList Event is triggered. Now, you can load one of the series given by DICOMLoader.availableSeries to load a DICOM, by calling the startLoading function. Once the loading process is finished, access the loaded DICOM through DICOMLoader.currentDICOM.

Definition at line 15 of file DICOMLoader.cs.

Member Function Documentation

void DICOMLoader.load ( object  sender,
DoWorkEventArgs  e 
)
inline

Loads a DICOM. Called in thread!

Note
if sliceToLoad is negative, this will load the whole volume.

Definition at line 212 of file DICOMLoader.cs.

void DICOMLoader.loadCallback ( object  sender,
RunWorkerCompletedEventArgs  e 
)
inline

Called when loader has finished parsing a directory.

Definition at line 227 of file DICOMLoader.cs.

void DICOMLoader.parseDirectory ( object  sender,
DoWorkEventArgs  e 
)
inline

Searches the directoryToLoad for DICOMs. Called in thread!

Definition at line 88 of file DICOMLoader.cs.

void DICOMLoader.parseDirectoryCallback ( object  sender,
RunWorkerCompletedEventArgs  e 
)
inline

Called when loader has finished parsing a directory.

Definition at line 114 of file DICOMLoader.cs.

bool DICOMLoader.setDirectory ( string  path)
inline

Starts searching the given path for DICOMs.

Returns
true if loading process is started, false if the loader is currently busy.

Definition at line 66 of file DICOMLoader.cs.

bool DICOMLoader.startLoading ( DICOMSeries  toLoad,
int  slice = 0 
)
inline

Starts loading the given DICOM, if available.

Note
If slice is negative, this loads the entire volume!
Returns
true if loading process is started, false if the loader is currently busy.

Definition at line 127 of file DICOMLoader.cs.

bool DICOMLoader.startLoadingSlice ( int  index,
int  slice = 0 
)
inline

Starts loading the given DICOM slice, if available (overload for convenience)

Returns
true if loading process is started, false if the loader is currently busy or if no series with the given index is available.

Definition at line 156 of file DICOMLoader.cs.

bool DICOMLoader.startLoadingSlice ( string  seriesUID,
int  slice = 0 
)
inline

Starts loading the given DICOM slice, if available (overload for convenience)

Returns
true if loading process is started, false if the loader is currently busy or if no series with the given series UID is available.

Definition at line 167 of file DICOMLoader.cs.

bool DICOMLoader.startLoadingVolume ( DICOMSeries  toLoad)
inline

Starts loading the given DICOM volume, if available.

Returns
true if loading process is started, false if the loader is currently busy.

Definition at line 179 of file DICOMLoader.cs.

bool DICOMLoader.startLoadingVolume ( int  index)
inline

Starts loading the given DICOM volume, if available (overload for convenience)

Returns
true if loading process is started, false if the loader is currently busy or if no series with the given index is available.

Definition at line 187 of file DICOMLoader.cs.

bool DICOMLoader.startLoadingVolume ( string  seriesUID)
inline

Starts loading the given DICOM volume, if available (overload for convenience)

Returns
true if loading process is started, false if the loader is currently busy or if no series with the given series UID is available.

Definition at line 198 of file DICOMLoader.cs.

void DICOMLoader.unloadVolume ( )
inline

Can be called to unload the current volume. Assuming that all other users correctly respond to DICOM_CloseVolume event, the memory should be freed.

Definition at line 266 of file DICOMLoader.cs.

Property Documentation

DICOM2D DICOMLoader.currentDICOM
getset

The DICOM slice which has been loaded

Definition at line 21 of file DICOMLoader.cs.

DICOMSeries DICOMLoader.currentDICOMSeries
getset

The DICOM series which has been loaded

Definition at line 25 of file DICOMLoader.cs.

DICOM3D DICOMLoader.currentDICOMVolume
getset

The DICOM volume which has been loaded

Definition at line 23 of file DICOMLoader.cs.

DICOMLoader DICOMLoader.instance
staticgetset

The singleton instance of the loader (for easier access)

Definition at line 18 of file DICOMLoader.cs.

bool DICOMLoader.isBusy
getset

Can be used to check if the loader is currently working on something.

Definition at line 28 of file DICOMLoader.cs.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.6