plastimatch
Loading...
Searching...
No Matches
Rt_study Class Reference

The Rt_study class encapsulates the concept of a radiotherapy planning data set, including image, structure set, and dose. More...

#include <rt_study.h>

Public Types

typedef Rt_study Self
 
typedef std::shared_ptr< SelfPointer
 

Public Member Functions

 Rt_study ()
 
 ~Rt_study ()
 
void load (const char *input_path, Plm_file_format file_type=PLM_FILE_FMT_UNKNOWN)
 
void load (const std::string &input_path, Plm_file_format file_type=PLM_FILE_FMT_UNKNOWN)
 
void load_dicom_dir (const char *dicom_dir)
 
void load_dicom (const char *dicom_dir)
 
void load_dicom_dose (const char *dicom_path)
 
void load_dicom_rtss (const char *dicom_path)
 
void load_dicom_rtplan (const char *dicom_path)
 
void load_image (const char *fn)
 
void load_image (const std::string &fn)
 
void load_xio (const char *xio_dir)
 
void load_rt_study_dir (const char *rt_study_dir)
 
void load_rt_study_dir (const std::string &rt_study_dir)
 
void load_ss_img (const char *ss_img, const char *ss_list)
 
void load_dose_img (const char *dose_img)
 
void load_dose_xio (const char *dose_xio)
 
void load_dose_astroid (const char *dose_astroid)
 
void load_dose_mc (const char *dose_mc)
 
void load_rdd (const char *image_directory)
 
void load_dcmtk (const char *dicom_dir)
 
void load_gdcm (const char *dicom_dir)
 
void load_cxt (const char *input_fn)
 
void load_prefix (const char *input_fn)
 
void load_prefix (const std::string &input_fn)
 
void save (const std::string &output_dir)
 Save as directory of nrrd files.
 
void save_dicom (const std::string &output_dir, bool filenames_with_uid=true)
 
void save_dicom (const char *output_dir, bool filenames_with_uid=true)
 
void save_dicom_dose (const char *output_dir)
 
void save_image (const std::string &fname)
 
void save_image (const char *fname)
 
void save_image (const char *fname, Plm_image_type image_type)
 
void save_dose (const std::string &fname)
 
void save_dose (const char *fname)
 
void save_dose (const char *fname, Plm_image_type image_type)
 
void save_prefix (const std::string &output_prefix, const std::string &extension="mha")
 
const Rt_study_metadata::Pointerget_rt_study_metadata () const
 Get the Rt_study_metadata.
 
Rt_study_metadata::Pointerget_rt_study_metadata ()
 
void set_study_metadata (const std::vector< std::string > &metadata)
 Set metadata items into study_metadata portion of Rt_study_metadata.
 
Metadata::Pointer & get_study_metadata ()
 Get the study_metadata portion of Rt_study_metadata.
 
void set_image_metadata (const std::vector< std::string > &metadata)
 Set metadata items into image portion of Rt_study_metadata.
 
Metadata::Pointer & get_image_metadata ()
 Get the image portion of Rt_study_metadata.
 
void set_dose_metadata (const std::vector< std::string > &metadata)
 Set metadata items into dose portion of Rt_study_metadata.
 
Metadata::Pointer & get_dose_metadata ()
 Get the dose portion of Rt_study_metadata.
 
void set_rtstruct_metadata (const std::vector< std::string > &metadata)
 Set metadata items into rtstruct portion of Rt_study_metadata.
 
Metadata::Pointer & get_rtstruct_metadata ()
 Get the rtstruct portion of Rt_study_metadata.
 
void generate_new_study_uids ()
 Create new StudyInstanceUID and FrameOfReferenceUID for the study.
 
void force_ct_series_uid (const std::string &series_uid)
 Force the CT series UID to a certain value when saving.
 
bool have_image ()
 
void set_image (ShortImageType::Pointer &itk_image)
 
void set_image (FloatImageType::Pointer &itk_image)
 
