An encapsulation of icosahedral symmetry 222. More...
#include <symmetry.h>
Inheritance diagram for EMAN::Icosahedral2Sym:
Collaboration diagram for EMAN::Icosahedral2Sym:
Public Member Functions | |
| Icosahedral2Sym () | |
| Constructor calls PlatonicSym::init. More... | |
| virtual | ~Icosahedral2Sym () |
| virtual string | get_name () const |
| Return IcosahedralSym::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 an icosahedron. More... | |
| virtual int | get_nsym () const |
| Gets the total number of unique roational symmetry operations associated with this symmetry For icosahedral symmetry, this is 60. 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 icosahedron. 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_in_asym_unit (const float &altitude, const float &azimuth, const bool inc_mirror) const |
| A function to be used when generating orientations over portion of the unit sphere defined by parameters returned by get_delimiters. 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... | |
| virtual bool | is_tet_sym () const |
| A function that is used to determine if this is the tetrahedral symmetry object This function is only virtually overidden by the TetSym 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 = "icos2" |
| The name of this class - used to access it from factories etc. Should be "icos2". More... | |
Private Member Functions | |
| Icosahedral2Sym (const Icosahedral2Sym &) | |
| Disallow copy construction. More... | |
| Icosahedral2Sym & | operator= (const Icosahedral2Sym &) |
| 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< Vec3f > | get_asym_unit_points (bool inc_mirror=false) const |
| 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 icosahedral symmetry 222.
Definition at line 919 of file symmetry.h.
Constructor & Destructor Documentation
◆ Icosahedral2Sym() [1/2]
|
inline |
Constructor calls PlatonicSym::init.
Definition at line 924 of file symmetry.h.
Referenced by NEW().
◆ ~Icosahedral2Sym()
|
inlinevirtual |
Definition at line 925 of file symmetry.h.
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().
◆ Icosahedral2Sym() [2/2]
|
private |
Disallow copy construction.
Member Function Documentation
◆ get_az_alignment_offset()
|
virtual |
Get the azimuth alignment offset required to ensure that orientations align correctly with symmetric axes of the icosahedron.
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 1869 of file symmetry.cpp.
◆ get_desc()
|
inlinevirtual |
Get a description.
- Returns
- a clear desciption of this class
Implements EMAN::FactoryBase.
Definition at line 943 of file symmetry.h.
◆ get_max_csym()
|
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 icosahedral symmetry, this number is 2
Implements EMAN::Symmetry3D.
Definition at line 949 of file symmetry.h.
◆ get_name()
|
inlinevirtual |
Return IcosahedralSym::NAME.
- Returns
- the unique name of this class
Implements EMAN::FactoryBase.
Definition at line 938 of file symmetry.h.
static const string NAME
The name of this class - used to access it from factories etc. Should be "icos2".
Definition: symmetry.h:974
References NAME.
◆ get_nsym()
|
inlinevirtual |
Gets the total number of unique roational symmetry operations associated with this symmetry For icosahedral symmetry, this is 60.
- Returns
- 60
Implements EMAN::Symmetry3D.
Definition at line 963 of file symmetry.h.
◆ get_sym()
|
virtual |
This function provides access to the unique rotational symmetries of an icosahedron.
We have placed the icosahedral symmetry group with a face along the z-axis. In all, there are 60 (accessed by get_nysm) unique rotational symmetric operations for the icosahedron.
- Parameters
-
n the symmetric operation number.
- Returns
- a transform containing the correct rotational symmetry operation.
Implements EMAN::Symmetry3D.
Definition at line 1871 of file symmetry.cpp.
A Transform object is a somewhat specialized object designed specifically for EMAN2/Sparx storage of ...
Definition: transform.h:75
◆ NEW()
|
inlinestatic |
Factory support function NEW.
- Returns
- a newly instantiated class of this type
Definition at line 930 of file symmetry.h.
References Icosahedral2Sym().
◆ operator=()
|
private |
Disallow assignment.
Member Data Documentation
◆ NAME
|
static |
The name of this class - used to access it from factories etc. Should be "icos2".
Definition at line 974 of file symmetry.h.
Referenced by get_name().
The documentation for this class was generated from the following files:
