coloringbook

README

go-sfomuseum-colouringbook

Go package for generating SFO Museum "coloring book" sheets.

Important

This is SFO Museum specific code and is not designed to be a general purpose tool. It is being released "as-is" as a reference implementation in a spirit of generousity and to support the Coloring Books Pages For the SFO Museum Aviation Collection blog post.

General purpose tools for "outlining" arbitrary images are available in the sfomuseum/go-coloringbook package.

Documentation

Documentation is incomplete at this time.

See also

• https://www.visioncortex.org/vtracer/
• https://xmlgraphics.apache.org/batik/
• https://github.com/fogleman/contourmap
• https://github.com/go-pdf/fpdf
• https://github.com/sfomuseum/go-coloringbook

Documentation

Index

• Constants
• func AddSheet(ctx context.Context, pdf *fpdf.Fpdf, opts *AddSheetOptions) error
• func DeriveObjectImage(ctx context.Context, opts *DeriveObjectImageOptions, image_id int64) (string, error)
• func GenerateColoringBookLambda(ctx context.Context, function_uri string, object_id int64) error
• func Orientation(im image.Image) string
• type AddSheetOptions
• type ColoringBookRequest
• type DeriveObjectImageOptions

Constants

const GENERATE_COLORING_BOOK_LAMBDA_URI string = "aws://GenerateColouringBook?region=us-west-2&credentials=session"

Functions

func AddSheet

func AddSheet(ctx context.Context, pdf *fpdf.Fpdf, opts *AddSheetOptions) error

func DeriveObjectImage

func DeriveObjectImage(ctx context.Context, opts *DeriveObjectImageOptions, image_id int64) (string, error)

func GenerateColoringBookLambda

func GenerateColoringBookLambda(ctx context.Context, function_uri string, object_id int64) error

func Orientation

func Orientation(im image.Image) string

Types

type AddSheetOptions

type AddSheetOptions struct {
	Image           image.Image
	ImageReader     io.Reader
	ImagePath       string
	Title           string
	Date            string
	CreditLine      string
	AccessionNumber string
	URL             string
	Outline         *outline.OutlineOptions
}

type ColoringBookRequest

type ColoringBookRequest struct {
	ObjectId     int64 `json:"object_id"`
	UpdateObject bool  `json:"update_object"`
}

type DeriveObjectImageOptions

type DeriveObjectImageOptions struct {
	Reader  reader.Reader
	Outline *outline.OutlineOptions
}