#include <aperture.h>

Public Member Functions
	SMART_POINTER_SUPPORT (Aperture)

	Aperture ()

	~Aperture ()

	Aperture (const Aperture::Pointer &)

Inputs
const plm_long *	get_dim () const
	Get the aperture dimension, in pixels.

plm_long	get_dim (int dim) const
	Get the i or j aperture dimension, in pixels.

void	set_dim (const plm_long *dim)
	Set the aperture dimension, in pixels.

const double *	get_center () const
	Get the aperture center, in pixels.

double	get_center (int dim) const
	Get the aperture center in the i or j dimension, in pixels.

void	set_center (const float *center)
	Set the aperture center, in pixels.

void	set_center (const double *center)

void	set_origin (const float *center)
	Set the aperture origin, in mm.

void	set_origin (const double *center)

double	get_distance () const
	Get the aperture offset: the distance from the beam source to closest point on the aperture plane.

void	set_distance (double distance)
	Get the aperture offset: the distance from the beam source to closest point on the aperture plane.

const double *	get_spacing () const
	Get the aperture spacing: the distance between sampling points in the aperture plane, in mm.

double	get_spacing (int dim) const
	Get the aperture spacing in the i or j dimension, in mm.

void	set_spacing (const float *spacing)
	Get the aperture spacing: the distance between sampling points in the aperture plane.

void	set_spacing (const double *spacing)

void	set_vup (const float *vup)
	Get the aperture vup vector, which is the vector that orients the top of the aperture in room coordinates.

void	allocate_aperture_images ()
	Allocate aperture and range compensator images.

bool	have_aperture_image ()
	Test if the aperture has a bitmap image describing shape.

Plm_image::Pointer &	get_aperture_image ()
	Get the aperture image as Plm_image.

Volume::Pointer &	get_aperture_volume ()
	Get the aperture image as Volume.

Volume *	get_aperture_vol ()

void	set_aperture_image (const char *ap_filename)
	Load the aperture image from a file.

void	set_aperture_volume (Volume::Pointer ap)
	Load the aperture volume from a file.

bool	have_range_compensator_image ()
	Test if the aperture has a float image describing range compensator thicknesses.

Plm_image::Pointer &	get_range_compensator_image ()
	Get the range_compensator image as Plm_image.

Volume::Pointer &	get_range_compensator_volume ()
	Get the range_compensator image as Volume.

void	set_range_compensator_image (const char *rc_filename)
	Load the range_compensator image from a file.

void	set_range_compensator_volume (Volume::Pointer ap)
	Load the range_compensator volume from a file.

void	apply_smearing_to_aperture (float smearing, float target_depth)
	Expand aperture and smear compensator. The smearing parameters is defined as mm around the target in the beam eye view frame at the target minimal depth.

void	apply_smearing_to_range_compensator (float smearing, float target_depth)

Public Attributes
Aperture_private *	d_ptr

double	vup [3]

double	ic_room [3]

double	ul_room [3]

double	incr_r [3]

double	incr_c [3]

double	nrm [3]

double	pdn [3]

double	prt [3]

double	tmp [3]

Constructor & Destructor Documentation

◆ Aperture() [1/2]

Aperture::Aperture ( )

◆ ~Aperture()

Aperture::~Aperture ( )

◆ Aperture() [2/2]

Aperture::Aperture ( const Aperture::Pointer & ap )

Member Function Documentation

◆ allocate_aperture_images()

void Aperture::allocate_aperture_images ( )

Allocate aperture and range compensator images.

◆ apply_smearing_to_aperture()

void Aperture::apply_smearing_to_aperture	(	float	smearing,
		float	target_depth
	)

Expand aperture and smear compensator. The smearing parameters is defined as mm around the target in the beam eye view frame at the target minimal depth.

◆ apply_smearing_to_range_compensator()

void Aperture::apply_smearing_to_range_compensator	(	float	smearing,
		float	target_depth
	)

◆ get_aperture_image()

Plm_image::Pointer & Aperture::get_aperture_image ( )

Get the aperture image as Plm_image.

◆ get_aperture_vol()

