opentile

Jun 27, 2026

Changes in this version

type Level

+ OverlapMode OverlapMode

+ func (l *Level) TileContentRect(col, row int) (Region, bool)

+ type OverlapMode int

+ const OverlapBordered

+ const OverlapNone

+ const OverlapStitched

+ func (m OverlapMode) String() string

Jun 25, 2026

Changes in this version

type Level

+ func (l *Level) StitchedGridFor(tile Size) Size

Jun 24, 2026

Changes in this version

+ func SetDZIPathOpenHook(fn func(path string) (any, error))

type Format

+ const FormatDZI

Jun 24, 2026

Changes in this version

type Level

+ func (l *Level) StitchedTileInto(tx, ty int, dst *decoder.Image, opts ...DecodeOption) error

Jun 24, 2026

Changes in this version

type Level

+ func (l *Level) StitchedGrid() Size

+ func (l *Level) StitchedTile(tx, ty int, opts ...DecodeOption) (*decoder.Image, error)

Jun 18, 2026

Changes in this version

type Level

+ Overlapping bool

Jun 18, 2026

Changes in this version

type Pyramid

+ func (p *Pyramid) RenderThumbnail(bounds Size, opts ...DecodeOption) (*decoder.Image, error)

type Slide

+ func (s *Slide) RenderMacro(bounds Size, opts ...DecodeOption) (*decoder.Image, error)

+ func (s *Slide) RenderThumbnail(bounds Size, opts ...DecodeOption) (*decoder.Image, error)

Jun 17, 2026

Changes in this version

+ type CheckCode string

+ const CheckInconsistentPyramid

+ const CheckMissingMetadata

+ const CheckNonConformantFormat

+ const CheckOffsetsOutOfBounds

+ const CheckOrphanIFD

+ const CheckTileGridMismatch

+ const CheckUnopenable

+ type Finding struct

+ Code CheckCode

+ Count int

+ Level int

+ Message string

+ Pyramid int

+ Severity Severity

type Format

+ const FormatUnknown

+ type Report struct

+ Findings []Finding

+ Format Format

+ func Validate(r io.ReaderAt, size int64, opts ...ValidateOption) (*Report, error)

+ func ValidateFile(path string, opts ...ValidateOption) (*Report, error)

+ func (r *Report) OK() bool

+ func (r *Report) Worst() Severity

+ type Severity int

+ const Error

+ const Info

+ const Warning

+ func (s Severity) String() string

type Slide

+ func (s *Slide) Validate(opts ...ValidateOption) *Report

+ type ValidateOption func(*validateConfig)

+ type ValidationProbe struct

+ func (p *ValidationProbe) Flag(code CheckCode, pyramid, level int, msg string)

+ func (p *ValidationProbe) Size() int64

+ type Validator interface

+ Validate func(p *ValidationProbe)

Jun 13, 2026

Changes in this version

type AssociatedImage

+ Encoding func() (AssociatedEncoding, bool)

+ IFDOffset func() (int64, bool)

+ TIFFTags func() (TIFFTags, bool)

+ type AssociatedType string

type Level

+ func (l *Level) DecodedTile(tx, ty int, opts ...DecodeOption) (*decoder.Image, error)

+ func (l *Level) DecodedTileInto(tx, ty int, dst *decoder.Image, opts ...DecodeOption) error

+ func (l *Level) ReadRegion(r Region, opts ...DecodeOption) (*decoder.Image, error)

+ func (l *Level) ReadRegionInto(origin Point, dst *decoder.Image, opts ...DecodeOption) error

+ func (l *Level) TIFFTags() (TIFFTags, bool)

+ func (l *Level) Warm() error

+ type MPP struct

+ X float64

+ Y float64

+ func (m MPP) IsZero() bool

+ func (m MPP) Symmetric() float64

type Metadata

+ MPP MPP

+ type Pyramid struct

+ Index int

+ Levels []Level

+ Name string

+ func (p *Pyramid) BestLevelForDownsample(downsample float64) *Level

+ func (p *Pyramid) Level(i int) (*Level, error)

+ func (p *Pyramid) ReadRegionScaled(src Region, out Size, opts ...DecodeOption) (*decoder.Image, error)

