davidmigloz/go-bees

/*
 * GoBees
 * Copyright (c) 2016 - 2017 David Miguel Lozano
 *
 * 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
 * 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 <https://www.gnu.org/licenses/gpl-3.0.txt>.
 */

package com.davidmiguel.gobees.monitoring.algorithm;

import org.opencv.core.Mat;

/**
 * A BeeCounter has to count the number of bees present in a given frame.
 */
public interface BeesCounter {

    /**
     * Count the number of bees in a frame.
     *
     * @param frame the target frame in CV_8UC1 Mat format.
     * @return number of bees counted.
     */
    int countBees(Mat frame);


    /**
     * Get a processed frame with the bees highlighted in green and the rest of contours in red.
     *
     * @return CV_8UC3 Mat with bees highlighted
     */
    Mat getProcessedFrame();

    /**
     * Update blob size. This causes regions within an image get "thicker" or "thinner".
     *
     * @param size desired size.
     */
    void updateBlobSize(BlobSize size);

    /**
     * Update min area. Smaller areas are not consider to be a bee.
     *
     * @param minArea min area.
     */
    void updateMinArea(Double minArea);

    /**
     * Update max area. Greater areas are not consider to be a bee.
     *
     * @param maxArea max area.
     */
    void updateMaxArea(Double maxArea);

    enum BlobSize {
        SMALL, NORMAL, BIG
    }
}