MDL Class Reference

#include <metadata_static.h>

Static Public Member Functions
static void	addLabelAlias (MDLabel label, const String &alias, bool replace=false, MDLabelType type=LABEL_NOTYPE)
static MDLabel	getNewAlias (const String &alias, MDLabelType type=LABEL_NOTYPE)
static void	resetBufferIndex ()
static MDRowSql	emptyHeaderSql ()
static MDRowVec	emptyHeaderVec ()
static void	emptifyHeader (MDRow &)
String conversions
static void	str2LabelVector (const String &labelsStr, std::vector< MDLabel > &labels)
static MDLabel	str2Label (const String &labelName)
static String	label2Str (const MDLabel &label)
static String	label2StrSql (const MDLabel label)
static String	label2SqlColumn (const MDLabel label)
static String	labelType2Str (MDLabelType type)
Type checks
Several label type checks
static bool	isInt (const MDLabel label)
static bool	isLong (const MDLabel label)
static bool	isBool (const MDLabel label)
static bool	isString (const MDLabel label)
static bool	isDouble (const MDLabel label)
static bool	isVector (const MDLabel label)
static bool	isVectorLong (const MDLabel label)
static bool	isValidLabel (const MDLabel &label)
static bool	isValidLabel (const String &labelName)
static MDLabelType	labelType (const MDLabel label)
static MDLabelType	labelType (const String &labelName)
static bool	hasTag (const MDLabel label, const int tags)
static bool	isTextFile (const MDLabel label)
static bool	isMetadata (const MDLabel label)
static bool	isCtfParam (const MDLabel label)
static bool	isImage (const MDLabel label)
static bool	isVolume (const MDLabel label)
static bool	isStack (const MDLabel label)
static bool	isMicrograph (const MDLabel label)
static bool	isPSD (const MDLabel label)
static std::map< String, MDLabel > &	getLabelDict ()

Friends
class	MDLabelStaticInit

Detailed Description

Static class to group some functions with labels. This class holds several function to work with labels. Also performs the static initialization of the labels data.

Definition at line 37 of file metadata_static.h.

Member Function Documentation

addLabelAlias()

void MDL::addLabelAlias ( MDLabel  label, const String &  alias, bool  replace = false, MDLabelType  type = LABEL_NOTYPE  )

static

Add an alias for an existing label. Params: label: The label id to create the alias to alias: The new alternative string name (alias) replace: If true, then new alias name will be used as the label string for writing back to file type: if provided, the label type will be replaced (only used with replace=True)

NOTE: Be aware that this function is not thread safe, so do not use it concurrently from different threads.

Definition at line 90 of file metadata_static.cpp.

{
    names[alias] = label;
    if (replace)
    {
        data[label]->str = alias;
        if (type != LABEL_NOTYPE)
            data[label]->type = type;
    }
}

emptifyHeader()

void MDL::emptifyHeader ( MDRow &  row )

static

Definition at line 321 of file metadata_static.cpp.

                                  {
    row.resetGeo();
    row.setValue(MDL_ANGLE_ROT, 0.);
    row.setValue(MDL_ANGLE_TILT,0.);
}

emptyHeaderSql()

MDRowSql MDL::emptyHeaderSql ( )

static

Definition at line 305 of file metadata_static.cpp.

                             {
    MDRowSql row;
    row.resetGeo();
    row.setValue(MDL_ANGLE_ROT, 0.);
    row.setValue(MDL_ANGLE_TILT,0.);
    return row;
}

emptyHeaderVec()

MDRowVec MDL::emptyHeaderVec ( )

static

Definition at line 313 of file metadata_static.cpp.

                             {
    MDRowVec row;
    row.resetGeo();
    row.setValue(MDL_ANGLE_ROT, 0.);
    row.setValue(MDL_ANGLE_TILT,0.);
    return row;
}

getLabelDict()

std::map< String, MDLabel > & MDL::getLabelDict ( )

static

Definition at line 260 of file metadata_static.cpp.

{
    return names;
}

getNewAlias()

MDLabel MDL::getNewAlias ( const String &  alias, MDLabelType  type = LABEL_NOTYPE  )

