MeVisLab Toolbox Reference
ml::MLToROIContourSequence Class Reference

#include <mlMLToROIContourSequence.h>

Public Types

enum  ImageReferenceMode { RequireExactlyOneSlice , DoNotReferenceImage , ReferenceImageIfOneSlice }
 

Public Member Functions

 MLToROIContourSequence (boost::function< void(float)> *setProgress)
 Constructor. More...
 
void setTreatCollinearAsPlanar (bool collinearIsPlanar)
 Set treatCollinearAsPlanar option. More...
 
DCMTree::TreePtr convert (PagedImage *image, CSOList *csoList, int precision)
 Converter function. More...
 
void setImageReferenceMode (ImageReferenceMode mode)
 Set image reference mode, which tells the MLToROIContourSequence when to create a reference to an image slice. More...
 
ImageReferenceMode imageReferenceMode () const
 

Detailed Description

Definition at line 61 of file mlMLToROIContourSequence.h.

Member Enumeration Documentation

◆ ImageReferenceMode

Enumerator
RequireExactlyOneSlice 

always reference one image slice, print an error if the CSO does not lie in exactly one existing slice

DoNotReferenceImage 

never reference image

ReferenceImageIfOneSlice 

reference one image slice if the CSO lies in one slice

Definition at line 80 of file mlMLToROIContourSequence.h.

Constructor & Destructor Documentation

◆ MLToROIContourSequence()

ml::MLToROIContourSequence::MLToROIContourSequence ( boost::function< void(float)> *  setProgress)

Constructor.

Parameters
setProgress- Callback function for setting the conversion progress. If no progress feedback is required pass NULL.

Member Function Documentation

◆ convert()

DCMTree::TreePtr ml::MLToROIContourSequence::convert ( PagedImage image,
CSOList csoList,
int  precision 
)

Converter function.

Parameters
image- Image (user is responsible for passing a valid pointer).
csoList- CSOList (user is responsible for passing a valid pointer).
Returns
- DCMTree with (3006,0039) tag containing the sequence.
Exceptions
std::runtime_error.

◆ imageReferenceMode()

ImageReferenceMode ml::MLToROIContourSequence::imageReferenceMode ( ) const
inline

Definition at line 89 of file mlMLToROIContourSequence.h.

◆ setImageReferenceMode()

void ml::MLToROIContourSequence::setImageReferenceMode ( ImageReferenceMode  mode)
inline

Set image reference mode, which tells the MLToROIContourSequence when to create a reference to an image slice.

Definition at line 88 of file mlMLToROIContourSequence.h.

◆ setTreatCollinearAsPlanar()

void ml::MLToROIContourSequence::setTreatCollinearAsPlanar ( bool  collinearIsPlanar)

Set treatCollinearAsPlanar option.

If set, collinear CSOs (e.g., where all points are in a line) are marked as CLOSED_PLANAR or OPEN_PLANAR, otherwise they are marked as OPEN_NONPLANAR.


The documentation for this class was generated from the following file: