getFlag

Класс: BioMap

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

Синтаксис

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

Описание

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

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

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

BioObj

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

Subset

Одно из следующих, чтобы задать подмножество элементов в BioObj:

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

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

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

Примечание

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

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

Flag

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

Примеры

Создайте объект 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 не может быть массивом ячеек из символьных векторов или представить в виде строки вектор, содержащий заголовки последовательности.