+ func (p *Pyramid) ReadRegionScaledInto(src Region, dst *decoder.Image, opts ...DecodeOption) error

+ func (p *Pyramid) ScaledStrips(src Region, out Size, stripHeight int, opts ...StripOption) *StripIterator

type Slide

+ func (s *Slide) AssociatedImages() []AssociatedImage

+ func (s *Slide) Pyramid(i int) *Pyramid

+ func (s *Slide) Pyramids() []*Pyramid

+ func (s *Slide) TIFFDirectories() ([]TIFFDirectory, bool)

Jun 13, 2026

Changes in this version

+ const AssociatedGeneric

+ const AssociatedLabel

+ const AssociatedMacro

+ const AssociatedMap

+ const AssociatedOverview

+ const AssociatedProbability

+ const AssociatedThumbnail

+ type AssociatedEncoding struct

+ Compression Compression

+ JPEGTables []byte

+ Photometric int

+ Predictor int

+ RowsPerStrip int

+ Samples int

+ Strips [][]byte

type Slide

+ func (s *Slide) AssociatedEncoding(a AssociatedImage) (AssociatedEncoding, bool)

Jun 12, 2026

Changes in this version

+ type AssociatedSource struct

+ Compression Compression

+ JPEGTables []byte

+ Photometric int

+ Predictor int

+ RowsPerStrip int

+ Samples int

+ Strips [][]byte

type Slide

+ func (s *Slide) AssociatedSourceOf(a AssociatedImage) (AssociatedSource, bool)

Jun 12, 2026

Changes in this version

type AssociatedImage

+ Decode func(opts decoder.DecodeOptions) (*decoder.Image, error)

Jun 6, 2026

Changes in this version

type Slide

+ func (s *Slide) AssociatedIFDOffset(a AssociatedImage) (offset int64, ok bool)

Jun 5, 2026

Changes in this version

+ type DirectoryType uint8

type TIFFDirectory

+ AssociatedType string

+ Type DirectoryType

Jun 2, 2026

Changes in this version

+ func SetDICOMPathOpenHook(fn func(path string) (any, error))

type Format

+ const FormatDICOM

Jun 1, 2026

Changes in this version

+ type DirectoryKind uint8

+ const DirAssociated

+ const DirLevel

+ const DirOther

+ type Rational struct

+ Denom uint32

+ Num uint32

type Slide

+ func (s *Slide) AssociatedTIFFTags(a AssociatedImage) (TIFFTags, bool)

+ func (s *Slide) ImageLevelTIFFTags(image, level int) (TIFFTags, bool)

+ func (s *Slide) LevelTIFFTags(level int) (TIFFTags, bool)

+ type TIFFDirectory struct

+ Associated string

+ Image int

+ Kind DirectoryKind

+ Level int

+ Tags TIFFTags

+ func TIFFDirectoriesOf(s *Slide) ([]TIFFDirectory, bool)

+ func (d TIFFDirectory) Tag(number uint16) (TIFFTag, bool)

+ type TIFFTag struct

+ Count int

+ Name string

+ Number uint16

+ Raw []byte

+ Type TIFFType

+ func (t TIFFTag) ASCII() (string, bool)

+ func (t TIFFTag) Rationals() ([]Rational, bool)

+ func (t TIFFTag) Uints() ([]uint64, bool)

+ type TIFFTags []TIFFTag

+ func TIFFTagsFromPage(p *tiff.Page) TIFFTags

+ func (ts TIFFTags) ByName(name string) (TIFFTag, bool)

+ func (ts TIFFTags) Tag(number uint16) (TIFFTag, bool)

+ type TIFFType uint16

+ const TIFFASCII

+ const TIFFByte

+ const TIFFLong

+ const TIFFLong8

+ const TIFFRational

+ const TIFFSLong

+ const TIFFSRational

+ const TIFFSShort

+ const TIFFShort

+ const TIFFUndefined

May 30, 2026

Changes in this version

type Option

+ func WithMemoryBudget(bytes int64) Option

May 26, 2026

Changes in this version

type Slide

+ func (s *Slide) ScaledStrips(l0Rect image.Rectangle, outSize image.Point, stripHeight int, ...) *StripIterator

+ type StripIterator struct

+ func (it *StripIterator) Close() error

