TranslationFrames - SeqAn API Documentation

# Enum TranslationFrames
Class Enum with frames for translate()

Defined in | <seqan/translation.h>
Signature | `enum class TranslationFrames : uint8_t { ... };`

## Enum Values

`SINGLE_FRAME = 0` | Translate the sequence(s) "as is", n input sequences result in n output sequences.
`WITH_REVERSE_COMPLEMENT = 1` | Translate the sequence(s) as well as their reverse complements (n -> * 2n).
`WITH_FRAME_SHIFTS = 2` | Translate the sequence(s) as well as their shifted frames (n -> 3n).
`SIX_FRAME = 3` | Equals (WITH_REVERSE_COMPLEMENT | WITH_FRAME_SHIFTS); shifted frames of original and reverse complement are translated (n -> 6n).

## Detailed Description

Please not that this is part of the translation module which requires C++11.

#### Dox Sources

    /*!
     * @enum TranslationFrames
     *
     * @headerfile <seqan/translation.h>
     *
     * @brief Class Enum with frames for @link translate @endlink()
     *
     * @signature enum class TranslationFrames : uint8_t { ... };
     *
     * Please not that this is part of the translation module which requires C++11.
     *
     * @val TranslationFrames SINGLE_FRAME = 0;
     *
     * @brief Translate the sequence(s) "as is", n input sequences result in n
     *        output sequences.
     *
     * @val TranslationFrames WITH_REVERSE_COMPLEMENT = 1;
     *
     * @brief Translate the sequence(s) as well as their reverse complements (n -> *
     *        2n).
     *
     * @val TranslationFrames WITH_FRAME_SHIFTS = 2;
     *
     * @brief Translate the sequence(s) as well as their shifted frames (n -> 3n).
     *
     * @val TranslationFrames SIX_FRAME = 3;
     *
     * @brief Equals (WITH_REVERSE_COMPLEMENT | WITH_FRAME_SHIFTS); shifted frames
     *        of original and reverse complement are translated (n -> 6n).
     */