Xmipp  v3.23.11-Nereus
metadata_label.h
Go to the documentation of this file.
1 /***************************************************************************
2  *
3  * Authors: J.M. De la Rosa Trevin (jmdelarosa@cnb.csic.es)
4  * Jan Horacek (xhorace4@fi.muni.cz)
5  *
6  * Unidad de Bioinformatica of Centro Nacional de Biotecnologia , CSIC
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21  * 02111-1307 USA
22  *
23  * All comments concerning this program package may be sent to the
24  * e-mail address 'xmipp@cnb.csic.es'
25  ***************************************************************************/
26 
27 #ifndef CORE_METADATALABEL_H
28 #define CORE_METADATALABEL_H
29 
30 #include <map>
31 #include "xmipp_strings.h"
32 #include <vector>
33 
34 class MDLabelData;
35 class MDObject;
36 class MDLabelStaticInit;
37 
44 enum MDLabel
45 {
50 
78 
96 
99 
112 
121 
125 
126  MDL_CTF_DATA_PHASE_FLIPPED, // Is the Data Phase-Flippled?
127  MDL_CTF_CORRECTED, // Is the CTF corrected?
156  MDL_CTF_ENVELOPE, //<Envelope function
157  MDL_CTF_ENVELOPE_PLOT, //<Envelope function
205  MDL_CTF_DIMENSIONS, // Size in pixels of the 3D PSF to be created (Xdim, Ydim, Zdim)
209  MDL_CTF_XRAY_ZONES_NUMBER, // Number of zones of the X-ray Fresnel lens
210  MDL_CTF_PHASE_SHIFT, //Volta Phase Plate phase shift
211  MDL_CTF_VPP_RADIUS, //Phase Plate radius
217 
218 
228 
229  //End of labels
230 
232 
233  MDL_DATE,// < timestamp (string)
234  MDL_TIME,// < time in seconds (double)
235 
299 
304 
320  MDL_NOISE_COORD, //Use instead of MDL_NOISE_PARTICLE_COORD in future
326 
331 
340 
341  MDL_MACRO_CMD, //ImageJ macro command on picker
342  MDL_MACRO_CMD_ARGS, //ImageJ macro args on picker
353 
354  MDL_PRJ_DIMENSIONS, // X,Y dimensions for the generated projections
364  MDL_PRJ_TILT_RANGE, // Vector with the initial and final tilt angle values, and step size
365  MDL_PRJ_VOL, // Volume file name to generate projections from
366 
367  MDL_PROGRAM,// < program name
368  MDL_USER,// < user name
369 
370  MDL_DIMENSIONS_3D, // X,Y,Z dimensions
371  MDL_DIMENSIONS_2D, // X,Y dimensions
380 
381  MDL_RESIDUE, //<residue of an atomic model (int)
396 
402 
463 
464  MDL_TEST_SIZE,// < number of test assigned to a program
465  MDL_TILT_ANALYSIS_MEAN, // <Mean correlation between the PSD segments of a micrograph
466  MDL_TILT_ANALYSIS_STD, // <STD correlation between the PSD segments of a micrograph
467  MDL_TILT_ANALYSIS_MIN, // <Min correlation between the PSD segments of a micrograph
468  MDL_TILT_ANALYSIS_MAX, // <Max correlation between the PSD segments of a micrograph
469  MDL_TILT_ANALYSIS_PSDs, // <Image composed of the PSDs of each segment of a micrograph
470 
516 
520  RLN_COMMENT, // The RLN_COMMENT is handled specially as well
521 
546 
578 
580 
590 
598 
654 
738 
754 
768 
770 
774 
785 
807 
823 
830 
835 
937 
938  MDL_LAST_LABEL // **** NOTE ****: Do keep this label always at the end,it is here for looping purposes
939 };//close enum Label
940 
941 typedef std::vector<MDLabel> MDLabelVector;
942 
944 #define FOR_ALL_LABELS() for (int _label = MDL_FIRST_LABEL; _label < MDL_LAST_LABEL; ++_label)
945 
948 {
958 };
959 
962 {
972 };
973 
975 bool vectorContainsLabel(const std::vector<MDLabel>& labelsVector, const MDLabel label);
976 
977 //Just an struct to store type and string alias
979 {
980 public:
983  int tags;
984  //Default constructor
986  {
987  type = LABEL_NOTYPE;
988  tags=TAGLABEL_NOTAG;
989  }
990 
991  MDLabelData(MDLabelType t, const String &s, int tags)
992  {
993  type = t;
994  str = s;
995  this->tags=tags;
996  }
997 }
998 ;//close class MDLabelData
999 
1001 #ifndef __APPLE__
1002 template class std::vector<MDObject *>
1003 ;
1004 #endif
1005 
1006 #endif
object id (int), NOTE: This label is special and shouldn&#39;t be used
Logarithm of the structure factor.
scale y of continuous assignment
CTF Background parameter.
linear scale-factor
MDLabelTag
Z size (int)
CTF gain.
correlation of references assigned by two methods
contribution of an image to log-likelihood value
Feature vectors used to classify particles (vector double)
MDLabelType type
< Micrographs Gini Coeff. (double)
X shift of continuous assignment.
Name of Metadata file for all references(string)
The CTF is valid within (x0,y0) to (xF,yF) in the micrograph coordinates.
Name of the original micrograph, MDL_MICROGRAPH is probably a downsampled version of this one (std::s...
Particular neighbor (pointed myNEIGHBORS)
tsne coefficients in 2D
Rotation angle of an image (double,degrees)
< Score 2 for volumes
score by alignability (double)
Algorithm used to generate Xray PSF.
Current block number (for incremental EM)
Weight due to Alignability Precision and Accuracy.
Defocus U (Angstroms)
Name of the corresponding original, tilted micrograph (std::string)
weighted correlation value between a particle and its assigned projection taking into the difference ...
Tilting angle of an image (double,degrees)
CTF gain.
Shift for the image in the X axis (double)
Fourier shell correlation (double)
scale angle of continuous assignment
Fourier shell occupancy (double)
shift difference (double)
sampling rate in A/pixel (double)
Frequency in A of the local resolution of a residue (double)
Shift for the image in the Y axis (double)
CTF Background parameter.
Amplitude contrast.
Symmetry number for a projection (used in ART)
Defocus V (Angstroms)
sampling rate in A/pixel (double)
Cell location for crystals.
Weight due to Alignability Precision.
Feature vectors used to classify particles (vector double)
MDLabelType
sampling rate in A/pixel (double)
Weight due to angular jumping.
Name of a position file (std::string)
Image associated to this object (std::string)
Number which will multiply all features (double)
score by alignability experimental particles (double)
Defocus angle (degrees)
Functional value (double)
Microscope voltage (kV)
Longitudinal displacement.
difference between rot angles (double,degrees)
Feature vectors used to classify particles (vector double)
Initial tilt angle in X for missing region in subtomogram.
Index of an image within a list (size_t)
Correlation between the denoised image and the projection proposed.
Sum of elements of a given type (double) [this is a genereic type do not use to transfer information ...
< Type of randomness for Tilt (std::string)
score by alignability references (double)
Parameters file for the CTF Model (std::string)
Flip of continuous assignment.
Gctf-based validation score for CTF fit.
CTF Background parameter.
Defocus = A*x+B*y+C.
Defocus = A*x+B*y+C.
Name for the reconstructed tomogram volume (std::string)
Cost percentile for the image (double)
Z component (double)
Distance to graph filtered max.
BSpline coefficient in Y dim.
< Rotational angle dev and mean noise (vector double)
Maximum frequency (in Angstroms) at which non-astigmatic CTF correction is valid. ...
Signal change for an image.
Maximum value (double)
Resolution anisotropy used to store the significance of the Bingham Test (double) ...
Tilting angle of an image (double,degrees)
Particle size for particle picking.
Weight due correlation between two images/subtomos.
Number of automatic particles picked.
difference between two angles (double,degrees)
Initial tilt angle in Y for missing region in subtomogram.
Shift for the image in the X axis (double)
score by alignability (double)
First zero average (in Angstroms)
Tilt series id (std::string)
Convergence cone.
Z Score (double)
File for generated angles.
Tilting angle of an image (double,degrees)
Z Score (double)
Percentage of images assigned to the same class as this image.
CTF Background parameter.
Average change in offset (double pixels)
PSD correlation at 90 degrees.
Special label to be used when gathering MDs in MpiMetadataPrograms.
Feature vectors used to classify particles (vector double)
A shift amount at confidence level of 2.5%.
CTF Background parameter.
Name for the CTF Model (std::string)
difference in Shift along Y axis (double)
A collection of micrographs, e.g. a tilt serie (std::string)
if read from file original image datatype, this is an struct defined in image
Noise description for projected angles.
Defocus U (Angstroms)
Z Score (double)
Weight of t-student distribution in robust Maximum likelihood.
Chromatic aberration.
Lens stability.
Defocus = A*x+B*y+C.
<Bfactor of a map, or even a local bfactor
Store a score for the coords. consensus (it will change the behavoir of the viewer) ...
Defocus = A*x+B*y+C.
auxiliary label to be used as an index (long)
CTF Background parameter.
Maximum value observed for a given NMA mode.
Z Score (double)
The CTF is valid within (x0,y0) to (xF,yF) in the micrograph coordinates.
Sigma value (double)
NMA Atom shift in Angstroms.
Y shift of continuous assignment.
Coefficients of the defocus adjustment plane.
A Power Spectrum Density file name (std::string)
CTF Background parameter.
CTF Background parameter.
Weight assigned to the image accordint to its clusterability with a significance with respect noise (...
Spherical aberration.
Z Score (double)
Name of the tilted images associated to MDL_IMAGE.
correlation value between a particle and its assigned projection
CTF value.
Angle between y-axis and tilt-axis (double, degrees) for tilted micrographs.
when previous assignment validation
< Lattice vector for projection (vector double)
Is this image enabled? (int [-1 or 1])
differential phase residual (double)
Mean of the movement in y direction of the motion map> (double)
Unique identifier for items inside a list or set (std::size_t)
The density of the feature (double)
Microscope voltage (kV)
CTF Background parameter.
Correlation between the 1st and 3rd ring of the CTF.
Y size (int)
Defocus = A*x+B*y+C.
Shift for the image in the Z axis (double) for crystals.
Shift for the image in the Y axis (double)
Score corresponding to the mean of cc with cc>threshold.
Detector MTF value.
P-value (1-percentile) of the class size compared to a random distribution (double in [0...
Three values representing number of control points used for local alignment (X, Y, N)
Image associated to this object (std::string)
Store a second class (int)
CTF Background polynomial parameter.
Rotation angle of an image (double,degrees)
tsne coefficicient in 1D
Sampling rate in Z direction.
Centroid of a cluster for the KMEANS2D classification.
Minimum value (double)
Name for the area (or field of view). If one does not use (tilt) series, area would be the same as mi...
CTF Envelope polynomial parameter.
score by alignability references (double)
Score of the fitting.
Shift for the image in the Y axis (double) for crystals.
Weight due to Angular significance.
NMA Score of a given mode.
shift difference (double)
Name of an image from which MDL_IMAGE is coming from.
Number of elements of a type (int) [this is a genereic type do not use to transfer information to ano...
Shift for the image in the Z axis (double)
Score corresponding to the min of cc with cc>threshold.
noise if center of unit cell (vector double)
Micrograph state for particle picking.
Half map/image file name (string)
NMA Collectivity of a given mode.
CTF Envelope polynomial parameter.
MDLabelData(MDLabelType t, const String &s, int tags)
Two values representing number of patches used for local alignment (X, Y)
Name of an image (std::string)
difference between psi angles (double,degrees)
A shift amount at confidence level of 95.5%.
< Shift file for crystal projection
<Orthogonal projection or not (bool)
The label MDL_OBJID is special and should not be used.
CTF Envelope polynomial parameter.
Inelastic absorption.
Frequency in 1/A squared (double)
Integral of the radial PSD.
Standard deviation of the movement in y direction of the motion map> (double)
original sampling rate in A/pixel (double)
Weight due to angular jumping.
< Score corresponding to the sum of cc with cc>threshold
CTF Background parameter.
Deformation in voxels.
Defocus angle (degrees)
a value of continuous assignment
Minimum damping at border.
Origin for the image in the Y axis (double)
Longitudinal displacement.
Frequency in A (double)
Y component in tilted micrograph (int)
< Have a crystal projection (bool)
Unique id of frame inside a Movie.
group images by defocus
Defocus group.
Cost for the image (double)
NMA Eigenvalue of a given mode.
average defocus (Angtroms)
R2 coefficient of subtracted particle.
< Particle variance (double)
< Score 3 for volumes
Feature vectors used to classify particles (vector double)
Angle between y-axis and tilt-axis (double, degrees) for untilted micrographs.
State for particle picking.
Number of manual particles picked.
Convergence cone.
X component (int)
Flip the image? (bool)
Name for a Metadata file (std::string)
Name of a movie (std::string)
Normality test between histogram of micrography and gaussian distribution.
Size of data vectors for classification (int)
MLF signal (double)
< Number of non-redundant projections directions (size_t)
Unique identifier of a movie.
CTF Background parameter.
Phase-shift from a phase-plate (in degrees)
Number of changes between iterations.
Maximum value of normalized probability function (now called "Pmax/sumP") (double) ...
Number of elements of a type (int) [this is a genereic type do not use to transfer information to ano...
CTF Background parameter.
Image associated to this object (std::string)
Sum of all weights in ML model.
Outermost zone width of the X-ray Fresnel lens (nm)
Normal mode displacements (vector double)
Maximum frequency at which the envelope drops below 0.1 (in Angstroms)
Ratio sigma(firstMinimum)/sigma(firstZero)
CTF Background polynomial parameter.
Standard deviation of the noise in ML model.
Half map/image 1 file name (string)
Projection onto a reduced manifold (vector double)
Average change in class assignment(double dimensionaless)
Weight due phase correlation between two images/subtomos.
bool vectorContainsLabel(const std::vector< MDLabel > &labelsVector, const MDLabel label)
std::vector< MDLabel > MDLabelVector
Name of a residual image associated to this image.
Noise description for pixels&#39; gray level (when projecting)
Image associated to this object (std::string)
Intensity scale for an image.
Digital frequency at which the FRC drops below 0.5 (double)
Z Score (double)
Maximum cross-correlation for the image (double)
Micrograph unique id for reference (MDL_ITEM_ID should be used for Micrographs list) ...
Name of a mask associated to image.
Defocus coefficient of determination.
CTF Background parameter.
Model fraction (alpha_k) for a Maximum Likelihood model.
Number of missing region in subtomogram.
scaling factor for an image or volume (double)
Z Score of the mean of the residuals (double)
name of an image describing the CTF model
Name of a micrograph (std::string)
Phantom background density (double)
BSpline coefficient in X dim.
Maximum resolution with Thon rings.
Average cross-correlation for the image (double)
score by alignability experimental particles (double)
Type of the feature (Sphere, Blob, ...) (std::string)
Defocus = A*x+B*y+C.
< Psi angle dev and mean noise (vector double)
KS-test statistics.
Cumulative SSNR (double)
Image associated to this object (std::string)
First zero disagreement with second model (in Angstroms)
Psi angle of an image (double,degrees)
Runs test on the projection of the PSD on the first principal component.
CTF_ CTF Background parameter.
X component in tilted micrograph (int)
Standard deviation of the offsets in ML model.
Wavelength (nm)
Type of missing region in subtomogram.
Z component (int)
3D Class to which the image belongs (int)
Frequency in 1/A (double)
difference between two angles (double,degrees)
Particle unique identifier for reference. (The MDL_ITEM_ID should be used when particle list) ...
Weight due to SSNR.
Standatd deviation of the movement in x direction of the motion map> (double)
Correlation from previous alignment.
Name of the covariance imagee associated to this image.
Downsampling performed to estimate the CTF.
Keywords associated to this line, should be a single string block (do not use spaces as separators) ...
Pixel size for detector as used in CTF-determination.
Operation in case of overlapping features (+,-)
CTF Background parameter.
Specific parameters for a feature (vector double)
score by alignability noise (double)
A enhanced Power Spectrum Density file name (std::string)
Beta 0 coefficient of adjusted model for subtract particle.
Class to which the image belongs (int)
Center of the feature (vector double)
Difference between the observed defocus value and the estimated defocus value.
Variance in the first principal component of the PSDs.
Weight due to angular continuous assignment.
Magnification of microscope.
Vector of indexes to points some "neighbors".
Shift for the image in the X axis (double)
NMA energy contained in the NMA displacement vector.
ctffind3 FOM (CC) for quality of CTF-fit
b value of continuous assignment
X size (int)
Global Z Score (double)
Number of images assigned to the same class as this image.
< Lattice vector for projection (vector double)
Name of Metadata file for all images (string)
Small values represent worse particles. Much larger than 1 for good particles.
Name for another CTF model (std::string)
score by mirror (double)
Y component (double)
Mean of the movement in x direction of the motion map> (double)
ID for the area (or field of view). If one does not use (tilt) series, area would be the same as micr...
MLF CTF estimated value (double)
Iceness of the micrograph.
Error in l2 (double)
std::string String
Definition: xmipp_strings.h:34
Fourier shell correlation noise (double)
Percentile of the maximum cross-correlation for the image (double)
Deformation coefficients.
Name of the corresponding tilted micrograph (std::string)
Data vector for classification (vector double)
Rotation angle of an image (double,degrees)
transformation matrix in numpy string format or space separated (std::string)
Feature vectors used to classify particles (vector double)
Figure of Merit in 0-1 range (double)
Shift for the image in the Z axis (double)
Average change in angular orientation (double degrees)
X component (double)
Index within a list (size_t)
Final tilt angle in Y for missing region in subtomogram.
Angular temperature (double,degrees)
P-value (1-percentile) of the relative class size (size/max(original_classes)) compared to a random d...
CTF Background parameter.
difference between two angles (double,degrees)
Weight due to Mirror Precision.
< Type of randomness for Rotational (std::string)
Weight due to Alignability Accuracy.
< Score 1 for volumes
The CTF is valid within (x0,y0) to (xF,yF) in the micrograph coordinates.
scale x of continuous assignment
Correlation between the denoised image and the noisy version.
Apply shift when project the volume ,.
Regularization value (double)
Origin for the image in the Z axis (double)
average value (double)
difference between tilt angles (double,degrees)
Average intraclass distance (double)
Direction in 3D.
score by alignability (double)
Y component (int)
Defocus change with respect to previous defoucs (Angstroms)
Z Score of the stddev of the residuals (double)
Final tilt angle in X for missing region in subtomogram.
Ratio sigma(firstMinimum-firstZero)/sigma(firstZero)
CTF Background polynomial parameter.
Mirror fraction for a Maximum Likelihood model.
when previous assignment validation
Weight due to angular jumping.
Minimum value observed for a given NMA mode.
Shift for the image in the Y axis (double)
Radius of the neighborhood (radians)
Shift for the image in the Z axis (double)
Z Score of the covariance matrix of the residuals (double)
< Disappearing threshold (double)
Transversal displacemente.
shift difference (double)
< Psi angle range (vector double)
Current iteration number (int)
Spherical aberration.
< Tilt angle dev and mean noise (vector double)
Defocus V (Angstroms)
Chromatic aberration.
Transversal displacemente.
MLF Wiener filter (double)
Correlation between assigned direction and graph filtered maximum.
File with an NMA mode.
Psi angle of an image (double,degrees)
Name of an image (std::string)
Lens stability.
Magnification used for CTF-determination.
MDLabel
< Type of randomness for Psi (std::string)
Name of of the class image from which MDL_IMAGE is coming from.
Number of templates.
Color for particle picking.
Feature vectors used to classify particles (vector double)
MLF Wiener filter (double)
Beta 1 coefficient of adjusted model for subtract particle.
< Score 4 for volumes
Cell location for crystals.
imed value between a particle and its assigned projection
Fourier shell correlation (double)
masked correlation value between a particle and its assigned projection inside the region with pixel ...
The CTF is valid within (x0,y0) to (xF,yF) in the micrograph coordinates.
Dose e/A^2 (double)
Serve to make annotations on the metadata row.
Differential Phase Residual evaluated at FRC=0.5.
difference in Shift along X axis (double)
A comment for this object /*** NOTE THIS IS A SPECIAL CASE AND SO IS TREATED ***/.
CTF Background parameter.
Seed for random number generator.
Noise description for particle&#39;s center coordenates (when projecting)