AstroPixImageSource¶
-
class
toasty.pipeline.AstroPixImageSource[source]¶ Bases:
toasty.pipeline.ImageSourceAn ImageSource that obtains its inputs from a query to the AstroPix service.
Methods Summary
deserialize(data)Create an instance of this class by deserializing configuration data.
Get the name of the section key used for this source’s configuration data.
open_input(unique_id, cachedir)Open an input image for processing.
Generate a sequence of candidate input images that the pipeline may want to process.
Methods Documentation
-
classmethod
deserialize(data)[source]¶ Create an instance of this class by deserializing configuration data.
- Parameters
- datadict-like object
A dict-like object containing configuration items deserialized from a format such as JSON or YAML. The particular contents can vary depending on the implementation.
- Returns
- An instance of cls
-
classmethod
get_config_key()[source]¶ Get the name of the section key used for this source’s configuration data.
- Returns
- A string giving a key name usable in a YAML file.
-
open_input(unique_id, cachedir)[source]¶ Open an input image for processing.
- Parameters
- unique_idstr
The unique ID returned by the
CandidateInputinstance that created the cached data for this input image.- cachedirstr
A path pointing to a local directory inside of which the source data were cached.
- Returns
- An instance of
InputImagecorresponding to the cached data.
- An instance of
-
query_candidates()[source]¶ Generate a sequence of candidate input images that the pipeline may want to process.
- Returns
- A generator that yields a sequence of
CandidateInputinstances.
- A generator that yields a sequence of
-
classmethod