void set_image (Plm_image *pli)
 
void set_image (const Plm_image::Pointer &pli)
 
Plm_image::Pointerget_image ()
 
bool have_dose ()
 
void set_dose (Plm_image *pli)
 
void set_dose (FloatImageType::Pointer itk_dose)
 
void set_dose (Volume *vol)
 
void set_dose (const Plm_image::Pointer &pli)
 
Plm_image::Pointer get_dose ()
 
bool have_segmentation ()
 
Segmentation::Pointer get_segmentation ()
 
void set_segmentation (Segmentation::Pointer seg)
 
void add_structure (const UCharImageType::Pointer &itk_image, const char *structure_name=0, const char *structure_color=0)
 
bool have_plan ()
 
Rtplan::Pointerget_plan ()
 
const std::string & get_xio_dose_filename () const
 
Xio_ct_transformget_xio_ct_transform ()
 
Volume::Pointer get_image_volume_short ()
 
Volume::Pointer get_image_volume_float ()
 
bool has_dose ()
 
Volume::Pointer get_dose_volume_float ()
 
void resample (float spacing[3])
 

Static Public Member Functions

static Rt_study::Pointer New ()
 
static Rt_study::Pointer New (Rt_study *t)
 
template<class U1 >
static Rt_study::Pointer New (const U1 &u1)
 
template<class U1 , class U2 >
static Rt_study::Pointer New (const U1 &u1, const U2 &u2)
 
template<class U1 , class U2 , class U3 >
static Rt_study::Pointer New (const U1 &u1, const U2 &u2, const U3 &u3)
 
template<class U1 , class U2 , class U3 , class U4 , class U5 , class U6 >
static Rt_study::Pointer New (const U1 &u1, const U2 &u2, const U3 &u3, const U4 &u4, const U5 &u5, const U6 &u6)
 

Public Attributes

Rt_study_privated_ptr
 

Protected Member Functions

void save_dcmtk (const char *dicom_dir, bool filenames_with_uid)
 
void save_dcmtk_dose (const char *dicom_dir)
 
void convert_ss_img_to_cxt ()
 

Detailed Description

The Rt_study class encapsulates the concept of a radiotherapy planning data set, including image, structure set, and dose.

Member Typedef Documentation

◆ Pointer

typedef std::shared_ptr<Self> Rt_study::Pointer

◆ Self

Constructor & Destructor Documentation

◆ Rt_study()

Rt_study::Rt_study ( )

◆ ~Rt_study()

Rt_study::~Rt_study ( )

Member Function Documentation

◆ add_structure()

void Rt_study::add_structure ( const UCharImageType::Pointer & itk_image,
const char * structure_name = 0,
const char * structure_color = 0 )

◆ convert_ss_img_to_cxt()

void Rt_study::convert_ss_img_to_cxt ( )
protected

◆ force_ct_series_uid()

void Rt_study::force_ct_series_uid ( const std::string & series_uid)

Force the CT series UID to a certain value when saving.

◆ generate_new_study_uids()

void Rt_study::generate_new_study_uids ( )

Create new StudyInstanceUID and FrameOfReferenceUID for the study.

◆ get_dose()

Plm_image::Pointer Rt_study::get_dose ( )

◆ get_dose_metadata()

Metadata::Pointer & Rt_study::get_dose_metadata ( void )

Get the dose portion of Rt_study_metadata.

◆ get_dose_volume_float()

Volume::Pointer Rt_study::get_dose_volume_float ( )

◆ get_image()

Plm_image::Pointer & Rt_study::get_image ( )

◆ get_image_metadata()

Metadata::Pointer & Rt_study::get_image_metadata ( void )

Get the image portion of Rt_study_metadata.

◆ get_image_volume_float()

Volume::Pointer Rt_study::get_image_volume_float ( void )

◆ get_image_volume_short()

Volume::Pointer Rt_study::get_image_volume_short ( )

◆ get_plan()

Rtplan::Pointer & Rt_study::get_plan ( )

