![]() |
ProSHADE
0.7.5.4 (MAR 2021)
Protein Shape Detection
|
This class contains all inputed data for the rotation function angle-axis converted spheres. More...
#include <ProSHADE_maths.hpp>
Public Member Functions | |
ProSHADE_rotFun_sphere (proshade_double rad, proshade_double radRange, proshade_unsign dim, proshade_double repAng, proshade_unsign sphNo) | |
Constructor for getting empty ProSHADE_rotFun_sphere class. More... | |
~ProSHADE_rotFun_sphere (void) | |
Destructor for releasing memory from the ProSHADE_rotFun_sphere class. More... | |
proshade_double | getRadius (void) |
Accessor function for the private variable radius. More... | |
proshade_double | getMaxRadius (void) |
Accessor function for the private variable maximum radius. More... | |
proshade_double | getMinRadius (void) |
Accessor function for the private variable minimal radius. More... | |
proshade_unsign | getAngularDim (void) |
Accessor function for the private variable angular dim. More... | |
proshade_double | getRepresentedAngle (void) |
Accessor function for the private variable represented angle. More... | |
proshade_unsign | getSphereNumber (void) |
Accessor function for the private variable sphere number. More... | |
std::vector< std::pair< proshade_unsign, proshade_unsign > > | getPeaks (void) |
Accessor function for the private variable containing all detected peaks. More... | |
proshade_double | getSphereLatLonPosition (proshade_unsign lattitude, proshade_unsign longitude) |
Accessor function for specific lattitude and longitude point of the sphere sampling grid. More... | |
proshade_double | getSphereLatLonLinearInterpolationPos (proshade_double lattitude, proshade_double longitude) |
Function for obtaining sphere values outside of the grid points. More... | |
void | interpolateSphereValues (proshade_complex *rotFun) |
Function for interpolating the sphere grid values from angle-axis converted rotation function. More... | |
void | findAllPeaks (proshade_signed noSmNeighbours, std::vector< proshade_double > *allHeights) |
Function for finding all peaks in the sampling grid. More... | |
void | removeSmallPeaks (proshade_double peakThres) |
Function for removing peaks with too small height. More... | |
This class contains all inputed data for the rotation function angle-axis converted spheres.
This class codes the object that contains all the information about a single concentric sphere in the angle-axis space obtained by conversion of the rotation function. It also contains all the functionality required to process such data.
Definition at line 50 of file ProSHADE_maths.hpp.
ProSHADE_internal_spheres::ProSHADE_rotFun_sphere::ProSHADE_rotFun_sphere | ( | proshade_double | rad, |
proshade_double | radRange, | ||
proshade_unsign | dim, | ||
proshade_double | repAng, | ||
proshade_unsign | sphNo | ||
) |
Constructor for getting empty ProSHADE_rotFun_sphere class.
This function simply creates an object of the ProSHADE_rotFun_sphere class and allocates the memory as required.
[in] | rad | The radius of this sphere. |
[in] | radRange | The range in the radial dimension covered by this sphere. |
[in] | dim | The required size of the sampling grid. |
[in] | repAng | The angle represented by this sphere. |
[in] | sphNo | The number of this sphere in the spheres vector. |
[out] | X | Data object with all values set and ready to accept the rotation function values. |
Definition at line 648 of file ProSHADE_spheres.cpp.
ProSHADE_internal_spheres::ProSHADE_rotFun_sphere::~ProSHADE_rotFun_sphere | ( | void | ) |
Destructor for releasing memory from the ProSHADE_rotFun_sphere class.
[out] | X | N/A. |
Definition at line 671 of file ProSHADE_spheres.cpp.
void ProSHADE_internal_spheres::ProSHADE_rotFun_sphere::findAllPeaks | ( | proshade_signed | noSmNeighbours, |
std::vector< proshade_double > * | allHeights | ||
) |
Function for finding all peaks in the sampling grid.
This function takes the values on the sampling grid and does a naive peak search, saving the peak position into an internal variable.
[in] | noSmNeighbours | The number of surrounding peaks in any direction that need to be smaller for a value to be a peak. |
[in] | allHeights | A vector to which all detected non-peaks heights will be saved into. This will later be used to determine the threshold for "small" peaks. |
Definition at line 924 of file ProSHADE_spheres.cpp.
proshade_unsign ProSHADE_internal_spheres::ProSHADE_rotFun_sphere::getAngularDim | ( | void | ) |
Accessor function for the private variable angular dim.
[out] | radius | The dimension size of the angular sampling grid. |
Definition at line 705 of file ProSHADE_spheres.cpp.
proshade_double ProSHADE_internal_spheres::ProSHADE_rotFun_sphere::getMaxRadius | ( | void | ) |
Accessor function for the private variable maximum radius.
[out] | radius | The value of the maximum radius of this specific concentric shell. |
Definition at line 694 of file ProSHADE_spheres.cpp.
proshade_double ProSHADE_internal_spheres::ProSHADE_rotFun_sphere::getMinRadius | ( | void | ) |
Accessor function for the private variable minimal radius.
[out] | radius | The value of the minimal radius of this specific concentric shell. |
Definition at line 716 of file ProSHADE_spheres.cpp.
std::vector< std::pair< proshade_unsign, proshade_unsign > > ProSHADE_internal_spheres::ProSHADE_rotFun_sphere::getPeaks | ( | void | ) |
Accessor function for the private variable containing all detected peaks.
[out] | peaks | The vector containing all detected peaks. |
Definition at line 749 of file ProSHADE_spheres.cpp.
proshade_double ProSHADE_internal_spheres::ProSHADE_rotFun_sphere::getRadius | ( | void | ) |
Accessor function for the private variable radius.
[out] | radius | The value of the radius of this specific concentric shell. |
Definition at line 684 of file ProSHADE_spheres.cpp.
proshade_double ProSHADE_internal_spheres::ProSHADE_rotFun_sphere::getRepresentedAngle | ( | void | ) |
Accessor function for the private variable represented angle.
[out] | radius | The value of the angle represented by this sphere. |
Definition at line 727 of file ProSHADE_spheres.cpp.
proshade_double ProSHADE_internal_spheres::ProSHADE_rotFun_sphere::getSphereLatLonLinearInterpolationPos | ( | proshade_double | lattitude, |
proshade_double | longitude | ||
) |
Function for obtaining sphere values outside of the grid points.
This function computes linear interpolation value for any grid position of the sampling grid of this sphere.
[in] | lattitude | The lattitude index decimal place of the requested sampling grid position. |
[in] | longitude | The longitude index of the requested sampling grid position. |
[out] | radius | The value of the sampling grid position at given lattitude and longitude. |
Definition at line 878 of file ProSHADE_spheres.cpp.
proshade_double ProSHADE_internal_spheres::ProSHADE_rotFun_sphere::getSphereLatLonPosition | ( | proshade_unsign | lattitude, |
proshade_unsign | longitude | ||
) |
Accessor function for specific lattitude and longitude point of the sphere sampling grid.
[in] | lattitude | The lattitude index of the requested sampling grid point. |
[in] | longitude | The longitude index of the requested sampling grid point. |
[out] | radius | The value of the sampling grid point at given lattitude and longitude position. |
Definition at line 864 of file ProSHADE_spheres.cpp.
proshade_unsign ProSHADE_internal_spheres::ProSHADE_rotFun_sphere::getSphereNumber | ( | void | ) |
Accessor function for the private variable sphere number.
[out] | sphereNumber | The sphere number. |
Definition at line 738 of file ProSHADE_spheres.cpp.
void ProSHADE_internal_spheres::ProSHADE_rotFun_sphere::interpolateSphereValues | ( | proshade_complex * | rotFun | ) |
Function for interpolating the sphere grid values from angle-axis converted rotation function.
This function starts by converting each of the sphere sampling points lattitude and longitude to the XYZ position and by adding the represented rotation angle, obtains the angle-axis representation for the given point. It then proceeds to locate such points exact position in the indices space of the supplied rotation map. From there, it interpolates the exact correlation value for the given point, thus effectivelly re-sampling the rotation function space onto the sphere.
[in] | rotFun | proshade_complex pointer to the rotation function values. |
Definition at line 765 of file ProSHADE_spheres.cpp.
void ProSHADE_internal_spheres::ProSHADE_rotFun_sphere::removeSmallPeaks | ( | proshade_double | peakThres | ) |
Function for removing peaks with too small height.
This function takes the threshold for peaks being too small (computed from all peaks as returned by findAllPeaks() function, but could be any other value) and removes all peaks with height below this threshold.
[in] | peakThres | The height above which a peak needs to be in order not to be deleted. |
[in] | minThres | The minimum threshold that needs to be passed for a peak to be believed in. |
Definition at line 986 of file ProSHADE_spheres.cpp.