The Rt_study_metadata encapsulate DICOM metadata for an Rt_study. The Rt_study_metadata includes separate metadata for image, dose, and rtstruct, as well as a study_metadata which is shared by all components. Items such as Patient Name or Study Description will be held in study_metadata. More...

#include <rt_study_metadata.h>

Public Member Functions
	SMART_POINTER_SUPPORT (Rt_study_metadata)

	Rt_study_metadata ()

	~Rt_study_metadata ()

const char *	get_ct_series_uid () const

void	set_ct_series_uid (const char *uid)

void	force_ct_series_uid (const std::string &uid)

const char *	get_ct_series_description () const

const std::string &	get_dose_instance_uid () const

const char *	get_dose_series_uid () const

const std::string &	get_frame_of_reference_uid () const

void	set_frame_of_reference_uid (const char *uid)

void	set_frame_of_reference_uid (const std::string &uid)

const char *	get_plan_instance_uid () const

const std::string &	get_rtstruct_instance_uid () const

void	set_rtstruct_instance_uid (const char *rtstruct_instance_uid)

const char *	get_rtstruct_series_uid () const

const char *	get_position_reference_indicator () const

void	set_position_reference_indicator (const char *position_reference_indicator)

void	set_position_reference_indicator (const std::string &position_reference_indicator)

const char *	get_referring_physician_name () const

void	set_referring_physician_name (const char *referring_physician_name)

void	set_referring_physician_name (const std::string &referring_physician_name)

const char *	get_accession_number () const

void	set_accession_number (const char *accession_number)

void	set_accession_number (const std::string &accession_number)

const char *	get_study_date () const

void	set_study_date (const char *date)

void	set_study_date (const std::string &date)

const char *	get_study_description () const

void	set_study_description (const char *description)

void	set_study_description (const std::string &description)

const char *	get_study_time () const

void	set_study_time (const char *time)

void	set_study_time (const std::string &time)

const std::string &	get_study_uid () const

void	set_study_uid (const char *uid)

void	set_study_uid (const std::string &uid)

const char *	get_study_id () const

void	set_study_id (const char *id)

void	set_study_id (const std::string &id)

const std::string &	get_patient_name ()

void	set_patient_name (const char *name)

void	set_patient_name (const std::string &name)

const std::string &	get_patient_id ()

void	set_patient_id (const std::string &id)

const std::string &	get_patient_birth_date ()

void	set_patient_birth_date (const char *birth_date)

void	set_patient_birth_date (const std::string &birth_date)

const std::string &	get_patient_sex ()

void	set_patient_sex (const char *sex)

void	set_patient_sex (const std::string &sex)

const Plm_image_header *	get_image_header () const

void	set_image_header (const Plm_image::Pointer &pli)

void	set_image_header (const Plm_image_header &pih)

void	set_image_header (ShortImageType::Pointer img)

const Slice_list *	get_slice_list () const

void	reset_slice_uids ()

const char *	get_slice_uid (int index) const

void	set_slice_uid (int index, const char *slice_uid)

bool	slice_list_complete () const

void	set_slice_list_complete ()

int	num_slices () const

Metadata::Pointer &	get_study_metadata ()

const Metadata::Pointer &	get_study_metadata () const

const std::string &	get_study_metadata (unsigned short key1, unsigned short key2) const

void	set_study_metadata (unsigned short key1, unsigned short key2, const std::string &val)

Metadata::Pointer &	get_image_metadata ()

const Metadata::Pointer &	get_image_metadata () const

const std::string &	get_image_metadata (unsigned short key1, unsigned short key2) const

void	set_image_metadata (unsigned short key1, unsigned short key2, const std::string &val)

Metadata::Pointer &	get_rtstruct_metadata ()

const Metadata::Pointer &	get_rtstruct_metadata () const

void	set_rtstruct_metadata (unsigned short key1, unsigned short key2, const std::string &val)

Metadata::Pointer &	get_dose_metadata ()

const Metadata::Pointer &	get_dose_metadata () const

void	set_dose_metadata (unsigned short key1, unsigned short key2, const std::string &val)

