imagetile

Documentation

Overview

Package imagetile implements DVID support for imagetiles in XY, XZ, and YZ orientation. All raw tiles are stored as PNG images that are by default gzipped. This allows raw tile gets to be already compressed at the cost of more expensive uncompression to retrieve arbitrary image sizes.

Index

• Constants
• Variables
• func NewTKey(tile dvid.ChunkPoint3d, plane dvid.DataShape, scale Scaling) storage.TKey
• func NewTKeyByTileReq(req TileReq) storage.TKey
• type Data
  • func (d *Data) ConstructTiles(uuidStr string, tileSpec TileSpec, request datastore.Request) error
  • func (d *Data) CopyPropertiesFrom(src datastore.DataService, fs storage.FilterSpec) error
  • func (d *Data) DefaultTileSpec(uuidStr string) (TileSpec, error)
  • func (d *Data) DoRPC(request datastore.Request, reply *datastore.Response) error
  • func (d *Data) GetImage(ctx storage.Context, src *imageblk.Data, geom dvid.Geometry, isotropic bool) (*dvid.Image, error)
  • func (d *Data) GetTileKey(ctx storage.Context, w http.ResponseWriter, r *http.Request, parts []string) (string, error)
  • func (d *Data) GobDecode(b []byte) error
  • func (d *Data) GobEncode() ([]byte, error)
  • func (d *Data) Help() string
  • func (d *Data) MarshalJSON() ([]byte, error)
  • func (d *Data) NewFilter(fs storage.FilterSpec) (storage.Filter, error)
  • func (d *Data) ParseTileReq(r *http.Request, parts []string) (TileReq, error)
  • func (d *Data) PostTile(ctx storage.Context, w http.ResponseWriter, r *http.Request, parts []string) error
  • func (d *Data) PushData(p *datastore.PushSession) error
  • func (d *Data) ServeHTTP(uuid dvid.UUID, ctx *datastore.VersionedCtx, w http.ResponseWriter, ...)
  • func (d *Data) ServeTile(ctx storage.Context, w http.ResponseWriter, r *http.Request, parts []string) error
  • func (d *Data) SetMetadata(uuid dvid.UUID, jsonBytes []byte) error
• type Filter
  • func (f *Filter) Check(tkv *storage.TKeyValue) (skip bool, err error)
• type Format
  • func (f Format) String() string
• type LevelSpec
  • func (spec LevelSpec) Duplicate() LevelSpec
• type Properties
• type Scaling
  • func DecodeTKey(tk storage.TKey) (tile dvid.ChunkPoint3d, plane dvid.DataShape, scale Scaling, err error)
• type SourceData
• type TileReq
  • func NewTileReq(tile dvid.ChunkPoint3d, plane dvid.DataShape, scale Scaling) TileReq
• type TileScaleSpec
• type TileSpec
  • func LoadTileSpec(jsonBytes []byte) (TileSpec, error)
  • func (tileSpec TileSpec) MarshalJSON() ([]byte, error)
• type Type
  • func NewType() *Type
  • func (dtype *Type) Help() string
  • func (dtype *Type) NewDataService(uuid dvid.UUID, id dvid.InstanceID, name dvid.InstanceName, c dvid.Config) (datastore.DataService, error)

Constants

const (
	Version  = "0.1"
	RepoURL  = "github.com/janelia-flyem/dvid/datatype/imagetile"
	TypeName = "imagetile"
)

Variables

var DefaultTileSize = dvid.Point3d{512, 512, 512}

var (
	ErrNoMetadataSet = errors.New("Tile metadata has not been POSTed yet.  GET requests require metadata to be POST.")
)

Functions

func NewTKey

func NewTKey(tile dvid.ChunkPoint3d, plane dvid.DataShape, scale Scaling) storage.TKey

NewTKey returns an imagetile-specific key component based on the components of a tile request.

func NewTKeyByTileReq

func NewTKeyByTileReq(req TileReq) storage.TKey

NewTKeyByTileReq returns an imagetile-specific key component based on a tile request.

Types

type Data

type Data struct {
	*datastore.Data
	Properties
}

Data embeds the datastore's Data and extends it with voxel-specific properties.

func (*Data) ConstructTiles

func (d *Data) ConstructTiles(uuidStr string, tileSpec TileSpec, request datastore.Request) error

func (*Data) CopyPropertiesFrom

func (d *Data) CopyPropertiesFrom(src datastore.DataService, fs storage.FilterSpec) error

CopyPropertiesFrom copies the data instance-specific properties from a given data instance into the receiver's properties. Fulfills the datastore.PropertyCopier interface.

func (*Data) DefaultTileSpec

func (d *Data) DefaultTileSpec(uuidStr string) (TileSpec, error)

DefaultTileSpec returns the default tile spec that will fully cover the source extents and scaling 0 uses the original voxel resolutions with each subsequent scale causing a 2x zoom out.

func (*Data) DoRPC

func (d *Data) DoRPC(request datastore.Request, reply *datastore.Response) error

DoRPC handles the 'generate' command.

func (*Data) GetImage

func (d *Data) GetImage(ctx storage.Context, src *imageblk.Data, geom dvid.Geometry, isotropic bool) (*dvid.Image, error)

GetImage returns an image given a 2d orthogonal image description. Since imagetile tiles have precomputed XY, XZ, and YZ orientations, reconstruction of the desired image should be much faster than computing the image from voxel blocks.

func (*Data) GetTileKey

func (d *Data) GetTileKey(ctx storage.Context, w http.ResponseWriter, r *http.Request, parts []string) (string, error)