Volume * Aperture::get_aperture_vol ( )

◆ get_aperture_volume()

Volume::Pointer & Aperture::get_aperture_volume ( )

Get the aperture image as Volume.

◆ get_center() [1/2]

const double * Aperture::get_center ( ) const

Get the aperture center, in pixels.

◆ get_center() [2/2]

double Aperture::get_center ( int dim ) const

Get the aperture center in the i or j dimension, in pixels.

◆ get_dim() [1/2]

const plm_long * Aperture::get_dim ( ) const

Get the aperture dimension, in pixels.

◆ get_dim() [2/2]

plm_long Aperture::get_dim ( int dim ) const

Get the i or j aperture dimension, in pixels.

◆ get_distance()

double Aperture::get_distance ( ) const

Get the aperture offset: the distance from the beam source to closest point on the aperture plane.

◆ get_range_compensator_image()

Plm_image::Pointer & Aperture::get_range_compensator_image ( )

Get the range_compensator image as Plm_image.

◆ get_range_compensator_volume()

Volume::Pointer & Aperture::get_range_compensator_volume ( )

Get the range_compensator image as Volume.

◆ get_spacing() [1/2]

const double * Aperture::get_spacing ( ) const

Get the aperture spacing: the distance between sampling points in the aperture plane, in mm.

◆ get_spacing() [2/2]

double Aperture::get_spacing ( int dim ) const

Get the aperture spacing in the i or j dimension, in mm.

◆ have_aperture_image()

bool Aperture::have_aperture_image ( )

Test if the aperture has a bitmap image describing shape.

◆ have_range_compensator_image()

bool Aperture::have_range_compensator_image ( )

Test if the aperture has a float image describing range compensator thicknesses.

◆ set_aperture_image()

void Aperture::set_aperture_image ( const char * ap_filename )

Load the aperture image from a file.

◆ set_aperture_volume()

void Aperture::set_aperture_volume ( Volume::Pointer ap )

Load the aperture volume from a file.

◆ set_center() [1/2]

void Aperture::set_center ( const double * center )

◆ set_center() [2/2]

void Aperture::set_center ( const float * center )

Set the aperture center, in pixels.

◆ set_dim()

void Aperture::set_dim ( const plm_long * dim )

Set the aperture dimension, in pixels.

◆ set_distance()

void Aperture::set_distance ( double distance )

Get the aperture offset: the distance from the beam source to closest point on the aperture plane.

◆ set_origin() [1/2]

void Aperture::set_origin ( const double * center )

◆ set_origin() [2/2]

void Aperture::set_origin ( const float * center )

Set the aperture origin, in mm.

◆ set_range_compensator_image()

void Aperture::set_range_compensator_image ( const char * rc_filename )

Load the range_compensator image from a file.

◆ set_range_compensator_volume()

void Aperture::set_range_compensator_volume ( Volume::Pointer ap )

Load the range_compensator volume from a file.

◆ set_spacing() [1/2]

void Aperture::set_spacing ( const double * spacing )

◆ set_spacing() [2/2]

void Aperture::set_spacing ( const float * spacing )

Get the aperture spacing: the distance between sampling points in the aperture plane.

◆ set_vup()

void Aperture::set_vup ( const float * vup )

Get the aperture vup vector, which is the vector that orients the top of the aperture in room coordinates.

◆ SMART_POINTER_SUPPORT()

Aperture::SMART_POINTER_SUPPORT ( Aperture )

Member Data Documentation

◆ d_ptr

Aperture_private* Aperture::d_ptr

◆ ic_room

double Aperture::ic_room[3]

◆ incr_c

double Aperture::incr_c[3]

◆ incr_r

double Aperture::incr_r[3]

◆ nrm

double Aperture::nrm[3]

◆ pdn

double Aperture::pdn[3]

◆ prt

double Aperture::prt[3]

◆ tmp

double Aperture::tmp[3]

◆ ul_room

double Aperture::ul_room[3]

◆ vup

double Aperture::vup[3]

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

src/base/aperture.h
src/base/aperture.cxx

Public Member Functions

Public Attributes