CandidateInput¶
-
class
toasty.pipeline.
CandidateInput
[source]¶ Bases:
abc.ABC
An abstract base class representing an image from one of our sources. If it has not been processed before, we will fetch its data and queue it for processing.
Methods Summary
cache_data
(cachedir)Cache all of the source image data and metadata locally.
Get an ID for this image that will be unique in its
ImageSource
.Methods Documentation
-
abstract
cache_data
(cachedir)[source]¶ Cache all of the source image data and metadata locally.
- Parameters
- cachedirstr
A path pointing to a local directory inside of which the source data should be cached.
- Returns
- None.
- Raises
- May raise
NotActionableError
if it turns out that this - candidate is not one that can be imported into WWT.
- May raise
-
abstract
get_unique_id
()[source]¶ Get an ID for this image that will be unique in its
ImageSource
.- Returns
- An identifier as a string. Should be limited to path-friendly
- characters, i.e. ASCII without spaces.
-
abstract