Metadata::Pointer &	get_rtplan_metadata ()

const Metadata::Pointer &	get_rtplan_metadata () const

void	set_rtplan_metadata (unsigned short key1, unsigned short key2, const std::string &val)

Metadata::Pointer &	get_sro_metadata ()

const Metadata::Pointer &	get_sro_metadata () const

void	set_sro_metadata (unsigned short key1, unsigned short key2, const std::string &val)

void	generate_new_dose_instance_uid ()

void	generate_new_plan_instance_uid ()

void	generate_new_rtstruct_instance_uid ()

void	generate_new_series_uids ()

void	generate_new_study_uids ()

void	print () const

Static Public Member Functions
static Rt_study_metadata::Pointer	load (const std::string &dicom_path)

static Rt_study_metadata::Pointer	load (const char *dicom_path)

Public Attributes
Rt_study_metadata_private *	d_ptr

Detailed Description

The Rt_study_metadata encapsulate DICOM metadata for an Rt_study. The Rt_study_metadata includes separate metadata for image, dose, and rtstruct, as well as a study_metadata which is shared by all components. Items such as Patient Name or Study Description will be held in study_metadata.

Constructor & Destructor Documentation

◆ Rt_study_metadata()

Rt_study_metadata::Rt_study_metadata ( )

◆ ~Rt_study_metadata()

Rt_study_metadata::~Rt_study_metadata ( )

Member Function Documentation

◆ force_ct_series_uid()

void Rt_study_metadata::force_ct_series_uid ( const std::string & uid )

◆ generate_new_dose_instance_uid()

void Rt_study_metadata::generate_new_dose_instance_uid ( )

◆ generate_new_plan_instance_uid()

void Rt_study_metadata::generate_new_plan_instance_uid ( )

◆ generate_new_rtstruct_instance_uid()

void Rt_study_metadata::generate_new_rtstruct_instance_uid ( )

◆ generate_new_series_uids()

void Rt_study_metadata::generate_new_series_uids ( )

◆ generate_new_study_uids()

void Rt_study_metadata::generate_new_study_uids ( )

◆ get_accession_number()

const char * Rt_study_metadata::get_accession_number ( ) const

◆ get_ct_series_description()

const char * Rt_study_metadata::get_ct_series_description ( ) const

◆ get_ct_series_uid()

const char * Rt_study_metadata::get_ct_series_uid ( ) const

◆ get_dose_instance_uid()

const std::string & Rt_study_metadata::get_dose_instance_uid ( ) const

◆ get_dose_metadata() [1/2]

Metadata::Pointer & Rt_study_metadata::get_dose_metadata ( )

◆ get_dose_metadata() [2/2]

const Metadata::Pointer & Rt_study_metadata::get_dose_metadata ( ) const

◆ get_dose_series_uid()

const char * Rt_study_metadata::get_dose_series_uid ( ) const

◆ get_frame_of_reference_uid()

const std::string & Rt_study_metadata::get_frame_of_reference_uid ( ) const

◆ get_image_header()

const Plm_image_header * Rt_study_metadata::get_image_header ( ) const

◆ get_image_metadata() [1/3]

Metadata::Pointer & Rt_study_metadata::get_image_metadata ( )

◆ get_image_metadata() [2/3]

const Metadata::Pointer & Rt_study_metadata::get_image_metadata ( ) const

◆ get_image_metadata() [3/3]

const std::string & Rt_study_metadata::get_image_metadata	(	unsigned short	key1,
		unsigned short	key2
	)		const

◆ get_patient_birth_date()

const std::string & Rt_study_metadata::get_patient_birth_date ( )

◆ get_patient_id()

const std::string & Rt_study_metadata::get_patient_id ( )

◆ get_patient_name()

const std::string & Rt_study_metadata::get_patient_name ( )

◆ get_patient_sex()

const std::string & Rt_study_metadata::get_patient_sex ( )

◆ get_plan_instance_uid()

const char * Rt_study_metadata::get_plan_instance_uid ( ) const