+ func (it *StripIterator) Next() (*decoder.Image, error)

+ func (it *StripIterator) Strips() int

+ type StripOption func(*stripConfig)

+ func WithStripContext(ctx context.Context) StripOption

+ func WithStripIDCTScale(scale int) StripOption

+ func WithStripKernel(k resample.Kernel) StripOption

+ func WithStripLookahead(strips int) StripOption

+ func WithStripWorkers(n int) StripOption

May 25, 2026

Changes in this version

+ var ErrRegionEmpty = errors.New("opentile: region has no in-bounds pixels")

type DecodeOption

+ func WithResampleKernel(k resample.Kernel) DecodeOption

type Level

+ Downsample float64

type Slide

+ func (s *Slide) BestLevelForDownsample(downsample float64) int

+ func (s *Slide) ImageBestLevelForDownsample(image int, downsample float64) int

+ func (s *Slide) ImageReadRegion(image, level, x, y, w, h int, opts ...DecodeOption) (*decoder.Image, error)

+ func (s *Slide) ImageReadRegionInto(image, level, x, y int, dst *decoder.Image, opts ...DecodeOption) error

+ func (s *Slide) ImageReadRegionScaled(image int, l0x, l0y, l0w, l0h, outW, outH int, opts ...DecodeOption) (*decoder.Image, error)

+ func (s *Slide) ImageReadRegionScaledInto(image int, l0x, l0y, l0w, l0h int, dst *decoder.Image, opts ...DecodeOption) error

+ func (s *Slide) ReadRegion(level, x, y, w, h int, opts ...DecodeOption) (*decoder.Image, error)

+ func (s *Slide) ReadRegionInto(level, x, y int, dst *decoder.Image, opts ...DecodeOption) error

+ func (s *Slide) ReadRegionScaled(l0x, l0y, l0w, l0h, outW, outH int, opts ...DecodeOption) (*decoder.Image, error)

+ func (s *Slide) ReadRegionScaledInto(l0x, l0y, l0w, l0h int, dst *decoder.Image, opts ...DecodeOption) error

May 25, 2026

Changes in this version

+ var ErrCodecNotRegistered = errors.New("opentile: codec not registered for this slide's tile compression")

+ var ErrImageIndexOutOfRange = errors.New("opentile: image index out of range")

+ func CompressionToTIFFTag(c Compression) uint16

+ type DecodeOption func(*decodeConfig)

+ func WithFormat(f decoder.PixelFormat) DecodeOption

+ func WithScale(s int) DecodeOption

type Slide

+ func (s *Slide) DecodedTile(level, tx, ty int, opts ...DecodeOption) (*decoder.Image, error)

+ func (s *Slide) DecodedTileInto(level, tx, ty int, dst *decoder.Image, opts ...DecodeOption) error

+ func (s *Slide) ImageDecodedTile(image, level, tx, ty int, opts ...DecodeOption) (*decoder.Image, error)

+ func (s *Slide) ImageDecodedTileInto(image, level, tx, ty int, dst *decoder.Image, opts ...DecodeOption) error

+ func (s *Slide) ImageRangeTiles(ctx context.Context, image, level int) iter.Seq2[TilePos, TileResult]

+ func (s *Slide) ImageRawTile(image, level, tx, ty int) ([]byte, error)

+ func (s *Slide) ImageRawTileInto(image, level, tx, ty int, dst []byte) (int, error)

+ func (s *Slide) ImageTileBodyInto(image, level, tx, ty int, dst []byte) (int, error)

+ func (s *Slide) ImageTileBodyMaxSize(image, level int) int

+ func (s *Slide) ImageTileMaxSize(image, level int) int

+ func (s *Slide) ImageTilePrefix(image, level int) []byte

+ func (s *Slide) ImageTileReader(image, level, tx, ty int) (io.ReadCloser, error)

+ func (s *Slide) ImageWarmLevel(image, level int) error

+ func (s *Slide) RangeTiles(ctx context.Context, level int) iter.Seq2[TilePos, TileResult]

+ func (s *Slide) RawTile(level, tx, ty int) ([]byte, error)

+ func (s *Slide) RawTileInto(level, tx, ty int, dst []byte) (int, error)

