AstroPixCandidateInput¶
-
class
toasty.pipeline.
AstroPixCandidateInput
(json_dict)[source]¶ Bases:
toasty.pipeline.CandidateInput
A CandidateInput obtained from an AstroPix query.
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
-
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
-
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.
-