◆ get_position_reference_indicator()

const char * Rt_study_metadata::get_position_reference_indicator ( ) const

◆ get_referring_physician_name()

const char * Rt_study_metadata::get_referring_physician_name ( ) const

◆ get_rtplan_metadata() [1/2]

Metadata::Pointer & Rt_study_metadata::get_rtplan_metadata ( )

◆ get_rtplan_metadata() [2/2]

const Metadata::Pointer & Rt_study_metadata::get_rtplan_metadata ( ) const

◆ get_rtstruct_instance_uid()

const std::string & Rt_study_metadata::get_rtstruct_instance_uid ( ) const

◆ get_rtstruct_metadata() [1/2]

Metadata::Pointer & Rt_study_metadata::get_rtstruct_metadata ( )

◆ get_rtstruct_metadata() [2/2]

const Metadata::Pointer & Rt_study_metadata::get_rtstruct_metadata ( ) const

◆ get_rtstruct_series_uid()

const char * Rt_study_metadata::get_rtstruct_series_uid ( ) const

◆ get_slice_list()

const Slice_list * Rt_study_metadata::get_slice_list ( ) const

◆ get_slice_uid()

const char * Rt_study_metadata::get_slice_uid ( int index ) const

◆ get_sro_metadata() [1/2]

Metadata::Pointer & Rt_study_metadata::get_sro_metadata ( )

◆ get_sro_metadata() [2/2]

const Metadata::Pointer & Rt_study_metadata::get_sro_metadata ( ) const

◆ get_study_date()

const char * Rt_study_metadata::get_study_date ( ) const

◆ get_study_description()

const char * Rt_study_metadata::get_study_description ( ) const

◆ get_study_id()

const char * Rt_study_metadata::get_study_id ( ) const

◆ get_study_metadata() [1/3]

Metadata::Pointer & Rt_study_metadata::get_study_metadata ( )

◆ get_study_metadata() [2/3]

const Metadata::Pointer & Rt_study_metadata::get_study_metadata ( ) const

◆ get_study_metadata() [3/3]

const std::string & Rt_study_metadata::get_study_metadata	(	unsigned short	key1,
		unsigned short	key2
	)		const

◆ get_study_time()

const char * Rt_study_metadata::get_study_time ( ) const

◆ get_study_uid()

const std::string & Rt_study_metadata::get_study_uid ( ) const

◆ load() [1/2]

Rt_study_metadata::Pointer Rt_study_metadata::load ( const char * dicom_path )

static

◆ load() [2/2]

Rt_study_metadata::Pointer Rt_study_metadata::load ( const std::string & dicom_path )

static

◆ num_slices()

int Rt_study_metadata::num_slices ( ) const

◆ print()

void Rt_study_metadata::print ( ) const

◆ reset_slice_uids()

void Rt_study_metadata::reset_slice_uids ( )

◆ set_accession_number() [1/2]

void Rt_study_metadata::set_accession_number ( const char * accession_number )

◆ set_accession_number() [2/2]

void Rt_study_metadata::set_accession_number ( const std::string & accession_number )

◆ set_ct_series_uid()

void Rt_study_metadata::set_ct_series_uid ( const char * uid )

◆ set_dose_metadata()

void Rt_study_metadata::set_dose_metadata	(	unsigned short	key1,
		unsigned short	key2,
		const std::string &	val
	)

◆ set_frame_of_reference_uid() [1/2]

void Rt_study_metadata::set_frame_of_reference_uid ( const char * uid )

◆ set_frame_of_reference_uid() [2/2]

void Rt_study_metadata::set_frame_of_reference_uid ( const std::string & uid )

◆ set_image_header() [1/3]

void Rt_study_metadata::set_image_header ( const Plm_image::Pointer & pli )

◆ set_image_header() [2/3]

void Rt_study_metadata::set_image_header ( const Plm_image_header & pih )

◆ set_image_header() [3/3]

void Rt_study_metadata::set_image_header ( ShortImageType::Pointer img )

◆ set_image_metadata()

