An encapsulation of tetrahedral symmetry Doctor Phil has this to say about tetrahedral symmetry: " Each Platonic Solid has 2E symmetry elements. More...

#include <symmetry.h>

Inheritance diagram for EMAN::TetrahedralSym:

[legend]

Collaboration diagram for EMAN::TetrahedralSym:

[legend]

Public Member Functions
	TetrahedralSym ()
	Constructor calls PlatonicSym::init. More...

virtual	~TetrahedralSym ()

virtual string	get_name () const
	Return TetrahedralSym::NAME. More...

virtual string	get_desc () const
	Get a description. More...

virtual int	get_max_csym () const
	Gets the maximum symmetry of this object. More...

virtual Transform	get_sym (const int n) const
	This function provides access to the unique rotational symmetries of a tetrahedron. More...

virtual bool	is_in_asym_unit (const float &altitude, const float &azimuth, const bool inc_mirror) const
	In tetrahedral symmetry special consideration must be taken when generating orientations in the asymmetric unit. More...

virtual int	get_nsym () const
	Gets the total number of unique roational symmetry operations associated with this symmetry For tetrahedral symmetry symmetry, this is 12. More...

virtual float	get_az_alignment_offset () const
	Get the azimuth alignment offset required to ensure that orientations align correctly with symmetric axes of the tetrahedron. More...

virtual vector< Vec3f >	get_asym_unit_points (bool inc_mirror=false) const

virtual bool	is_tet_sym () const
	A function that is used to determine if this is the tetrahedral symmetry object. More...

Public Member Functions inherited from EMAN::PlatonicSym
	PlatonicSym ()

virtual	~PlatonicSym ()

virtual TypeDict	get_param_types () const
	Get a dictionary containing the permissable parameters of this class Platonic symmetries actually have no parameters. More...

virtual Dict	get_delimiters (const bool inc_mirror=false) const
	Returns the range of altitude and azimuth angles which encompass the asymmetric unit of the Platonic symmetry (and more). More...

virtual bool	is_platonic_sym () const
	Determines whether or not this Symmetry3D is the platonic type - returns true. More...

Public Member Functions inherited from EMAN::Symmetry3D
	Symmetry3D ()

virtual	~Symmetry3D ()

virtual bool	is_h_sym () const
	A function that is used to determine if this is a Helical symmetry object This function is only virtually overidden by the HSym symmetry, which returns true, not false. More...

virtual bool	is_c_sym () const
	A function that is used to determine if this is a c symmetry object This function is only virtually overidden by the CSym object, which returns true. More...

virtual bool	is_d_sym () const
	A function that is used to determine if this is a d symmetry object This function is only virtually overidden by the DSym object, which returns true. More...

vector< Transform >	gen_orientations (const string &generatorname="eman", const Dict &parms=Dict())
	Ask the Symmetry3D object to generate a set of orientations in its asymmetric unit using an OrientationGenerator constructed from the given parameters (using a Factory). More...

virtual Transform	reduce (const Transform &t3d, int n=0) const
	A function that will reduce an orientation, as characterized by Euler anges, into a specific asymmetric unit. More...

virtual int	in_which_asym_unit (const Transform &t3d) const
	A function that will determine in which asymmetric unit a given orientation resides The asymmetric unit 'number' will depend entirely on the order in which different symmetry operations are return by the Symmetry3D::get_sym function. More...

virtual int	point_in_which_asym_unit (const Vec3f &v) const
	A function that will determine in which asymmetric unit a given vector resides The asymmetric unit 'number' will depend entirely on the order in which different symmetry operations are return by the Symmetry3D::get_sym function The vector is a point. More...

virtual vector< Transform >	get_touching_au_transforms (bool inc_mirror=true) const
	Gets a vector of Transform objects that define the set of asymmetric units that touch the default asymmetric unit. More...

virtual vector< Transform >	get_syms () const

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 Symmetry3D *	NEW ()
	Factory support function NEW. More...

Static Public Member Functions inherited from EMAN::Symmetry3D
static vector< Transform >	get_symmetries (const string &symmetry)

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

Private Member Functions
	TetrahedralSym (const TetrahedralSym &)
	Disallow copy construction. More...

TetrahedralSym &	operator= (const TetrahedralSym &)
	Disallow assignment. More...

