EMAN::SingleOrientationGenerator Class Reference

SingleOrientationGenerator generates a single orientation with the specified EMAN-style Euler angles. More...

#include <symmetry.h>

Inheritance diagram for EMAN::SingleOrientationGenerator:

Collaboration diagram for EMAN::SingleOrientationGenerator:

Public Member Functions
	SingleOrientationGenerator ()
virtual	~SingleOrientationGenerator ()
virtual string	get_name () const
	Return "eman". More...
virtual string	get_desc () const
	Get a description. More...
virtual TypeDict	get_param_types () const
	Get a dictionary containing the permissable parameters of this class. More...
virtual vector< Transform >	gen_orientations (const Symmetry3D *const sym) const
	generate orientations given some symmetry type More...
Public Member Functions inherited from EMAN::OrientationGenerator
	OrientationGenerator ()
virtual	~OrientationGenerator ()
bool	add_orientation (vector< Transform > &v, const float &az, const float &alt) const
	This functions adds one or more Transform objects to the vector v, depending on the parameters stored in the dictionary (which the inheriting class may include by initializing the typedict in get_param_types by calling. More...
float	get_optimal_delta (const Symmetry3D *const sym, const int &n) const
	This function gets the optimal value of the delta (or angular spacing) of the orientations based on a desired total number of orientations (n). More...
Public Member Functions inherited from EMAN::FactoryBase
	FactoryBase ()
virtual	~FactoryBase ()
Dict	get_params () const
	get a copy of the parameters of this class More...
void	set_params (const Dict &new_params)
	Set new parameters. More...
void	set_param (const string key, const EMObject val)
void	insert_params (const Dict &new_params)
	Insert parameters. More...
Dict	copy_relevant_params (const FactoryBase *const that) const

Static Public Member Functions
static OrientationGenerator *	NEW ()
	Factory support function NEW. More...

Static Public Attributes
static const string	NAME = "single"
	The name of this class - used to access it from factories etc. Should be "icos". More...

Private Member Functions
	SingleOrientationGenerator (const SingleOrientationGenerator &)
	Disallow copy construction. More...
SingleOrientationGenerator &	operator= (const SingleOrientationGenerator &)
	Disallow assignment. More...
virtual int	get_orientations_tally (const Symmetry3D *const sym, const float &delta) const
	This function returns how many orientations will be generated for a given delta (angular spacing) It does this by simulated gen_orientations. More...

Additional Inherited Members
Protected Member Functions inherited from EMAN::OrientationGenerator
void	get_az_max (const Symmetry3D *const sym, const float &altmax, const bool inc_mirror, const float &alt_iterator, const float &h, bool &d_odd_mirror_flag, float &azmax_adjusted) const
Protected Attributes inherited from EMAN::FactoryBase
Dict	params
	This is the dictionary the stores the parameters of the object. More...

Detailed Description

SingleOrientationGenerator generates a single orientation with the specified EMAN-style Euler angles.

Author

Steve Ludtke

Date

August 17, 2015

Definition at line 1164 of file symmetry.h.

Constructor & Destructor Documentation

SingleOrientationGenerator() [1/2]

EMAN::SingleOrientationGenerator::SingleOrientationGenerator ( )

inline

Definition at line 1167 of file symmetry.h.

{};

Referenced by NEW().

~SingleOrientationGenerator()

virtual EMAN::SingleOrientationGenerator::~SingleOrientationGenerator ( )

inlinevirtual

Definition at line 1168 of file symmetry.h.

{};

SingleOrientationGenerator() [2/2]

EMAN::SingleOrientationGenerator::SingleOrientationGenerator ( const SingleOrientationGenerator &  )

private

Disallow copy construction.

Member Function Documentation

gen_orientations()

vector< Transform > SingleOrientationGenerator::gen_orientations ( const Symmetry3D *const  sym ) const

virtual

generate orientations given some symmetry type

Parameters

sym	the symmetry which defines the interesting asymmetric unit

Returns

a vector of Transform objects containing the set of evenly distributed orientations

Implements EMAN::OrientationGenerator.

Definition at line 524 of file symmetry.cpp.

{
        float az = params.set_default("az", 0.0f);
        float alt = params.set_default("alt", 0.0f);
        float phi = params.set_default("phi", 0.0f);
 
        float alt_iterator = 0.0f;
 
        Transform base(Dict("type","eman","az",az,"alt",alt,"phi",phi));
        
        vector<Transform> ret;
        ret.push_back(base);
        
//      for (int i=0; i<sym->get_nsym(); i++) {
//              ret.push_back(base*sym->get_sym(i));
//      }
        
        
        return ret;
}

References EMAN::FactoryBase::params, and EMAN::Dict::set_default().

get_desc()

virtual string EMAN::SingleOrientationGenerator::get_desc ( ) const

inlinevirtual

Get a description.

Returns

a clear desciption of this class

Implements EMAN::FactoryBase.

Definition at line 1186 of file symmetry.h.

{ return "Generate a single orientation with the specified EMAN style Euler angles. Symmetry is ignored."; }

get_name()

virtual string EMAN::SingleOrientationGenerator::get_name ( ) const

inlinevirtual

Return "eman".

Returns

the unique name of this class

Implements EMAN::FactoryBase.

Definition at line 1181 of file symmetry.h.

{ return NAME; }

References NAME.

get_orientations_tally()

int SingleOrientationGenerator::get_orientations_tally ( const Symmetry3D *const  sym, const float &  delta  ) const

privatevirtual

This function returns how many orientations will be generated for a given delta (angular spacing) It does this by simulated gen_orientations.

Parameters

sym	the symmetry which defines the interesting asymmetric unit
delta	the desired angular spacing of the orientations

Returns

the number of orientations that will be generated using these parameters

Implements EMAN::OrientationGenerator.

Definition at line 519 of file symmetry.cpp.

{
return 1;
}

get_param_types()

virtual TypeDict EMAN::SingleOrientationGenerator::get_param_types ( ) const

inlinevirtual

Get a dictionary containing the permissable parameters of this class.

Returns

a dictionary containing the permissable parameters of this class parameters are explained in the dictionary itself

Reimplemented from EMAN::OrientationGenerator.

Definition at line 1192 of file symmetry.h.

                {
                        TypeDict d = OrientationGenerator::get_param_types();
                        d.put("az", EMObject::FLOAT, "Azimuthal angle (Z rotation in deg)");
                        d.put("alt", EMObject::FLOAT, "Altitude (X rotation in deg)");
                        d.put("phi", EMObject::FLOAT, "Phi angle (Z' rotation in deg");
                        d.put("phitoo", EMObject::INT, "This option is ignored for the single orientation generator");
                        d.put("randomphi", EMObject::INT, "This option is ignored for the single orientation generator");
                        return d;
                }

References EMAN::EMObject::FLOAT, EMAN::OrientationGenerator::get_param_types(), EMAN::EMObject::INT, and EMAN::TypeDict::put().

NEW()

static OrientationGenerator * EMAN::SingleOrientationGenerator::NEW ( )

inlinestatic

Factory support function NEW.

Returns

a newly instantiated class of this type

Definition at line 1173 of file symmetry.h.

                {
                        return new SingleOrientationGenerator();
                }

References SingleOrientationGenerator().

operator=()

SingleOrientationGenerator & EMAN::SingleOrientationGenerator::operator= ( const SingleOrientationGenerator &  )

private

Disallow assignment.

Member Data Documentation

NAME

const string SingleOrientationGenerator::NAME = "single"

static

The name of this class - used to access it from factories etc. Should be "icos".

Definition at line 1210 of file symmetry.h.

Referenced by get_name().

---

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

• symmetry.h
• symmetry.cpp