◆ get_rt_study_metadata() [1/2]

Rt_study_metadata::Pointer & Rt_study::get_rt_study_metadata ( )

◆ get_rt_study_metadata() [2/2]

const Rt_study_metadata::Pointer & Rt_study::get_rt_study_metadata ( ) const

◆ get_rtstruct_metadata()

Metadata::Pointer & Rt_study::get_rtstruct_metadata ( void )

Get the rtstruct portion of Rt_study_metadata.

◆ get_segmentation()

Segmentation::Pointer Rt_study::get_segmentation ( )

◆ get_study_metadata()

Metadata::Pointer & Rt_study::get_study_metadata ( void )

Get the study_metadata portion of Rt_study_metadata.

◆ get_xio_ct_transform()

Xio_ct_transform * Rt_study::get_xio_ct_transform ( )

◆ get_xio_dose_filename()

const std::string & Rt_study::get_xio_dose_filename ( void ) const

◆ has_dose()

bool Rt_study::has_dose ( )

◆ have_dose()

bool Rt_study::have_dose ( )

◆ have_image()

bool Rt_study::have_image ( )

◆ have_plan()

bool Rt_study::have_plan ( )

◆ have_segmentation()

bool Rt_study::have_segmentation ( )

◆ load() [1/2]

void Rt_study::load ( const char * input_path,
Plm_file_format file_type = PLM_FILE_FMT_UNKNOWN )

◆ load() [2/2]

void Rt_study::load ( const std::string & input_path,
Plm_file_format file_type = PLM_FILE_FMT_UNKNOWN )

◆ load_cxt()

void Rt_study::load_cxt ( const char * input_fn)

◆ load_dcmtk()

void Rt_study::load_dcmtk ( const char * dicom_dir)

◆ load_dicom()

void Rt_study::load_dicom ( const char * dicom_dir)

◆ load_dicom_dir()

void Rt_study::load_dicom_dir ( const char * dicom_dir)

◆ load_dicom_dose()

void Rt_study::load_dicom_dose ( const char * dicom_path)

◆ load_dicom_rtplan()

void Rt_study::load_dicom_rtplan ( const char * dicom_path)

◆ load_dicom_rtss()

void Rt_study::load_dicom_rtss ( const char * dicom_path)

◆ load_dose_astroid()

void Rt_study::load_dose_astroid ( const char * dose_astroid)

◆ load_dose_img()

void Rt_study::load_dose_img ( const char * dose_img)

◆ load_dose_mc()

void Rt_study::load_dose_mc ( const char * dose_mc)

◆ load_dose_xio()

void Rt_study::load_dose_xio ( const char * dose_xio)

◆ load_gdcm()

void Rt_study::load_gdcm ( const char * dicom_dir)

◆ load_image() [1/2]

void Rt_study::load_image ( const char * fn)

◆ load_image() [2/2]

void Rt_study::load_image ( const std::string & fn)

◆ load_prefix() [1/2]

void Rt_study::load_prefix ( const char * input_fn)

◆ load_prefix() [2/2]

void Rt_study::load_prefix ( const std::string & input_fn)

◆ load_rdd()

void Rt_study::load_rdd ( const char * image_directory)

◆ load_rt_study_dir() [1/2]

void Rt_study::load_rt_study_dir ( const char * rt_study_dir)

◆ load_rt_study_dir() [2/2]

void Rt_study::load_rt_study_dir ( const std::string & rt_study_dir)

◆ load_ss_img()

void Rt_study::load_ss_img ( const char * ss_img,
const char * ss_list )

◆ load_xio()

void Rt_study::load_xio ( const char * xio_dir)

◆ New() [1/6]

static Rt_study::Pointer Rt_study::New ( )
inlinestatic

◆ New() [2/6]

template<class U1 >
static Rt_study::Pointer Rt_study::New ( const U1 & u1)
inlinestatic

◆ New() [3/6]

