README
¶
go-image-emboss
Go package for interacting with the sfomuseum/swift-image-emboss-grpc tools
Documentation
Documentation is incomplete.
Example
import (
"context"
"github.com/sfomuseum/go-image-emboss"
)
ctx := context.Background()
embosser, _ := emboss.NewEmbosser(ctx, "grpc://localhost:1234")
combined := false
rsp, _ := embosser.EmbossImage(ctx, "example.jpg", combined)
for _, im := range rsp {
// Do something with im (which is an `image.Image` instance here)
}
Tools
$> make cli
go build -mod vendor -ldflags="-s -w" -o bin/emboss cmd/emboss/main.go
images-emboss
$> ./bin/emboss -h
Usage of ./bin/emboss:
-combined
Return a single image combining all the subjects that were derived from an image.
-embosser-uri string
A valid sfomuseum/go-image-emboss.Embosser URI. (default "grpc://localhost:1234")
Examples
Note that all these examples assume there is a copy of the sfomuseum/swift-image-emboss-grpc server instance already running somewhere it can be reached (localhost:1234 in these examples).
Given this image of a tie tack from Civil Air Transport (CAT) airlines passed to the gRPC image embossing service like this:
$> ./bin/emboss -embosser-uri grpc://localhost:1234 fixtures/cat-pin.jpg
2023/10/02 12:13:39 fixtures/cat-pin-emboss-001.png
The image embossing service will return this image:
Given this image of an Air France amenity kit passed to the gRPC image embossing service like this:
$> ./bin/emboss -embosser-uri grpc://localhost:1234 fixtures/af-kit.jpg
2023/10/02 12:17:51 fixtures/af-kit-emboss-001.png
2023/10/02 12:17:51 fixtures/af-kit-emboss-002.png
2023/10/02 12:17:51 fixtures/af-kit-emboss-003.png
2023/10/02 12:17:51 fixtures/af-kit-emboss-004.png
2023/10/02 12:17:51 fixtures/af-kit-emboss-005.png
The image embossing service will return the following images:
If you want the service to return all those images in a single image passed the -combined flag, like this:
$> ./bin/emboss -embosser-uri grpc://localhost:1234 -combined fixtures/af-kit.jpg
2023/10/02 12:28:57 fixtures/af-kit-emboss-combined-001.png
The image embossing service will return the following image:
See also
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterEmbosser ¶
func RegisterEmbosser(ctx context.Context, scheme string, init_func EmbosserInitializationFunc) error
RegisterEmbosser registers 'scheme' as a key pointing to 'init_func' in an internal lookup table used to create new `Embosser` instances by the `NewEmbosser` method.
Types ¶
type Embosser ¶
type Embosser interface {
EmbossImage(context.Context, string, bool) ([]image.Image, error)
EmbossImageWithReader(context.Context, io.Reader, string, bool) ([]image.Image, error)
Close(context.Context) error
}
func NewEmbosser ¶
NewEmbosser returns a new `Embosser` instance configured by 'uri'. The value of 'uri' is parsed as a `url.URL` and its scheme is used as the key for a corresponding `EmbosserInitializationFunc` function used to instantiate the new `Embosser`. It is assumed that the scheme (and initialization function) have been registered by the `RegisterEmbosser` method.
type EmbosserInitializationFunc ¶
EmbosserInitializationFunc is a function defined by individual embosser package and used to create an instance of that embosser
type GrpcEmbosser ¶
type GrpcEmbosser struct {
// contains filtered or unexported fields
}
Source Files
Directories