void Rt_study_metadata::set_image_metadata	(	unsigned short	key1,
		unsigned short	key2,
		const std::string &	val
	)

◆ set_patient_birth_date() [1/2]

void Rt_study_metadata::set_patient_birth_date ( const char * birth_date )

◆ set_patient_birth_date() [2/2]

void Rt_study_metadata::set_patient_birth_date ( const std::string & birth_date )

◆ set_patient_id()

void Rt_study_metadata::set_patient_id ( const std::string & id )

◆ set_patient_name() [1/2]

void Rt_study_metadata::set_patient_name ( const char * name )

◆ set_patient_name() [2/2]

void Rt_study_metadata::set_patient_name ( const std::string & name )

◆ set_patient_sex() [1/2]

void Rt_study_metadata::set_patient_sex ( const char * sex )

◆ set_patient_sex() [2/2]

void Rt_study_metadata::set_patient_sex ( const std::string & sex )

◆ set_position_reference_indicator() [1/2]

void Rt_study_metadata::set_position_reference_indicator ( const char * position_reference_indicator )

◆ set_position_reference_indicator() [2/2]

void Rt_study_metadata::set_position_reference_indicator ( const std::string & position_reference_indicator )

◆ set_referring_physician_name() [1/2]

void Rt_study_metadata::set_referring_physician_name ( const char * referring_physician_name )

◆ set_referring_physician_name() [2/2]

void Rt_study_metadata::set_referring_physician_name ( const std::string & referring_physician_name )

◆ set_rtplan_metadata()

void Rt_study_metadata::set_rtplan_metadata	(	unsigned short	key1,
		unsigned short	key2,
		const std::string &	val
	)

◆ set_rtstruct_instance_uid()

void Rt_study_metadata::set_rtstruct_instance_uid ( const char * rtstruct_instance_uid )

◆ set_rtstruct_metadata()

void Rt_study_metadata::set_rtstruct_metadata	(	unsigned short	key1,
		unsigned short	key2,
		const std::string &	val
	)

◆ set_slice_list_complete()

void Rt_study_metadata::set_slice_list_complete ( )

◆ set_slice_uid()

void Rt_study_metadata::set_slice_uid	(	int	index,
		const char *	slice_uid
	)

◆ set_sro_metadata()

void Rt_study_metadata::set_sro_metadata	(	unsigned short	key1,
		unsigned short	key2,
		const std::string &	val
	)

◆ set_study_date() [1/2]

void Rt_study_metadata::set_study_date ( const char * date )

◆ set_study_date() [2/2]

void Rt_study_metadata::set_study_date ( const std::string & date )

◆ set_study_description() [1/2]

void Rt_study_metadata::set_study_description ( const char * description )

◆ set_study_description() [2/2]

void Rt_study_metadata::set_study_description ( const std::string & description )

◆ set_study_id() [1/2]

void Rt_study_metadata::set_study_id ( const char * id )

◆ set_study_id() [2/2]

void Rt_study_metadata::set_study_id ( const std::string & id )

◆ set_study_metadata()

void Rt_study_metadata::set_study_metadata	(	unsigned short	key1,
		unsigned short	key2,
		const std::string &	val
	)

◆ set_study_time() [1/2]

void Rt_study_metadata::set_study_time ( const char * time )

◆ set_study_time() [2/2]

void Rt_study_metadata::set_study_time ( const std::string & time )

◆ set_study_uid() [1/2]

void Rt_study_metadata::set_study_uid ( const char * uid )

◆ set_study_uid() [2/2]

void Rt_study_metadata::set_study_uid ( const std::string & uid )

◆ slice_list_complete()

bool Rt_study_metadata::slice_list_complete ( ) const

◆ SMART_POINTER_SUPPORT()

Rt_study_metadata::SMART_POINTER_SUPPORT ( Rt_study_metadata )

Member Data Documentation

◆ d_ptr

Rt_study_metadata_private* Rt_study_metadata::d_ptr

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

src/base/rt_study_metadata.h
src/base/rt_study_metadata.cxx

Public Member Functions

Static Public Member Functions

Public Attributes