ska_oso_pdm.schemas.sdp
The schemas.sdp.sdp_configuration module defines Marshmallow schemas .
- class SDPConfigurationSchema(*args: Any, **kwargs: Any)[source]
Marshmallow class for the SDPConfiguration class
- create_sdp_config(data, **_)
Convert parsed JSON back into a SDPConfiguration object.
- Parameters:
data – Marshmallow-provided dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
SDPConfiguration object populated from data
- execution_block
alias of
ExecutionBlockSchema
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict suitable for BeamMapping
- processing_blocks
alias of
ProcessingBlockSchema
- resources
alias of
ResourcesSchema
The schemas.sdp.sdp_configuration module defines Marshmallow schemas .
- class ExecutionBlockSchema(*args: Any, **kwargs: Any)[source]
Marshmallow class for the Execution Block class
- beams
alias of
BeamSchema
- channels
alias of
ChannelsSchema
- create_execution_block(data, **_)
Convert parsed JSON back into a SDPConfiguration object.
- Parameters:
data – Marshmallow-provided dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
Execution Block object populated from data
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict suitable for EB configuration
- polarisations
alias of
PolarisationSchema
- scan_types
alias of
ScanTypeSchema
The schemas.sdp.processing_block module defines Marshmallow schemas .
- class PbDependencySchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema for the PbDependency class.
- create_pb_dependency(data, **_)
Convert parsed JSON back into a PbDependency object.
- Parameters:
data – Marshmallow-provided dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
PbDependency object populated from data
- class ProcessingBlockSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema for the ProcessingBlock class.
- create_processing_block(data, **_)
Convert parsed JSON back into a PB object.
- Parameters:
data – Marshmallow-provided dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
PB object populated from data
- dependencies
alias of
PbDependencySchema
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict suitable for PB configuration
- script
alias of
ScriptSchema
- class ScriptSchema(*args: Any, **kwargs: Any)[source]
Represents the type of workflow being configured on the SDP
- create_sdp_script(data, **_)
Convert parsed JSON back into a Script object.
- Parameters:
data – Marshmallow-provided dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
SDP Script object populated from data
- kind
alias of
ScriptKind
The schemas.sdp.resources defines Marshmallow schemas to convert an SDP Resources instance to/from JSON.
- class ResourcesSchema(*args: Any, **kwargs: Any)[source]
Represents the type of Resources being configured on the SDP
- create_sdp_res(data, **_)
Convert parsed JSON back into a Resources object.
- Parameters:
data – Marshmallow-provided dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
SDP Resources object populated from data
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict suitable for Resources configuration
The schemas.sdp.beam module defines Marshmallow schemas that convert an SDP Beam instance to/from JSON.
- class BeamSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema for the Beams class.
- create_beams(data, **_)
Convert parsed JSON back into a Beam object.
- Parameters:
data – Marshmallow-provided dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
Beam instance populated from data
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict suitable for Beam configuration
- function
alias of
BeamFunction
The schemas.sdp.channels module defines Marshmallow schemas .
- class ChannelsSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema for the Channel class.
- create_channel(data, **_)
Convert parsed JSON back into a Channel object.
- Parameters:
data – Marshmallow-provided dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
ScanType object populated from data
- spectral_windows
alias of
SpectralWindowSchema
- class SpectralWindowSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema for the SpectralWindow class.
- create_spectral_window(data, **_)
Convert parsed JSON back into a Channel object.
- Parameters:
data – Marshmallow-provided dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
SubBand object populated from data
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict suitable for PB configuration
The schemas.sdp.scan_type module defines Marshmallow schemas that convert BeamMapping and ScanTypes SDP classes to/from JSON.
- class BeamMappingSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema to convert a BeamMapping instance to/from JSON.
- create_channel(data, **_)
Convert parsed JSON back into a BeamMapping object.
- Parameters:
data – Marshmallow-provided dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
BeamMapping object populated from data
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict suitable for BeamMapping
- class ScanTypeSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema for the ScanType class.
- beams
alias of
BeamMappingSchema
- create_scan_type(data, **_)
Convert parsed JSON back into a ScanType object.
- Parameters:
data – Marshmallow-provided dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
ScanType object populated from data
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict suitable for PB configuration
The schemas.sdp.polarisation module defines Marshmallow schemas that convert an SDP Polarisation instance to/from JSON.
- class PolarisationSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema for the Polarisation class.
- create_polarisations(data, **_)
Convert parsed JSON back into a Polarisation object.
- Parameters:
data – Marshmallow-provided dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
Polarisation instance populated from data
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict suitable for Polarisation configuration