Additional Inherited Members
Public Types inherited from EMAN::Symmetry3D
typedef vector< vector< Vec3f > >::const_iterator	cit

typedef vector< vector< Vec3f > >::iterator	ncit

Protected Member Functions inherited from EMAN::PlatonicSym
void	init ()
	Init - Called to initialize platonic_params, should be called in the constructor of all Platonic solids that derive from this. More...

float	platonic_alt_lower_bound (const float &azimuth, const float &alpha) const
	Returns the lower bound of the asymmetric unit, as dependent on azimuth, and on alpha - alpha is alt_max for icos and oct, but may be alt_max/2.0 for tet depending on mirror symmetry etc. More...

virtual vector< vector< Vec3f > >	get_asym_unit_triangles (bool inc_mirror) const
	Get triangles that precisely occlude the projection area of the default asymmetric unit. More...

Protected Member Functions inherited from EMAN::Symmetry3D
void	cache_au_planes () const
	Establish the asymmetric unit planes cache. More...

void	delete_au_planes ()
	Clear the asymmetric unit planes cache. More...

Protected Attributes inherited from EMAN::PlatonicSym
Dict	platonic_params
	A dictionary that stores important angles, in radians. More...

Protected Attributes inherited from EMAN::Symmetry3D
float **	cached_au_planes
	The asymmetric unit planes are cached to provide a great speed up the point_in_which_asym_unit function, which is called by reduce and by in_which_asym_unit. More...

int	cache_size
	Have to remember the cache size. More...

int	num_triangles
	This is stores the number of triangles returned by get_asym_unit_triangles(true) More...

vector< vector< Vec3f > >	au_sym_triangles
	This cache is of size cache_size. More...

Protected Attributes inherited from EMAN::FactoryBase
Dict	params
	This is the dictionary the stores the parameters of the object. More...

Detailed Description

An encapsulation of tetrahedral symmetry Doctor Phil has this to say about tetrahedral symmetry: " Each Platonic Solid has 2E symmetry elements.

The tetrahedron has n=m=3; F=4, E=6=nF/2, V=4=nF/m. It is composed of four triangles."

Author: David Woolford (based on previous work by Phil Baldwin and Steve Ludtke)

Date: Feb 2008

Definition at line 675 of file symmetry.h.

Constructor & Destructor Documentation

◆ TetrahedralSym() [1/2]

EMAN::TetrahedralSym::TetrahedralSym ( )

inline

Constructor calls PlatonicSym::init.

Definition at line 680 of file symmetry.h.

680{init();}

EMAN::PlatonicSym::init

void init()

Init - Called to initialize platonic_params, should be called in the constructor of all Platonic soli...

Definition: symmetry.cpp:1673

References EMAN::PlatonicSym::init().

Referenced by NEW().

◆ ~TetrahedralSym()

virtual EMAN::TetrahedralSym::~TetrahedralSym ( )

inlinevirtual

Definition at line 681 of file symmetry.h.

681{}

◆ TetrahedralSym() [2/2]

EMAN::TetrahedralSym::TetrahedralSym ( const TetrahedralSym & )

private

Disallow copy construction.

Member Function Documentation

◆ get_asym_unit_points()

vector< Vec3f > TetrahedralSym::get_asym_unit_points ( bool inc_mirror = false ) const

virtual

Parameters

inc_mirror whether or not to include the mirror portion of the asymmetric unit

Returns: a cyclic set of points which can be connected using great arcs on the unit sphere to demarcate the asymmetric unit. The last should may be connected to the first.

Reimplemented from EMAN::PlatonicSym.

Definition at line 2031 of file symmetry.cpp.