+ func (s *Slide) TileBodyInto(level, tx, ty int, dst []byte) (int, error)

+ func (s *Slide) TileBodyMaxSize(level int) int

+ func (s *Slide) TileMaxSize(level int) int

+ func (s *Slide) TilePrefix(level int) []byte

+ func (s *Slide) TileReader(level, tx, ty int) (io.ReadCloser, error)

May 25, 2026

Changes in this version

+ func SetOpenAnyHook(...)

+ type Slide struct

+ func (s *Slide) Associated() []AssociatedImage

+ func (s *Slide) Close() error

+ func (s *Slide) Format() Format

+ func (s *Slide) ICCProfile() []byte

+ func (s *Slide) Images() []Image

+ func (s *Slide) Level(i int) (Level, error)

+ func (s *Slide) Levels() []Level

+ func (s *Slide) Metadata() Metadata

+ func (s *Slide) UnwrapReader() any

+ func (s *Slide) WarmLevel(i int) error

May 23, 2026

Changes in this version

+ const PropertyCaseNumber

+ const PropertyComments

+ const PropertyScanDurationSec

+ const PropertyScannedAreaMM2

+ const PropertyUserName

+ var ErrBadJPEGBitstream = errors.New("opentile: invalid JPEG bitstream")

+ var ErrBadJPEGSplice = errors.New("opentile: bad JPEG splice input")

+ var ErrCGORequired = errors.New("opentile: operation requires cgo build with libjpeg-turbo")

+ var ErrCorruptTile = errors.New("opentile: corrupt tile")

+ var ErrDimensionUnavailable = errors.New("opentile: dimension not supported on this format/image")

+ var ErrInvalidTIFF = errors.New("opentile: invalid TIFF structure")

+ var ErrLevelOutOfRange = errors.New("opentile: level index out of range")

+ var ErrMCUAlignment = errors.New("opentile: operation requires MCU alignment")

+ var ErrMmapUnavailable = errors.New("opentile: memory-map unavailable for this file")

+ var ErrSparseTile = errors.New("opentile: sparse tile (no compressed bytes at this position)")

+ var ErrTileOutOfBounds = errors.New("opentile: tile position out of bounds")

+ var ErrTileSizeRequired = errors.New("opentile: tile size not representable for this format")

+ var ErrTooManyIFDs = tiff.ErrTooManyIFDs

+ var ErrUnsupportedCompression = errors.New("opentile: unsupported compression")

+ var ErrUnsupportedFormat = errors.New("opentile: unsupported format")

+ func Register(f FormatFactory)

+ func SpliceJPEGTile(prefix, body []byte) ([]byte, error)

+ type AssociatedImage interface

+ Bytes func() ([]byte, error)

+ Compression func() Compression

+ Size func() Size

+ Type func() string

+ type Backing uint8

+ const BackingMmap

+ const BackingPread

+ type Compression uint8

+ const CompressionAVIF

+ const CompressionDeflate

+ const CompressionHTJ2K

+ const CompressionIRIS

+ const CompressionJP2K

+ const CompressionJPEG

+ const CompressionJPEGXL

+ const CompressionLZW

+ const CompressionNone

+ const CompressionPNG

+ const CompressionUnknown

+ const CompressionWebP

+ func (c Compression) String() string

+ type Config struct

+ func NewTestConfig(tileSize Size, policy CorruptTilePolicy) *Config

+ func (c *Config) Backing() Backing

+ func (c *Config) CorruptTilePolicy() CorruptTilePolicy

+ func (c *Config) NDPISynthesizedLabel() bool

+ func (c *Config) TileSize() (Size, bool)

+ type CorruptTilePolicy uint8

+ const CorruptTileBlank

+ const CorruptTileError

+ const CorruptTileFix

+ type Format string

+ const FormatBIF

+ const FormatCOGWSI

+ const FormatGenericTIFF

+ const FormatIFE

+ const FormatLeicaSCN

+ const FormatNDPI

+ const FormatOMETIFF

+ const FormatPhilipsTIFF

+ const FormatSVS

+ const FormatSZI

+ func Formats() []Format

+ type FormatFactory interface

+ Format func() Format

+ Open func(file *tiff.File, cfg *Config) (Tiler, error)

