be_view_an2kview.h

Go to the documentation of this file.

/*
 * This software was developed at the National Institute of Standards and
 * Technology (NIST) by employees of the Federal Government in the course
 * of their official duties. Pursuant to title 17 Section 105 of the
 * United States Code, this software is not subject to copyright protection
 * and is in the public domain. NIST assumes no responsibility whatsoever for
 * its use by other parties, and makes no guarantees, expressed or implied,
 * about its quality, reliability, or any other characteristic.
 */
 
#ifndef __BE_VIEW_AN2KVIEW_H__
#define __BE_VIEW_AN2KVIEW_H__
 
#include <set>
#include <string>
#include <vector>
 
#include <memory>
 
#include <be_finger_an2kminutiae_data_record.h>
#include <be_framework_enumeration.h>
#include <be_memory_autobuffer.h>
#include <be_view_view.h>
#include <be_image_image.h>
 
/* an2k.h forward declares */
struct record;
typedef record RECORD;
struct ansi_nist;
typedef ansi_nist ANSI_NIST;
 
namespace BiometricEvaluation 
{
        namespace View
        {
                class AN2KView : public BiometricEvaluation::View::View {
                public:
                        enum class RecordType : uint16_t
                        {
                                Type_1 = 1,
                                Type_2 = 2,
                                Type_3 = 3,
                                Type_4 = 4,
                                Type_5 = 5,
                                Type_6 = 6,
                                Type_7 = 7,
                                Type_8 = 8,
                                Type_9 = 9,
                                Type_10 = 10,
                                Type_11 = 11,
                                Type_12 = 12,
                                Type_13 = 13,
                                Type_14 = 14,
                                Type_15 = 15,
                                Type_16 = 16,
                                Type_17 = 17,
                                Type_99 = 99
                        };
 
                        enum class DeviceMonitoringMode
                        {
                                Controlled,
                                Assisted,
                                Observed,
                                Unattended,
                                Unknown,
                                NA
                        };
                        
                        static DeviceMonitoringMode
                        convertDeviceMonitoringMode(
                            const char *dmm);
 
                        static Image::CompressionAlgorithm
                            convertCompressionAlgorithm(
                            const uint16_t recordType,
                            const unsigned char *an2kValue);
 
                        static const double MinimumScanResolutionPPMM;
                        static const double HalfMinimumScanResolutionPPMM;
 
                        static const int FixedResolutionBitDepth = 8;
 
                        AN2KView(
                            const std::string filename,
                            const RecordType typeID,
                            const uint32_t recordNumber);
 
                        AN2KView(
                            Memory::uint8Array &buf,
                            const RecordType typeID,
                            const uint32_t recordNumber);
 
                        ~AN2KView();
 
                        std::vector<Finger::AN2KMinutiaeDataRecord>
                        getMinutiaeDataRecordSet() const;
 
                        RecordType getRecordType() const;
 
                protected:
 
                        Memory::AutoBuffer<ANSI_NIST>
                        getAN2K()
                            const;
 
                        RECORD*
                        getAN2KRecord()
                            const;
 
                private:
 
                        void readImageCommon(
                            const ANSI_NIST *an2k,
                            const RecordType typeID,
                            const uint32_t recordNumber);
 
                        void
                        associateMinutiaeData(
                            Memory::uint8Array &buf);
                            
                        void
                        associateMinutiaeData(
                            const std::string &filename);
                            
                        void
                        addMinutiaeDataRecord(
                            Finger::AN2KMinutiaeDataRecord &mdr);
                            
                        /* The record that this object represents. The Nth
                         * record is searched for when the object is
                         * constructed and may be referenced by subclasses.
                         */
                        Memory::AutoBuffer<ANSI_NIST> _an2k;
                        RECORD *_an2kRecord;
                        RecordType _recordType;
                        int _idc;
                        
                        std::vector<Finger::AN2KMinutiaeDataRecord>
                            _minutiaeDataRecordSet;
                };
                
                std::ostream&
                operator<<(
                    std::ostream &stream,
                    const AN2KView::DeviceMonitoringMode &kind);
        }
}
 
BE_FRAMEWORK_ENUMERATION_DECLARATIONS(
    BiometricEvaluation::View::AN2KView::RecordType,
    BE_View_AN2KView_RecordType_EnumToStringMap);
 
BE_FRAMEWORK_ENUMERATION_DECLARATIONS(
    BiometricEvaluation::View::AN2KView::DeviceMonitoringMode,
    BE_View_AN2KView_DeviceMonitoringMode_EnumToStringMap);
 
#endif /* __BE_VIEW_AN2KVIEW_H__ */