#include <phantom.h>

Inheritance diagram for Ellipsoid:

Collaboration diagram for Ellipsoid:

Public Member Functions
void	prepare ()

void	assign (const Ellipsoid &F)

int	point_inside (const Matrix1D< double > &r, Matrix1D< double > &aux) const

double	density_inside (const Matrix1D< double > &r, Matrix1D< double > &aux) const

Feature *	scale (double factor) const

	__attribute__ ((deprecated)) void scale(double factor

double	intersection (const Matrix1D< double > &direction, const Matrix1D< double > &passing_point, Matrix1D< double > &r, Matrix1D< double > &u) const

double	volume () const

void	read_specific (char *line)

void	read_specific (const std::vector< double > &vect)

void	feat_printf (FILE *fh) const

void	feat_printm (MetaData &MD, size_t id)

void	init_rnd (double minXradius, double maxXradius, double minYradius, double maxYradius, double minZradius, double maxZradius, double minden=1.0, double maxden=1.0, double minx0=0, double maxx0=0, double miny0=0, double maxy0=0, double minz0=0, double maxz0=0, double minrot=0, double maxrot=360, double mintilt=0, double maxtilt=180, double minpsi=0, double maxpsi=360)

Public Member Functions inherited from Oriented_Feature
void	prepare_Euler ()

void	assign (const Oriented_Feature &OF)

virtual void	rotate (const Matrix2D< double > &E)

Public Member Functions inherited from Feature
void	assign (const Feature &F)

virtual void	rotate_center (const Matrix2D< double > &E)

int	point_inside (const Matrix1D< double > &r) const

int	voxel_inside (const Matrix1D< double > &r, Matrix1D< double > &aux1, Matrix1D< double > &aux2) const

int	voxel_inside (const Matrix1D< double > &r) const

double	voxel_inside_by_normalized_density (const Matrix1D< double > &r, Matrix1D< double > &aux1, Matrix1D< double > &aux2) const

int	intersects_sphere (const Matrix1D< double > &r, double radius, Matrix1D< double > &aux1, Matrix1D< double > &aux2, Matrix1D< double > &aux3) const

int	intersects_sphere (const Matrix1D< double > &r, double radius) const

Feature *	encircle (double radius=0) const

Feature *	background (int back_mode, double back_param) const

double	intersection (const Matrix1D< double > &direction, const Matrix1D< double > &passing_point) const

void	mean_variance_in_plane (Image< double > *V, double z, double &mean, double &var)

void	project_to (Projection &P, const Matrix2D< double > &VP, const Matrix2D< double > &PV) const

void	corners (const MultidimArray< double > &V, Matrix1D< double > &corner1, Matrix1D< double > &corner2)

void	draw_in (MultidimArray< double > &V, int color_mode=INTERNAL, double colour=-1)

void	sketch_in (MultidimArray< double > &V, double colour=2)

void	shift (double shiftX, double shiftY, double shiftZ)

void	selfApplyGeometry (const Matrix2D< double > &A)

void	readCommon (char *line)

void	readCommon (MDRow &row)

void	read (MDRow &row)

Public Attributes
double	xradius
	X radius before rotating. More...

double	yradius
	Y radius before rotating. More...

double	zradius
	Z radius before rotating. More...

Feature **_f	const

Public Attributes inherited from Oriented_Feature
double	rot
	First Euler angle. More...

double	tilt
	Second Euler angle. More...

double	psi
	Third Euler angle. More...

Matrix2D< double >	euler
	Euler matrix. More...

Matrix2D< double >	eulert
	Inverse Euler matrix. More...

Public Attributes inherited from Feature
std::string	type

char	add_assign

double	density

Matrix1D< double >	center

double	max_distance

Friends
std::ostream &	operator<< (std::ostream &o, const Ellipsoid &f)

Detailed Description

Ellipsoid. An elliposid is defined by its center, and the radius in the 3 dimensions (X, Y and Z, before rotating), label="ell". The center of the ellipsoid is at the geometrical center, and the dimensions define the elliposid from "-Xradius/2" to "Xradius/2", ... around the center. Then the ellipsoid is rotated after the three Euler angles. The corresponding Euler matrix is stored in the field "euler" while its inverse is in "eulert".

A point (r) in the universal coordinate system, where elliposids are defined in general, can be expressed (rp) with respect to a system where the ellipsoid is centered at the origin, all its radii are unity and its axes are aligned with XYZ by

V3_MINUS_V3(rp,r,ell.Center);
M3x3_BY_V3x1(rp,ell.euler,rp);
XX(rp) /= ell.xradius;
YY(rp) /= ell.yradius;
ZZ(rp) /= ell.zradius;

Directions (free vectors) are transformed in the same fashion except that for the first vector subtraction (referring the origin).

Definition at line 1127 of file phantom.h.

Member Function Documentation

◆ attribute()

Ellipsoid::__attribute__ ( (deprecated) )

Another function for return a scaled elliposoid.

◆ assign()

void Ellipsoid::assign ( const Ellipsoid & F )

Another function for assignment.

Definition at line 138 of file phantom.cpp.

 {
     *this = F;
 }

◆ density_inside()

double Ellipsoid::density_inside	(	const Matrix1D< double > &	r,
		Matrix1D< double > &	aux
	)		const

inlinevirtual

Density inside a Ellipsoid. This function tells you the density of the ellipsoid at point r for constant valued features is trivial

Implements Feature.

Definition at line 1156 of file phantom.h.

     {
         return 1.;
     }

◆ feat_printf()

void Ellipsoid::feat_printf ( FILE * fh ) const

virtual

Print ellipsoid in the standard feature format. \ See {Feature::feat_printf}, Phantoms

Implements Feature.

Definition at line 523 of file phantom.cpp.

 {
     fprintf(fh, "ell    %c     %1.4f    % 7.2f   % 7.2f    % 7.2f    % 7.2f    "
             "% 7.2f    % 7.2f    % 7.2f    % 7.2f   % 7.2f\n",
             add_assign, density, XX(center), YY(center), ZZ(center),
             xradius, yradius, zradius,
             rot, tilt, psi);
 }

◆ feat_printm()

void Ellipsoid::feat_printm	(	MetaData &	MD,
		size_t	id
	)

virtual

Implements Feature.

Definition at line 533 of file phantom.cpp.

 {
     std::vector<double> FSVect;
     FSVect.push_back(xradius);
     FSVect.push_back(yradius);
     FSVect.push_back(zradius);
     FSVect.push_back(rot);
     FSVect.push_back(tilt);
     FSVect.push_back(psi);
     MD.setValue(MDL_PHANTOM_FEATURE_SPECIFIC,FSVect,id);
 }

◆ init_rnd()

void Ellipsoid::init_rnd	(	double	minXradius,
		double	maxXradius,
		double	minYradius,
		double	maxYradius,
		double	minZradius,
		double	maxZradius,
		double	minden = `1.0`,
		double	maxden = `1.0`,
		double	minx0 = `0`,
		double	maxx0 = `0`,
		double	miny0 = `0`,
		double	maxy0 = `0`,
		double	minz0 = `0`,
		double	maxz0 = `0`,
		double	minrot = `0`,
		double	maxrot = `360`,
		double	mintilt = `0`,
		double	maxtilt = `180`,
		double	minpsi = `0`,
		double	maxpsi = `360`
	)

Generate a random ellipsoid. An ellipsoid is generated randomly within the range of the parameters given. Notice that most of them are set by default. The exact parameters are picked uniformly from the range. The maximum distance is adjusted properly according to the randomly generated feature. 'den' stands for density and (x0,y0,z0) is the center of the feature. The behaviour of the new sphere is always Add.

Definition at line 1854 of file phantom.cpp.

 {
     randomize_random_generator();
     center.resize(3);
     type           = "ell";
     add_assign     = '+';
     density        = rnd_unif(minden, maxden);
     XX(center)     = rnd_unif(minx0, maxx0);
     YY(center)     = rnd_unif(miny0, maxy0);
     ZZ(center)     = rnd_unif(minz0, maxz0);
 
     if (minYradius == 0)
         minYradius = minXradius;
     if (minZradius == 0)
         minZradius = minXradius;
     if (maxYradius == 0)
         maxYradius = maxXradius;
     if (maxZradius == 0)
         maxZradius = maxXradius;
     xradius        = rnd_unif(minXradius, maxXradius);
     yradius        = rnd_unif(minYradius, maxYradius);
     zradius        = rnd_unif(minZradius, maxZradius);
     rot            = rnd_unif(minrot, maxrot);
     tilt           = rnd_unif(mintilt, maxtilt);
     psi            = rnd_unif(minpsi, maxpsi);
     Euler_angles2matrix(rot, tilt, psi, euler);
     eulert = euler.transpose();
 
     max_distance   = XMIPP_MAX(XMIPP_MAX(xradius, yradius), zradius);
 }

◆ intersection()

double Ellipsoid::intersection	(	const Matrix1D< double > &	direction,
		const Matrix1D< double > &	passing_point,
		Matrix1D< double > &	r,
		Matrix1D< double > &	u
	)		const

virtual

Intersection of a ray with an ellipsoid. See Feature::intersection to know more about the parameters meaning.

Implements Feature.

Definition at line 1250 of file phantom.cpp.

 {
     double norm = direction.module();
     SPEED_UP_temps012;
 
     // Set the passing point in the ellipsoid coordinate system
     // and normalise to a unit sphere
     V3_MINUS_V3(r, passing_point, center);
     M3x3_BY_V3x1(r, euler, r);
     XX(r) /= xradius;
     YY(r) /= yradius;
     ZZ(r) /= zradius;
 
     // Express also the direction in the ellipsoid coordinate system
     // and normalise to a unit sphere
     M3x3_BY_V3x1(u, euler, direction);
     XX(u) /= xradius;
     YY(u) /= yradius;
     ZZ(u) /= zradius;
 
     return intersection_unit_sphere(u, r) / norm;
 }

◆ point_inside()

int Ellipsoid::point_inside	(	const Matrix1D< double > &	r,
		Matrix1D< double > &	aux
	)		const

virtual

Speeded up point inside an ellipsoid. This function tells you if a point is inside the elliposoid or not. See Feature::point_inside

Implements Feature.

Definition at line 794 of file phantom.cpp.

 {
     SPEED_UP_temps012;
     double tx;
     double ty;
     double tz;
 
     // Express r in the feature coord. system
     V3_MINUS_V3(aux, r, center);
     M3x3_BY_V3x1(aux, euler, aux);
 
     // Check if inside
     tx = XX(aux) / xradius;
     ty = YY(aux) / yradius;
     tz = ZZ(aux) / zradius;
     if (tx*tx + ty*ty + tz*tz <= 1.0)
         return 1;
     return 0;
 }

◆ prepare()

void Ellipsoid::prepare ( )

virtual

Prepare ellipsoid for work. Computes the maximum distance, in this case, equal to "MAX(MAX(xradius,yradius),zradius)", and computes the Euler and inverse Euler matrices as a function of the Euler angles

Implements Feature.

Definition at line 77 of file phantom.cpp.

 {
     prepare_Euler();
     max_distance = XMIPP_MAX(XMIPP_MAX(xradius, yradius), zradius);
 }

◆ read_specific() [1/2]

void Ellipsoid::read_specific ( char * line )

Read specific description for an ellipsoid. An exception is thrown if the line doesn't conform the standard specification. See Feature::read_specific

Definition at line 357 of file phantom.cpp.

 {
     int stat;
     stat = sscanf(line, "%*s %*c %*f %*f %*f %*f %lf %lf %lf %lf %lf %lf",
                   &xradius, &yradius, &zradius, &rot, &tilt, &psi);
     if (stat != 6)
         REPORT_ERROR(ERR_IO_NOREAD, (std::string)"Error when reading an ellipsoid" + line);
     prepare();
 }

◆ read_specific() [2/2]

void Ellipsoid::read_specific ( const std::vector< double > & vector )

virtual

Read a feature from a file, VIRTUAL!!!. The format must be the one given in Phantoms, and each subclass must implement its own I/O routines. These routines must fill only the non common part of the feature description, but they receive the whole line with the description.

Implements Feature.

Definition at line 368 of file phantom.cpp.

 {
     if (vect.size() != 6)
         REPORT_ERROR(ERR_IO_NOREAD, (std::string)"Error when reading a ellipsoid");
     xradius = vect[0];
     yradius = vect[1];
     zradius = vect[2];
     rot = vect[3];
     tilt = vect[4];
     psi =  vect[5];
     prepare();
 }

◆ scale()

void Ellipsoid::scale ( double factor ) const

virtual

Return a scaled elliposoid. The center, density, angles and behaviour of the new ellipsoid is exactly the same as the actual one. The dimensions are multiplied by the scale factor and the maximum distance is recalculated for the new ellipsoid.

Implements Feature.

Definition at line 1599 of file phantom.cpp.

 {
     Ellipsoid *f;
     f = new Ellipsoid;
     COPY_COMMON_PART;
     COPY_ANGLES;
 
     f->xradius      = factor * xradius;
     f->yradius      = factor * yradius;
     f->zradius      = factor * zradius;
     f->prepare();
     return (Feature *)f;
 }

◆ volume()

double Ellipsoid::volume ( ) const

inlinevirtual

Volume of an ellipsoid. This function returns 4/3*PI*xradius*yradius*zradius. See Feature::volume

Implements Feature.

Definition at line 1180 of file phantom.h.

     {
         return 4 / 3*PI*xradius*yradius*zradius;
     }

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	o,
		const Ellipsoid &	f
	)

