InputImage

class toasty.pipeline.InputImage(unique_id, cachedir)

Bases: abc.ABC

An abstract base class representing an image to be processed by the pipeline. Such an “image” need not correspond to a single RGB image, but it does have to be convertible into some kind of WWT-compatible format expressible as a wwt_data_formats.imageset.ImageSet item.

Parameters

unique_idstr

The unique ID returned by the CandidateInput instance that created the cached data for this input image.

cachedirstr

A path pointing to a local directory inside of which the image source data were cached locally.

Methods Summary

process_image(baseoutdir)

Convert the image into WWT-compatible data and metadata.

Methods Documentation

process_image(baseoutdir)

Convert the image into WWT-compatible data and metadata.

Parameters

baseoutdirstr

A path pointing to a local directory inside of which the WWT-compatible data files will be written. The data for this particular image will be written inside a subdirectory corresponding to this image’s unique ID.

Returns

A wwt_data_formats.place.Place object containing a single

“foreground image set” with data about the processed image. URLs for

any locally-generated data will be relative to the image-specific

subdirectory.