ReadEdge¶
- class lsst.pipe.base.pipeline_graph.ReadEdge(dataset_type_key: NodeKey, task_key: NodeKey, *, storage_class_name: str, connection_name: str, is_calibration: bool, raw_dimensions: frozenset[str], is_prerequisite: bool, component: str | None, defer_query_constraint: bool)¶
Bases:
Edge
Representation of an input connection (including init-inputs and prerequisites) in a pipeline graph.
- Parameters:
- dataset_type_key
NodeKey
Key for the dataset type node this edge is connected to. This should hold the parent dataset type name for component dataset types.
- task_key
NodeKey
Key for the task node this edge is connected to.
- storage_class_name
str
Name of the dataset type’s storage class as seen by the task.
- connection_name
str
Internal name for the connection as seen by the task.
- is_calibration
bool
Whether this dataset type can be included in
CALIBRATION
collections.- raw_dimensions
frozenset
[str
] Raw dimensions from the connection definition.
- is_prerequisite
bool
Whether this dataset must be present in the data repository prior to
QuantumGraph
generation.- component
str
orNone
Component of the dataset type requested by the task.
- defer_query_constraint
bool
If
True
, by default do not include this dataset type’s existence as a constraint on the initial data ID query in QuantumGraph generation.
- dataset_type_key
Notes
When included in an exported
networkx
graph (e.g.PipelineGraph.make_xgraph
), read edges set the following edge attributes:parent_dataset_type_name
storage_class_name
is_init
component
is_prerequisite
As with
ReadEdge
instance attributes, these descriptions of dataset types are those specific to a task, and may differ from the graph’s resolved dataset type or (ifPipelineGraph.resolve
has not been called) there may not even be a consistent definition of the dataset type.Attributes Summary
Edge key for the special edge that connects a task init node to the task node itself (for regular edges, this would be the connection name).
Complete dataset type name, as seen by the task.
Whether this dataset is read or written when the task is constructed, not when it is run.
Ordered tuple of node keys and connection name that uniquely identifies this edge in a pipeline graph.
The directed pair of
NodeKey
instances this edge connects.Name of the parent dataset type.
Label of the task.
Methods Summary
adapt_dataset_ref
(ref)Transform the graph's definition of a dataset reference (parent dataset type, with the registry or producer's storage class) to the one seen by this task.
adapt_dataset_type
(dataset_type)Transform the graph's definition of a dataset type (parent, with the registry or producer's storage class) to the one seen by this task.
diff
(other[, connection_type])Compare this edge to another one from a possibly-different configuration of the same task label.
Attributes Documentation
- INIT_TO_TASK_NAME: ClassVar[str] = 'INIT'¶
Edge key for the special edge that connects a task init node to the task node itself (for regular edges, this would be the connection name).
- dataset_type_name¶
Complete dataset type name, as seen by the task.
- is_init¶
Whether this dataset is read or written when the task is constructed, not when it is run.
- key¶
Ordered tuple of node keys and connection name that uniquely identifies this edge in a pipeline graph.
- nodes¶
- parent_dataset_type_name¶
Name of the parent dataset type.
All dataset type nodes in a pipeline graph are for parent dataset types; components are represented by additional
ReadEdge
state.
- task_label¶
Label of the task.
Methods Documentation
- adapt_dataset_ref(ref: DatasetRef) DatasetRef ¶
Transform the graph’s definition of a dataset reference (parent dataset type, with the registry or producer’s storage class) to the one seen by this task.
- Parameters:
- ref
DatasetRef
Graph’s definition of the dataset reference.
- ref
- Returns:
- out_dataset_ref
DatasetRef
Dataset reference seen by this task.
- out_dataset_ref
- adapt_dataset_type(dataset_type: DatasetType) DatasetType ¶
Transform the graph’s definition of a dataset type (parent, with the registry or producer’s storage class) to the one seen by this task.
- Parameters:
- dataset_type
DatasetType
Graph’s definition of dataset type.
- dataset_type
- Returns:
- out_dataset_type
DatasetType
Dataset type seen by this task.
- out_dataset_type