getFlag

Класс: BioMap

Извлечение флагов последовательности чтения из BioMap объект

Синтаксис

Flag = getFlag(BioObj)
Flag = getFlag(BioObj, Subset)

Описание

Flag = getFlag(BioObj) возвращает Flagвектор неотрицательных целых чисел, указывающий битовую информацию, которая задает состояние 11 флагов, описанных спецификацией формата SAM. Каждое целое число соответствует одной последовательности считывания из a BioMap объект.

Flag = getFlag(BioObj, Subset) возвращает целые числа флагов только для элементов объекта, заданных Subset.

Входные параметры

BioObj

Объект BioMap класс.

Subset

Одно из следующих для задания подмножества элементов в BioObj:

  • Вектор положительных целых чисел

  • Логический вектор

  • Массив ячеек из символьных векторов или строкового вектора, содержащий допустимые заголовки последовательностей

Примечание

Если для задания используется массив ячеек с заголовками Subsetследует иметь в виду, что повторяющийся заголовок задает все элементы с этим заголовком.

Выходные аргументы

Flag

Вектор неотрицательных целых чисел. Каждое целое число соответствует одной последовательности считывания и указывает битовую информацию, которая определяет состояние 11 флагов, описанных спецификацией формата SAM. Эти флаги описывают различные аспекты секвенирования и выравнивания последовательности чтения. Flag включает целые числа флагов только для считанных последовательностей, заданных Subset.

Примеры

Создайте a BioMap и затем извлеките значения флага SAM для различных элементов объекта:

% Construct a BioMap object from a SAM file 
BMObj1 = BioMap('ex1.sam');
% Retrieve integer specifying bit-wise information for 11
% SAM flags of the second element
flagValue = getFlag(BMObj1, 2)
flagValue =

     73
% Retrieve integers specifying bit-wise information for 11
% SAM flags of the first and third elements
flagValues = getFlag(BMObj1, [1 3])
flagValues =

     73
    137
% Retrieve integers specifying bit-wise information for 11
% SAM flags of all elements
allFlagValues = getFlag(BMObj1);
% Determine the status of the fourth flag (mate is unmapped)
% for the second element, which has a flag value of 73
bitget(73, 4)
ans =

     1

Совет

После использования getFlag метод, чтобы вернуть целое число, указывающее битовую информацию для флагов SAM, используйте bitget функция для определения статуса определенного флага SAM. Для получения дополнительной информации см. Примеры.

Альтернативы

Альтернатива использованию getFlag метод состоит в том, чтобы использовать индексацию через точку с Flag свойство:

BioObj.Flag(Indices)

В предыдущем синтаксисе Indices - вектор положительных целых чисел или логический вектор. Indices не может быть массивом ячеек из векторов символов или строковым вектором, содержащим заголовки последовательностей.