GetTileKey returns the internal key as a hexadecimal string

func (*Data) GobDecode

func (d *Data) GobDecode(b []byte) error

func (*Data) GobEncode

func (d *Data) GobEncode() ([]byte, error)

func (*Data) Help

func (d *Data) Help() string

func (*Data) MarshalJSON

func (d *Data) MarshalJSON() ([]byte, error)

func (*Data) NewFilter

func (d *Data) NewFilter(fs storage.FilterSpec) (storage.Filter, error)

NewFilter returns a Filter for use with a push of key-value pairs.

func (*Data) ParseTileReq

func (d *Data) ParseTileReq(r *http.Request, parts []string) (TileReq, error)

func (*Data) PostTile

func (d *Data) PostTile(ctx storage.Context, w http.ResponseWriter, r *http.Request, parts []string) error

PostTile stores a tile.

func (*Data) PushData

func (d *Data) PushData(p *datastore.PushSession) error

PushData does an imagetile-specific push using optional ROI and tile filters.

func (*Data) ServeHTTP

func (d *Data) ServeHTTP(uuid dvid.UUID, ctx *datastore.VersionedCtx, w http.ResponseWriter, r *http.Request)

ServeHTTP handles all incoming HTTP requests for this data.

func (*Data) ServeTile

func (d *Data) ServeTile(ctx storage.Context, w http.ResponseWriter, r *http.Request, parts []string) error

ServeTile returns a tile with appropriate Content-Type set.

func (*Data) SetMetadata

func (d *Data) SetMetadata(uuid dvid.UUID, jsonBytes []byte) error

SetMetadata loads JSON data giving MinTileCoord, MaxTileCoord, and tile level specifications.

type Filter

type Filter struct {
	*Data
	// contains filtered or unexported fields
}

func (*Filter) Check

func (f *Filter) Check(tkv *storage.TKeyValue) (skip bool, err error)

type Format

type Format uint8

const (
	LZ4 Format = iota
	PNG
	JPG
)

func (Format) String

func (f Format) String() string

type LevelSpec

type LevelSpec struct {
	Resolution dvid.NdFloat32
	TileSize   dvid.Point3d
}

func (LevelSpec) Duplicate

func (spec LevelSpec) Duplicate() LevelSpec

type Properties

type Properties struct {
	// Source of the data for these imagetile.  Could be blank if tiles are not generated from
	// an associated grayscale data instance, but were loaded directly from external processing.
	Source dvid.InstanceName

	// MinTileCoord gives the minimum tile coordinate.
	MinTileCoord dvid.Point3d

	// MaxTileCoord gives the maximum tile coordinate.
	MaxTileCoord dvid.Point3d

	// Levels describe the resolution and tile sizes at each level of resolution.
	Levels TileSpec

	// Placeholder, when true (false by default), will generate fake tile images if a tile cannot
	// be found.  This is useful in testing clients.
	Placeholder bool

	// Encoding describes encoding of the stored tile.  See imagetile.Format
	Encoding Format

	// Quality is optional quality of encoding for jpeg, 1-100, higher is better.
	Quality int
}

Properties are additional properties for keyvalue data instances beyond those in standard datastore.Data. These will be persisted to metadata storage.

type Scaling

type Scaling uint8

Scaling describes the scale level where 0 = original data resolution and higher levels have been downsampled.

func DecodeTKey

func DecodeTKey(tk storage.TKey) (tile dvid.ChunkPoint3d, plane dvid.DataShape, scale Scaling, err error)

DecodeTKey returns the components of a tile request based on an imagetile-specific key component.

type SourceData

type SourceData interface{}

SourceData is the source of the tile data and should be voxels or voxels-derived data.

type TileReq

type TileReq struct {
	// contains filtered or unexported fields
}

func NewTileReq

func NewTileReq(tile dvid.ChunkPoint3d, plane dvid.DataShape, scale Scaling) TileReq

type TileScaleSpec

type TileScaleSpec struct {
	LevelSpec
	// contains filtered or unexported fields
}

TileScaleSpec is a slice of tile resolution & size for each dimensions.

type TileSpec

type TileSpec map[Scaling]TileScaleSpec

TileSpec specifies the resolution & size of each dimension at each scale level.

func LoadTileSpec

func LoadTileSpec(jsonBytes []byte) (TileSpec, error)

LoadTileSpec loads a TileSpec from JSON data. JSON data should look like:

{
   "0": { "Resolution": [3.1, 3.1, 40.0], "TileSize": [512, 512, 40] },
   "1": { "Resolution": [6.2, 6.2, 40.0], "TileSize": [512, 512, 80] },
   ...
}

Each line is a scale with a n-D resolution/voxel and a n-D tile size in voxels.

func (TileSpec) MarshalJSON

func (tileSpec TileSpec) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON of the imagetile specifications for each scale level.

type Type

type Type struct {
	datastore.Type
}

Type embeds the datastore's Type to create a unique type with tile functions. Refinements of general tile types can be implemented by embedding this type, choosing appropriate # of channels and bytes/voxel, overriding functions as needed, and calling datastore.Register(). Note that these fields are invariant for all instances of this type. Fields that can change depending on the type of data (e.g., resolution) should be in the Data type.

func NewType

func NewType() *Type

NewDatatype returns a pointer to a new voxels Datatype with default values set.

func (*Type) Help

func (dtype *Type) Help() string

func (*Type) NewDataService

func (dtype *Type) NewDataService(uuid dvid.UUID, id dvid.InstanceID, name dvid.InstanceName, c dvid.Config) (datastore.DataService, error)

NewData returns a pointer to new tile data with default values.