pipeline.hsd.tasks.skycal package¶
Submodules¶
pipeline.hsd.tasks.skycal.display module¶
-
class
pipeline.hsd.tasks.skycal.display.
SingleDishPlotmsAntComposite
(context, result, calapp, xaxis, yaxis, spw='', pol='', **kwargs)[source]¶ Bases:
pipeline.h.tasks.common.displays.common.AntComposite
-
leaf_class
¶ alias of
SingleDishPlotmsLeaf
-
-
class
pipeline.hsd.tasks.skycal.display.
SingleDishPlotmsAntSpwComposite
(context, result, calapp, xaxis, yaxis, pol='', **kwargs)[source]¶ Bases:
pipeline.h.tasks.common.displays.common.AntSpwComposite
-
leaf_class
¶ alias of
SingleDishPlotmsSpwComposite
-
-
class
pipeline.hsd.tasks.skycal.display.
SingleDishPlotmsLeaf
(context, result, calapp, xaxis, yaxis, spw='', ant='', coloraxis='', **kwargs)[source]¶ Bases:
object
Class to execute plotms and return a plot wrapper. Task arguments for plotms is customized for single dish usecase.
-
class
pipeline.hsd.tasks.skycal.display.
SingleDishPlotmsSpwComposite
(context, result, calapp, xaxis, yaxis, ant='', pol='', **kwargs)[source]¶ Bases:
pipeline.h.tasks.common.displays.common.SpwComposite
-
leaf_class
¶ alias of
SingleDishPlotmsLeaf
-
-
class
pipeline.hsd.tasks.skycal.display.
SingleDishSkyCalAmpVsFreqDetailChart
(context, result, field)[source]¶ Bases:
pipeline.h.tasks.common.displays.bandpass.BandpassDetailChart
,pipeline.hsd.tasks.skycal.display.SingleDishSkyCalDisplayBase
-
class
pipeline.hsd.tasks.skycal.display.
SingleDishSkyCalAmpVsFreqSummaryChart
(context, result, field)[source]¶ Bases:
pipeline.h.tasks.common.displays.common.PlotbandpassDetailBase
,pipeline.hsd.tasks.skycal.display.SingleDishSkyCalDisplayBase
-
class
pipeline.hsd.tasks.skycal.display.
SingleDishSkyCalAmpVsTimeDetailChart
(context, result, calapp)[source]¶ Bases:
pipeline.hsd.tasks.skycal.display.SingleDishPlotmsAntSpwComposite
-
class
pipeline.hsd.tasks.skycal.display.
SingleDishSkyCalAmpVsTimeSummaryChart
(context, result, calapp)[source]¶ Bases:
pipeline.hsd.tasks.skycal.display.SingleDishPlotmsSpwComposite
-
class
pipeline.hsd.tasks.skycal.display.
SingleDishSkyCalIntervalVsTimeDisplay
(context, result, calapp, figtype='')[source]¶ Bases:
pipeline.h.tasks.common.displays.common.PlotbandpassDetailBase
,pipeline.hsd.tasks.skycal.display.SingleDishSkyCalDisplayBase
Class to execute pyplot and return a plot (figure) of Interval vs. Time. If figtype=’summary’, the first spw is used, while all spw are used if figtype=’detail’.
-
plot
(**kwargs)¶
-
pipeline.hsd.tasks.skycal.qa module¶
-
class
pipeline.hsd.tasks.skycal.qa.
SDSkyCalListQAHandler
[source]¶ Bases:
pipeline.infrastructure.pipelineqa.QAPlugin
-
child_cls
¶
-
result_cls
¶
-
-
class
pipeline.hsd.tasks.skycal.qa.
SDSkyCalQAHandler
[source]¶ Bases:
pipeline.infrastructure.pipelineqa.QAPlugin
-
child_cls
= None¶
-
result_cls
¶
-
pipeline.hsd.tasks.skycal.renderer module¶
-
class
pipeline.hsd.tasks.skycal.renderer.
T2_4MDetailsSingleDishSkyCalRenderer
(uri='skycal.mako', description='Single-Dish Sky Calibration', always_rerender=False)[source]¶ Bases:
pipeline.infrastructure.renderer.basetemplates.T2_4MDetailsDefaultRenderer
pipeline.hsd.tasks.skycal.skycal module¶
-
class
pipeline.hsd.tasks.skycal.skycal.
HpcSDSkyCal
(inputs)[source]¶ Bases:
pipeline.infrastructure.sessionutils.ParallelTemplate
-
Inputs
¶ alias of
HpcSDSkyCalInputs
-
Task
¶ alias of
SerialSDSkyCal
-
get_result_for_exception
(*args, **kw)¶
-
-
class
pipeline.hsd.tasks.skycal.skycal.
HpcSDSkyCalInputs
(context, calmode=None, fraction=None, noff=None, width=None, elongated=None, output_dir=None, infiles=None, outfile=None, field=None, spw=None, scan=None, parallel=None)[source]¶ Bases:
pipeline.hsd.tasks.skycal.skycal.SDSkyCalInputs
-
property
parallel
¶
-
property
-
class
pipeline.hsd.tasks.skycal.skycal.
SDSkyCalInputs
(context, calmode=None, fraction=None, noff=None, width=None, elongated=None, output_dir=None, infiles=None, outfile=None, field=None, spw=None, scan=None)[source]¶ Bases:
pipeline.infrastructure.vdp.StandardInputs
-
calmode
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
elongated
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
field
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
fraction
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
infiles
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
noff
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
outfile
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
scan
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
spw
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
to_casa_args
()[source]¶ Express these inputs as a dictionary of CASA arguments. The values in the dictionary are in a format suitable for CASA and can be directly passed to the CASA task.
- Return type
a dictionary of string/??? kw/val pairs
-
width
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
-
class
pipeline.hsd.tasks.skycal.skycal.
SDSkyCalResults
(task=None, success=None, outcome=None)[source]¶
-
class
pipeline.hsd.tasks.skycal.skycal.
SerialSDSkyCal
(inputs)[source]¶ Bases:
pipeline.infrastructure.basetask.StandardTaskTemplate
-
ElevationDifferenceThreshold
= 3.0¶
-
Inputs
¶ alias of
SDSkyCalInputs
-
analyse
(result)[source]¶ Determine the best parameters by analysing the given jobs before returning any final jobs to execute.
- Parameters
jobs (a list of
JobRequest
) – the job requests generated byprepare()
- Return type
Result
-
-
pipeline.hsd.tasks.skycal.skycal.
compute_elevation_difference
(context, results)[source]¶ Compute elevation difference
- Returns
dictionary[field_id][antenna_id][spw_id]
Value of the dictionary should be ElevationDifference and the value should contain the result from one MS (given that SDSkyCal is per-MS task)