bitmap.hpp

Go to the documentation of this file.

#ifndef GENESIS_SEQUENCE_PRINTERS_BITMAP_H_
#define GENESIS_SEQUENCE_PRINTERS_BITMAP_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2023 Lucas Czech
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
    Contact:
    Lucas Czech <lczech@carnegiescience.edu>
    Department of Plant Biology, Carnegie Institution For Science
    260 Panama Street, Stanford, CA 94305, USA
*/
 
#include "genesis/utils/io/output_target.hpp"
#include "genesis/utils/color/color.hpp"
 
#include <iosfwd>
#include <map>
#include <string>
 
// =================================================================================================
//     Forward Declarations
// =================================================================================================
 
namespace genesis {
namespace utils {
 
    template<typename T>
    class Matrix;
 
} // namespace utils
 
namespace sequence {
 
    class Sequence;
 
    class SequenceSet;
} // namespace sequence
} // namespace genesis
 
// =================================================================================================
//     Printer Bitmap
// =================================================================================================
 
namespace genesis {
namespace sequence {
 
class PrinterBitmap
{
public:
 
    // -------------------------------------------------------------------------
    //     Constructors and Rule of Five
    // -------------------------------------------------------------------------
 
    PrinterBitmap()  = default;
    ~PrinterBitmap() = default;
 
    PrinterBitmap( PrinterBitmap const& ) = default;
    PrinterBitmap( PrinterBitmap&& )      = default;
 
    PrinterBitmap& operator= ( PrinterBitmap const& ) = default;
    PrinterBitmap& operator= ( PrinterBitmap&& )      = default;
 
    // -------------------------------------------------------------------------
    //     Print
    // -------------------------------------------------------------------------
 
    void write( SequenceSet const& set, std::shared_ptr<utils::BaseOutputTarget> target ) const;
 
    // -------------------------------------------------------------------------
    //     Properties
    // -------------------------------------------------------------------------
 
    PrinterBitmap& color_map( std::map<char, utils::Color> const& value );
 
    std::map<char, utils::Color> const& color_map() const;
 
    PrinterBitmap& pixel_height_per_char( size_t value );
 
    size_t pixel_height_per_char() const;
 
    PrinterBitmap& pixel_width_per_char( size_t value );
 
    size_t pixel_width_per_char() const;
 
    // -------------------------------------------------------------------------
    //     Interal Helper Functions
    // -------------------------------------------------------------------------
 
private:
 
    utils::Matrix<utils::Color> make_image_( SequenceSet const& set ) const;
 
    // -------------------------------------------------------------------------
    //     Data Members
    // -------------------------------------------------------------------------
 
private:
 
    std::map<char, utils::Color> color_map_;
 
    size_t pixel_height_ = 1;
    size_t pixel_width_  = 1;
 
};
 
} // namespace sequence
} // namespace genesis
 
#endif // include guard