{
        vector<Vec3f> ret;
 
        Vec3f b = Vec3f(0,0,1);
        ret.push_back(b);
        float theta_c_on_two = (float)platonic_params["theta_c_on_two"]; // already in radians
        float theta_c = 2*theta_c_on_two;
 
        Vec3f c_on_two = Vec3f(0,-sin(theta_c_on_two),cos(theta_c_on_two));
        Vec3f c = Vec3f(0,-sin(theta_c),cos(theta_c));
        ret.push_back(c_on_two);
        float cap_sig = platonic_params["az_max"];
        if ( inc_mirror ) {
                Vec3f a = Vec3f(sin(theta_c)*sin(cap_sig),-sin(theta_c)*cos(cap_sig),cos(theta_c));
 
                Vec3f f = a+b+c;
                f.normalize();
 
                ret.push_back(f);
        }
 
        Vec3f a_on_two = Vec3f(sin(theta_c_on_two)*sin(cap_sig),-sin(theta_c_on_two)*cos(cap_sig),cos(theta_c_on_two));
        ret.push_back(a_on_two);
 
 
        if ( get_az_alignment_offset() != 0 ) {
                Dict d("type","eman");
                d["az"] = get_az_alignment_offset();
                d["phi"] = 0.0f;
                d["alt"] = 0.0f;
                Transform t(d);
                for (vector<Vec3f>::iterator it = ret.begin(); it != ret.end(); ++it )
                {
                        *it = (*it)*t;
                }
        }
 
        return ret;
}

References get_az_alignment_offset(), EMAN::Vec3< Type >::normalize(), and EMAN::PlatonicSym::platonic_params.

◆ get_az_alignment_offset()

float TetrahedralSym::get_az_alignment_offset ( ) const

virtual

Get the azimuth alignment offset required to ensure that orientations align correctly with symmetric axes of the tetrahedron.

This offset is directly related to the way the symmetric operations are generated by get_sym. All orientations generated as a result of using the delimiters supplied by this class should by offset by this azimuth to ensure proper alignment with tetrahedral objects in EMAN2

Reimplemented from EMAN::Symmetry3D.

Definition at line 1977 of file symmetry.cpp.

1977{ return 0.0; }

Referenced by get_asym_unit_points().

◆ get_desc()

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

inlinevirtual

Get a description.

Returns: a clear desciption of this class

Implements EMAN::FactoryBase.

Definition at line 700 of file symmetry.h.

700{ return "Tetrahedral symmetry support"; }

◆ get_max_csym()

virtual int EMAN::TetrahedralSym::get_max_csym ( ) const

inlinevirtual

Gets the maximum symmetry of this object.

This is used by OrientationGenerators, and is probably not something a general user would utilize.

Returns: for tetrahedral symmetry, this number is 3

Implements EMAN::Symmetry3D.

Definition at line 706 of file symmetry.h.

706{ return 3; }

◆ get_name()

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

inlinevirtual

Return TetrahedralSym::NAME.

Returns: the unique name of this class

Implements EMAN::FactoryBase.

Definition at line 694 of file symmetry.h.

694{ return NAME; }

EMAN::TetrahedralSym::NAME

static const string NAME

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

Definition: symmetry.h:747

References NAME.

◆ get_nsym()

virtual int EMAN::TetrahedralSym::get_nsym ( ) const

inlinevirtual

Gets the total number of unique roational symmetry operations associated with this symmetry For tetrahedral symmetry symmetry, this is 12.

Returns: 12

Implements EMAN::Symmetry3D.

Definition at line 736 of file symmetry.h.

736{ return 12; };

◆ get_sym()

Transform TetrahedralSym::get_sym ( const int n ) const

virtual

This function provides access to the unique rotational symmetries of a tetrahedron.

In this implementation, the tetrahedral symmetry group has a face along the z-axis. In all, there are 12 (accessed by get_nysm) unique rotational symmetric operations for the tetrahedron. In the terminology defined Append A (titled Symmetry Elements) in the manuscript Baldwin and Penczek, 2007. The Transform Class in SPARX and EMAN2. JSB 157(250-261), Doctor Phil has this to say: "B^3=A^3=1; BABA=1; implies A^2=BAB, ABA=B^2 , AB^2A = B^2AB^2 and 12 words with at most a single A 1 B BB A BA AB BBA BAB ABB BBAB BABB BBABB at most one A is necessary"

Parameters

n	the symmetric operation number

Returns: a transform containing the correct rotational symmetry operation.

Implements EMAN::Symmetry3D.

Definition at line 2006 of file symmetry.cpp.