static

Get an alias of an available BUFFER label with the provided name. Params: alias: The name to create the alias from BUFFER label type: if provided, the label type will be replaced

Definition at line 102 of file metadata_static.cpp.

{
    MDLabel newLabel = MDL::bufferIndex;

    if (newLabel == MDL_LAST_LABEL)
        REPORT_ERROR(ERR_ARG_INCORRECT, "Not more buffer labels to use!!!");

    addLabelAlias(newLabel, alias, true, type);
    MDL::bufferIndex = (MDLabel)((int)newLabel + 1);

    return newLabel;
}

hasTag()

bool MDL::hasTag ( const MDLabel  label, const int  tags  )

static

Definition at line 265 of file metadata_static.cpp.

{
    return data[label]->tags & tags;
}

isBool()

bool MDL::isBool ( const MDLabel  label )

static

Definition at line 213 of file metadata_static.cpp.

{
    return (data[label]->type == LABEL_BOOL);
}

isCtfParam()

bool MDL::isCtfParam ( const MDLabel  label )

static

Definition at line 280 of file metadata_static.cpp.

{
    return data[label]->tags & TAGLABEL_CTFPARAM;
}

isDouble()

bool MDL::isDouble ( const MDLabel  label )

static

Definition at line 223 of file metadata_static.cpp.

{
    return (data[label]->type == LABEL_DOUBLE);
}

isImage()

bool MDL::isImage ( const MDLabel  label )

static

Definition at line 285 of file metadata_static.cpp.

{
    return data[label]->tags & TAGLABEL_IMAGE;
}

isInt()

bool MDL::isInt ( const MDLabel  label )

static

Definition at line 203 of file metadata_static.cpp.

{
    return (data[label]->type == LABEL_INT);
}

isLong()

bool MDL::isLong ( const MDLabel  label )

static

Definition at line 208 of file metadata_static.cpp.

{
    return (data[label]->type == LABEL_SIZET);
}

isMetadata()

bool MDL::isMetadata ( const MDLabel  label )

static

Definition at line 275 of file metadata_static.cpp.

{
    return data[label]->tags & TAGLABEL_METADATA;
}

isMicrograph()

bool MDL::isMicrograph ( const MDLabel  label )

static

Definition at line 295 of file metadata_static.cpp.

{
    return data[label]->tags & TAGLABEL_MICROGRAPH;
}

isPSD()

bool MDL::isPSD ( const MDLabel  label )

static

Definition at line 300 of file metadata_static.cpp.

{
    return data[label]->tags & TAGLABEL_PSD;
}

isStack()

bool MDL::isStack ( const MDLabel  label )

static

Definition at line 290 of file metadata_static.cpp.

{
    return data[label]->tags & TAGLABEL_STACK;
}

isString()

bool MDL::isString ( const MDLabel  label )

static

Definition at line 218 of file metadata_static.cpp.

{
    return (data[label]->type == LABEL_STRING);
}

isTextFile()

bool MDL::isTextFile ( const MDLabel  label )

static

Definition at line 270 of file metadata_static.cpp.

{
    return data[label]->tags & TAGLABEL_TEXTFILE;
}

isValidLabel() [1/2]

bool MDL::isValidLabel ( const MDLabel &  label )

static

Definition at line 238 of file metadata_static.cpp.

{
    return label > MDL_UNDEFINED &&
           label < MDL_LAST_LABEL &&
           data[label] != NULL;
}

isValidLabel() [2/2]

bool MDL::isValidLabel ( const String &  labelName )

static

Definition at line 245 of file metadata_static.cpp.

{
    return isValidLabel(str2Label(labelName));
}

isVector()

bool MDL::isVector ( const MDLabel  label )

static

Definition at line 228 of file metadata_static.cpp.

{
    return (data[label]->type == LABEL_VECTOR_DOUBLE);
}

isVectorLong()

bool MDL::isVectorLong ( const MDLabel  label )

static

Definition at line 233 of file metadata_static.cpp.

{
    return (data[label]->type == LABEL_VECTOR_SIZET);
}

