svg

Documentation

Overview

Package svg provides methods for working with fingerprint SVG documents.

Index

• Constants
• func DerivePathType(d string) string
• func Draw(dc *gg.Context, coords Coordinates, color string, scale float64) error
• func DrawCubic(dc *gg.Context, curves Cubic, color string, scale float64) error
• func DrawLine(dc *gg.Context, points Line, color string, scale float64) error
• type Coordinates
  • func DeriveCoordinates(d string) (Coordinates, error)
• type Cubic
  • func (c Cubic) Type() string
• type Document
  • func Unmarshal(r io.Reader) (*Document, error)
  • func (doc *Document) ToImage(max_dimension float64) (image.Image, error)
• type Line
  • func (l Line) Type() string
• type Path
  • func (p *Path) Coordinates() (Coordinates, error)
  • func (p *Path) Draw(dc *gg.Context, scale float64) error
  • func (p *Path) HexColor() string
  • func (p *Path) Type() string
• type Point
  • func (p Point) Type() string

Constants

const CUBIC string = "C"

CUBIC is the string identifier for a `Cubic` path.

const LINE string = "L"

LINE is the string identifier for a `Line` path.

const MISSING string = "X"

MISSING is a the string identifier for a path that can not be parsed.

const POINT string = "P"

POINT is the string identifier for a `Point`.

const UNKNOWN string = ""

UNKNOWN is a the string identifier for a path type that is not supported.

Functions

func DerivePathType

func DerivePathType(d string) string

DerivePathType returns a string identifier for the SVG path (`d` attribute) defined by 'd'.

func Draw

func Draw(dc *gg.Context, coords Coordinates, color string, scale float64) error

Draw renders the path defined by 'coords' on to 'gg'.

func DrawCubic

func DrawCubic(dc *gg.Context, curves Cubic, color string, scale float64) error

Draw renders the path defined by 'coords' as a closed cubic curve path on to 'gg'.

func DrawLine

func DrawLine(dc *gg.Context, points Line, color string, scale float64) error

Draw renders the path defined by 'coords' as a closed line string on to 'gg'.

Types

type Coordinates

type Coordinates interface {
	Type() string
}

Coordinate is an interface representation the coordinates defined by a `Path` instance.

func DeriveCoordinates

func DeriveCoordinates(d string) (Coordinates, error)

DerivePathType returns a `Coordinates` instance derived from the SVG path (`d` attribute) defined by 'd'.

type Cubic

type Cubic [][3]Point

Cubic is a list of a tuples of `Point` instances that make up a cubic curve path.

func (Cubic) Type

func (c Cubic) Type() string

Type returns the `CUBIC` string.

type Document

type Document struct {
	// Width is the width of the fingerprint SVG drawing.
	Width int `xml:"width,attr" json:"width"`
	// Height is the width of the fingerprint SVG drawing.
	Height int `xml:"height,attr" json:"height"`
	// ViewBox is the viewbox boundary of the fingerprint SVG drawing.
	ViewBox string `xml:"viewBox,attr" json:"viewbox"`
	// Date is the date that a fingerprint SVG drawing was produced.
	Date string `xml:"x-fingerprint-date,attr" json:"date"`
	// Paths is the list of SVG path that define a fingerprint SVG drawing.
	Paths []*Path `xml:"path" json:"paths"`
}

Document defines a struct representing a fingerprint SVG document. At this time it is not

func Unmarshal

func Unmarshal(r io.Reader) (*Document, error)

Unmarshal will parse the fingerprint SVG document defined by 'r' in a new `Document` instance.

func (*Document) ToImage

func (doc *Document) ToImage(max_dimension float64) (image.Image, error)

ToImage will rasterize 'doc' and return it as an `image.Image` instance whose maximum dimension is scaled to 'max_dimension'

type Line

type Line []Point

Line is a list of pairs of `Point` instances that make up a line path.

func (Line) Type

func (l Line) Type() string

Type returns the `LINE` string.

type Path

type Path struct {
	// Fill is the colour assigned to the path.
	Fill string `xml:"fill,attr" json:"f"`
	// FillOpacity is the opacity of the colour (assigned to the path).
	FillOpacity float64 `xml:"fill-opacity,attr" json:"o"`
	// D is the SVG-encoded value of the path.
	D string `xml:"d,attr" json:"d"`
}

Path is a struct representing an individual path element in a fingerprint SVG drawing.

func (*Path) Coordinates

func (p *Path) Coordinates() (Coordinates, error)

Coodinates with return a `Coordinates` instance derived derived from the `D` property of 'p'.

func (*Path) Draw

func (p *Path) Draw(dc *gg.Context, scale float64) error

Draw will render 'p' in to 'dc'.

func (*Path) HexColor

func (p *Path) HexColor() string

HexColor will return the 8-digit hexidecial color (fill + fill opacity) for the path

func (*Path) Type

func (p *Path) Type() string

Type will return a string identifier for the type of path derived from the `D` property of 'p'.

type Point

type Point [2]float64

Point is a two dimensional X,Y coordinate.

func (Point) Type

func (p Point) Type() string

Type returns the `POINT` string.