{
        // These rotations courtesy of Phil Baldwin
         // It has n=m=3; F=4, E=6=nF/2, V=4=nF/m
        float lvl0 = 0.0f;   // There is a face along z
        float lvl1 = (float)(EMConsts::rad2deg*acos(-1.0f/3.0f));  // There  are 3 faces at this angle
 
        float TET[36] = {// This is with the face along z
                0,lvl0,0,   0,lvl0,120,    0,lvl0,240,
                0,lvl1,60,   0,lvl1,180,    0,lvl1,300,
                120,lvl1,60, 120,lvl1,180,  120,lvl1,300,
                240,lvl1,60, 240,lvl1,180,  240,lvl1,300
        };
 
        int idx = n % 12;
 
        Dict d("type","eman");
        d["az"]  = TET[idx * 3 ];
        d["alt"] = TET[idx * 3 + 1];
        d["phi"] = TET[idx * 3 + 2];
        return Transform(d);
 
}

References EMAN::EMConsts::rad2deg.

◆ is_in_asym_unit()

bool TetrahedralSym::is_in_asym_unit	(	const float &	altitude,
		const float &	azimuth,
		const bool	inc_mirror
	)		const

virtual

In tetrahedral symmetry special consideration must be taken when generating orientations in the asymmetric unit.

This function is a specialization of the functionality in PlatonicSym::is_in_asym_unit

Parameters

altitude	the EMAN style altitude of the 3D orientation in degrees
azimuth	the EMAN style azimuth of the 3D orientation in degrees
inc_mirror	whether or not to include orientations if they are in the mirror portion of the asymmetric unit

Returns: true or false, depending on whether or not the orientation is within the asymmetric unit

Reimplemented from EMAN::PlatonicSym.

Definition at line 1979 of file symmetry.cpp.

{
        Dict d = get_delimiters(inc_mirror);
        float alt_max = d["alt_max"];
        float az_max = d["az_max"];
        if ( altitude >= 0 &&  altitude <= alt_max && azimuth < az_max && azimuth >= 0) {
                // convert azimuth to radians
                float tmpaz = (float)(EMConsts::deg2rad * azimuth);
 
                float cap_sig = platonic_params["az_max"];
                float alt_max = platonic_params["alt_max"];
                tmpaz = Util::get_min( tmpaz, cap_sig-tmpaz);
 
                // convert altitude to radians
                float tmpalt = (float)(EMConsts::deg2rad * altitude);
                if ( platonic_alt_lower_bound(tmpaz, alt_max ) > tmpalt ) {
                        if ( inc_mirror ) return true;
                        else {
                                // you could change the "<" to a ">" here to get the other mirror part of the asym unit
                                if ( platonic_alt_lower_bound( tmpaz, alt_max/2.0f) < tmpalt ) return false;
                                else return true;
                        }
                } else return false;
        } else return false;
}

References EMAN::EMConsts::deg2rad, EMAN::PlatonicSym::get_delimiters(), EMAN::Util::get_min(), EMAN::PlatonicSym::platonic_alt_lower_bound(), and EMAN::PlatonicSym::platonic_params.

◆ is_tet_sym()

virtual bool EMAN::TetrahedralSym::is_tet_sym ( ) const

inlinevirtual

A function that is used to determine if this is the tetrahedral symmetry object.

Returns: true - indicating that this is not a tetrahedral symmetry object

Reimplemented from EMAN::Symmetry3D.

Definition at line 758 of file symmetry.h.

758{ return true; }

◆ NEW()

static Symmetry3D * EMAN::TetrahedralSym::NEW ( )

inlinestatic

Factory support function NEW.

Returns: a newly instantiated class of this type

Definition at line 686 of file symmetry.h.

                {
                        return new TetrahedralSym();
                }

References TetrahedralSym().

◆ operator=()

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

private

Disallow assignment.

Member Data Documentation

◆ NAME

const string TetrahedralSym::NAME = "tet"

static

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

Definition at line 747 of file symmetry.h.

Referenced by get_name().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TetrahedralSym() [1/2]

◆ ~TetrahedralSym()

◆ TetrahedralSym() [2/2]

Member Function Documentation

◆ get_asym_unit_points()

◆ get_az_alignment_offset()

◆ get_desc()

◆ get_max_csym()

◆ get_name()

◆ get_nsym()

◆ get_sym()

◆ is_in_asym_unit()

◆ is_tet_sym()

◆ NEW()

◆ operator=()

Member Data Documentation

◆ NAME