#include <emobject.h>
Inheritance diagram for EMAN::FactoryBase:
Public Member Functions | |
FactoryBase () | |
virtual | ~FactoryBase () |
virtual string | get_name () const =0 |
Get the unique name of this class (especially for factory based instantiation access). | |
virtual string | get_desc () const =0 |
Get a clear, concise description of this class. | |
Dict | get_params () const |
get a copy of the parameters of this class | |
void | set_params (const Dict &new_params) |
Set new parameters. | |
void | set_param (const string key, const EMObject val) |
virtual TypeDict | get_param_types () const =0 |
void | insert_params (const Dict &new_params) |
Insert parameters. | |
Dict | copy_relevant_params (const FactoryBase *const that) const |
Protected Attributes | |
Dict | params |
This is the dictionary the stores the parameters of the object. |
This class is abstract.
Definition at line 878 of file emobject.h.
EMAN::FactoryBase::FactoryBase | ( | ) | [inline] |
virtual EMAN::FactoryBase::~FactoryBase | ( | ) | [inline, virtual] |
Dict EMAN::FactoryBase::copy_relevant_params | ( | const FactoryBase *const | that | ) | const [inline] |
Definition at line 933 of file emobject.h.
References EMAN::Dict::copy_keys_in(), get_param_types(), and params.
Referenced by EMAN::OptimumOrientationGenerator::gen_orientations().
00934 { 00935 return params.copy_keys_in(that->get_param_types()); 00936 00937 }
virtual string EMAN::FactoryBase::get_desc | ( | ) | const [pure virtual] |
Get a clear, concise description of this class.
Implemented in EMAN::XYZReconstructor, EMAN::FourierReconstructorSimple2D, EMAN::FourierReconstructor, EMAN::WienerFourierReconstructor, EMAN::FourierPlaneReconstructor, EMAN::BackProjectionReconstructor, EMAN::nn4Reconstructor, EMAN::nn4_rectReconstructor, EMAN::nnSSNR_Reconstructor, EMAN::nn4_ctfReconstructor, EMAN::nn4_ctf_rectReconstructor, EMAN::nnSSNR_ctfReconstructor, EMAN::FourierInserter3DMode1, EMAN::FourierInserter3DMode2, EMAN::FourierInserter3DMode3, EMAN::FourierInserter3DMode5, EMAN::FourierInserter3DMode6, EMAN::FourierInserter3DMode7, EMAN::FourierInserter3DMode8, EMAN::CSym, EMAN::DSym, EMAN::HSym, EMAN::TetrahedralSym, EMAN::OctahedralSym, EMAN::IcosahedralSym, EMAN::Icosahedral2Sym, EMAN::EmanOrientationGenerator, EMAN::RandomOrientationGenerator, EMAN::EvenOrientationGenerator, EMAN::SaffOrientationGenerator, and EMAN::OptimumOrientationGenerator.
virtual string EMAN::FactoryBase::get_name | ( | ) | const [pure virtual] |
Get the unique name of this class (especially for factory based instantiation access).
Implemented in EMAN::XYZReconstructor, EMAN::FourierReconstructorSimple2D, EMAN::FourierReconstructor, EMAN::WienerFourierReconstructor, EMAN::FourierPlaneReconstructor, EMAN::BackProjectionReconstructor, EMAN::nn4Reconstructor, EMAN::nn4_rectReconstructor, EMAN::nnSSNR_Reconstructor, EMAN::nn4_ctfReconstructor, EMAN::nn4_ctf_rectReconstructor, EMAN::nnSSNR_ctfReconstructor, EMAN::FourierInserter3DMode1, EMAN::FourierInserter3DMode2, EMAN::FourierInserter3DMode3, EMAN::FourierInserter3DMode5, EMAN::FourierInserter3DMode6, EMAN::FourierInserter3DMode7, EMAN::FourierInserter3DMode8, EMAN::CSym, EMAN::DSym, EMAN::HSym, EMAN::TetrahedralSym, EMAN::OctahedralSym, EMAN::IcosahedralSym, EMAN::Icosahedral2Sym, EMAN::EmanOrientationGenerator, EMAN::RandomOrientationGenerator, EMAN::EvenOrientationGenerator, EMAN::SaffOrientationGenerator, and EMAN::OptimumOrientationGenerator.
Referenced by EMAN::PlatonicSym::get_delimiters().
virtual TypeDict EMAN::FactoryBase::get_param_types | ( | ) | const [pure virtual] |
Implemented in EMAN::XYZReconstructor, EMAN::FourierReconstructorSimple2D, EMAN::FourierReconstructor, EMAN::FourierPlaneReconstructor, EMAN::BackProjectionReconstructor, EMAN::nn4Reconstructor, EMAN::nn4_rectReconstructor, EMAN::nnSSNR_Reconstructor, EMAN::nn4_ctfReconstructor, EMAN::nn4_ctf_rectReconstructor, EMAN::nnSSNR_ctfReconstructor, EMAN::FourierPixelInserter3D, EMAN::CSym, EMAN::DSym, EMAN::HSym, EMAN::PlatonicSym, EMAN::OrientationGenerator, EMAN::EmanOrientationGenerator, EMAN::RandomOrientationGenerator, EMAN::EvenOrientationGenerator, EMAN::SaffOrientationGenerator, and EMAN::OptimumOrientationGenerator.
Referenced by copy_relevant_params(), and insert_params().
Dict EMAN::FactoryBase::get_params | ( | ) | const [inline] |
get a copy of the parameters of this class
Definition at line 897 of file emobject.h.
References params.
Referenced by EMAN::SaffOrientationGenerator::gen_orientations(), and EMAN::SaffOrientationGenerator::get_orientations_tally().
00897 { return params; }
void EMAN::FactoryBase::insert_params | ( | const Dict & | new_params | ) | [inline] |
Insert parameters.
Previously present parameters are replaced, new ones are inserted.
new_params | the parameters to insert |
Definition at line 917 of file emobject.h.
References EMAN::Dict::begin(), EMAN::Dict::end(), EMAN::TypeDict::find_type(), get_param_types(), InvalidParameterException, and params.
Referenced by set_params().
00918 { 00919 // this is really inserting OR individually replacing... 00920 // the old data will be kept if it is not written over 00921 TypeDict permissable_params = get_param_types(); 00922 for ( Dict::const_iterator it = new_params.begin(); it != new_params.end(); ++it ) 00923 { 00924 00925 if ( !permissable_params.find_type(it->first) ) 00926 { 00927 throw InvalidParameterException(it->first); 00928 } 00929 params[it->first] = it->second; 00930 } 00931 }
void EMAN::FactoryBase::set_param | ( | const string | key, | |
const EMObject | val | |||
) | [inline] |
void EMAN::FactoryBase::set_params | ( | const Dict & | new_params | ) | [inline] |
Set new parameters.
Old parameters are cleared
new_params | the new parameters |
Definition at line 902 of file emobject.h.
References EMAN::Dict::clear(), insert_params(), and params.
Referenced by EMAN::OptimumOrientationGenerator::gen_orientations().
00903 { 00904 params.clear(); 00905 insert_params(new_params); 00906 }
Dict EMAN::FactoryBase::params [mutable, protected] |
This is the dictionary the stores the parameters of the object.
Definition at line 941 of file emobject.h.
Referenced by EMAN::OrientationGenerator::add_orientation(), EMAN::nnSSNR_ctfReconstructor::buildFFTVolume(), EMAN::nn4_ctf_rectReconstructor::buildFFTVolume(), EMAN::nn4_ctfReconstructor::buildFFTVolume(), EMAN::nnSSNR_Reconstructor::buildFFTVolume(), EMAN::nn4_rectReconstructor::buildFFTVolume(), EMAN::nn4Reconstructor::buildFFTVolume(), EMAN::nnSSNR_ctfReconstructor::buildNorm2Volume(), EMAN::nnSSNR_Reconstructor::buildNorm2Volume(), EMAN::nnSSNR_ctfReconstructor::buildNorm3Volume(), EMAN::nnSSNR_ctfReconstructor::buildNormVolume(), EMAN::nn4_ctf_rectReconstructor::buildNormVolume(), EMAN::nn4_ctfReconstructor::buildNormVolume(), EMAN::nnSSNR_Reconstructor::buildNormVolume(), EMAN::nn4_rectReconstructor::buildNormVolume(), EMAN::nn4Reconstructor::buildNormVolume(), copy_relevant_params(), EMAN::WienerFourierReconstructor::do_compare_slice_work(), EMAN::FourierReconstructor::do_compare_slice_work(), EMAN::WienerFourierReconstructor::do_insert_slice_work(), EMAN::FourierReconstructor::do_insert_slice_work(), EMAN::nnSSNR_ctfReconstructor::finish(), EMAN::nnSSNR_Reconstructor::finish(), EMAN::BackProjectionReconstructor::finish(), EMAN::WienerFourierReconstructor::finish(), EMAN::FourierReconstructor::finish(), EMAN::OptimumOrientationGenerator::gen_orientations(), EMAN::SaffOrientationGenerator::gen_orientations(), EMAN::EvenOrientationGenerator::gen_orientations(), EMAN::RandomOrientationGenerator::gen_orientations(), EMAN::EmanOrientationGenerator::gen_orientations(), EMAN::HSym::get_asym_unit_points(), EMAN::DSym::get_asym_unit_points(), EMAN::CSym::get_asym_unit_points(), EMAN::DSym::get_asym_unit_triangles(), EMAN::CSym::get_asym_unit_triangles(), EMAN::HSym::get_delimiters(), EMAN::DSym::get_delimiters(), EMAN::CSym::get_delimiters(), EMAN::HSym::get_max_csym(), EMAN::DSym::get_max_csym(), EMAN::CSym::get_max_csym(), EMAN::HSym::get_nsym(), EMAN::DSym::get_nsym(), EMAN::CSym::get_nsym(), EMAN::OptimumOrientationGenerator::get_orientations_tally(), EMAN::SaffOrientationGenerator::get_orientations_tally(), EMAN::EvenOrientationGenerator::get_orientations_tally(), EMAN::EmanOrientationGenerator::get_orientations_tally(), get_params(), EMAN::HSym::get_sym(), EMAN::DSym::get_sym(), EMAN::CSym::get_sym(), EMAN::FourierPixelInserter3D::init(), insert_params(), EMAN::BackProjectionReconstructor::insert_slice(), EMAN::HSym::is_in_asym_unit(), EMAN::DSym::is_in_asym_unit(), EMAN::CSym::is_in_asym_unit(), EMAN::BackProjectionReconstructor::load_default_settings(), EMAN::FourierReconstructor::load_inserter(), EMAN::Reconstructor::operator[](), EMAN::Reconstructor::print_params(), set_param(), set_params(), EMAN::nnSSNR_ctfReconstructor::setup(), EMAN::nn4_ctf_rectReconstructor::setup(), EMAN::nn4_ctfReconstructor::setup(), EMAN::nnSSNR_Reconstructor::setup(), EMAN::nn4_rectReconstructor::setup(), EMAN::nn4Reconstructor::setup(), EMAN::BackProjectionReconstructor::setup(), EMAN::FourierReconstructor::setup(), EMAN::FourierReconstructorSimple2D::setup(), and EMAN::FourierReconstructor::setup_seed().