plastimatch
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
Dvh Class Reference

#include <dvh.h>

Public Types

enum  Dvh_units { DVH_UNITS_GY , DVH_UNITS_CGY }
 
enum  Dvh_normalization { DVH_NORMALIZATION_PCT , DVH_NORMALIZATION_VOX }
 
enum  Histogram_type { DVH_CUMULATIVE_HISTOGRAM , DVH_DIFFERENTIAL_HISTOGRAM }
 

Public Member Functions

 Dvh ()
 
 ~Dvh ()
 
Inputs
void set_input (const std::string &dicom_dir)
 Set the input directory containing the DICOM or Rt_study data.
 
void set_structure_set_image (const char *ss_image_fn, const char *ss_list_fn)
 Set the structure set image. The image will be loaded from the specified filename, and an optional file containing the image list will be loaded.
 
void set_structure_set_image (Segmentation *image)
 Set the structure set image as an Segmentation.
 
void set_dose_image (const char *image_fn)
 Set the dose image. The image will be loaded from the specified filename.
 
void set_dose_image (Plm_image *image)
 Set the dose image as a Plm image.
 
void set_dose_image (const FloatImageType::Pointer image)
 Set the dose image as an ITK image.
 
void set_dose_units (enum Dvh_units units)
 Set the units for dose image.
 
void set_dvh_parameters (enum Dvh_normalization normalization, enum Histogram_type histogram_type, int num_bins, float bin_width)
 Set the units for dvh computation. Normalization in either percent or voxels, choice of cumulative or differential histogram, number of bins, and bin width.
 
Execution
void run ()
 Compute dvh.
 
Outputs
void save_csv (const char *csv_fn)
 Save the DVH as a csv file.
 

Static Public Member Functions

Defaults
static Dvh::Dvh_units default_dose_units ()
 Return the default value for dose units.
 
static Dvh::Dvh_normalization default_normalization ()
 Return the default value for DVH normalization.
 
static Dvh::Histogram_type default_histogram_type ()
 Return the default value for histogram type.
 
static int default_histogram_num_bins ()
 Return the default number of bins in the histogram.
 
static float default_histogram_bin_width ()
 Return the default bin width (in Gy) in the histogram.
 

Public Attributes

Dvh_privated_ptr
 

Member Enumeration Documentation

◆ Dvh_normalization

Enumerator
DVH_NORMALIZATION_PCT 
DVH_NORMALIZATION_VOX 

◆ Dvh_units

Enumerator
DVH_UNITS_GY 
DVH_UNITS_CGY 

◆ Histogram_type

Enumerator
DVH_CUMULATIVE_HISTOGRAM 
DVH_DIFFERENTIAL_HISTOGRAM 

Constructor & Destructor Documentation

◆ Dvh()

Dvh::Dvh ( )

◆ ~Dvh()

Dvh::~Dvh ( )

Member Function Documentation

◆ default_dose_units()

static Dvh::Dvh_units Dvh::default_dose_units ( )
inlinestatic

Return the default value for dose units.

◆ default_histogram_bin_width()

static float Dvh::default_histogram_bin_width ( )
inlinestatic

Return the default bin width (in Gy) in the histogram.

◆ default_histogram_num_bins()

static int Dvh::default_histogram_num_bins ( )
inlinestatic

Return the default number of bins in the histogram.

◆ default_histogram_type()

static Dvh::Histogram_type Dvh::default_histogram_type ( )
inlinestatic

Return the default value for histogram type.

◆ default_normalization()

static Dvh::Dvh_normalization Dvh::default_normalization ( )
inlinestatic

Return the default value for DVH normalization.

◆ run()

void Dvh::run ( )

Compute dvh.

◆ save_csv()

void Dvh::save_csv ( const char *  csv_fn)

Save the DVH as a csv file.

◆ set_dose_image() [1/3]

void Dvh::set_dose_image ( const char *  image_fn)

Set the dose image. The image will be loaded from the specified filename.

◆ set_dose_image() [2/3]

void Dvh::set_dose_image ( const FloatImageType::Pointer  image)

Set the dose image as an ITK image.

◆ set_dose_image() [3/3]

void Dvh::set_dose_image ( Plm_image image)

Set the dose image as a Plm image.

◆ set_dose_units()

void Dvh::set_dose_units ( enum Dvh_units  units)

Set the units for dose image.

◆ set_dvh_parameters()

void Dvh::set_dvh_parameters ( enum Dvh_normalization  normalization,
enum Histogram_type  histogram_type,
int  num_bins,
float  bin_width 
)

Set the units for dvh computation. Normalization in either percent or voxels, choice of cumulative or differential histogram, number of bins, and bin width.

◆ set_input()

void Dvh::set_input ( const std::string &  dicom_dir)

Set the input directory containing the DICOM or Rt_study data.

◆ set_structure_set_image() [1/2]

void Dvh::set_structure_set_image ( const char *  ss_image_fn,
const char *  ss_list_fn 
)

Set the structure set image. The image will be loaded from the specified filename, and an optional file containing the image list will be loaded.

◆ set_structure_set_image() [2/2]

void Dvh::set_structure_set_image ( Segmentation image)

Set the structure set image as an Segmentation.

Member Data Documentation

◆ d_ptr

Dvh_private* Dvh::d_ptr

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