It holds all functions and data related to print manipulation. More...

#include <PrintCapture.h>

Collaboration diagram for PrintCapture:

Public Member Functions
std::shared_ptr< PrintCapture >	ChangeDpiTo (ImageDpi targetDpi) const
	Create new PrintCapture with given DPI.
std::shared_ptr< PrintCapture >	ChangeDpiTo (const Image::ImageResampler &resampler) const
	Create new PrintCapture using provided DPI-change configuration.
virtual std::vector< std::shared_ptr< PrintSegment > >	SegmentWith (PrintCaptureSegmentation &detector)
	It segments print capture.
std::shared_ptr< Image >	CropPrint (const Rectangle &rectangle, const PrintCropConfiguration &cfg) const final
	It crops image with given rectangle and background color.
std::shared_ptr< Image >	CropPrint (const Rectangle &rectangle) const
	It crops image with given rectangle by default PrintCropConfiguration.
std::shared_ptr< Image >	Draw (const std::vector< std::shared_ptr< PrintSegment > > &segments, const ImageShapeAttributes &attr) const
	It draws rounding boxes into PrintCapture.
void	WriteTo (Writer &writer) const final
	Function serializes print via provided Writer.
uint8_t	CalculateIntensity ()
	Function calculates the image intensity.

Static Public Member Functions
static std::shared_ptr< PrintCapture >	Create (std::shared_ptr< Image > img, const PrintAttributes &pa=PrintAttributes(), std::shared_ptr< PrintExecutor > executor=GlobalPrintExecutor::Get())
	Constructor of PrintCapture.

Public Attributes
const std::shared_ptr< Image >	image
	Provides PrintCapture Image.
const PrintAttributes	printAttributes
	Provides PrintCapture Image.

Detailed Description

It holds all functions and data related to print manipulation.

See Description with examples.

Member Function Documentation

◆ CalculateIntensity()

uint8_t CalculateIntensity ( )

inline

Function calculates the image intensity.

The intensity value is low for dry fingerprints (and for low pressure prints) and high for wet fingerprints (or for high pressure prints).

Returns: image intensity in range 0 (lowest intensity, dry finger, low pressure) to 100 (highest intensity, wet finger, high pressure)

Exceptions

EnrollmentException when fails to calculate intensity

References Print::CalculateIntensity(), and image.

Here is the call graph for this function:

◆ ChangeDpiTo() [1/2]

std::shared_ptr< PrintCapture > ChangeDpiTo ( const Image::ImageResampler & resampler ) const

inlinenodiscard

Create new PrintCapture using provided DPI-change configuration.

It creates new print with changed image dpi by function Image::ChangeDpiTo() and with same attributes using a DPI-change configuration.

Parameters

resampler image resampler

Returns: print capture with given DPI

Exceptions

ImageException	when there is an processing error
EnrollmentInvalidArgumentException	when resize algorithm is NIST and print capture image is not single-channel grayscale

References Create(), image, and printAttributes.

Here is the call graph for this function:

◆ ChangeDpiTo() [2/2]

std::shared_ptr< PrintCapture > ChangeDpiTo ( ImageDpi targetDpi ) const

inlinenodiscard

Create new PrintCapture with given DPI.

It creates new print with changed image dpi by function Image::ChangeDpiTo() and with same position and attributes. The function uses Standard resizing algorithm. See BicubicImageResampler.

Parameters

targetDpi DPI of new print.

Returns: print with target DPI

Exceptions

ImageException	when it is not possible to change image DPI
EnrollmentInvalidArgumentException	when targetDpi is 0

References ChangeDpiTo().

Referenced by ChangeDpiTo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Create()

std::shared_ptr< PrintCapture > Create	(	std::shared_ptr< Image >	img,
		const PrintAttributes &	pa = PrintAttributes(),
		std::shared_ptr< PrintExecutor >	executor = GlobalPrintExecutor::Get() )

inlinestatic

Constructor of PrintCapture.

Parameters

img	print image, can contain one or more fingerprints to segment
pa	optional PrintAttributes
executor	PrintExecutor to use for PrintCapture functionality execution

Exceptions

NullArgumentException when image is null

Returns: created PrintCapture object

References GlobalPrintExecutor::Get().

Referenced by ChangeDpiTo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CropPrint() [1/2]

std::shared_ptr< Image > CropPrint ( const Rectangle & rectangle ) const

inlinenodiscard

It crops image with given rectangle by default PrintCropConfiguration.

Parameters

rectangle Rectangle to be cropped

Returns: cropped Image

References CropPrint().

Here is the call graph for this function:

◆ CropPrint() [2/2]

std::shared_ptr< Image > CropPrint	(	const Rectangle &	rectangle,
		const PrintCropConfiguration &	cfg ) const

inlinenodiscardfinal

It crops image with given rectangle and background color.

Parameters

rectangle	Rectangle to be cropped
cfg	configuration of print cropping

Returns: Image cropped image

References image.

Referenced by CropPrint().

Here is the caller graph for this function:

◆ Draw()

std::shared_ptr< Image > Draw	(	const std::vector< std::shared_ptr< PrintSegment > > &	segments,
		const ImageShapeAttributes &	attr ) const

inline

It draws rounding boxes into PrintCapture.

Parameters

segments	detected segments
attr	ImageShapeAttributes of rounding boxes

Returns: Image with drawn rounding boxes

References image.

◆ SegmentWith()

virtual std::vector< std::shared_ptr< PrintSegment > > SegmentWith ( PrintCaptureSegmentation & detector )

inlinevirtual

It segments print capture.

It uses PrintDetector::Segment function to find print segments. It always returns segments without position. The user MUST assign position to segment via function PrintSegment::SetPosition to be possible to transform PrintSegment into Print.

Parameters

detector PrintDetector to detect PrintSegments in PrintCapture