template<class U1 , class U2 >
static Rt_study::Pointer Rt_study::New ( const U1 & u1,
const U2 & u2 )
inlinestatic

◆ New() [4/6]

template<class U1 , class U2 , class U3 >
static Rt_study::Pointer Rt_study::New ( const U1 & u1,
const U2 & u2,
const U3 & u3 )
inlinestatic

◆ New() [5/6]

template<class U1 , class U2 , class U3 , class U4 , class U5 , class U6 >
static Rt_study::Pointer Rt_study::New ( const U1 & u1,
const U2 & u2,
const U3 & u3,
const U4 & u4,
const U5 & u5,
const U6 & u6 )
inlinestatic

◆ New() [6/6]

static Rt_study::Pointer Rt_study::New ( Rt_study * t)
inlinestatic

◆ resample()

void Rt_study::resample ( float spacing[3])

◆ save()

void Rt_study::save ( const std::string & output_dir)

Save as directory of nrrd files.

◆ save_dcmtk()

void Rt_study::save_dcmtk ( const char * dicom_dir,
bool filenames_with_uid )
protected

◆ save_dcmtk_dose()

void Rt_study::save_dcmtk_dose ( const char * dicom_dir)
protected

◆ save_dicom() [1/2]

void Rt_study::save_dicom ( const char * output_dir,
bool filenames_with_uid = true )

◆ save_dicom() [2/2]

void Rt_study::save_dicom ( const std::string & output_dir,
bool filenames_with_uid = true )

◆ save_dicom_dose()

void Rt_study::save_dicom_dose ( const char * output_dir)

◆ save_dose() [1/3]

void Rt_study::save_dose ( const char * fname)

◆ save_dose() [2/3]

void Rt_study::save_dose ( const char * fname,
Plm_image_type image_type )

◆ save_dose() [3/3]

void Rt_study::save_dose ( const std::string & fname)

◆ save_image() [1/3]

void Rt_study::save_image ( const char * fname)

◆ save_image() [2/3]

void Rt_study::save_image ( const char * fname,
Plm_image_type image_type )

◆ save_image() [3/3]

void Rt_study::save_image ( const std::string & fname)

◆ save_prefix()

void Rt_study::save_prefix ( const std::string & output_prefix,
const std::string & extension = "mha" )

◆ set_dose() [1/4]

void Rt_study::set_dose ( const Plm_image::Pointer & pli)

◆ set_dose() [2/4]

void Rt_study::set_dose ( FloatImageType::Pointer itk_dose)

◆ set_dose() [3/4]

void Rt_study::set_dose ( Plm_image * pli)

◆ set_dose() [4/4]

void Rt_study::set_dose ( Volume * vol)

◆ set_dose_metadata()

void Rt_study::set_dose_metadata ( const std::vector< std::string > & metadata)

Set metadata items into dose portion of Rt_study_metadata.

◆ set_image() [1/4]

void Rt_study::set_image ( const Plm_image::Pointer & pli)

◆ set_image() [2/4]

void Rt_study::set_image ( FloatImageType::Pointer & itk_image)

◆ set_image() [3/4]

void Rt_study::set_image ( Plm_image * pli)

◆ set_image() [4/4]

void Rt_study::set_image ( ShortImageType::Pointer & itk_image)

◆ set_image_metadata()

void Rt_study::set_image_metadata ( const std::vector< std::string > & metadata)

Set metadata items into image portion of Rt_study_metadata.

◆ set_rtstruct_metadata()

void Rt_study::set_rtstruct_metadata ( const std::vector< std::string > & metadata)

Set metadata items into rtstruct portion of Rt_study_metadata.

◆ set_segmentation()

void Rt_study::set_segmentation ( Segmentation::Pointer seg)

◆ set_study_metadata()

void Rt_study::set_study_metadata ( const std::vector< std::string > & metadata)

Set metadata items into study_metadata portion of Rt_study_metadata.

Member Data Documentation

◆ d_ptr

Rt_study_private* Rt_study::d_ptr

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