btom_slice_simulator_params Class Reference

#include <btom_slice_simulator_params.h>

Inheritance diagram for btom_slice_simulator_params:

List of all members.

Public Member Functions
	btom_slice_simulator_params (const int ncyl=10, const float min_xy_sigma=2.0, const float max_xy_sigma=10.0)
	btom_slice_simulator_params (const btom_slice_simulator_params &old_params)
	~btom_slice_simulator_params ()
bool	SanityCheck ()
	Checks that parameters are within acceptable bounds.
bool	Valid () const
const char *	GetErrorMsg () const
void	SetErrorMsg (const char *msg)
Public Attributes
int	ncyl_
	number of cylinders in each direction
float	min_xy_sigma_
	min,max cylinder sigmas
float	max_xy_sigma_
Protected Member Functions
void	InitParams (int ncyl, float min_xy_sigma, float max_xy_sigma)
Friends
vcl_ostream &	operator<< (vcl_ostream &, const btom_slice_simulator_params &sp)

---

Detailed Description

Definition at line 15 of file btom_slice_simulator_params.h.

---

Constructor & Destructor Documentation

btom_slice_simulator_params::btom_slice_simulator_params	(	const int	ncyl = 10,
		const float	min_xy_sigma = 2.0,
		const float	max_xy_sigma = 10.0
	)

Definition at line 21 of file btom_slice_simulator_params.cxx.

btom_slice_simulator_params::btom_slice_simulator_params

(

const btom_slice_simulator_params &

old_params

)

Definition at line 15 of file btom_slice_simulator_params.cxx.

btom_slice_simulator_params::~btom_slice_simulator_params

(

)

[inline]

Definition at line 23 of file btom_slice_simulator_params.h.

---

Member Function Documentation

void btom_slice_simulator_params::InitParams	(	int	ncyl,
		float	min_xy_sigma,
		float	max_xy_sigma
	)		[protected]

Definition at line 30 of file btom_slice_simulator_params.cxx.

bool btom_slice_simulator_params::SanityCheck

(

)

[virtual]

Checks that parameters are within acceptable bounds.

Note that msg << ends seems to restart the string and erase the previous string. We should only use it as the last call, use vcl_endl otherwise.

Reimplemented from gevd_param_mixin.

Definition at line 47 of file btom_slice_simulator_params.cxx.

---

Friends And Related Function Documentation

vcl_ostream& operator<<	(	vcl_ostream &	os,
		const btom_slice_simulator_params &	sp
	)		[friend]

Definition at line 76 of file btom_slice_simulator_params.cxx.

---

Member Data Documentation

float btom_slice_simulator_params::max_xy_sigma_

Definition at line 38 of file btom_slice_simulator_params.h.

float btom_slice_simulator_params::min_xy_sigma_

min,max cylinder sigmas

Definition at line 37 of file btom_slice_simulator_params.h.

int btom_slice_simulator_params::ncyl_

number of cylinders in each direction

Definition at line 36 of file btom_slice_simulator_params.h.

---

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

• contrib/brl/bmvl/btom/btom_slice_simulator_params.h
• contrib/brl/bmvl/btom/btom_slice_simulator_params.cxx