friend

Show feature not in the standard format but more informatively. This function only shows the non common part of the feature. Use the << operator of Feature to show the whole feature.

Definition at line 658 of file phantom.cpp.

 {
     o << "   Xradius: " << f.xradius << std::endl;
     o << "   Yradius: " << f.yradius << std::endl;
     o << "   Zradius: " << f.zradius << std::endl;
     o << "   Rot:     " << f.rot << std::endl;
     o << "   Tilt:    " << f.tilt << std::endl;
     o << "   Psi:     " << f.psi << std::endl;
     return o;
 }

Member Data Documentation

◆ const

Feature** _f Ellipsoid::const

Definition at line 1168 of file phantom.h.

◆ xradius

double Ellipsoid::xradius

X radius before rotating.

Definition at line 1131 of file phantom.h.

◆ yradius

double Ellipsoid::yradius

Y radius before rotating.

Definition at line 1134 of file phantom.h.

◆ zradius

double Ellipsoid::zradius

Z radius before rotating.

Definition at line 1137 of file phantom.h.

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

xmipp/libraries/data/phantom.h
xmipp/libraries/data/phantom.cpp

Public Member Functions

Public Attributes

Friends

Detailed Description

Member Function Documentation

◆ __attribute__()

◆ assign()

◆ density_inside()

◆ feat_printf()

◆ feat_printm()

◆ init_rnd()

◆ intersection()

◆ point_inside()

◆ prepare()

◆ read_specific() [1/2]

◆ read_specific() [2/2]

◆ scale()

◆ volume()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ const

◆ xradius

◆ yradius

◆ zradius

◆ attribute()