// -*- C++ -*-
// Copyright 2006-2008 Deutsches Forschungszentrum fuer Kuenstliche Intelligenz
// or its licensors, as applicable.
//
// You may not use this file except under the terms of the accompanying license.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you
// may not use this file except in compliance with the License. You may
// obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Project: OCRopus
// File: line-info.h
// Purpose: interface to line-info.cc
// Responsible: mezhirov
// Reviewer:
// Primary Repository:
// Web Sites: www.iupr.org, www.dfki.de


#ifndef h_line_info__
#define h_line_info__

#include "colib.h"
#include "ocr-ctextline-rast-extended.h"

namespace ocropus {
    /// Get line information by character segmentation.
    /// Having a true character segmentation is best, but CCs should also work.
    ///
    /// @param intercept Y coordinate of intersection of the baseline with Oy axis.
    /// @param slope Slope of the baseline (dy/dx, i.e. tangent)
    /// @param xheight Height of letters.
    /// @param descender_sink Distance between descender line and baseline (positive)
    /// @param ascender_rise Distance between ascender line and baseline plus x-height
    bool get_extended_line_info(float &intercept, float &slope,
                                float &xheight, float &descender_sink,
                                float &ascender_rise, colib::intarray &seg);

    /// Another, more Lua-friendly interface for get_extended_line_info().
    /// Packs all the line parameters into the struct but doesn't change
    /// the bbox.
    bool get_extended_line_info(TextLineExtended &result, colib::intarray &seg);

    /// Get line information of a black-and-white line.
    bool get_extended_line_info_using_ccs(float &intercept, float &slope,
                                          float &xheight, float &descender_sink,
                                          float &ascender_rise, colib::bytearray &img);
    
    /// Lua-friendly interface for get_extended_line_info_using_css().
    /// Analogous to get_extended_line_info().
    bool get_extended_line_info_using_ccs(TextLineExtended &result,
                                          colib::bytearray &image);
    
    void paint_line(colib::intarray &image, TextLineExtended l);

};

#endif