isVolume()

static bool MDL::isVolume ( const MDLabel  label )

static

label2SqlColumn()

String MDL::label2SqlColumn ( const MDLabel  label )

static

Converts MDLabel to string representing SQL column

Definition at line 150 of file metadata_static.cpp.

{
    std::stringstream ss;
    ss << MDL::label2StrSql(label) << " ";

    switch (MDL::labelType(label))
    {
    case LABEL_BOOL: //bools are int in sqlite3
    case LABEL_INT:
    case LABEL_SIZET:
        ss << "INTEGER";
        break;
    case LABEL_DOUBLE:
        ss << "REAL";
        break;
    case LABEL_STRING:
        ss << "TEXT";
        break;
    case LABEL_VECTOR_DOUBLE:
    case LABEL_VECTOR_SIZET:
        ss << "TEXT";
        break;
    case LABEL_NOTYPE:
        ss << "NO_TYPE";
        break;
    }
    return ss.str();
}

label2Str()

String MDL::label2Str ( const MDLabel &  label )

static

Converts MDLabel to string

Definition at line 139 of file metadata_static.cpp.

{
    return (isValidLabel(label)) ? data[(int)label]->str : "";
}

label2StrSql()

String MDL::label2StrSql ( const MDLabel  label )

static

Same as label2Str but escaping with '' to use in Sqlite.

Definition at line 144 of file metadata_static.cpp.

{
  String labelSqlite = "\"" + label2Str(label) + "\"";
  return labelSqlite;
}

labelType() [1/2]

MDLabelType MDL::labelType ( const MDLabel  label )

static

Definition at line 250 of file metadata_static.cpp.

{
    return data[label]->type;
}

labelType() [2/2]

MDLabelType MDL::labelType ( const String &  labelName )

static

Definition at line 255 of file metadata_static.cpp.

{
    return data[str2Label(labelName)]->type;
}

labelType2Str()

String MDL::labelType2Str ( MDLabelType  type )

static

Return the type of the label as String

Definition at line 179 of file metadata_static.cpp.

{
    switch (type)
    {
    case LABEL_STRING:
        return "STRING";
    case LABEL_DOUBLE:
        return "DOUBLE";
    case LABEL_INT:
        return "INT";
    case LABEL_BOOL:
        return "BOOL";
    case LABEL_VECTOR_DOUBLE:
        return "VECTOR(DOUBLE)";
    case LABEL_SIZET:
        return "SIZE_T";
    case LABEL_VECTOR_SIZET:
        return "VECTOR(SIZE_T)";
    case LABEL_NOTYPE:
        return "NO_TYPE";
    }
    return "UNKNOWN";
}

resetBufferIndex()

void MDL::resetBufferIndex ( )

static

Reset the counter of buffer labels. Use this function with care, since when you change the alias, the existing metadata could change and write wrong values to file.

Definition at line 115 of file metadata_static.cpp.

{
    MDL::bufferIndex = BUFFER_01;
}

str2Label()

MDLabel MDL::str2Label ( const String &  labelName )

static

Definition at line 132 of file metadata_static.cpp.

{
    if (names.find(labelName) == names.end())
        return MDL_UNDEFINED;
    return names[labelName];
}

str2LabelVector()

void MDL::str2LabelVector ( const String &  labelsStr, std::vector< MDLabel > &  labels  )

static

Converts an string to MDLabel

Definition at line 120 of file metadata_static.cpp.

{
    labels.clear();
    StringVector parts;
    splitString(labelsStr, " ", parts);
    for (size_t i = 0; i < parts.size(); ++i)
        if (MDL::isValidLabel(parts[i]))
            labels.push_back(MDL::str2Label(parts[i]));
        else
            REPORT_ERROR(ERR_PARAM_INCORRECT, formatString("Unknown label '%s' received.", parts[i].c_str()));
}

Friends And Related Function Documentation

MDLabelStaticInit

friend class MDLabelStaticInit

friend

Definition at line 126 of file metadata_static.h.

---

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

• xmippCore/core/metadata_static.h
• xmippCore/core/metadata_static.cpp