+ OpenRaw func(r io.ReaderAt, size int64, cfg *Config) (Tiler, error)

+ Supports func(file *tiff.File) bool

+ SupportsRaw func(r io.ReaderAt, size int64) bool

+ type Image interface

+ ChannelName func(c int) string

+ Index func() int

+ Level func(i int) (Level, error)

+ Levels func() []Level

+ MPP func() SizeMm

+ Name func() string

+ SizeC func() int

+ SizeT func() int

+ SizeZ func() int

+ ZPlaneFocus func(z int) float64

+ type Level interface

+ Compression func() Compression

+ FocalPlane func() float64

+ Grid func() Size

+ Index func() int

+ MPP func() SizeMm

+ PyramidIndex func() int

+ Size func() Size

+ Tile func(x, y int) ([]byte, error)

+ TileAt func(coord TileCoord) ([]byte, error)

+ TileBodyInto func(x, y int, dst []byte) (int, error)

+ TileBodyMaxSize func() int

+ TileInto func(x, y int, dst []byte) (int, error)

+ TileMaxSize func() int

+ TileOverlap func() image.Point

+ TilePrefix func() []byte

+ TileReader func(x, y int) (io.ReadCloser, error)

+ TileSize func() Size

+ Tiles func(ctx context.Context) iter.Seq2[TilePos, TileResult]

+ type Metadata struct

+ AcquisitionDateTime time.Time

+ ImageDescription string

+ Magnification float64

+ MicronsPerPixel float64

+ MicronsPerPixelX float64

+ MicronsPerPixelY float64

+ Properties map[string]string

+ ScannerManufacturer string

+ ScannerModel string

+ ScannerSerial string

+ ScannerSoftware []string

+ Writer string

+ func (m *Metadata) SetMPPSymmetric()

+ func (m *Metadata) SetProperty(key, value string)

+ type Option func(*config)

+ func WithBacking(b Backing) Option

+ func WithCorruptTilePolicy(p CorruptTilePolicy) Option

+ func WithNDPISynthesizedLabel(enable bool) Option

+ func WithTileSize(w, h int) Option

+ type Point struct

+ X int

+ Y int

+ func (p Point) String() string

+ type RawUnsupported struct

+ func (RawUnsupported) OpenRaw(io.ReaderAt, int64, *Config) (Tiler, error)

+ func (RawUnsupported) SupportsRaw(io.ReaderAt, int64) bool

+ type Region struct

+ Origin Point

+ Size Size

+ func (r Region) Contains(p Point) bool

+ type SingleImage struct

+ func NewSingleImage(levels []Level) *SingleImage

+ func (s *SingleImage) ChannelName(c int) string

+ func (s *SingleImage) Index() int

+ func (s *SingleImage) Level(i int) (Level, error)

+ func (s *SingleImage) Levels() []Level

+ func (s *SingleImage) MPP() SizeMm

+ func (s *SingleImage) Name() string

+ func (s *SingleImage) SizeC() int

+ func (s *SingleImage) SizeT() int

+ func (s *SingleImage) SizeZ() int

+ func (s *SingleImage) ZPlaneFocus(z int) float64

+ type Size struct

+ H int

+ W int

+ func (s Size) Area() int

+ func (s Size) String() string

+ type SizeMm struct

+ H float64

+ W float64

+ func (s SizeMm) IsZero() bool

+ type TileCoord struct

+ C int

+ T int

+ X int

+ Y int

+ Z int

+ func (t TileCoord) String() string

+ type TileError struct

+ Err error

+ Level int

+ X int

+ Y int

+ func (e *TileError) Error() string

+ func (e *TileError) Unwrap() error

+ type TilePos struct

+ X int

+ Y int

+ type TileResult struct

+ Bytes []byte

+ Err error

+ type Tiler interface

+ Associated func() []AssociatedImage

+ Close func() error

+ Format func() Format

+ ICCProfile func() []byte

+ Images func() []Image

+ Level func(i int) (Level, error)

+ Levels func() []Level

+ Metadata func() Metadata

+ WarmLevel func(i int) error

+ func Open(r io.ReaderAt, size int64, opts ...Option) (Tiler, error)

+ func OpenFile(path string, opts ...Option) (Tiler, error)