PixelLine15.h

# ifndef PixelLine15_h
# define PixelLine15_h PixelLine15_h

// ####################################################################
// # Conjecture: An Extensible Optical Character Recognition Framework  #
// #                                                                  #
// # Copyright: Lesser GNU Public License (LGPL)                      #
// #                                                                  #
// # Overview:                                                        #
// #  - Conjecture is a collection of C++ classes, and an OCR engine    #
// #  - Conjecture is designed to allow customization at all levels     #
// #    and to encourage individuals to contribute incremental        #
// #    improvements in algorithms.                                   #
// #  - Overall design discussions can be found in                    #
// #      $SNROOT/docs/doxygen/html/index.html                        #
// #  - Conjecture is designed to interact with and build on other      #
// #    open-source OCR programs.                                     #
// ####################################################################

# include "Root.h"  // parent
# include "Coord.h"

namespace Conjecture {

  // ##################################################################
  // ##################################################################

  // IMPLEMENTATION NOTES:
  //   - this class is designed for highly efficient space utiliation,
  //     while also providing support for highly efficient feature
  //     analysis.
  //   - some "auxillary" methods are quite slow (i.e. 'set' and
  //     'clear' - this class is meant to be used primarily on
  //     frozen images, so setting and clearing bits is not a
  //     priority for efficient implementation.
  //   - does NOT store the size of the pixel line (assumed to be
  //     be maintained elsewhere). This implies that the number of
  //     white pixels cannot be reported without obtaining the size
  //     (#black is stored, and #white = total - #black).
  //   - not using setters internally in some situations because
  //     bit-specifiers cause temporaries to be used in returns

  class PixelLine15 : public Root {
  public:
    // Constructors/Destructors
    PixelLine15(unsigned int pixels);

    // **************
    // Accessors
    inline unsigned int holes()  const { return this->_holes;  }
    inline unsigned int pixels() const { return this->_pixels; }
    inline unsigned int black()  const { return this->_black;  }
    
    // **************
    // Input/Output
    
    // **************
    // Interface

    inline bool get(unsigned i) const {
      return (this->pixels() & (1<<i)) ? true : false;
    }

    void set(unsigned i);

    void clear(unsigned i);

    std::string str(char on = '#', char off = '.', unsigned char size = 15) const;

    static void test(int argc = 0, const char* argv[] = NULL);

  protected:
    // **************
    // Accessors
    inline void   holesIs(unsigned int holes)   { this->_holes  = holes;  }
    inline void   pixelsIs(unsigned int pixels) { this->_pixels = pixels; }
    inline void   blackIs(unsigned int black)   { this->_black  = black;  }
    
    // **************
    // Methods 
    
  private: 
    // **************
    // Accessors
    
    // **************
    // Methods 
    void updateMeta();

    // **************
    // State

    unsigned int    _pixels:15;

    unsigned int    _clean:1;

    unsigned int    _black:4;

    unsigned int    _holes:3;

    // FUTURE FIX: There are still 8 bits remaining that can be
    // filled with other information useful to feature analysis.
    // Possibilities include:
    //   - 2 bits to indicate whether the left-most black pixel
    //     is at left border (0), 1 in from left border (1),
    //     2 in from left border (2), or 3+ in from left border
    //     (3).  An analogous 2 bits for right-most black pixel
    //     as well.  Leaves 4 bits for other things.
    //   - index of left-most black pixel (4 bits) and index of
    //     right-most black pixel (4 bits).

  };
}

# endif // PixelLine15_h

---